1
0
mirror of https://github.com/esphome/esphome.git synced 2025-10-28 05:33:53 +00:00

Add support for TMP1075 temperature sensor (#4776)

* Add support for TMP1075 temperature sensor

TMP1075 is a temperature sensor with I2C interface in industry standard
LM75 form factor and pinout.

https://www.ti.com/product/TMP1075

Example YAML:

```yaml
sensor:
  - platform: tmp1075
    name: TMP1075 Temperature
    id: radiator_temp
    update_interval: 10s
    i2c_id: i2c_bus_1
    conversion_rate: 27.5ms
    alert:
      limit_low: 50
      limit_high: 75
      fault_count: 1
      polarity: active_high
```

* Add myself as codeowner of the TMP1075 component

* Include '°C' unit when logging low/high limit setting

* Reformat

No functional changes.

* Fix logging: use %.4f for temperatures, not %d

* Fix config initialisation

* Use relative include for `tmp1075.h`

* Apply formatting changes suggested by script/clang-tidy for ESP32

* Add YAML to test1.yaml

* Fix test1.yaml by giving TMP1075 a name

* Less verbose logging (debug -> verbose level)

* Schema: reduce accuracy_decimals to 2

* I2C address as hexadecimal

* Proper name for enum in Python

The enum on the C++ side was renamed (clang-tidy) but I forgot to take that
into account in the Python code.

* Expose 'alert function' to the code generator/YAML params and remove 'shutdown'

Shutdown mode doesn't work the way I expect it, so remove it until someone
actually asks for it.

Also 'alert mode' was renamed to 'alert function' for clarity.

* Move simple setters to header file

* Remove `load_config_();` function
This commit is contained in:
Sybren A. Stüvel
2023-05-26 07:01:21 +02:00
committed by GitHub
parent 79abd773a2
commit 97c1c34708
6 changed files with 326 additions and 0 deletions

View File

@@ -0,0 +1,129 @@
#include "esphome/core/log.h"
#include "tmp1075.h"
namespace esphome {
namespace tmp1075 {
static const char *const TAG = "tmp1075";
constexpr uint8_t REG_TEMP = 0x0; // Temperature result
constexpr uint8_t REG_CFGR = 0x1; // Configuration
constexpr uint8_t REG_LLIM = 0x2; // Low limit
constexpr uint8_t REG_HLIM = 0x3; // High limit
constexpr uint8_t REG_DIEID = 0xF; // Device ID
constexpr uint16_t EXPECT_DIEID = 0x0075; // Expected Device ID.
static uint16_t temp2regvalue(float temp);
static float regvalue2temp(uint16_t regvalue);
void TMP1075Sensor::setup() {
uint8_t die_id;
if (!this->read_byte(REG_DIEID, &die_id)) {
ESP_LOGW(TAG, "'%s' - unable to read ID", this->name_.c_str());
this->mark_failed();
return;
}
if (die_id != EXPECT_DIEID) {
ESP_LOGW(TAG, "'%s' - unexpected ID 0x%x found, expected 0x%x", this->name_.c_str(), die_id, EXPECT_DIEID);
this->mark_failed();
return;
}
this->write_config();
}
void TMP1075Sensor::update() {
uint16_t regvalue;
if (!read_byte_16(REG_TEMP, &regvalue)) {
ESP_LOGW(TAG, "'%s' - unable to read temperature register", this->name_.c_str());
this->status_set_warning();
return;
}
const float temp = regvalue2temp(regvalue);
this->publish_state(temp);
}
void TMP1075Sensor::dump_config() {
LOG_SENSOR("", "TMP1075 Sensor", this);
if (this->is_failed()) {
ESP_LOGE(TAG, " Communication with TMP1075 failed!");
return;
}
ESP_LOGCONFIG(TAG, " limit low : %.4f °C", alert_limit_low_);
ESP_LOGCONFIG(TAG, " limit high : %.4f °C", alert_limit_high_);
ESP_LOGCONFIG(TAG, " oneshot : %d", config_.fields.oneshot);
ESP_LOGCONFIG(TAG, " rate : %d", config_.fields.rate);
ESP_LOGCONFIG(TAG, " fault_count: %d", config_.fields.faults);
ESP_LOGCONFIG(TAG, " polarity : %d", config_.fields.polarity);
ESP_LOGCONFIG(TAG, " alert_mode : %d", config_.fields.alert_mode);
ESP_LOGCONFIG(TAG, " shutdown : %d", config_.fields.shutdown);
}
void TMP1075Sensor::set_fault_count(const int faults) {
if (faults < 1) {
ESP_LOGE(TAG, "'%s' - fault_count too low: %d", this->name_.c_str(), faults);
return;
}
if (faults > 4) {
ESP_LOGE(TAG, "'%s' - fault_count too high: %d", this->name_.c_str(), faults);
return;
}
config_.fields.faults = faults - 1;
}
void TMP1075Sensor::log_config_() {
ESP_LOGV(TAG, " oneshot : %d", config_.fields.oneshot);
ESP_LOGV(TAG, " rate : %d", config_.fields.rate);
ESP_LOGV(TAG, " faults : %d", config_.fields.faults);
ESP_LOGV(TAG, " polarity : %d", config_.fields.polarity);
ESP_LOGV(TAG, " alert_mode: %d", config_.fields.alert_mode);
ESP_LOGV(TAG, " shutdown : %d", config_.fields.shutdown);
}
void TMP1075Sensor::write_config() {
send_alert_limit_low_();
send_alert_limit_high_();
send_config_();
}
void TMP1075Sensor::send_config_() {
ESP_LOGV(TAG, "'%s' - sending configuration %04x", this->name_.c_str(), config_.regvalue);
log_config_();
if (!this->write_byte_16(REG_CFGR, config_.regvalue)) {
ESP_LOGW(TAG, "'%s' - unable to write configuration register", this->name_.c_str());
return;
}
}
void TMP1075Sensor::send_alert_limit_low_() {
ESP_LOGV(TAG, "'%s' - sending alert limit low %.3f °C", this->name_.c_str(), alert_limit_low_);
const uint16_t regvalue = temp2regvalue(alert_limit_low_);
if (!this->write_byte_16(REG_LLIM, regvalue)) {
ESP_LOGW(TAG, "'%s' - unable to write low limit register", this->name_.c_str());
return;
}
}
void TMP1075Sensor::send_alert_limit_high_() {
ESP_LOGV(TAG, "'%s' - sending alert limit high %.3f °C", this->name_.c_str(), alert_limit_high_);
const uint16_t regvalue = temp2regvalue(alert_limit_high_);
if (!this->write_byte_16(REG_HLIM, regvalue)) {
ESP_LOGW(TAG, "'%s' - unable to write high limit register", this->name_.c_str());
return;
}
}
static uint16_t temp2regvalue(const float temp) {
const uint16_t regvalue = temp / 0.0625f;
return regvalue << 4;
}
static float regvalue2temp(const uint16_t regvalue) {
const int16_t signed_value = regvalue;
return (signed_value >> 4) * 0.0625f;
}
} // namespace tmp1075
} // namespace esphome