mirror of https://github.com/esphome/esphome.git
Add thermocouple type, autoconversion, averaging, and has_fault to max31856
This commit is contained in:
Frank Riley
parent
05fbb260ee
commit
66426606fc
|
|
@ -8,148 +8,242 @@ namespace max31856 {
|
|||
|
||||
static const char *const TAG = "max31856";
|
||||
|
||||
enum MAX31856RegisterMasks : uint8_t { SPI_WRITE_M = 0x80 };
|
||||
|
||||
enum MAX31856Registers : uint8_t {
|
||||
MAX31856_MASK_REG = 0x02, ///< Fault Mask register
|
||||
MAX31856_CJHF_REG = 0x03, ///< Cold junction High temp fault register
|
||||
MAX31856_CJLF_REG = 0x04, ///< Cold junction Low temp fault register
|
||||
MAX31856_LTHFTH_REG = 0x05, ///< Linearized Temperature High Fault Threshold Register, MSB
|
||||
MAX31856_LTHFTL_REG = 0x06, ///< Linearized Temperature High Fault Threshold Register, LSB
|
||||
MAX31856_LTLFTH_REG = 0x07, ///< Linearized Temperature Low Fault Threshold Register, MSB
|
||||
MAX31856_LTLFTL_REG = 0x08, ///< Linearized Temperature Low Fault Threshold Register, LSB
|
||||
MAX31856_CJTO_REG = 0x09, ///< Cold-Junction Temperature Offset Register
|
||||
MAX31856_CJTH_REG = 0x0A, ///< Cold-Junction Temperature Register, MSB
|
||||
MAX31856_CJTL_REG = 0x0B, ///< Cold-Junction Temperature Register, LSB
|
||||
MAX31856_LTCBH_REG = 0x0C, ///< Linearized TC Temperature, Byte 2
|
||||
MAX31856_LTCBM_REG = 0x0D, ///< Linearized TC Temperature, Byte 1
|
||||
MAX31856_LTCBL_REG = 0x0E, ///< Linearized TC Temperature, Byte 0
|
||||
MAX31856_SR_REG = 0x0F, ///< Fault Status Register
|
||||
|
||||
MAX31856_FAULT_CJRANGE = 0x80, ///< Fault status Cold Junction Out-of-Range flag
|
||||
MAX31856_FAULT_TCRANGE = 0x40, ///< Fault status Thermocouple Out-of-Range flag
|
||||
MAX31856_FAULT_CJHIGH = 0x20, ///< Fault status Cold-Junction High Fault flag
|
||||
MAX31856_FAULT_CJLOW = 0x10, ///< Fault status Cold-Junction Low Fault flag
|
||||
MAX31856_FAULT_TCHIGH = 0x08, ///< Fault status Thermocouple Temperature High Fault flag
|
||||
MAX31856_FAULT_TCLOW = 0x04, ///< Fault status Thermocouple Temperature Low Fault flag
|
||||
MAX31856_FAULT_OVUV = 0x02, ///< Fault status Overvoltage or Undervoltage Input Fault flag
|
||||
MAX31856_FAULT_OPEN = 0x01, ///< Fault status Thermocouple Open-Circuit Fault flag
|
||||
};
|
||||
|
||||
constexpr static uint8_t MAX31856_CR0_REG = 0x00;
|
||||
constexpr static uint8_t MAX31856_CR0_AUTOCONVERT = 1 << 7;
|
||||
constexpr static uint8_t MAX31856_CR0_1SHOT = 1 << 6;
|
||||
constexpr static uint8_t MAX31856_CR0_OCFAULT_ENABLED = 1 << 4;
|
||||
constexpr static uint8_t MAX31856_CR0_CJ_SENSOR_DISABLE = 1 << 3;
|
||||
constexpr static uint8_t MAX31856_CR0_FAULT_INT_MODE = 1 << 2;
|
||||
constexpr static uint8_t MAX31856_CR0_FAULTCLR = 1 << 1;
|
||||
|
||||
constexpr static uint8_t MAX31856_CR1_REG = 0x01;
|
||||
|
||||
// Based on Adafruit's library: https://github.com/adafruit/Adafruit_MAX31856
|
||||
|
||||
#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
|
||||
|
||||
static const char *enum_type_to_str(MAX31856ThermocoupleType type) {
|
||||
switch (type) {
|
||||
case MAX31856_TCTYPE_B:
|
||||
return "B";
|
||||
case MAX31856_TCTYPE_E:
|
||||
return "E";
|
||||
case MAX31856_TCTYPE_J:
|
||||
return "J";
|
||||
case MAX31856_TCTYPE_K:
|
||||
return "K";
|
||||
case MAX31856_TCTYPE_N:
|
||||
return "N";
|
||||
case MAX31856_TCTYPE_R:
|
||||
return "R";
|
||||
case MAX31856_TCTYPE_S:
|
||||
return "S";
|
||||
case MAX31856_TCTYPE_T:
|
||||
return "T";
|
||||
}
|
||||
return "K";
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
static int enum_samples_per_value_to_int(MAX31856SamplesPerValue value) {
|
||||
switch (value) {
|
||||
case AVE_SAMPLES_1:
|
||||
return 1;
|
||||
case AVE_SAMPLES_2:
|
||||
return 2;
|
||||
case AVE_SAMPLES_4:
|
||||
return 4;
|
||||
case AVE_SAMPLES_8:
|
||||
return 8;
|
||||
case AVE_SAMPLES_16:
|
||||
return 16;
|
||||
}
|
||||
return 16;
|
||||
}
|
||||
|
||||
void MAX31856Sensor::setup() {
|
||||
ESP_LOGCONFIG(TAG, "Setting up MAX31856Sensor '%s'...", this->name_.c_str());
|
||||
ESP_LOGVV(TAG, "Setting up MAX31856Sensor '%s'...", this->name_.c_str());
|
||||
|
||||
this->spi_setup();
|
||||
|
||||
// assert on any fault
|
||||
ESP_LOGCONFIG(TAG, "Setting up assertion on all faults");
|
||||
this->write_register_(MAX31856_MASK_REG, 0x0);
|
||||
|
||||
ESP_LOGCONFIG(TAG, "Setting up open circuit fault detection");
|
||||
this->write_register_(MAX31856_CR0_REG, MAX31856_CR0_OCFAULT01);
|
||||
// Set the thermocouple type and the number of samples to average
|
||||
this->write_register_(MAX31856_CR1_REG, static_cast<uint8_t>(samples_per_value_) | static_cast<uint8_t>(type_));
|
||||
|
||||
this->set_thermocouple_type_();
|
||||
this->set_noise_filter_();
|
||||
// Turn on open circuit faults and set the filter
|
||||
cr0_ = MAX31856_CR0_OCFAULT_ENABLED | static_cast<uint8_t>(filter_);
|
||||
|
||||
ESP_LOGCONFIG(TAG, "Completed setting up MAX31856Sensor '%s'...", this->name_.c_str());
|
||||
if (this->data_ready_ != nullptr) {
|
||||
// Enable autoconversion
|
||||
cr0_ |= MAX31856_CR0_AUTOCONVERT;
|
||||
|
||||
// Data ready is active low
|
||||
this->data_ready_->pin_mode(gpio::FLAG_INPUT | gpio::FLAG_PULLUP);
|
||||
|
||||
ESP_LOGI(TAG, "Using autoconversion mode, update_interval will be ignored");
|
||||
}
|
||||
|
||||
this->write_register_(MAX31856_CR0_REG, cr0_);
|
||||
|
||||
ESP_LOGVV(TAG, "Completed setting up MAX31856Sensor '%s'...", this->name_.c_str());
|
||||
}
|
||||
|
||||
void MAX31856Sensor::dump_config() {
|
||||
LOG_SENSOR("", "MAX31856", this);
|
||||
LOG_PIN(" CS Pin: ", this->cs_);
|
||||
if (this->data_ready_ != nullptr) {
|
||||
LOG_PIN(" Data Ready Pin: ", this->data_ready_);
|
||||
} else {
|
||||
LOG_UPDATE_INTERVAL(this);
|
||||
}
|
||||
ESP_LOGCONFIG(TAG, " Mains Filter: %s",
|
||||
(filter_ == FILTER_60HZ ? "60 Hz" : (filter_ == FILTER_50HZ ? "50 Hz" : "Unknown!")));
|
||||
LOG_UPDATE_INTERVAL(this);
|
||||
ESP_LOGCONFIG(TAG, " Type: %s", enum_type_to_str(type_));
|
||||
ESP_LOGCONFIG(TAG, " Samples per value: %d", enum_samples_per_value_to_int(samples_per_value_));
|
||||
ESP_LOGCONFIG(TAG, " Mode: %s", (this->data_ready_ != nullptr) ? "autoconversion" : "polling");
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
LOG_BINARY_SENSOR(" ", "HasFaultBinarySensor", this->has_fault_binary_sensor_);
|
||||
#endif
|
||||
}
|
||||
|
||||
// This method is used for autoconversion mode
|
||||
void MAX31856Sensor::loop() {
|
||||
ESP_LOGVV(TAG, "loop");
|
||||
|
||||
if (this->data_ready_ == nullptr || this->have_faults_()) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Data ready is active low
|
||||
if (!this->data_ready_->digital_read()) {
|
||||
this->read_thermocouple_temperature_();
|
||||
}
|
||||
}
|
||||
|
||||
// This method is used for polling mode
|
||||
void MAX31856Sensor::update() {
|
||||
ESP_LOGVV(TAG, "update");
|
||||
|
||||
this->one_shot_temperature_();
|
||||
if (this->data_ready_ != nullptr) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Datasheet max conversion time for 1 shot is 155ms for 60Hz / 185ms for 50Hz
|
||||
auto f = std::bind(&MAX31856Sensor::read_thermocouple_temperature_, this);
|
||||
this->set_timeout("MAX31856Sensor::read_thermocouple_temperature_", filter_ == FILTER_60HZ ? 155 : 185, f);
|
||||
// Start a oneshot reading
|
||||
this->write_register_(MAX31856_CR0_REG, cr0_ | MAX31856_CR0_1SHOT);
|
||||
|
||||
// Datasheet max conversion time for 1 shot for 1 sample is 155ms for 60Hz / 185ms for 50Hz
|
||||
uint32_t timeout{};
|
||||
auto nsamples = enum_samples_per_value_to_int(samples_per_value_);
|
||||
if (filter_ == FILTER_60HZ) {
|
||||
timeout = 155 + static_cast<uint32_t>(std::ceil((nsamples - 1) * 33.33f));
|
||||
} else {
|
||||
timeout = 185 + (nsamples - 1) * 40;
|
||||
}
|
||||
this->set_timeout("MAX31856Sensor::read_oneshot_temperature_", timeout,
|
||||
[this]() { this->read_oneshot_temperature_(); });
|
||||
}
|
||||
|
||||
void MAX31856Sensor::call_setup() {
|
||||
this->setup();
|
||||
|
||||
if (this->data_ready_ == nullptr) {
|
||||
this->start_poller();
|
||||
}
|
||||
}
|
||||
|
||||
void MAX31856Sensor::read_oneshot_temperature_() {
|
||||
if (this->have_faults_()) {
|
||||
return;
|
||||
}
|
||||
|
||||
read_thermocouple_temperature_();
|
||||
}
|
||||
|
||||
void MAX31856Sensor::read_thermocouple_temperature_() {
|
||||
if (this->has_fault_()) {
|
||||
// Faults have been logged, clear it for next loop
|
||||
this->clear_fault_();
|
||||
} else {
|
||||
int32_t temp24 = this->read_register24_(MAX31856_LTCBH_REG);
|
||||
if (temp24 & 0x800000) {
|
||||
temp24 |= 0xFF000000; // fix sign
|
||||
}
|
||||
|
||||
temp24 >>= 5; // bottom 5 bits are unused
|
||||
|
||||
float temp_c = temp24;
|
||||
temp_c *= 0.0078125;
|
||||
|
||||
ESP_LOGD(TAG, "Got thermocouple temperature: %.2f°C", temp_c);
|
||||
this->publish_state(temp_c);
|
||||
int32_t temp24 = this->read_register24_(MAX31856_LTCBH_REG);
|
||||
if (temp24 & 0x800000) {
|
||||
temp24 |= 0xFF000000; // fix sign
|
||||
}
|
||||
|
||||
temp24 >>= 5; // bottom 5 bits are unused
|
||||
|
||||
float temp_c = temp24;
|
||||
temp_c /= 128.0f;
|
||||
|
||||
ESP_LOGD(TAG, "Got thermocouple temperature: %.3f°C", temp_c);
|
||||
this->publish_state(temp_c);
|
||||
}
|
||||
|
||||
void MAX31856Sensor::one_shot_temperature_() {
|
||||
ESP_LOGVV(TAG, "one_shot_temperature_");
|
||||
this->write_register_(MAX31856_CJTO_REG, 0x0);
|
||||
|
||||
uint8_t t = this->read_register_(MAX31856_CR0_REG);
|
||||
|
||||
t &= ~MAX31856_CR0_AUTOCONVERT; // turn off autoconversion mode
|
||||
t |= MAX31856_CR0_1SHOT; // turn on one shot mode
|
||||
|
||||
this->write_register_(MAX31856_CR0_REG, t);
|
||||
}
|
||||
|
||||
bool MAX31856Sensor::has_fault_() {
|
||||
ESP_LOGVV(TAG, "read_fault_");
|
||||
bool MAX31856Sensor::have_faults_() {
|
||||
uint8_t faults = this->read_register_(MAX31856_SR_REG);
|
||||
|
||||
if (faults == 0) {
|
||||
ESP_LOGV(TAG, "status_set_warning");
|
||||
this->status_clear_warning();
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
if (this->has_fault_binary_sensor_) {
|
||||
this->has_fault_binary_sensor_->publish_state(false);
|
||||
}
|
||||
#endif
|
||||
this->status_clear_error();
|
||||
return false;
|
||||
}
|
||||
|
||||
ESP_LOGV(TAG, "status_set_warning");
|
||||
this->status_set_warning();
|
||||
if (!this->status_has_error()) {
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
if (this->has_fault_binary_sensor_) {
|
||||
this->has_fault_binary_sensor_->publish_state(true);
|
||||
}
|
||||
#endif
|
||||
this->status_set_error();
|
||||
|
||||
if ((faults & MAX31856_FAULT_CJRANGE) == MAX31856_FAULT_CJRANGE) {
|
||||
ESP_LOGW(TAG, "Cold Junction Out-of-Range: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_TCRANGE) == MAX31856_FAULT_TCRANGE) {
|
||||
ESP_LOGW(TAG, "Thermocouple Out-of-Range: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_CJHIGH) == MAX31856_FAULT_CJHIGH) {
|
||||
ESP_LOGW(TAG, "Cold-Junction High Fault: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_CJLOW) == MAX31856_FAULT_CJLOW) {
|
||||
ESP_LOGW(TAG, "Cold-Junction Low Fault: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_TCHIGH) == MAX31856_FAULT_TCHIGH) {
|
||||
ESP_LOGW(TAG, "Thermocouple Temperature High Fault: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_TCLOW) == MAX31856_FAULT_TCLOW) {
|
||||
ESP_LOGW(TAG, "Thermocouple Temperature Low Fault: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_OVUV) == MAX31856_FAULT_OVUV) {
|
||||
ESP_LOGW(TAG, "Overvoltage or Undervoltage Input Fault: '%s'...", this->name_.c_str());
|
||||
}
|
||||
if ((faults & MAX31856_FAULT_OPEN) == MAX31856_FAULT_OPEN) {
|
||||
ESP_LOGW(TAG, "Thermocouple Open-Circuit Fault (possibly not connected): '%s'...", this->name_.c_str());
|
||||
const auto log_err = [&](uint8_t bit, const char *msg) {
|
||||
if ((faults & bit) != 0) {
|
||||
ESP_LOGE(TAG, "%s", msg);
|
||||
}
|
||||
};
|
||||
|
||||
log_err(MAX31856_FAULT_CJRANGE, "Cold Junction Out-of-Range");
|
||||
log_err(MAX31856_FAULT_TCRANGE, "Thermocouple Out-of-Range");
|
||||
log_err(MAX31856_FAULT_CJHIGH, "Cold-Junction High Fault");
|
||||
log_err(MAX31856_FAULT_CJLOW, "Cold-Junction Low Fault");
|
||||
log_err(MAX31856_FAULT_TCHIGH, "Thermocouple Temperature High Fault");
|
||||
log_err(MAX31856_FAULT_TCLOW, "Thermocouple Temperature Low Fault");
|
||||
log_err(MAX31856_FAULT_OVUV, "Overvoltage or Undervoltage Input Fault");
|
||||
log_err(MAX31856_FAULT_OPEN, "Thermocouple Open-Circuit Fault");
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
void MAX31856Sensor::clear_fault_() {
|
||||
ESP_LOGV(TAG, "clear_fault_");
|
||||
uint8_t t = this->read_register_(MAX31856_CR0_REG);
|
||||
|
||||
t |= MAX31856_CR0_FAULT; // turn on fault interrupt mode
|
||||
t |= MAX31856_CR0_FAULTCLR; // enable the fault status clear bit
|
||||
|
||||
this->write_register_(MAX31856_CR0_REG, t);
|
||||
}
|
||||
|
||||
void MAX31856Sensor::set_thermocouple_type_() {
|
||||
MAX31856ThermocoupleType type = MAX31856_TCTYPE_K;
|
||||
ESP_LOGCONFIG(TAG, "set_thermocouple_type_: 0x%02X", type);
|
||||
uint8_t t = this->read_register_(MAX31856_CR1_REG);
|
||||
t &= 0xF0; // mask off bottom 4 bits
|
||||
t |= (uint8_t) type & 0x0F;
|
||||
this->write_register_(MAX31856_CR1_REG, t);
|
||||
}
|
||||
|
||||
void MAX31856Sensor::set_noise_filter_() {
|
||||
ESP_LOGCONFIG(TAG, "set_noise_filter_: 0x%02X", filter_);
|
||||
uint8_t t = this->read_register_(MAX31856_CR0_REG);
|
||||
if (filter_ == FILTER_50HZ) {
|
||||
t |= 0x01;
|
||||
ESP_LOGCONFIG(TAG, "set_noise_filter_: 50 Hz, t==0x%02X", t);
|
||||
} else {
|
||||
t &= 0xfe;
|
||||
ESP_LOGCONFIG(TAG, "set_noise_filter_: 60 Hz, t==0x%02X", t);
|
||||
}
|
||||
this->write_register_(MAX31856_CR0_REG, t);
|
||||
}
|
||||
|
||||
void MAX31856Sensor::write_register_(uint8_t reg, uint8_t value) {
|
||||
ESP_LOGVV(TAG, "write_register_ raw reg=0x%02X value=0x%02X", reg, value);
|
||||
reg |= SPI_WRITE_M;
|
||||
|
|
|
|||
|
|
@ -4,96 +4,79 @@
|
|||
#include "esphome/components/spi/spi.h"
|
||||
#include "esphome/core/component.h"
|
||||
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
#include "esphome/components/binary_sensor/binary_sensor.h"
|
||||
#endif
|
||||
|
||||
#include <cinttypes>
|
||||
|
||||
namespace esphome {
|
||||
namespace max31856 {
|
||||
|
||||
enum MAX31856RegisterMasks { SPI_WRITE_M = 0x80 };
|
||||
|
||||
enum MAX31856Registers {
|
||||
MAX31856_CR0_REG = 0x00, ///< Config 0 register
|
||||
MAX31856_CR0_AUTOCONVERT = 0x80, ///< Config 0 Auto convert flag
|
||||
MAX31856_CR0_1SHOT = 0x40, ///< Config 0 one shot convert flag
|
||||
MAX31856_CR0_OCFAULT00 = 0x00, ///< Config 0 open circuit fault 00 flag
|
||||
MAX31856_CR0_OCFAULT01 = 0x10, ///< Config 0 open circuit fault 01 flag
|
||||
MAX31856_CR0_OCFAULT10 = 0x20, ///< Config 0 open circuit fault 10 flag
|
||||
MAX31856_CR0_CJ = 0x08, ///< Config 0 cold junction disable flag
|
||||
MAX31856_CR0_FAULT = 0x04, ///< Config 0 fault mode flag
|
||||
MAX31856_CR0_FAULTCLR = 0x02, ///< Config 0 fault clear flag
|
||||
|
||||
MAX31856_CR1_REG = 0x01, ///< Config 1 register
|
||||
MAX31856_MASK_REG = 0x02, ///< Fault Mask register
|
||||
MAX31856_CJHF_REG = 0x03, ///< Cold junction High temp fault register
|
||||
MAX31856_CJLF_REG = 0x04, ///< Cold junction Low temp fault register
|
||||
MAX31856_LTHFTH_REG = 0x05, ///< Linearized Temperature High Fault Threshold Register, MSB
|
||||
MAX31856_LTHFTL_REG = 0x06, ///< Linearized Temperature High Fault Threshold Register, LSB
|
||||
MAX31856_LTLFTH_REG = 0x07, ///< Linearized Temperature Low Fault Threshold Register, MSB
|
||||
MAX31856_LTLFTL_REG = 0x08, ///< Linearized Temperature Low Fault Threshold Register, LSB
|
||||
MAX31856_CJTO_REG = 0x09, ///< Cold-Junction Temperature Offset Register
|
||||
MAX31856_CJTH_REG = 0x0A, ///< Cold-Junction Temperature Register, MSB
|
||||
MAX31856_CJTL_REG = 0x0B, ///< Cold-Junction Temperature Register, LSB
|
||||
MAX31856_LTCBH_REG = 0x0C, ///< Linearized TC Temperature, Byte 2
|
||||
MAX31856_LTCBM_REG = 0x0D, ///< Linearized TC Temperature, Byte 1
|
||||
MAX31856_LTCBL_REG = 0x0E, ///< Linearized TC Temperature, Byte 0
|
||||
MAX31856_SR_REG = 0x0F, ///< Fault Status Register
|
||||
|
||||
MAX31856_FAULT_CJRANGE = 0x80, ///< Fault status Cold Junction Out-of-Range flag
|
||||
MAX31856_FAULT_TCRANGE = 0x40, ///< Fault status Thermocouple Out-of-Range flag
|
||||
MAX31856_FAULT_CJHIGH = 0x20, ///< Fault status Cold-Junction High Fault flag
|
||||
MAX31856_FAULT_CJLOW = 0x10, ///< Fault status Cold-Junction Low Fault flag
|
||||
MAX31856_FAULT_TCHIGH = 0x08, ///< Fault status Thermocouple Temperature High Fault flag
|
||||
MAX31856_FAULT_TCLOW = 0x04, ///< Fault status Thermocouple Temperature Low Fault flag
|
||||
MAX31856_FAULT_OVUV = 0x02, ///< Fault status Overvoltage or Undervoltage Input Fault flag
|
||||
MAX31856_FAULT_OPEN = 0x01, ///< Fault status Thermocouple Open-Circuit Fault flag
|
||||
};
|
||||
|
||||
/**
|
||||
* Multiple types of thermocouples supported by the chip.
|
||||
* Currently only K type implemented here.
|
||||
*/
|
||||
enum MAX31856ThermocoupleType {
|
||||
MAX31856_TCTYPE_B = 0b0000, // 0x00
|
||||
MAX31856_TCTYPE_E = 0b0001, // 0x01
|
||||
MAX31856_TCTYPE_J = 0b0010, // 0x02
|
||||
MAX31856_TCTYPE_K = 0b0011, // 0x03
|
||||
MAX31856_TCTYPE_N = 0b0100, // 0x04
|
||||
MAX31856_TCTYPE_R = 0b0101, // 0x05
|
||||
MAX31856_TCTYPE_S = 0b0110, // 0x06
|
||||
MAX31856_TCTYPE_T = 0b0111, // 0x07
|
||||
MAX31856_VMODE_G8 = 0b1000, // 0x08
|
||||
MAX31856_VMODE_G32 = 0b1100, // 0x12
|
||||
enum MAX31856ThermocoupleType : uint8_t {
|
||||
MAX31856_TCTYPE_B = 0b0000, // 0x00
|
||||
MAX31856_TCTYPE_E = 0b0001, // 0x01
|
||||
MAX31856_TCTYPE_J = 0b0010, // 0x02
|
||||
MAX31856_TCTYPE_K = 0b0011, // 0x03
|
||||
MAX31856_TCTYPE_N = 0b0100, // 0x04
|
||||
MAX31856_TCTYPE_R = 0b0101, // 0x05
|
||||
MAX31856_TCTYPE_S = 0b0110, // 0x06
|
||||
MAX31856_TCTYPE_T = 0b0111, // 0x07
|
||||
};
|
||||
|
||||
enum MAX31856ConfigFilter {
|
||||
enum MAX31856ConfigFilter : uint8_t {
|
||||
FILTER_60HZ = 0,
|
||||
FILTER_50HZ = 1,
|
||||
};
|
||||
|
||||
enum MAX31856SamplesPerValue : uint8_t {
|
||||
AVE_SAMPLES_1 = 0 << 4,
|
||||
AVE_SAMPLES_2 = 1 << 4,
|
||||
AVE_SAMPLES_4 = 2 << 4,
|
||||
AVE_SAMPLES_8 = 3 << 4,
|
||||
AVE_SAMPLES_16 = 4 << 4,
|
||||
};
|
||||
|
||||
class MAX31856Sensor : public sensor::Sensor,
|
||||
public PollingComponent,
|
||||
public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW,
|
||||
spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_4MHZ> {
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
SUB_BINARY_SENSOR(has_fault)
|
||||
#endif
|
||||
|
||||
public:
|
||||
void setup() override;
|
||||
void loop() override;
|
||||
void update() override;
|
||||
void call_setup() override;
|
||||
void dump_config() override;
|
||||
float get_setup_priority() const override;
|
||||
|
||||
void set_type(MAX31856ThermocoupleType type) { type_ = type; }
|
||||
void set_filter(MAX31856ConfigFilter filter) { filter_ = filter; }
|
||||
void update() override;
|
||||
void set_samples_per_value(MAX31856SamplesPerValue value) { samples_per_value_ = value; }
|
||||
void set_data_ready_pin(GPIOPin *pin) { data_ready_ = pin; }
|
||||
|
||||
protected:
|
||||
MAX31856ConfigFilter filter_;
|
||||
MAX31856ThermocoupleType type_{};
|
||||
MAX31856ConfigFilter filter_{};
|
||||
MAX31856SamplesPerValue samples_per_value_{};
|
||||
GPIOPin *data_ready_{};
|
||||
uint8_t cr0_{};
|
||||
|
||||
void read_oneshot_temperature_();
|
||||
void read_thermocouple_temperature_();
|
||||
bool have_faults_();
|
||||
|
||||
uint8_t read_register_(uint8_t reg);
|
||||
uint16_t read_register16_(uint8_t reg);
|
||||
uint32_t read_register24_(uint8_t reg);
|
||||
void write_register_(uint8_t reg, uint8_t value);
|
||||
|
||||
void one_shot_temperature_();
|
||||
bool has_fault_();
|
||||
void clear_fault_();
|
||||
void read_thermocouple_temperature_();
|
||||
void set_thermocouple_type_();
|
||||
void set_noise_filter_();
|
||||
void write_bits_(uint8_t reg, uint8_t bits);
|
||||
};
|
||||
|
||||
} // namespace max31856
|
||||
|
|
|
|||
|
|
@ -1,13 +1,22 @@
|
|||
from esphome import pins
|
||||
import esphome.codegen as cg
|
||||
import esphome.config_validation as cv
|
||||
from esphome.components import sensor, spi
|
||||
from esphome.components import binary_sensor, sensor, spi
|
||||
from esphome.const import (
|
||||
CONF_MAINS_FILTER,
|
||||
CONF_TYPE,
|
||||
CONF_UPDATE_INTERVAL,
|
||||
DEVICE_CLASS_PROBLEM,
|
||||
DEVICE_CLASS_TEMPERATURE,
|
||||
ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
STATE_CLASS_MEASUREMENT,
|
||||
UNIT_CELSIUS,
|
||||
)
|
||||
|
||||
CONF_DATA_READY_PIN = "data_ready_pin"
|
||||
CONF_HAS_FAULT = "has_fault"
|
||||
CONF_SAMPLES_PER_VALUE = "samples_per_value"
|
||||
|
||||
max31856_ns = cg.esphome_ns.namespace("max31856")
|
||||
MAX31856Sensor = max31856_ns.class_(
|
||||
"MAX31856Sensor", sensor.Sensor, cg.PollingComponent, spi.SPIDevice
|
||||
|
|
@ -19,22 +28,68 @@ FILTER = {
|
|||
"60HZ": MAX31865ConfigFilter.FILTER_60HZ,
|
||||
}
|
||||
|
||||
MAX31856ThermocoupleType = max31856_ns.enum("MAX31856ThermocoupleType")
|
||||
TYPE = {
|
||||
"B": MAX31856ThermocoupleType.MAX31856_TCTYPE_B,
|
||||
"E": MAX31856ThermocoupleType.MAX31856_TCTYPE_E,
|
||||
"J": MAX31856ThermocoupleType.MAX31856_TCTYPE_J,
|
||||
"K": MAX31856ThermocoupleType.MAX31856_TCTYPE_K,
|
||||
"N": MAX31856ThermocoupleType.MAX31856_TCTYPE_N,
|
||||
"R": MAX31856ThermocoupleType.MAX31856_TCTYPE_R,
|
||||
"S": MAX31856ThermocoupleType.MAX31856_TCTYPE_S,
|
||||
"T": MAX31856ThermocoupleType.MAX31856_TCTYPE_T,
|
||||
}
|
||||
|
||||
MAX31856SamplesPerValue = max31856_ns.enum("MAX31856SamplesPerValue")
|
||||
SAMPLES_PER_VALUE = {
|
||||
1: MAX31856SamplesPerValue.AVE_SAMPLES_1,
|
||||
2: MAX31856SamplesPerValue.AVE_SAMPLES_2,
|
||||
4: MAX31856SamplesPerValue.AVE_SAMPLES_4,
|
||||
8: MAX31856SamplesPerValue.AVE_SAMPLES_8,
|
||||
16: MAX31856SamplesPerValue.AVE_SAMPLES_16,
|
||||
}
|
||||
|
||||
exclusive_err_msg = "Use only one of data_ready_pin or update_interval"
|
||||
|
||||
# Unfortunately, Exclusive doesn't pass a default through to the base Optional so we have to set it manually
|
||||
exclusive_update_interval_with_default = cv.Exclusive(
|
||||
CONF_UPDATE_INTERVAL,
|
||||
"mode",
|
||||
exclusive_err_msg,
|
||||
"update_interval will enable polling mode",
|
||||
)
|
||||
exclusive_update_interval_with_default.default = lambda: "60s"
|
||||
|
||||
CONFIG_SCHEMA = (
|
||||
sensor.sensor_schema(
|
||||
MAX31856Sensor,
|
||||
unit_of_measurement=UNIT_CELSIUS,
|
||||
accuracy_decimals=1,
|
||||
accuracy_decimals=3,
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
)
|
||||
.extend(
|
||||
{
|
||||
cv.Optional(CONF_HAS_FAULT): binary_sensor.binary_sensor_schema(
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
device_class=DEVICE_CLASS_PROBLEM,
|
||||
),
|
||||
cv.Optional(CONF_MAINS_FILTER, default="60HZ"): cv.enum(
|
||||
FILTER, upper=True, space=""
|
||||
),
|
||||
cv.Optional(CONF_TYPE, default="K"): cv.enum(TYPE, upper=True, space=""),
|
||||
cv.Optional(CONF_SAMPLES_PER_VALUE, default=1): cv.enum(
|
||||
SAMPLES_PER_VALUE, int=True, space=""
|
||||
),
|
||||
cv.Exclusive(
|
||||
CONF_DATA_READY_PIN,
|
||||
"mode",
|
||||
exclusive_err_msg,
|
||||
"data_ready_pin will enable autoconversion mode",
|
||||
): pins.gpio_input_pullup_pin_schema,
|
||||
exclusive_update_interval_with_default: cv.update_interval,
|
||||
}
|
||||
)
|
||||
.extend(cv.polling_component_schema("60s"))
|
||||
.extend(spi.spi_device_schema())
|
||||
)
|
||||
|
||||
|
|
@ -44,3 +99,13 @@ async def to_code(config):
|
|||
await cg.register_component(var, config)
|
||||
await spi.register_spi_device(var, config)
|
||||
cg.add(var.set_filter(config[CONF_MAINS_FILTER]))
|
||||
cg.add(var.set_samples_per_value(config[CONF_SAMPLES_PER_VALUE]))
|
||||
cg.add(var.set_type(config[CONF_TYPE]))
|
||||
data_ready_config = config.get(CONF_DATA_READY_PIN)
|
||||
if data_ready_config is not None:
|
||||
pin = await cg.gpio_pin_expression(data_ready_config)
|
||||
cg.add(var.set_data_ready_pin(pin))
|
||||
has_fault = config.get(CONF_HAS_FAULT)
|
||||
if has_fault is not None:
|
||||
sens = await binary_sensor.new_binary_sensor(has_fault)
|
||||
cg.add(var.set_has_fault_binary_sensor(sens))
|
||||
|
|
|
|||
Loading…
Reference in New Issue