ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::mics_5524::MiCS5524Component Class Reference

The MiCS-5524 breakout: one analog output, converted for every configured gas against the clean-air reference, x_air (vendor) or R0 (datasheet), from the configuration, flash or a calibration at boot. More...

#include <mics_5524.h>

Inheritance diagram for esphome::mics_5524::MiCS5524Component:
esphome::PollingComponent esphome::Component

Public Member Functions

 MiCS5524Component (voltage_sampler::VoltageSampler *source)
 source must outlive this component, which code generation guarantees.
 
void setup () override
 
void loop () override
 
void update () override
 
void dump_config () override
 
void register_gas_sensor (MiCS5524GasSensor *gas)
 
void set_conversion (micsmath::ConversionModel conversion)
 
void set_vcc (float vcc)
 
void set_rl (float rl)
 
void set_voltage_multiplier (float multiplier)
 
void set_samples (uint8_t samples)
 
void set_warmup_time (uint32_t warmup)
 
void set_preference_key (uint32_t key)
 Base of the flash key of the stored reference, a hash of the component ID and the front end.
 
void set_enable_pin (GPIOPin *pin)
 Driven active in setup(); EN of the breakout is active low, so inverted: true turns that on.
 
void set_calibration (uint32_t delay, uint32_t samples, uint32_t sample_interval, bool persist, bool at_boot)
 Calibration parameters: start after delay ms, average samples readings sample_interval ms apart; persist keeps the result in flash, at_boot runs one at boot.
 
void set_reference (float reference)
 Clean-air reference from the configuration, x_air (dfrobot) or R0 (datasheet).
 
void request_calibration ()
 Deferred until the warm-up window ends.
 
SUB_SENSOR(voltage) SUB_SENSOR(ratio) SUB_SENSOR(rs) protected float model_value_ (float voltage)
 Value of the active model that the reference is taken from, x = VCC - V_AO (vendor) or RS (datasheet), or NAN (and a status warning) when the voltage is unusable.
 
void publish_ratio_ (float ratio)
 
void publish_diagnostics_ (float voltage, float ratio, float rs)
 
void schedule_calibration_ (uint32_t delay)
 Start a calibration after delay ms; every start goes through here.
 
void begin_calibration_ ()
 
void process_calibration_ ()
 
void finish_calibration_ ()
 
void schedule_calibration_retry_ ()
 
bool save_reference_ ()
 True when the reference reached the storage.
 
bool load_reference_ ()
 
bool is_vendor_model_ () const
 
bool has_reference_ () const
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual float get_setup_priority () const
 priority of setup().
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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 last before a reboot or deep sleep 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.
 
void mark_failed (const LogString *message)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, 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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 

Data Fields

voltage_sampler::VoltageSampler * source_ {nullptr}
 
float vcc_ {5.0f}
 
float rl_ {10.0f}
 
float voltage_multiplier_ {1.0f}
 
uint32_t warmup_time_ {0}
 
GPIOPin * enable_pin_ {nullptr}
 
uint32_t calibration_delay_ {0}
 
uint32_t calibration_samples_ {0}
 
uint32_t sample_interval_ {20}
 Spacing of the clean-air calibration samples (ms); the ~16 ms loop tick is the floor.
 
uint32_t calibration_last_sample_ {0}
 
uint32_t calibration_count_ {0}
 
uint32_t calibration_attempts_ {0}
 
float calibration_sum_ {0.0f}
 
float calibration_min_ {0.0f}
 Smallest and largest clean-air sample of the run, see calibration_is_stable().
 
float calibration_max_ {0.0f}
 
float reference_ {0.0f}
 Clean-air reference, x_air in volts or R0 in kOhm, 0 while there is none.
 
uint32_t preference_key_ {0}
 
ESPPreferenceObject reference_pref_
 
StaticVector< MiCS5524GasSensor *, MICS_5524_GAS_COUNT > gases_
 
micsmath::ConversionModel conversion_ {micsmath::CONVERSION_MODEL_DFROBOT}
 
