esp32-owb
ESP32-compatible C library for Maxim Integrated 1-Wire Bus.
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Pages
owb_gpio.h
Go to the documentation of this file.
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 
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 
49 typedef struct
50 {
51  int gpio;
54 
59 OneWireBus * owb_gpio_initialize(owb_gpio_driver_info *driver_info, int gpio);
60 
65 
66 #ifdef __cplusplus
67 }
68 #endif
69 
70 #endif // OWB_GPIO_H
OneWireBus * owb_gpio_initialize(owb_gpio_driver_info *driver_info, int gpio)
Initialise the GPIO driver.
Definition: owb_gpio.c:264
Structure containing 1-Wire bus information relevant to a single instance.
Definition: owb.h:68
int gpio
Value of the GPIO connected to the 1-Wire bus.
Definition: owb_gpio.h:51
GPIO driver information.
Definition: owb_gpio.h:49
void owb_gpio_uninitialize(owb_gpio_driver_info *driver_info)
Clean up after a call to owb_gpio_initialize()
Interface definitions for the 1-Wire bus component.
OneWireBus bus
OneWireBus instance.
Definition: owb_gpio.h:52