latonita/ce2727a-driver

uploaded 2 months ago

# CE2727A simple driver [](https://components.espressif.com/components/latonita/ce2727a-driver) [](https://github.com/latonita/ce2727a-driver/actions/workflows/build_example.yml) This repository contains an ESP-IDF driver for a CE2727A power meter connected over UART (RS485). ## Using the component Run the following command in your ESP-IDF project to install this component: ```bash idf.py add-dependency "latonita/ce2727a-driver" ``` ## Example To run the provided example, create it as follows: ```bash idf.py create-project-from-example "latonita/ce2727a-driver:ce2727a-example" ``` Then build as usual: ```bash cd ce2727a-example idf.py build ``` And flash it to the board: ```bash idf.py -p PORT flash monitor ``` ....todo.... ## License This component is provided under Apache 2.0 license, see [LICENSE](LICENSE.md) file for details. ## Contributing Please check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

# API Reference ## Header files - [include/ce2727a.h](#file-includece2727ah) ## File include/ce2727a.h ## Structures and Types | Type | Name | | ---: | :--- | | struct | [**ce2727a\_config\_t**](#struct-ce2727a_config_t) <br>_CE2727A driver configuration._ | | typedef struct ce2727a\_driver\_state\_t \* | [**ce2727a\_handle\_t**](#typedef-ce2727a_handle_t) <br>_CE2727A driver handle._ | | struct | [**ce2727a\_readings\_energy\_t**](#struct-ce2727a_readings_energy_t) <br>_CE2727A readings._ | ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**ce2727a\_deinit**](#function-ce2727a_deinit) (ce2727a\_handle\_t handle) <br>_Deinitialize the CE2727A driver._ | | esp\_err\_t | [**ce2727a\_get\_active\_power**](#function-ce2727a_get_active_power) (ce2727a\_handle\_t handle, uint32\_t \* active\_power, uint16\_t timeout\_ms) <br>_Get active power._ | | esp\_err\_t | [**ce2727a\_get\_energy**](#function-ce2727a_get_energy) (ce2727a\_handle\_t handle, [**ce2727a\_readings\_energy\_t**](#struct-ce2727a_readings_energy_t)\* readings, uint16\_t timeout\_ms) <br>_Get energy readings._ | | esp\_err\_t | [**ce2727a\_init**](#function-ce2727a_init) (const [**ce2727a\_config\_t**](#struct-ce2727a_config_t)\* config, ce2727a\_handle\_t \* out\_handle) <br>_Initialize the CE2727A driver._ | ## Structures and Types Documentation ### struct `ce2727a_config_t` _CE2727A driver configuration._ Variables: - uint32\_t addr <br>Target power meter address, default is 0x0 - broadcasting to all meters - uint32\_t password <br>Target power meter password, default is 0x0 - uint8\_t \* rx_buffer <br>Receive buffer. Shall be enough to hold required responses - uint16\_t rx_buffer_size <br>Size of receive buffer - uart\_config\_t \* uart_config_override <br>UART port configuration override parameters. defaults: 9600,8E1 - uint8\_t uart_de_pin <br>UART RTS pin for RS485 DE=!RE - uint8\_t uart_port <br>UART port number - uint8\_t uart_rx_pin <br>UART RX pin - uint8\_t uart_tx_pin <br>UART TX pin ### typedef `ce2727a_handle_t` _CE2727A driver handle._ ```c typedef struct ce2727a_driver_state_t* ce2727a_handle_t; ``` ### struct `ce2727a_readings_energy_t` _CE2727A readings._ Variables: - uint8\_t active_tariff <br>Current active tariff [1,2,3,4] - uint32\_t t1 <br>Cumulative energy for tariff 1 - uint32\_t t2 <br>Cumulative energy for tariff 2 - uint32\_t t3 <br>Cumulative energy for tariff 3 - uint32\_t t4 <br>Cumulative energy for tariff 4 - uint32\_t total <br>Cumulative energy consumed on all tariffs ## Functions Documentation ### function `ce2727a_deinit` _Deinitialize the CE2727A driver._ ```c esp_err_t ce2727a_deinit ( ce2727a_handle_t handle ) ``` **Parameters:** * `handle` Driver handle obtained from ce2727a\_init(), or NULL **Returns:** esp\_err\_t ESP\_OK on success. ### function `ce2727a_get_active_power` _Get active power._ ```c esp_err_t ce2727a_get_active_power ( ce2727a_handle_t handle, uint32_t * active_power, uint16_t timeout_ms ) ``` Get current active power **Parameters:** * `handle` Driver handle obtained from ce2727a\_init() * `active_power` Active power * `timeout_ms` Timeout in milliseconds for receiving a response from the meter **Returns:** esp\_err\_t * ESP\_OK on success * ESP\_ERR\_TIMEOUT if no message was received within the timeout * ESP\_ERR\_INVALID\_ARG if the buffer too short * ESP\_ERR\_INVALID\_RESPONSE * ESP\_ERR\_INVALID\_CRC * ESP\_ERR\_INVALID\_STATE Issues sending data ### function `ce2727a_get_energy` _Get energy readings._ ```c esp_err_t ce2727a_get_energy ( ce2727a_handle_t handle, ce2727a_readings_energy_t * readings, uint16_t timeout_ms ) ``` Get energy readings **Parameters:** * `handle` Driver handle obtained from ce2727a\_init() * `readings` Destination for readings * `timeout_ms` Timeout in milliseconds for receiving a response from the meter **Returns:** esp\_err\_t * ESP\_OK on success * ESP\_ERR\_TIMEOUT if no message was received within the timeout * ESP\_ERR\_INVALID\_ARG if the buffer too short * ESP\_ERR\_INVALID\_RESPONSE * ESP\_ERR\_INVALID\_CRC * ESP\_ERR\_INVALID\_STATE Issues sending data ### function `ce2727a_init` _Initialize the CE2727A driver._ ```c esp_err_t ce2727a_init ( const ce2727a_config_t * config, ce2727a_handle_t * out_handle ) ``` **Parameters:** * `config` Pointer to the configuration struct. The driver makes a copy, so can point to a local variable. * `out_handle` Pointer to a variable to receive the driver handle. **Returns:** esp\_err\_t ESP\_OK on success, ESP\_ERR\_NO\_MEM if out of memory.

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] - Command: Request general information - Command: Request date/time ## [0.2.0] - 2023-09-15 - Initial release