Thu, 06 Apr 2023 20:53:06 +0200
Set the new measured deep sleep current consumption. This is half of the Wemos D1 system.
/* * Copyright (c) 2019 Ruslan V. Uss <unclerus@gmail.com> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of the copyright holder nor the names of itscontributors * may be used to endorse or promote products derived from this software without * specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /** * @file qmc5883l.h * @defgroup qmc5883l qmc5883l * @{ * * ESP-IDF Driver for 3-axis magnetic sensor QMC5883L * * Copyright (c) 2019 Ruslan V. Uss <unclerus@gmail.com> * * BSD Licensed as described in the file LICENSE */ #ifndef __QMC5883L_H__ #define __QMC5883L_H__ #include <stdint.h> #include <stdbool.h> #include <i2cdev.h> #include <esp_err.h> #ifdef __cplusplus extern "C" { #endif /** * Default I2C address */ #define QMC5883L_I2C_ADDR_DEF 0x0d /** * Output data rate */ typedef enum { QMC5883L_DR_10 = 0, //!< 10Hz QMC5883L_DR_50, //!< 50Hz QMC5883L_DR_100, //!< 100Hz QMC5883L_DR_200, //!< 200Hz } qmc5883l_odr_t; /** * Oversampling rate */ typedef enum { QMC5883L_OSR_64 = 0, //!< 64 samples QMC5883L_OSR_128, //!< 128 samples QMC5883L_OSR_256, //!< 256 samples QMC5883L_OSR_512, //!< 512 samples } qmc5883l_osr_t; /** * Field range */ typedef enum { QMC5883L_RNG_2 = 0,//!< -2G..+2G QMC5883L_RNG_8 //!< -8G..+8G } qmc5883l_range_t; /** * Mode */ typedef enum { QMC5883L_MODE_STANDBY = 0, //!< Standby low power mode, no measurements QMC5883L_MODE_CONTINUOUS //!< Continuous measurements } qmc5883l_mode_t; /** * Raw measurement result */ typedef struct { int16_t x; int16_t y; int16_t z; } qmc5883l_raw_data_t; /** * Measurement result, milligauss */ typedef struct { float x; float y; float z; } qmc5883l_data_t; /** * Device descriptor */ typedef struct { i2c_dev_t i2c_dev; qmc5883l_range_t range; } qmc5883l_t; /** * @brief Initialize device descriptor * * @param dev Device descriptor * @param port I2C port number * @param addr I2C address * @param sda_gpio SDA GPIO * @param scl_gpio SCL GPIO * @return `ESP_OK` on success */ esp_err_t qmc5883l_init_desc(qmc5883l_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 Device descriptor * @return `ESP_OK` on success */ esp_err_t qmc5883l_free_desc(qmc5883l_t *dev); /** * @brief Reset device * * @param dev Device descriptor * @return `ESP_OK` on success */ esp_err_t qmc5883l_reset(qmc5883l_t *dev); /** * @brief Read chip ID * * @param dev Device descriptor * @param[out] id Chip ID * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_chip_id(qmc5883l_t *dev, uint8_t *id); /** * @brief Set device mode * * @param dev Device descriptor * @param mode Mode * @return `ESP_OK` on success */ esp_err_t qmc5883l_set_mode(qmc5883l_t *dev, qmc5883l_mode_t mode); /** * @brief Read current device mode * * @param dev Device descriptor * @param[out] mode Mode * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_mode(qmc5883l_t *dev, qmc5883l_mode_t *mode); /** * @brief Set device configuration * * @param dev Device descriptor * @param odr Output data rate * @param osr Oversampling * @param rng Field range * @return `ESP_OK` on success */ esp_err_t qmc5883l_set_config(qmc5883l_t *dev, qmc5883l_odr_t odr, qmc5883l_osr_t osr, qmc5883l_range_t rng); /** * @brief Read current device configuration * * @param dev Device descriptor * @param[out] odr Output data rate * @param[out] osr Oversampling * @param[out] rng Field range * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_config(qmc5883l_t *dev, qmc5883l_odr_t *odr, qmc5883l_osr_t *osr, qmc5883l_range_t *rng); /** * @brief Enable/disable interrupt pin * * @param dev Device descriptor * @param enable Enable interrupt if true * @return `ESP_OK` on success */ esp_err_t qmc5883l_set_int(qmc5883l_t *dev, bool enable); /** * @brief Get interrupt pin state * * @param dev Device descriptor * @param[out] enable Interrupt pin enabled if true * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_int(qmc5883l_t *dev, bool *enable); /** * @brief Get magnetic data state * * @param dev Device descriptor * @param[out] ready Magnetic data ready to read if true * @return `ESP_OK` on success */ esp_err_t qmc5883l_data_ready(qmc5883l_t *dev, bool *ready); /** * @brief Read raw magnetic data * * @param dev Device descriptor * @param[out] raw Raw magnetic data * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_raw_data(qmc5883l_t *dev, qmc5883l_raw_data_t *raw); /** * @brief Convert raw magnetic data to milligauss * * @param dev Device descriptor * @param raw Raw magnetic data * @param[out] data Magnetic data in mG * @return `ESP_OK` on success */ esp_err_t qmc5883l_raw_to_mg(qmc5883l_t *dev, qmc5883l_raw_data_t *raw, qmc5883l_data_t *data); /** * @brief Read magnetic data in milligauss * * @param dev Device descriptor * @param[out] data Magnetic data in mG * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_data(qmc5883l_t *dev, qmc5883l_data_t *data); /** * @brief Read raw temperature data (see datasheet) * * @param dev Device descriptor * @param[out] temp Raw temperature data * @return `ESP_OK` on success */ esp_err_t qmc5883l_get_raw_temp(qmc5883l_t *dev, int16_t *temp); #ifdef __cplusplus } #endif /**@}*/ #endif /* __QMC5883L_H__ */