|
| void | set_samples (uint32_t samples) |
| |
| void | set_phase_offset (int8_t phase_offset) |
| |
| void | set_pga_gain (CS5460APGAGain pga_gain) |
| |
| void | set_gains (float current_gain, float voltage_gain) |
| |
| void | set_hpf_enable (bool current_hpf, bool voltage_hpf) |
| |
| void | set_pulse_energy_wh (float pulse_energy_wh) |
| |
| void | set_current_sensor (sensor::Sensor *current_sensor) |
| |
| void | set_voltage_sensor (sensor::Sensor *voltage_sensor) |
| |
| void | set_power_sensor (sensor::Sensor *power_sensor) |
| |
| void | restart () |
| |
| void | setup () override |
| |
| void | dump_config () override |
| |
| virtual void | loop () |
| | This method will be called repeatedly.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| void | mark_failed () |
| | Mark this component as failed.
|
| |
| | ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message) |
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| bool | is_failed () const |
| |
| bool | is_ready () const |
| |
| virtual bool | can_proceed () |
| |
| bool | status_has_warning () const |
| |
| bool | status_has_error () const |
| |
| void | status_set_warning (const char *message=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error () |
| |
| | ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message) |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| | Set warning status flag and automatically clear it after a timeout.
|
| |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| | Set error status flag and automatically clear it after a timeout.
|
| |
| bool | has_overridden_loop () const |
| |
| void | set_component_source (const LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
| | SPIDevice () |
| |
| | SPIDevice (SPIComponent *parent, GPIOPin *cs_pin) |
| |
| void | spi_setup () override |
| |
| void | spi_teardown () override |
| |
| void | set_spi_parent (SPIComponent *parent) |
| |
| void | set_cs_pin (GPIOPin *cs) |
| |
| void | set_data_rate (uint32_t data_rate) |
| |
| void | set_bit_order (SPIBitOrder order) |
| |
| void | set_mode (SPIMode mode) |
| |
| uint8_t | read_byte () |
| |
| void | read_array (uint8_t *data, size_t length) |
| |
| void | write (uint16_t data, size_t num_bits) |
| | Write a single data item, up to 32 bits.
|
| |
| void | write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1) |
| |
| void | write_byte (uint8_t data) |
| |
| void | transfer_array (uint8_t *data, size_t length) |
| | Write the array data, replace with received data.
|
| |
| void | transfer_array (std::array< uint8_t, N > &data) |
| |
| uint8_t | transfer_byte (uint8_t data) |
| |
| void | write_byte16 (uint16_t data) |
| | Write 16 bit data.
|
| |
| void | write_array16 (const uint16_t *data, size_t length) |
| | Write an array of data as 16 bit values, byte-swapping if required.
|
| |
| void | enable () |
| |
| void | disable () |
| |
| void | write_array (const uint8_t *data, size_t length) |
| |
| void | write_array (const std::array< uint8_t, N > &data) |
| |
| void | write_array (const std::vector< uint8_t > &data) |
| |
| | SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate) |
| |
| bool | spi_is_ready () |
| |
| void | set_release_device (bool release) |
| |
| void | set_write_only (bool write_only) |
| |
|
| void | write_register_ (enum CS5460ARegister addr, uint32_t value) |
| |
| uint32_t | read_register_ (uint8_t addr) |
| |
| bool | softreset_ () |
| |
| void | hw_init_ () |
| |
| void | restart_ () |
| |
| void | started_ () |
| |
| void | schedule_next_check_ () |
| |
| bool | check_status_ () |
| |
| void | call_loop_ () |
| |
| virtual void | call_setup () |
| |
| void | call_dump_config_ () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| bool | set_status_flag_ (uint8_t flag) |
| | Helper to set a status LED flag on both this component and the app.
|
| |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a numeric ID (zero heap allocation).
|
| |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (uint32_t id) |
| |
| bool | cancel_interval (InternalSchedulerID id) |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time |
| |
| ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name) |
| |
| | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id) |
| |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a numeric ID (zero heap allocation).
|
| |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (uint32_t id) |
| |
| bool | cancel_timeout (InternalSchedulerID id) |
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (uint32_t id, std::function< void()> &&f) |
| | Defer a callback with a numeric ID (zero heap allocation)
|
| |
| bool | cancel_defer (uint32_t id) |
| |
|
| uint32_t | samples_ |
| |
| int8_t | phase_offset_ |
| |
| CS5460APGAGain | pga_gain_ |
| |
| float | current_gain_ |
| |
| float | voltage_gain_ |
| |
| bool | current_hpf_ |
| |
| bool | voltage_hpf_ |
| |
| float | pulse_energy_wh_ |
| |
| sensor::Sensor * | current_sensor_ {nullptr} |
| |
| sensor::Sensor * | voltage_sensor_ {nullptr} |
| |
| sensor::Sensor * | power_sensor_ {nullptr} |
| |
| float | current_multiplier_ |
| |
| float | voltage_multiplier_ |
| |
| float | power_multiplier_ |
| |
| float | pulse_freq_ |
| |
| uint32_t | expect_data_ts_ |
| |
| uint32_t | prev_raw_current_ {0} |
| |
| uint32_t | prev_raw_energy_ {0} |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi | set_interval )(const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo | cancel_interval )(const char *name) |
| | Cancel an interval function.
|
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t | initial_wait_time |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t | max_attempts |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint32_t | initial_wait_time |
| |
| uint32_t uint8_t | max_attempts |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint8_t | max_attempts |
| |
| uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi | set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo | cancel_timeout )(const char *name) |
| | Cancel a timeout function.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi | defer )(const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo | cancel_defer )(const char *name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| const LogString * | component_source_ {nullptr} |
| |
| uint16_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS} |
| | Warn if blocked for this many ms (max 65.5s)
|
| |
| uint8_t | component_state_ {0x00} |
| | State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
|
| |
| volatile bool | pending_enable_loop_ {false} |
| | ISR-safe flag for enable_loop_soon_any_context.
|
| |
| SPIBitOrder | bit_order_ {BIT_ORDER_MSB_FIRST} |
| |
| SPIMode | mode_ {MODE0} |
| |
| uint32_t | data_rate_ {1000000} |
| |
| SPIComponent * | parent_ {nullptr} |
| |
| GPIOPin * | cs_ {nullptr} |
| |
| bool | release_device_ {false} |
| |
| bool | write_only_ {false} |
| |
| SPIDelegate * | delegate_ {SPIDelegate::NULL_DELEGATE} |
| |
Definition at line 56 of file cs5460a.h.