esp-idf-lib/components/pcf8575/pcf8575.h@50dbb626fbab
esp-idf-lib/components/pcf8575/pcf8575.h
Sun, 10 Sep 2023 17:29:15 +0200
- author
- Michiel Broek <mbroek@mbse.eu>
- date
- Sun, 10 Sep 2023 17:29:15 +0200
- changeset 37
- 50dbb626fbab
- parent 1
- 1c9894662795
- permissions
- -rw-r--r--
Version 0.4.3. Attempt to fix the sunlight overflow of the APDS9930 sensor in the private part of the esp-idf-lib. Removed some error checks from functions that always return OK. Store light sensor registers in the state record and report the values in the json result string.
/* * The MIT License (MIT) * * Copyright (c) 2019 Ruslan V. Uss <unclerus@gmail.com> * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ /** * @file pcf8575.h * @defgroup pcf8575 pcf8575 * @{ * * ESP-IDF driver for PCF8575 remote 16-bit I/O expander for I2C-bus * * Copyright (c) 2019 Ruslan V. Uss <unclerus@gmail.com> * * MIT Licensed as described in the file LICENSE */ #ifndef __PCF8575_H__ #define __PCF8575_H__ #include <stddef.h> #include <i2cdev.h> #include <esp_err.h> #ifdef __cplusplus extern "C" { #endif #define PCF8575_I2C_ADDR_BASE 0x20 /** * @brief Initialize device descriptor * * Default SCL frequency is 400kHz * * @param dev Pointer to I2C device descriptor * @param port I2C port number * @param addr I2C address (`0b0100<A2><A1><A0>` for PCF8575) * @param sda_gpio SDA GPIO * @param scl_gpio SCL GPIO * @return `ESP_OK` on success */ esp_err_t pcf8575_init_desc(i2c_dev_t *dev, uint8_t addr, i2c_port_t port, gpio_num_t sda_gpio, gpio_num_t scl_gpio); /** * @brief Free device descriptor * @param dev Pointer to I2C device descriptor * @return `ESP_OK` on success */ esp_err_t pcf8575_free_desc(i2c_dev_t *dev); /** * @brief Read GPIO port value * @param dev Pointer to I2C device descriptor * @param val 8-bit GPIO port value * @return `ESP_OK` on success */ esp_err_t pcf8575_port_read(i2c_dev_t *dev, uint16_t *val); /** * @brief Write value to GPIO port * @param dev Pointer to I2C device descriptor * @param value GPIO port value * @return ESP_OK on success */ esp_err_t pcf8575_port_write(i2c_dev_t *dev, uint16_t value); #ifdef __cplusplus } #endif /**@}*/ #endif /* __PCF8575_H__ */
