ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
pmsx003.h
Go to the documentation of this file.
1#pragma once
2
7
8namespace esphome::pmsx003 {
9
10enum class Type : uint8_t {
11 PMS1003 = 0,
12 PMS3003,
13 PMSX003, // PMS5003, PMS6003, PMS7003, PMSA003 (NOT PMSA003I - see `pmsa003i` component)
18 LUFTMY, // Luftmy LD10, LD11, LD13, LD15, LD16: standard PM + particle counts, no atmospheric PM values
19};
20
21enum class Command : uint8_t {
22 MEASUREMENT_MODE = 0xE1, // Data Options: `CMD_MEASUREMENT_MODE_PASSIVE`, `CMD_MEASUREMENT_MODE_ACTIVE`
23 MANUAL_MEASUREMENT = 0xE2,
24 SLEEP_MODE = 0xE4, // Data Options: `CMD_SLEEP_MODE_SLEEP`, `CMD_SLEEP_MODE_WAKEUP`
25};
26
27enum class State : uint8_t {
28 IDLE = 0,
30 WAITING,
31};
32
33class PMSX003Component final : public uart::UARTDevice, public Component {
34 public:
35 PMSX003Component() = default;
36 void setup() override;
37 void dump_config() override;
38 void loop() override;
39
40 void set_update_interval(uint32_t update_interval) { this->update_interval_ = update_interval; }
41
42 void set_type(Type type) { this->type_ = type; }
43
44 // "Standard Particle"
45 SUB_SENSOR(pm_1_0_std)
46 SUB_SENSOR(pm_2_5_std)
47 SUB_SENSOR(pm_10_0_std)
48
49 // "Under Atmospheric Pressure"
50 SUB_SENSOR(pm_1_0)
51 SUB_SENSOR(pm_2_5)
52 SUB_SENSOR(pm_10_0)
53
54 // Particle counts by size
55 SUB_SENSOR(pm_particles_03um)
56 SUB_SENSOR(pm_particles_05um)
57 SUB_SENSOR(pm_particles_10um)
58 SUB_SENSOR(pm_particles_25um)
59 SUB_SENSOR(pm_particles_50um)
60 SUB_SENSOR(pm_particles_100um)
61
62 // Formaldehyde
63 SUB_SENSOR(formaldehyde)
64
65 // Temperature and Humidity
66 SUB_SENSOR(temperature)
67 SUB_SENSOR(humidity)
68
69 protected:
70 optional<bool> check_byte_();
71 void parse_data_();
72 bool check_payload_length_(uint16_t payload_length);
73 void send_command_(Command cmd, uint16_t data);
74 uint16_t get_16_bit_uint_(uint8_t start_index) const {
75 return encode_uint16(this->data_[start_index], this->data_[start_index + 1]);
76 }
77
80 bool initialised_{false};
81 uint8_t data_[64];
82 uint8_t data_index_{0};
87};
88
89} // namespace esphome::pmsx003
void set_update_interval(uint32_t update_interval)
Definition pmsx003.h:40
SUB_SENSOR(pm_1_0_std) SUB_SENSOR(pm_2_5_std) SUB_SENSOR(pm_10_0_std) SUB_SENSOR(pm_1_0) SUB_SENSOR(pm_2_5) SUB_SENSOR(pm_10_0) SUB_SENSOR(pm_particles_03um) SUB_SENSOR(pm_particles_05um) SUB_SENSOR(pm_particles_10um) SUB_SENSOR(pm_particles_25um) SUB_SENSOR(pm_particles_50um) SUB_SENSOR(pm_particles_100um) SUB_SENSOR(formaldehyde) SUB_SENSOR(temperature) SUB_SENSOR(humidity) protected void parse_data_()
Definition pmsx003.cpp:218
uint16_t get_16_bit_uint_(uint8_t start_index) const
Definition pmsx003.h:74
void send_command_(Command cmd, uint16_t data)
Definition pmsx003.cpp:197
bool check_payload_length_(uint16_t payload_length)
Definition pmsx003.cpp:175
uint8_t type
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
Definition helpers.h:1043
static void uint32_t
uint16_t temperature
Definition sun_gtil2.cpp:12