uint8_t samples_ {4}
 
bool persist_ {false}
 
bool calibrate_at_boot_ {false}
 
bool warming_up_ {false}
 Set from setup() until the warm-up timeout fires.
 
bool calibrating_ {false}
 
bool calibration_pending_ {false}
 A calibration waits for its start time; calibrating_ takes over from there.
 
bool input_fault_ {false}
 The out-of-range warning has been logged; the next usable reading clears it.
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Static Public Attributes

static constexpr uint32_t CALIBRATION_START_ID = 0
 
static constexpr uint32_t CALIBRATION_RETRY_MIN_MS = 10000
 Floor of the delay between two calibration attempts (ms).
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
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 (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
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 (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
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 (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
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.
 
ComponentRuntimeStats runtime_stats_
 

Detailed Description

The MiCS-5524 breakout: one analog output, converted for every configured gas against the clean-air reference, x_air (vendor) or R0 (datasheet), from the configuration, flash or a calibration at boot.

Definition at line 40 of file mics_5524.h.

Constructor & Destructor Documentation

◆ MiCS5524Component()

esphome::mics_5524::MiCS5524Component::MiCS5524Component ( voltage_sampler::VoltageSampler * source)
inlineexplicit

source must outlive this component, which code generation guarantees.

Definition at line 43 of file mics_5524.h.

Member Function Documentation

◆ begin_calibration_()

void esphome::mics_5524::MiCS5524Component::begin_calibration_ ( )

Definition at line 249 of file mics_5524.cpp.

◆ dump_config()

void esphome::mics_5524::MiCS5524Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 103 of file mics_5524.cpp.

◆ finish_calibration_()

void esphome::mics_5524::MiCS5524Component::finish_calibration_ ( )

Definition at line 280 of file mics_5524.cpp.

◆ has_reference_()

bool esphome::mics_5524::MiCS5524Component::has_reference_ ( ) const
inline

Definition at line 95 of file mics_5524.h.

◆ is_vendor_model_()

bool esphome::mics_5524::MiCS5524Component::is_vendor_model_ ( ) const
inline

Definition at line 94 of file mics_5524.h.

◆ load_reference_()

bool esphome::mics_5524::MiCS5524Component::load_reference_ ( )

Definition at line 341 of file mics_5524.cpp.

◆ loop()

void esphome::mics_5524::MiCS5524Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 230 of file mics_5524.cpp.

◆ model_value_()

float esphome::mics_5524::MiCS5524Component::model_value_ ( float voltage)

Value of the active model that the reference is taken from, x = VCC - V_AO (vendor) or RS (datasheet), or NAN (and a status warning) when the voltage is unusable.

Definition at line 141 of file mics_5524.cpp.

◆ process_calibration_()

void esphome::mics_5524::MiCS5524Component::process_calibration_ ( )

Definition at line 264 of file mics_5524.cpp.

◆ publish_diagnostics_()

void esphome::mics_5524::MiCS5524Component::publish_diagnostics_ ( float voltage,
float ratio,
float rs )

Definition at line 169 of file mics_5524.cpp.

◆ publish_ratio_()

void esphome::mics_5524::MiCS5524Component::publish_ratio_ ( float ratio)

Definition at line 161 of file mics_5524.cpp.

◆ register_gas_sensor()

void esphome::mics_5524::MiCS5524Component::register_gas_sensor ( MiCS5524GasSensor * gas)
inline

Definition at line 51 of file mics_5524.h.

◆ request_calibration()

void esphome::mics_5524::MiCS5524Component::request_calibration ( )

Deferred until the warm-up window ends.

Definition at line 211 of file mics_5524.cpp.

◆ save_reference_()

bool esphome::mics_5524::MiCS5524Component::save_reference_ ( )

True when the reference reached the storage.

Definition at line 330 of file mics_5524.cpp.

◆ schedule_calibration_()

void esphome::mics_5524::MiCS5524Component::schedule_calibration_ ( uint32_t delay)

Start a calibration after delay ms; every start goes through here.

Definition at line 245 of file mics_5524.cpp.

◆ schedule_calibration_retry_()

void esphome::mics_5524::MiCS5524Component::schedule_calibration_retry_ ( )

Definition at line 321 of file mics_5524.cpp.

◆ set_calibration()

void esphome::mics_5524::MiCS5524Component::set_calibration ( uint32_t delay,
uint32_t samples,
uint32_t sample_interval,
bool persist,
bool at_boot )

Calibration parameters: start after delay ms, average samples readings sample_interval ms apart; persist keeps the result in flash, at_boot runs one at boot.

Definition at line 202 of file mics_5524.cpp.

◆ set_conversion()

void esphome::mics_5524::MiCS5524Component::set_conversion ( micsmath::ConversionModel conversion)
inline

Definition at line 54 of file mics_5524.h.

◆ set_enable_pin()

void esphome::mics_5524::MiCS5524Component::set_enable_pin ( GPIOPin * pin)
inline

Driven active in setup(); EN of the breakout is active low, so inverted: true turns that on.

Definition at line 63 of file mics_5524.h.

◆ set_preference_key()

void esphome::mics_5524::MiCS5524Component::set_preference_key ( uint32_t key)
inline

Base of the flash key of the stored reference, a hash of the component ID and the front end.

Definition at line 61 of file mics_5524.h.

◆ set_reference()

void esphome::mics_5524::MiCS5524Component::set_reference ( float reference)
inline

Clean-air reference from the configuration, x_air (dfrobot) or R0 (datasheet).

Definition at line 68 of file mics_5524.h.

◆ set_rl()

void esphome::mics_5524::MiCS5524Component::set_rl ( float rl)
inline

Definition at line 56 of file mics_5524.h.

◆ set_samples()

void esphome::mics_5524::MiCS5524Component::set_samples ( uint8_t samples)
inline

Definition at line 58 of file mics_5524.h.

◆ set_vcc()

void esphome::mics_5524::MiCS5524Component::set_vcc ( float vcc)
inline

Definition at line 55 of file mics_5524.h.

◆ set_voltage_multiplier()

void esphome::mics_5524::MiCS5524Component::set_voltage_multiplier ( float multiplier)
inline

Definition at line 57 of file mics_5524.h.

◆ set_warmup_time()

void esphome::mics_5524::MiCS5524Component::set_warmup_time ( uint32_t warmup)
inline

Definition at line 59 of file mics_5524.h.

◆ setup()

void esphome::mics_5524::MiCS5524Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file mics_5524.cpp.

◆ update()

void esphome::mics_5524::MiCS5524Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 176 of file mics_5524.cpp.

Field Documentation

◆ calibrate_at_boot_

bool esphome::mics_5524::MiCS5524Component::calibrate_at_boot_ {false}

Definition at line 135 of file mics_5524.h.

◆ calibrating_

bool esphome::mics_5524::MiCS5524Component::calibrating_ {false}

Definition at line 138 of file mics_5524.h.

◆ calibration_attempts_

uint32_t esphome::mics_5524::MiCS5524Component::calibration_attempts_ {0}

Definition at line 115 of file mics_5524.h.

◆ calibration_count_

uint32_t esphome::mics_5524::MiCS5524Component::calibration_count_ {0}

Definition at line 114 of file mics_5524.h.

◆ calibration_delay_

uint32_t esphome::mics_5524::MiCS5524Component::calibration_delay_ {0}

Definition at line 104 of file mics_5524.h.

◆ calibration_last_sample_

uint32_t esphome::mics_5524::MiCS5524Component::calibration_last_sample_ {0}

Definition at line 113 of file mics_5524.h.

◆ calibration_max_

float esphome::mics_5524::MiCS5524Component::calibration_max_ {0.0f}

Definition at line 119 of file mics_5524.h.

◆ calibration_min_

float esphome::mics_5524::MiCS5524Component::calibration_min_ {0.0f}

Smallest and largest clean-air sample of the run, see calibration_is_stable().

Definition at line 118 of file mics_5524.h.

◆ calibration_pending_

bool esphome::mics_5524::MiCS5524Component::calibration_pending_ {false}

A calibration waits for its start time; calibrating_ takes over from there.

Definition at line 140 of file mics_5524.h.

◆ CALIBRATION_RETRY_MIN_MS

uint32_t esphome::mics_5524::MiCS5524Component::CALIBRATION_RETRY_MIN_MS = 10000
staticconstexpr

Floor of the delay between two calibration attempts (ms).

Definition at line 111 of file mics_5524.h.

◆ calibration_samples_

uint32_t esphome::mics_5524::MiCS5524Component::calibration_samples_ {0}

Definition at line 105 of file mics_5524.h.

◆ CALIBRATION_START_ID

uint32_t esphome::mics_5524::MiCS5524Component::CALIBRATION_START_ID = 0
staticconstexpr

Definition at line 109 of file mics_5524.h.

◆ calibration_sum_

float esphome::mics_5524::MiCS5524Component::calibration_sum_ {0.0f}

Definition at line 116 of file mics_5524.h.

◆ conversion_

micsmath::ConversionModel esphome::mics_5524::MiCS5524Component::conversion_ {micsmath::CONVERSION_MODEL_DFROBOT}

Definition at line 132 of file mics_5524.h.

◆ enable_pin_

GPIOPin* esphome::mics_5524::MiCS5524Component::enable_pin_ {nullptr}

Definition at line 102 of file mics_5524.h.

◆ gases_

StaticVector<MiCS5524GasSensor *, MICS_5524_GAS_COUNT> esphome::mics_5524::MiCS5524Component::gases_

Definition at line 129 of file mics_5524.h.

◆ input_fault_

bool esphome::mics_5524::MiCS5524Component::input_fault_ {false}

The out-of-range warning has been logged; the next usable reading clears it.

Definition at line 142 of file mics_5524.h.

◆ persist_

bool esphome::mics_5524::MiCS5524Component::persist_ {false}

Definition at line 134 of file mics_5524.h.

◆ preference_key_

uint32_t esphome::mics_5524::MiCS5524Component::preference_key_ {0}

Definition at line 124 of file mics_5524.h.

◆ reference_

float esphome::mics_5524::MiCS5524Component::reference_ {0.0f}

Clean-air reference, x_air in volts or R0 in kOhm, 0 while there is none.

Definition at line 122 of file mics_5524.h.

◆ reference_pref_

ESPPreferenceObject esphome::mics_5524::MiCS5524Component::reference_pref_

Definition at line 125 of file mics_5524.h.

◆ rl_

float esphome::mics_5524::MiCS5524Component::rl_ {10.0f}

Definition at line 99 of file mics_5524.h.

◆ sample_interval_

uint32_t esphome::mics_5524::MiCS5524Component::sample_interval_ {20}

Spacing of the clean-air calibration samples (ms); the ~16 ms loop tick is the floor.

Definition at line 107 of file mics_5524.h.

◆ samples_

uint8_t esphome::mics_5524::MiCS5524Component::samples_ {4}

Definition at line 133 of file mics_5524.h.

◆ source_

voltage_sampler::VoltageSampler* esphome::mics_5524::MiCS5524Component::source_ {nullptr}

Definition at line 97 of file mics_5524.h.

◆ vcc_

float esphome::mics_5524::MiCS5524Component::vcc_ {5.0f}

Definition at line 98 of file mics_5524.h.

◆ voltage_multiplier_

float esphome::mics_5524::MiCS5524Component::voltage_multiplier_ {1.0f}

Definition at line 100 of file mics_5524.h.

◆ warming_up_

bool esphome::mics_5524::MiCS5524Component::warming_up_ {false}

Set from setup() until the warm-up timeout fires.

Definition at line 137 of file mics_5524.h.

◆ warmup_time_

uint32_t esphome::mics_5524::MiCS5524Component::warmup_time_ {0}

Definition at line 101 of file mics_5524.h.


The documentation for this class was generated from the following files: