Mon, 24 Jun 2024 17:05:20 +0200
Start migration to IDF 5.1
0 | 1 | /* |
2 | * MIT License | |
3 | * | |
4 | * Copyright (c) 2017 David Antliff | |
5 | * Copyright (c) 2017 Chris Morgan <chmorgan@gmail.com> | |
6 | * | |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in all | |
15 | * copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
129 | 26 | /** |
27 | * @file | |
28 | * @brief Interface definitions for the ESP32 GPIO driver used to communicate with devices | |
29 | * on the One Wire Bus. | |
30 | * | |
31 | * @deprecated | |
32 | * This driver is deprecated and may be removed at some stage. It is not recommended for use | |
33 | * due to issues with imprecise timing. | |
34 | */ | |
35 | ||
0 | 36 | #pragma once |
37 | #ifndef OWB_GPIO_H | |
38 | #define OWB_GPIO_H | |
39 | ||
40 | #include "owb.h" | |
41 | ||
42 | #ifdef __cplusplus | |
43 | extern "C" { | |
44 | #endif | |
45 | ||
29 | 46 | /** |
129 | 47 | * @brief GPIO driver information |
29 | 48 | */ |
0 | 49 | typedef struct |
50 | { | |
51 | int gpio; ///< Value of the GPIO connected to the 1-Wire bus | |
52 | OneWireBus bus; ///< OneWireBus instance | |
53 | } owb_gpio_driver_info; | |
54 | ||
55 | /** | |
56 | * @brief Initialise the GPIO driver. | |
57 | * @return OneWireBus*, pass this into the other OneWireBus public API functions | |
58 | */ | |
59 | OneWireBus * owb_gpio_initialize(owb_gpio_driver_info *driver_info, int gpio); | |
60 | ||
61 | /** | |
62 | * @brief Clean up after a call to owb_gpio_initialize() | |
63 | */ | |
64 | void owb_gpio_uninitialize(owb_gpio_driver_info *driver_info); | |
65 | ||
66 | #ifdef __cplusplus | |
67 | } | |
68 | #endif | |
69 | ||
70 | #endif // OWB_GPIO_H |