2019-12-20 19:29:54 +00:00
|
|
|
/*
|
|
|
|
xsns_59_ds1624.ino - Support for I2C DS1624 Temperature Sensor
|
|
|
|
|
2021-01-01 12:44:04 +00:00
|
|
|
Copyright (C) 2021 Leonid Myravjev <asm@asm.pp.ru>
|
2019-12-20 19:29:54 +00:00
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef USE_I2C
|
|
|
|
#ifdef USE_DS1624
|
|
|
|
|
|
|
|
/*********************************************************************************************\
|
2019-12-28 10:35:44 +00:00
|
|
|
* DS1624, DS1621 - Temperature
|
|
|
|
*
|
2019-12-20 19:29:54 +00:00
|
|
|
* I2C Address: 0x48 - 0x4F
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
#define XSNS_59 59
|
|
|
|
#define XI2C_42 42 // See I2CDEVICES.md
|
|
|
|
|
|
|
|
#define DS1624_MEM_REGISTER 0x17 //only for ds1624, don't exists on 1621
|
|
|
|
#define DS1624_CONF_REGISTER 0xAC
|
|
|
|
#define DS1624_TEMP_REGISTER 0xAA
|
|
|
|
#define DS1624_START_REGISTER 0xEE
|
|
|
|
#define DS1624_STOP_REGISTER 0x22
|
|
|
|
|
|
|
|
#define DS1621_COUNTER_REGISTER 0xA8 //exists on 1621 and 1624(undocumented)
|
|
|
|
#define DS1621_SLOPE_REGISTER 0xA9 //exists on 1624 and 1624(undocumented)
|
|
|
|
|
2020-01-23 20:28:39 +00:00
|
|
|
#define DS1621_CFG_1SHOT (1<<0)
|
|
|
|
#define DS1621_CFG_DONE (1<<7)
|
|
|
|
|
2019-12-20 19:29:54 +00:00
|
|
|
enum {
|
|
|
|
DS1624_TYPE_DS1624,
|
|
|
|
DS1624_TYPE_DS1621
|
|
|
|
};
|
|
|
|
|
|
|
|
#define DS1624_MAX_SENSORS 8
|
2019-12-28 10:35:44 +00:00
|
|
|
|
|
|
|
bool ds1624_init = false;
|
|
|
|
|
2019-12-20 19:29:54 +00:00
|
|
|
struct {
|
2019-12-28 10:35:44 +00:00
|
|
|
float value;
|
|
|
|
uint8_t type;
|
2020-01-23 20:28:39 +00:00
|
|
|
int errcnt;
|
|
|
|
int misscnt;
|
2019-12-28 10:35:44 +00:00
|
|
|
bool valid;
|
|
|
|
char name[9];
|
2019-12-20 19:29:54 +00:00
|
|
|
} ds1624_sns[DS1624_MAX_SENSORS];
|
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
uint32_t DS1624_Idx2Addr(uint32_t idx) {
|
2019-12-20 19:29:54 +00:00
|
|
|
return 0x48 + idx;
|
|
|
|
}
|
|
|
|
|
2020-07-14 17:35:29 +01:00
|
|
|
void DS1624_Restart(uint8_t config, uint32_t idx) {
|
2020-01-23 20:28:39 +00:00
|
|
|
uint32_t addr = DS1624_Idx2Addr(idx);
|
|
|
|
if ((config & 1) == 1) {
|
|
|
|
config &= ~(DS1621_CFG_DONE|DS1621_CFG_1SHOT);
|
|
|
|
I2cWrite8(addr, DS1624_CONF_REGISTER, config); // 1shot off
|
|
|
|
delay(10); // by spec after writing
|
2021-01-23 16:10:06 +00:00
|
|
|
AddLog(LOG_LEVEL_ERROR, "%s addr %x is reset, reconfig: %x", ds1624_sns[idx].name, addr, config);
|
2020-01-23 20:28:39 +00:00
|
|
|
}
|
|
|
|
I2cValidRead(addr, DS1624_START_REGISTER, 1);
|
|
|
|
}
|
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
void DS1624_HotPlugUp(uint32_t idx)
|
|
|
|
{
|
|
|
|
uint32_t addr = DS1624_Idx2Addr(idx);
|
|
|
|
|
|
|
|
if (!I2cSetDevice(addr)) { return; }
|
2019-12-20 19:29:54 +00:00
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
uint8_t config;
|
2019-12-20 19:29:54 +00:00
|
|
|
if (I2cValidRead8(&config, addr, DS1624_CONF_REGISTER)) {
|
2019-12-28 10:35:44 +00:00
|
|
|
uint8_t tmp;
|
|
|
|
ds1624_sns[idx].type = (I2cValidRead8(&tmp, addr, DS1624_MEM_REGISTER)) ? DS1624_TYPE_DS1624 : DS1624_TYPE_DS1621;
|
|
|
|
|
|
|
|
snprintf_P(ds1624_sns[idx].name, sizeof(ds1624_sns[idx].name), PSTR("DS162%c%c%d"),
|
|
|
|
(ds1624_sns[idx].type == DS1624_TYPE_DS1621) ? '1' : '4', IndexSeparator(), idx);
|
2019-12-20 19:29:54 +00:00
|
|
|
I2cSetActiveFound(addr, ds1624_sns[idx].name);
|
2019-12-28 10:35:44 +00:00
|
|
|
|
|
|
|
ds1624_sns[idx].valid = true;
|
2020-01-23 20:28:39 +00:00
|
|
|
ds1624_sns[idx].errcnt = 0;
|
|
|
|
ds1624_sns[idx].misscnt = 0;
|
|
|
|
DS1624_Restart(config,idx);
|
2021-01-23 16:10:06 +00:00
|
|
|
AddLog(LOG_LEVEL_INFO, "Hot Plug %s addr %x config: %x", ds1624_sns[idx].name, addr, config);
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
void DS1624_HotPlugDown(int idx)
|
|
|
|
{
|
|
|
|
uint32_t addr = DS1624_Idx2Addr(idx);
|
|
|
|
if (!I2cActive(addr)) { return; }
|
2019-12-20 19:29:54 +00:00
|
|
|
I2cResetActive(addr);
|
2019-12-28 10:35:44 +00:00
|
|
|
ds1624_sns[idx].valid = false;
|
2021-01-23 16:10:06 +00:00
|
|
|
AddLog(LOG_LEVEL_INFO, "Hot UnPlug %s", ds1624_sns[idx].name);
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool DS1624GetTemp(float *value, int idx)
|
|
|
|
{
|
2019-12-28 10:35:44 +00:00
|
|
|
uint32_t addr = DS1624_Idx2Addr(idx);
|
|
|
|
|
2020-01-23 20:28:39 +00:00
|
|
|
uint8_t config;
|
|
|
|
if (!I2cValidRead8(&config, addr, DS1624_CONF_REGISTER)) {
|
|
|
|
ds1624_sns[idx].misscnt++;
|
2021-01-23 16:10:06 +00:00
|
|
|
AddLog(LOG_LEVEL_INFO, "%s device missing (errors: %i)", ds1624_sns[idx].name, ds1624_sns[idx].misscnt);
|
2020-01-23 20:28:39 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
ds1624_sns[idx].misscnt=0;
|
|
|
|
if (config & (DS1621_CFG_1SHOT|DS1621_CFG_DONE)) {
|
|
|
|
ds1624_sns[idx].errcnt++;
|
2021-01-23 16:10:06 +00:00
|
|
|
AddLog(LOG_LEVEL_INFO, "%s config error, restart... (errors: %i)", ds1624_sns[idx].name, ds1624_sns[idx].errcnt);
|
2020-01-23 20:28:39 +00:00
|
|
|
DS1624_Restart(config, idx);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2019-12-20 19:29:54 +00:00
|
|
|
uint16_t t;
|
2019-12-28 10:35:44 +00:00
|
|
|
if (!I2cValidRead16(&t, DS1624_Idx2Addr(idx), DS1624_TEMP_REGISTER)) { return false; }
|
2020-01-23 20:28:39 +00:00
|
|
|
if (ds1624_sns[idx].type == DS1624_TYPE_DS1624) {
|
2022-04-19 14:44:53 +01:00
|
|
|
*value = ((float)(int8_t)(t>>8)) + ((t>>4)&0xf)*0.0625f;
|
2020-01-23 20:28:39 +00:00
|
|
|
} else { //type == DS1624_TYPE_DS1621
|
|
|
|
// Datasheet for ds1621 is wrong for high resolution, real is:
|
|
|
|
*value = ((float)(int8_t)(t>>8));
|
2019-12-28 10:35:44 +00:00
|
|
|
uint8_t remain;
|
|
|
|
if (!I2cValidRead8(&remain, addr, DS1621_COUNTER_REGISTER)) { return true; }
|
|
|
|
uint8_t perc;
|
|
|
|
if (!I2cValidRead8(&perc, addr, DS1621_SLOPE_REGISTER)) { return true; }
|
2020-01-23 20:28:39 +00:00
|
|
|
float fix=(float)(perc - remain)/(float)perc;
|
|
|
|
*value+=fix;
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
2020-01-23 20:28:39 +00:00
|
|
|
ds1624_sns[idx].errcnt=0;
|
|
|
|
config &= ~(DS1621_CFG_DONE);
|
|
|
|
I2cWrite8(addr, DS1624_CONF_REGISTER, config);
|
2019-12-20 19:29:54 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void DS1624HotPlugScan(void)
|
|
|
|
{
|
|
|
|
uint16_t t;
|
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
for (uint32_t idx = 0; idx < DS1624_MAX_SENSORS; idx++) {
|
|
|
|
uint32_t addr = DS1624_Idx2Addr(idx);
|
|
|
|
if (I2cActive(addr) && !ds1624_sns[idx].valid) {
|
|
|
|
continue; // is busy by another driver
|
|
|
|
}
|
2020-01-23 20:28:39 +00:00
|
|
|
if (ds1624_sns[idx].valid) {
|
|
|
|
if ((ds1624_sns[idx].misscnt>2)||(ds1624_sns[idx].errcnt>2)) {
|
|
|
|
DS1624_HotPlugDown(idx);
|
|
|
|
continue;
|
|
|
|
}
|
2019-12-28 10:35:44 +00:00
|
|
|
}
|
2019-12-20 19:29:54 +00:00
|
|
|
DS1624_HotPlugUp(idx);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void DS1624EverySecond(void)
|
|
|
|
{
|
|
|
|
float t;
|
2019-12-28 10:35:44 +00:00
|
|
|
for (uint32_t i = 0; i < DS1624_MAX_SENSORS; i++) {
|
|
|
|
if (!ds1624_sns[i].valid) { continue; }
|
|
|
|
if (!DS1624GetTemp(&t, i)) { continue; }
|
|
|
|
ds1624_sns[i].value = ConvertTemp(t);
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void DS1624Show(bool json)
|
|
|
|
{
|
2019-12-28 10:35:44 +00:00
|
|
|
bool once = true;
|
2019-12-20 19:29:54 +00:00
|
|
|
|
2019-12-28 10:35:44 +00:00
|
|
|
for (uint32_t i = 0; i < DS1624_MAX_SENSORS; i++) {
|
|
|
|
if (!ds1624_sns[i].valid) { continue; }
|
2019-12-20 19:29:54 +00:00
|
|
|
|
|
|
|
if (json) {
|
2021-06-11 17:14:12 +01:00
|
|
|
ResponseAppend_P(JSON_SNS_F_TEMP, ds1624_sns[i].name, Settings->flag2.temperature_resolution, &ds1624_sns[i].value);
|
2020-10-29 12:37:09 +00:00
|
|
|
if ((0 == TasmotaGlobal.tele_period) && once) {
|
2019-12-28 10:35:44 +00:00
|
|
|
#ifdef USE_DOMOTICZ
|
2021-01-26 16:12:08 +00:00
|
|
|
DomoticzFloatSensor(DZ_TEMP, ds1624_sns[i].value);
|
2019-12-28 10:35:44 +00:00
|
|
|
#endif // USE_DOMOTICZ
|
|
|
|
#ifdef USE_KNX
|
2020-03-04 14:51:50 +00:00
|
|
|
KnxSensor(KNX_TEMPERATURE, ds1624_sns[i].value);
|
2019-12-28 10:35:44 +00:00
|
|
|
#endif // USE_KNX
|
|
|
|
once = false;
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
2019-12-28 10:35:44 +00:00
|
|
|
#ifdef USE_WEBSERVER
|
2019-12-20 19:29:54 +00:00
|
|
|
} else {
|
2021-01-26 16:12:08 +00:00
|
|
|
WSContentSend_Temp(ds1624_sns[i].name, ds1624_sns[i].value);
|
2019-12-28 10:35:44 +00:00
|
|
|
#endif // USE_WEBSERVER
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*********************************************************************************************\
|
|
|
|
* Interface
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
2022-11-11 09:44:56 +00:00
|
|
|
bool Xsns59(uint32_t function)
|
2019-12-20 19:29:54 +00:00
|
|
|
{
|
2019-12-28 10:35:44 +00:00
|
|
|
if (!I2cEnabled(XI2C_42)) { return false; }
|
2019-12-20 19:29:54 +00:00
|
|
|
|
|
|
|
bool result = false;
|
2019-12-28 10:35:44 +00:00
|
|
|
|
2019-12-20 19:29:54 +00:00
|
|
|
if (FUNC_INIT == function) {
|
2019-12-28 10:35:44 +00:00
|
|
|
if (!ds1624_init) {
|
2019-12-20 19:29:54 +00:00
|
|
|
memset(ds1624_sns, 0, sizeof(ds1624_sns));
|
2019-12-28 10:35:44 +00:00
|
|
|
ds1624_init = true;
|
|
|
|
DS1624HotPlugScan(); // If HotPlug is off
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
switch (function) {
|
|
|
|
case FUNC_HOTPLUG_SCAN:
|
|
|
|
DS1624HotPlugScan();
|
|
|
|
break;
|
|
|
|
case FUNC_EVERY_SECOND:
|
|
|
|
DS1624EverySecond();
|
|
|
|
break;
|
|
|
|
case FUNC_JSON_APPEND:
|
|
|
|
DS1624Show(1);
|
|
|
|
break;
|
2019-12-28 10:35:44 +00:00
|
|
|
#ifdef USE_WEBSERVER
|
2019-12-20 19:29:54 +00:00
|
|
|
case FUNC_WEB_SENSOR:
|
|
|
|
DS1624Show(0);
|
|
|
|
break;
|
2019-12-28 10:35:44 +00:00
|
|
|
#endif // USE_WEBSERVER
|
2019-12-20 19:29:54 +00:00
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // USE_DS1624
|
|
|
|
#endif // USE_I2C
|