ESPHome  2022.6.3
qmc5883l.cpp
Go to the documentation of this file.
1 #include "qmc5883l.h"
2 #include "esphome/core/log.h"
3 #include "esphome/core/hal.h"
4 #include <cmath>
5 
6 namespace esphome {
7 namespace qmc5883l {
8 
9 static const char *const TAG = "qmc5883l";
10 static const uint8_t QMC5883L_ADDRESS = 0x0D;
11 
12 static const uint8_t QMC5883L_REGISTER_DATA_X_LSB = 0x00;
13 static const uint8_t QMC5883L_REGISTER_DATA_X_MSB = 0x01;
14 static const uint8_t QMC5883L_REGISTER_DATA_Y_LSB = 0x02;
15 static const uint8_t QMC5883L_REGISTER_DATA_Y_MSB = 0x03;
16 static const uint8_t QMC5883L_REGISTER_DATA_Z_LSB = 0x04;
17 static const uint8_t QMC5883L_REGISTER_DATA_Z_MSB = 0x05;
18 static const uint8_t QMC5883L_REGISTER_STATUS = 0x06;
19 static const uint8_t QMC5883L_REGISTER_TEMPERATURE_LSB = 0x07;
20 static const uint8_t QMC5883L_REGISTER_TEMPERATURE_MSB = 0x08;
21 static const uint8_t QMC5883L_REGISTER_CONTROL_1 = 0x09;
22 static const uint8_t QMC5883L_REGISTER_CONTROL_2 = 0x0A;
23 static const uint8_t QMC5883L_REGISTER_PERIOD = 0x0B;
24 
26  ESP_LOGCONFIG(TAG, "Setting up QMC5883L...");
27  // Soft Reset
28  if (!this->write_byte(QMC5883L_REGISTER_CONTROL_2, 1 << 7)) {
30  this->mark_failed();
31  return;
32  }
33  delay(10);
34 
35  uint8_t control_1 = 0;
36  control_1 |= 0b01 << 0; // MODE (Mode) -> 0b00=standby, 0b01=continuous
37  control_1 |= this->datarate_ << 2;
38  control_1 |= this->range_ << 4;
39  control_1 |= this->oversampling_ << 6;
40  if (!this->write_byte(QMC5883L_REGISTER_CONTROL_1, control_1)) {
42  this->mark_failed();
43  return;
44  }
45 
46  uint8_t control_2 = 0;
47  control_2 |= 0b0 << 7; // SOFT_RST (Soft Reset) -> 0b00=disabled, 0b01=enabled
48  control_2 |= 0b0 << 6; // ROL_PNT (Pointer Roll Over) -> 0b00=disabled, 0b01=enabled
49  control_2 |= 0b0 << 0; // INT_ENB (Interrupt) -> 0b00=disabled, 0b01=enabled
50  if (!this->write_byte(QMC5883L_REGISTER_CONTROL_2, control_2)) {
52  this->mark_failed();
53  return;
54  }
55 
56  uint8_t period = 0x01; // recommended value
57  if (!this->write_byte(QMC5883L_REGISTER_PERIOD, period)) {
59  this->mark_failed();
60  return;
61  }
62 }
64  ESP_LOGCONFIG(TAG, "QMC5883L:");
65  LOG_I2C_DEVICE(this);
66  if (this->error_code_ == COMMUNICATION_FAILED) {
67  ESP_LOGE(TAG, "Communication with QMC5883L failed!");
68  }
69  LOG_UPDATE_INTERVAL(this);
70 
71  LOG_SENSOR(" ", "X Axis", this->x_sensor_);
72  LOG_SENSOR(" ", "Y Axis", this->y_sensor_);
73  LOG_SENSOR(" ", "Z Axis", this->z_sensor_);
74  LOG_SENSOR(" ", "Heading", this->heading_sensor_);
75 }
78  uint8_t status = false;
79  this->read_byte(QMC5883L_REGISTER_STATUS, &status);
80 
81  uint16_t raw_x, raw_y, raw_z;
82  if (!this->read_byte_16_(QMC5883L_REGISTER_DATA_X_LSB, &raw_x) ||
83  !this->read_byte_16_(QMC5883L_REGISTER_DATA_Y_LSB, &raw_y) ||
84  !this->read_byte_16_(QMC5883L_REGISTER_DATA_Z_LSB, &raw_z)) {
85  this->status_set_warning();
86  return;
87  }
88 
89  float mg_per_bit;
90  switch (this->range_) {
92  mg_per_bit = 0.0833f;
93  break;
95  mg_per_bit = 0.333f;
96  break;
97  default:
98  mg_per_bit = NAN;
99  }
100 
101  // in µT
102  const float x = int16_t(raw_x) * mg_per_bit * 0.1f;
103  const float y = int16_t(raw_y) * mg_per_bit * 0.1f;
104  const float z = int16_t(raw_z) * mg_per_bit * 0.1f;
105 
106  float heading = atan2f(0.0f - x, y) * 180.0f / M_PI;
107  ESP_LOGD(TAG, "Got x=%0.02fµT y=%0.02fµT z=%0.02fµT heading=%0.01f° status=%u", x, y, z, heading, status);
108 
109  if (this->x_sensor_ != nullptr)
110  this->x_sensor_->publish_state(x);
111  if (this->y_sensor_ != nullptr)
112  this->y_sensor_->publish_state(y);
113  if (this->z_sensor_ != nullptr)
114  this->z_sensor_->publish_state(z);
115  if (this->heading_sensor_ != nullptr)
116  this->heading_sensor_->publish_state(heading);
117 }
118 
119 bool QMC5883LComponent::read_byte_16_(uint8_t a_register, uint16_t *data) {
120  if (!this->read_byte_16(a_register, data))
121  return false;
122  *data = (*data & 0x00FF) << 8 | (*data & 0xFF00) >> 8; // Flip Byte order, LSB first;
123  return true;
124 }
125 
126 } // namespace qmc5883l
127 } // namespace esphome
bool read_byte(uint8_t a_register, uint8_t *data, bool stop=true)
Definition: i2c.h:96
bool read_byte_16(uint8_t a_register, uint16_t *data)
Definition: i2c.h:107
const float DATA
For components that import data from directly connected sensors like DHT.
Definition: component.cpp:18
sensor::Sensor * heading_sensor_
Definition: qmc5883l.h:51
enum esphome::qmc5883l::QMC5883LComponent::ErrorCode error_code_
float get_setup_priority() const override
Definition: qmc5883l.cpp:76
bool read_byte_16_(uint8_t a_register, uint16_t *data)
Definition: qmc5883l.cpp:119
void publish_state(float state)
Publish a new state to the front-end.
Definition: sensor.cpp:70
void status_set_warning()
Definition: component.cpp:140
bool write_byte(uint8_t a_register, uint8_t data, bool stop=true)
Definition: i2c.h:123
virtual void mark_failed()
Mark this component as failed.
Definition: component.cpp:111
Definition: a4988.cpp:4
QMC5883LOversampling oversampling_
Definition: qmc5883l.h:47
void IRAM_ATTR HOT delay(uint32_t ms)
Definition: core.cpp:27