Tasmota/tasmota/xdrv_12_home_assistant.ino

628 lines
25 KiB
Arduino
Raw Normal View History

/*
xdrv_12_home_assistant.ino - home assistant support for Tasmota
2019-12-31 13:23:34 +00:00
Copyright (C) 2020 Theo Arends
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_HOME_ASSISTANT
2020-02-06 02:29:44 +00:00
#define XDRV_12 12
// List of sensors ready for discovery
2020-02-06 16:32:54 +00:00
const char kHAssJsonSensorTypes[] PROGMEM =
2020-02-06 02:29:44 +00:00
D_JSON_TEMPERATURE "|" D_JSON_PRESSURE "|" D_JSON_PRESSUREATSEALEVEL "|"
D_JSON_APPARENT_POWERUSAGE "|Battery|" D_JSON_CURRENT "|" D_JSON_DISTANCE "|" D_JSON_FREQUENCY "|" D_JSON_HUMIDITY "|" D_JSON_ILLUMINANCE "|"
D_JSON_MOISTURE "|PB0.3|PB0.5|PB1|PB2.5|PB5|PB10|PM1|PM2.5|PM10|" D_JSON_POWERFACTOR "|" D_JSON_POWERUSAGE "|"
D_JSON_REACTIVE_POWERUSAGE "|" D_JSON_TODAY "|" D_JSON_TOTAL "|" D_JSON_VOLTAGE "|" D_JSON_WEIGHT "|" D_JSON_YESTERDAY;
2020-02-06 16:32:54 +00:00
const char kHAssJsonSensorUnits[] PROGMEM =
2020-02-06 02:29:44 +00:00
"|||"
"W|%|A|Cm|Hz|%|LX|"
"%|ppd|ppd|ppd|ppd|ppd|ppd|µg/m³|µg/m³|µg/m³||W|"
"W|KWh|KWh|V|Kg|KWh";
2020-02-06 16:32:54 +00:00
const char kHAssJsonSensorDevCla[] PROGMEM =
2020-02-06 02:29:44 +00:00
"dev_cla\":\"temperature|dev_cla\":\"pressure|dev_cla\":\"pressure|"
"dev_cla\":\"power|dev_cla\":\"battery|ic\":\"mdi:alpha-a-circle-outline|ic\":\"mdi:leak|ic\":\"mdi:current-ac|dev_cla\":\"humidity|dev_cla\":\"illuminance|"
"ic\":\"mdi:cup-water|ic\":\"mdi:flask|ic\":\"mdi:flask|ic\":\"mdi:flask|ic\":\"mdi:flask|ic\":\"mdi:flask|ic\":\"mdi:flask|"
"ic\":\"mdi:air-filter|ic\":\"mdi:air-filter|ic\":\"mdi:air-filter|ic\":\"mdi:alpha-f-circle-outline|dev_cla\":\"power|"
"dev_cla\":\"power|dev_cla\":\"power|dev_cla\":\"power|ic\":\"mdi:alpha-v-circle-outline|ic\":\"mdi:scale|dev_cla\":\"power";
2020-02-06 16:32:54 +00:00
// List of sensors ready for discovery
2020-02-06 02:29:44 +00:00
const char HASS_DISCOVER_SENSOR[] PROGMEM =
",\"unit_of_meas\":\"%s\",\"%s\"," // unit of measure and class (or icon)
"\"frc_upd\":true," // force update for better graph representation
"\"val_tpl\":\"{{value_json['%s']['%s']"; // "COUNTER":{"C1":0} -> {{ value_json['COUNTER'].['C1']
const char HASS_DISCOVER_BASE[] PROGMEM =
"{\"name\":\"%s\"," // dualr2 1
"\"stat_t\":\"%s\"," // stat/dualr2/RESULT (implies "\"optimistic\":\"false\",")
"\"avty_t\":\"%s\"," // tele/dualr2/LWT
"\"pl_avail\":\"" D_ONLINE "\"," // Online
"\"pl_not_avail\":\"" D_OFFLINE "\""; // Offline
2020-02-06 16:32:54 +00:00
const char HASS_DISCOVER_RELAY[] PROGMEM =
",\"cmd_t\":\"%s\"," // cmnd/dualr2/POWER2
"\"val_tpl\":\"{{value_json.%s}}\"," // POWER2
"\"pl_off\":\"%s\"," // OFF
"\"pl_on\":\"%s\""; // ON
2018-12-04 20:31:23 +00:00
2019-11-15 01:37:30 +00:00
const char HASS_DISCOVER_BUTTON_TOGGLE[] PROGMEM =
2020-02-06 16:32:54 +00:00
",\"value_template\":\"{%%if is_state(entity_id,\\\"off\\\")-%%}ON{%%-endif%%}\"," // STATE
"\"off_delay\":1"; // HAss has no support for TOGGLE, fake it by resetting to OFF after 1s
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_BUTTON_SWITCH_ONOFF[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"value_template\":\"{{value_json.%s}}\"," // STATE
"\"frc_upd\":true," // In ON/OFF case, enable force_update to make automations work
"\"pl_on\":\"%s\"," // ON
"\"pl_off\":\"%s\""; // OFF
2018-12-04 20:31:23 +00:00
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_LIGHT_DIMMER[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"bri_cmd_t\":\"%s\"," // cmnd/led2/Dimmer
"\"bri_stat_t\":\"%s\"," // stat/led2/RESULT
"\"bri_scl\":100," // 100%
"\"on_cmd_type\":\"%s\"," // power on (first), power on (last), no power on (brightness)
"\"bri_val_tpl\":\"{{value_json." D_CMND_DIMMER "}}\"";
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_LIGHT_COLOR[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"rgb_cmd_t\":\"%s2\"," // cmnd/led2/Color2
"\"rgb_stat_t\":\"%s\"," // stat/led2/RESULT
"\"rgb_val_tpl\":\"{{value_json." D_CMND_COLOR ".split(',')[0:3]|join(',')}}\"";
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_LIGHT_WHITE[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"whit_val_cmd_t\":\"%s\"," // cmnd/led2/White
"\"whit_val_stat_t\":\"%s\"," // stat/led2/RESULT
"\"white_value_scale\":100," // (No abbreviation defined)
"\"whit_val_tpl\":\"{{value_json.Channel[3]}}\"";
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_LIGHT_CT[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"clr_temp_cmd_t\":\"%s\"," // cmnd/led2/CT
"\"clr_temp_stat_t\":\"%s\"," // stat/led2/RESULT
"\"clr_temp_val_tpl\":\"{{value_json." D_CMND_COLORTEMPERATURE "}}\"";
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_LIGHT_SCHEME[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"fx_cmd_t\":\"%s\"," // cmnd/led2/Scheme
"\"fx_stat_t\":\"%s\"," // stat/led2/RESULT
"\"fx_val_tpl\":\"{{value_json." D_CMND_SCHEME "}}\","
"\"fx_list\":[\"0\",\"1\",\"2\",\"3\",\"4\"]"; // string list with reference to scheme parameter.
2018-11-18 14:33:13 +00:00
2019-02-06 19:07:28 +00:00
const char HASS_DISCOVER_SENSOR_HASS_STATUS[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"json_attributes_topic\":\"%s\","
"\"unit_of_meas\":\" \"," // " " As unit of measurement to get a value graph in HAss
"\"val_tpl\":\"{{value_json['" D_JSON_RSSI "']}}\","
"\"ic\":\"mdi:information-outline\"";
2019-02-06 19:07:28 +00:00
2018-12-22 12:21:04 +00:00
const char HASS_DISCOVER_DEVICE_INFO[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"uniq_id\":\"%s\","
"\"device\":{\"identifiers\":[\"%06X\"],"
"\"connections\":[[\"mac\",\"%s\"]],"
"\"name\":\"%s\","
"\"model\":\"%s\","
"\"sw_version\":\"%s%s\","
"\"manufacturer\":\"Tasmota\"}";
2018-12-10 18:51:47 +00:00
2019-02-06 19:07:28 +00:00
const char HASS_DISCOVER_DEVICE_INFO_SHORT[] PROGMEM =
2020-02-06 02:29:44 +00:00
",\"uniq_id\":\"%s\","
"\"device\":{\"identifiers\":[\"%06X\"],"
"\"connections\":[[\"mac\",\"%s\"]]}";
2019-02-06 19:07:28 +00:00
uint8_t hass_init_step = 0;
uint8_t hass_mode = 0;
2019-02-06 19:07:28 +00:00
int hass_tele_period = 0;
2020-02-06 02:29:44 +00:00
void TryResponseAppend_P(const char *format, ...)
2019-02-06 19:07:28 +00:00
{
va_list args;
va_start(args, format);
char dummy[2];
int dlen = vsnprintf_P(dummy, 1, format, args);
int mlen = strlen(mqtt_data);
2020-02-06 02:29:44 +00:00
int slen = sizeof(mqtt_data) - 1 - mlen;
if (dlen >= slen)
{
AddLog_P2(LOG_LEVEL_ERROR, PSTR("HASS: MQTT discovery failed due to too long topic or friendly name. "
2020-02-06 02:29:44 +00:00
"Please shorten topic and friendly name. Failed to format(%u/%u):"),
dlen, slen);
2019-02-07 19:54:30 +00:00
va_start(args, format);
vsnprintf_P(log_data, sizeof(log_data), format, args);
2019-02-06 19:07:28 +00:00
AddLog(LOG_LEVEL_ERROR);
2020-02-06 02:29:44 +00:00
}
else
{
2019-02-06 19:07:28 +00:00
va_start(args, format);
vsnprintf_P(mqtt_data + mlen, slen, format, args);
2019-02-06 19:07:28 +00:00
}
va_end(args);
}
2018-11-18 14:33:13 +00:00
void HAssAnnounceRelayLight(void)
{
char stopic[TOPSZ];
2018-12-10 18:51:47 +00:00
char stemp1[TOPSZ];
char stemp2[TOPSZ];
char stemp3[TOPSZ];
char unique_id[30];
bool is_light = false;
bool is_topic_light = false;
2020-02-06 02:29:44 +00:00
for (uint32_t i = 1; i <= MAX_RELAYS; i++)
{
is_light = ((i == devices_present) && (light_type));
2020-02-06 02:29:44 +00:00
is_topic_light = Settings.flag.hass_light || is_light; // SetOption30 - Enforce HAss autodiscovery as light
2020-02-06 02:29:44 +00:00
mqtt_data[0] = '\0'; // Clear retained message
2019-03-08 15:38:36 +00:00
// Clear "other" topic first in case the device has been reconfigured from light to switch or vice versa
2018-12-10 18:51:47 +00:00
snprintf_P(unique_id, sizeof(unique_id), PSTR("%06X_%s_%d"), ESP.getChipId(), (is_topic_light) ? "RL" : "LI", i);
2019-02-06 19:07:28 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/%s/%s/config"),
(is_topic_light) ? "switch" : "light", unique_id);
MqttPublish(stopic, true);
// Clear or Set topic
2018-12-10 18:51:47 +00:00
snprintf_P(unique_id, sizeof(unique_id), PSTR("%06X_%s_%d"), ESP.getChipId(), (is_topic_light) ? "LI" : "RL", i);
2019-02-06 19:07:28 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/%s/%s/config"),
(is_topic_light) ? "light" : "switch", unique_id);
2020-02-06 02:29:44 +00:00
if (Settings.flag.hass_discovery && (i <= devices_present))
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
char name[33 + 2]; // friendlyname(33) + " " + index
char value_template[33];
char prefix[TOPSZ];
2018-12-10 18:51:47 +00:00
char *command_topic = stemp1;
char *state_topic = stemp2;
char *availability_topic = stemp3;
2020-02-06 02:29:44 +00:00
if (i > MAX_FRIENDLYNAMES)
{
snprintf_P(name, sizeof(name), PSTR("%s %d"), SettingsText(SET_FRIENDLYNAME1), i);
}
2020-02-06 02:29:44 +00:00
else
{
snprintf_P(name, sizeof(name), SettingsText(SET_FRIENDLYNAME1 + i - 1));
}
GetPowerDevice(value_template, i, sizeof(value_template), Settings.flag.device_index_enable); // SetOption26 - Switch between POWER or POWER1
GetTopic_P(command_topic, CMND, mqtt_topic, value_template);
2018-12-02 14:23:25 +00:00
GetTopic_P(state_topic, TELE, mqtt_topic, D_RSLT_STATE);
GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT);
2020-02-06 16:32:54 +00:00
Response_P(HASS_DISCOVER_BASE, name, state_topic, availability_topic);
TryResponseAppend_P(HASS_DISCOVER_RELAY, command_topic, value_template, SettingsText(SET_STATE_TXT1), SettingsText(SET_STATE_TXT2));
TryResponseAppend_P(HASS_DISCOVER_DEVICE_INFO_SHORT, unique_id, ESP.getChipId(), WiFi.macAddress().c_str());
#ifdef USE_LIGHT
2020-02-06 02:29:44 +00:00
if (is_light)
{
2018-12-10 18:51:47 +00:00
char *brightness_command_topic = stemp1;
GetTopic_P(brightness_command_topic, CMND, mqtt_topic, D_CMND_DIMMER);
2020-02-06 02:29:44 +00:00
strncpy_P(stemp3, Settings.flag.not_power_linked ? PSTR("last") : PSTR("brightness"), sizeof(stemp3)); // SetOption20 - Control power in relation to Dimmer/Color/Ct changes
TryResponseAppend_P(HASS_DISCOVER_LIGHT_DIMMER, brightness_command_topic, state_topic, stemp3);
2020-02-06 02:29:44 +00:00
if (Light.subtype >= LST_RGB)
{
2018-12-10 18:51:47 +00:00
char *rgb_command_topic = stemp1;
GetTopic_P(rgb_command_topic, CMND, mqtt_topic, D_CMND_COLOR);
TryResponseAppend_P(HASS_DISCOVER_LIGHT_COLOR, rgb_command_topic, state_topic);
2018-12-10 18:51:47 +00:00
char *effect_command_topic = stemp1;
GetTopic_P(effect_command_topic, CMND, mqtt_topic, D_CMND_SCHEME);
TryResponseAppend_P(HASS_DISCOVER_LIGHT_SCHEME, effect_command_topic, state_topic);
}
2020-02-06 02:29:44 +00:00
if (LST_RGBW == Light.subtype)
{
2018-12-10 18:51:47 +00:00
char *white_temp_command_topic = stemp1;
GetTopic_P(white_temp_command_topic, CMND, mqtt_topic, D_CMND_WHITE);
TryResponseAppend_P(HASS_DISCOVER_LIGHT_WHITE, white_temp_command_topic, state_topic);
}
2020-02-06 02:29:44 +00:00
if ((LST_COLDWARM == Light.subtype) || (LST_RGBCW == Light.subtype))
{
2018-12-10 18:51:47 +00:00
char *color_temp_command_topic = stemp1;
GetTopic_P(color_temp_command_topic, CMND, mqtt_topic, D_CMND_COLORTEMPERATURE);
TryResponseAppend_P(HASS_DISCOVER_LIGHT_CT, color_temp_command_topic, state_topic);
}
}
2020-02-06 02:29:44 +00:00
#endif // USE_LIGHT
TryResponseAppend_P(PSTR("}"));
}
MqttPublish(stopic, true);
}
}
2020-02-06 02:29:44 +00:00
void HAssAnnounceButtonSwitch(uint8_t device, char *topic, uint8_t present, uint8_t key, uint8_t toggle)
{
2020-02-06 02:29:44 +00:00
// key 0 = button
// key 1 = switch
2018-12-04 20:31:23 +00:00
char stopic[TOPSZ];
2018-12-10 18:51:47 +00:00
char stemp1[TOPSZ];
char stemp2[TOPSZ];
char unique_id[30];
2018-12-04 20:31:23 +00:00
2020-02-06 02:29:44 +00:00
mqtt_data[0] = '\0'; // Clear retained message
2018-12-04 20:31:23 +00:00
// Clear or Set topic
2020-02-06 02:29:44 +00:00
snprintf_P(unique_id, sizeof(unique_id), PSTR("%06X_%s_%d"), ESP.getChipId(), key ? "SW" : "BTN", device + 1);
2018-12-10 18:51:47 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/binary_sensor/%s/config"), unique_id);
2018-12-04 20:31:23 +00:00
2020-02-06 02:29:44 +00:00
if (Settings.flag.hass_discovery && present)
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
char name[33 + 6]; // friendlyname(33) + " " + "BTN" + " " + index
2018-12-04 20:31:23 +00:00
char value_template[33];
char prefix[TOPSZ];
2018-12-10 18:51:47 +00:00
char *state_topic = stemp1;
char *availability_topic = stemp2;
2019-10-24 22:29:06 +01:00
char jsoname[8];
2018-12-04 20:31:23 +00:00
2020-02-06 02:29:44 +00:00
snprintf_P(name, sizeof(name), PSTR("%s %s%d"), SettingsText(SET_FRIENDLYNAME1), key ? "Switch" : "Button", device + 1);
snprintf_P(jsoname, sizeof(jsoname), PSTR("%s%d"), key ? "SWITCH" : "BUTTON", device + 1);
GetPowerDevice(value_template, device + 1, sizeof(value_template),
2019-11-03 11:33:36 +00:00
key + Settings.flag.device_index_enable); // Force index for Switch 1, Index on Button1 is controlled by SetOption26 - Switch between POWER or POWER1
2019-11-15 01:37:30 +00:00
GetTopic_P(state_topic, STAT, mqtt_topic, (PSTR("/'%s'"), jsoname));
2018-12-04 20:31:23 +00:00
GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT);
2019-10-24 22:29:06 +01:00
2020-02-06 02:29:44 +00:00
Response_P(HASS_DISCOVER_BASE, name, state_topic, availability_topic);
TryResponseAppend_P(HASS_DISCOVER_DEVICE_INFO_SHORT, unique_id, ESP.getChipId(), WiFi.macAddress().c_str());
2020-02-06 16:32:54 +00:00
2019-11-15 01:37:30 +00:00
if (toggle) {
if (!key) {
2020-02-06 16:32:54 +00:00
TryResponseAppend_P(HASS_DISCOVER_BUTTON_TOGGLE);
2020-02-06 02:29:44 +00:00
} else { // A switch must maintain his state until the next update
TryResponseAppend_P(",\"value_template\":\"{%%if is_state(entity_id,\\\"on\\\")-%%}OFF{%%-else-%%}ON{%%-endif%%}\"");
}
} else {
TryResponseAppend_P(HASS_DISCOVER_BUTTON_SWITCH_ONOFF, PSTR(D_RSLT_STATE), SettingsText(SET_STATE_TXT2), SettingsText(SET_STATE_TXT1));
2019-11-15 01:37:30 +00:00
}
TryResponseAppend_P(PSTR("}"));
2018-12-04 20:31:23 +00:00
}
MqttPublish(stopic, true);
}
void HAssAnnounceSwitches(void)
{
char sw_topic[TOPSZ];
2018-12-04 20:31:23 +00:00
// Send info about buttons
char *tmp = SettingsText(SET_MQTT_SWITCH_TOPIC);
2018-12-04 20:31:23 +00:00
Format(sw_topic, tmp, sizeof(sw_topic));
2020-02-06 02:29:44 +00:00
if (!strcmp_P(sw_topic, "0") || strlen(sw_topic) == 0)
{
for (uint32_t switch_index = 0; switch_index < MAX_SWITCHES; switch_index++)
{
uint8_t switch_present = 0;
uint8_t toggle = 1;
2018-12-04 20:31:23 +00:00
2020-02-06 02:29:44 +00:00
if (pin[GPIO_SWT1 + switch_index] < 99)
{
2018-12-04 20:31:23 +00:00
switch_present = 1;
}
2018-12-05 19:20:36 +00:00
// Check if MQTT message will be ON/OFF or TOGGLE
if (Settings.switchmode[switch_index] == FOLLOW || Settings.switchmode[switch_index] == FOLLOW_INV ||
2020-02-06 02:29:44 +00:00
Settings.flag3.button_switch_force_local || // SetOption61 - Force local operation when button/switch topic is set
!strcmp(mqtt_topic, sw_topic) || !strcmp(SettingsText(SET_MQTT_GRP_TOPIC), sw_topic))
2018-12-05 19:20:36 +00:00
{
2018-12-08 08:43:48 +00:00
toggle = 0; // MQTT message will be ON/OFF
2018-12-05 19:20:36 +00:00
}
HAssAnnounceButtonSwitch(switch_index, sw_topic, switch_present, 1, toggle);
2018-12-04 20:31:23 +00:00
}
}
}
void HAssAnnounceButtons(void)
{
char key_topic[TOPSZ];
// Send info about buttons
char *tmp = SettingsText(SET_MQTT_BUTTON_TOPIC);
Format(key_topic, tmp, sizeof(key_topic));
2020-02-06 02:29:44 +00:00
if (!strcmp_P(key_topic, "0") || strlen(key_topic) == 0)
{
for (uint32_t button_index = 0; button_index < MAX_KEYS; button_index++)
{
uint8_t button_present = 0;
uint8_t toggle = 1;
2020-02-06 02:29:44 +00:00
if (!button_index && ((SONOFF_DUAL == my_module_type) || (CH4 == my_module_type)))
{
button_present = 1;
2020-02-06 02:29:44 +00:00
}
else
{
if (pin[GPIO_KEY1 + button_index] < 99)
{
button_present = 1;
}
}
2018-12-05 19:20:36 +00:00
// Check if MQTT message will be ON/OFF or TOGGLE
2020-02-06 02:29:44 +00:00
if (Settings.flag3.button_switch_force_local || // SetOption61 - Force local operation when button/switch topic is set
!strcmp(mqtt_topic, key_topic) || !strcmp(SettingsText(SET_MQTT_GRP_TOPIC), key_topic))
2018-12-05 19:20:36 +00:00
{
2018-12-08 08:43:48 +00:00
toggle = 0; // MQTT message will be ON/OFF
2018-12-05 19:20:36 +00:00
}
HAssAnnounceButtonSwitch(button_index, key_topic, button_present, 0, toggle);
}
}
}
2020-02-06 02:29:44 +00:00
void HAssAnnounceSensor(const char *sensorname, const char *subsensortype, const char *MultiSubName, uint8_t subqty, uint8_t subidx)
2018-11-18 14:33:13 +00:00
{
char stopic[TOPSZ];
2018-12-10 18:51:47 +00:00
char stemp1[TOPSZ];
char stemp2[TOPSZ];
char unique_id[30];
2018-11-18 14:33:13 +00:00
2020-02-06 02:29:44 +00:00
mqtt_data[0] = '\0'; // Clear retained message
2020-02-07 15:11:29 +00:00
// Clear or Set topic
char subname[20];
NoAlNumToUnderscore(subname, MultiSubName); //Replace all non alphaumeric characters to '_' to avoid topic name issues
snprintf_P(unique_id, sizeof(unique_id), PSTR("%06X_%s_%s"), ESP.getChipId(), sensorname, subname);
2020-02-06 02:29:44 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/sensor/%s/config"), unique_id);;
if (Settings.flag.hass_discovery)
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
char name[33 + 42]; // friendlyname(33) + " " + sensorname(20?) + " " + sensortype(20?)
2018-11-18 14:33:13 +00:00
char prefix[TOPSZ];
2018-12-10 18:51:47 +00:00
char *state_topic = stemp1;
char *availability_topic = stemp2;
2018-11-18 14:33:13 +00:00
2020-02-06 02:29:44 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/sensor/%s/config"), unique_id);
GetTopic_P(state_topic, TELE, mqtt_topic, PSTR(D_RSLT_SENSOR));
snprintf_P(name, sizeof(name), PSTR("%s %s %s"), SettingsText(SET_FRIENDLYNAME1), sensorname, MultiSubName);
2018-11-18 14:33:13 +00:00
GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT);
2020-02-06 02:29:44 +00:00
Response_P(HASS_DISCOVER_BASE, name, state_topic, availability_topic);
TryResponseAppend_P(HASS_DISCOVER_DEVICE_INFO_SHORT, unique_id, ESP.getChipId(), WiFi.macAddress().c_str());
2020-02-06 16:32:54 +00:00
2020-02-06 02:29:44 +00:00
char jname[32];
2020-02-06 16:32:54 +00:00
int sensor_index = GetCommandCode(jname, sizeof(jname), subsensortype, kHAssJsonSensorTypes);
2020-02-06 02:29:44 +00:00
if (sensor_index > -1) {
char param1[20];
2020-02-06 16:32:54 +00:00
GetTextIndexed(param1, sizeof(param1), sensor_index, kHAssJsonSensorUnits);
2020-02-06 02:29:44 +00:00
switch (sensor_index) {
case 0: // Temperature
snprintf_P(param1, sizeof(param1), PSTR("°%c"),TempUnit()); // C or F
break;
case 1:
case 2:
snprintf_P(param1, sizeof(param1), PSTR("%s"), PressureUnit().c_str());
break;
}
2020-02-06 02:29:44 +00:00
char param2[50];
2020-02-06 16:32:54 +00:00
GetTextIndexed(param2, sizeof(param2), sensor_index, kHAssJsonSensorDevCla);
2020-02-06 02:29:44 +00:00
TryResponseAppend_P(HASS_DISCOVER_SENSOR, param1, param2, sensorname, subsensortype);
if (subidx) {
TryResponseAppend_P(PSTR("[%d]"), subqty -1);
}
} else {
TryResponseAppend_P(HASS_DISCOVER_SENSOR, " ", "ic\":\"mdi:eye", sensorname, subsensortype);
2018-11-18 14:33:13 +00:00
}
2020-02-06 02:29:44 +00:00
TryResponseAppend_P(PSTR("}}\"}"));
2018-11-18 14:33:13 +00:00
}
MqttPublish(stopic, true);
}
void HAssAnnounceSensors(void)
{
uint8_t hass_xsns_index = 0;
2020-02-06 02:29:44 +00:00
bool is_sensor = true;
uint8_t subqty = 0;
do
{
2018-11-18 14:33:13 +00:00
mqtt_data[0] = '\0';
int tele_period_save = tele_period;
2020-02-06 02:29:44 +00:00
tele_period = 2; // Do not allow HA updates during next function call
XsnsNextCall(FUNC_JSON_APPEND, hass_xsns_index); // ,"INA219":{"Voltage":4.494,"Current":0.020,"Power":0.089}
2018-11-18 14:33:13 +00:00
tele_period = tele_period_save;
2020-02-06 02:29:44 +00:00
char sensordata[512]; // Copy because we need to write to mqtt_data
2018-11-18 14:33:13 +00:00
strlcpy(sensordata, mqtt_data, sizeof(sensordata));
2020-02-06 02:29:44 +00:00
if (strlen(sensordata))
{
sensordata[0] = '{';
snprintf_P(sensordata, sizeof(sensordata), PSTR("%s}"), sensordata); // {"INA219":{"Voltage":4.494,"Current":0.020,"Power":0.089}}
// USE THE FOLLOWING LINE TO TEST JSON
//snprintf_P(sensordata, sizeof(sensordata), PSTR("{\"HX711\":{\"Weight\":[22,34,1023.4], \"Battery\":25}}"));
2018-11-18 14:33:13 +00:00
StaticJsonBuffer<500> jsonBuffer;
2020-02-06 02:29:44 +00:00
JsonObject &root = jsonBuffer.parseObject(sensordata);
if (!root.success())
{
2019-10-17 15:57:54 +01:00
AddLog_P2(LOG_LEVEL_ERROR, PSTR("HASS: jsonBuffer failed to parse '%s'"), sensordata);
2018-11-18 14:33:13 +00:00
continue;
}
2020-02-06 02:29:44 +00:00
for (auto sensor : root)
{
const char *sensorname = sensor.key;
JsonObject &sensors = sensor.value.as<JsonObject>();
if (!sensors.success())
{
2019-10-17 15:57:54 +01:00
AddLog_P2(LOG_LEVEL_ERROR, PSTR("HASS: JsonObject failed to parse '%s'"), sensordata);
2018-11-18 14:33:13 +00:00
continue;
}
2020-02-06 02:29:44 +00:00
for (auto subsensor : sensors)
{
// If there is more than a value on sensor data, 'n' entitites will be created
if (subsensor.value.is<JsonArray&>()) {
JsonArray& subsensors = subsensor.value.as<JsonArray&>();
subqty = subsensors.size();
char MultiSubName[20];
for (int i = 1; i <= subqty; i++) {
2020-02-07 15:11:29 +00:00
snprintf_P(MultiSubName, sizeof(MultiSubName), PSTR("%s %d"), subsensor.key, i);
2020-02-06 02:29:44 +00:00
HAssAnnounceSensor(sensorname, subsensor.key, MultiSubName, i, 1);
}
} else { HAssAnnounceSensor(sensorname, subsensor.key, subsensor.key, 0, 0);}
2018-11-18 14:33:13 +00:00
}
}
}
yield();
2018-11-18 14:33:13 +00:00
} while (hass_xsns_index != 0);
}
2019-02-06 19:07:28 +00:00
void HAssAnnounceStatusSensor(void)
{
char stopic[TOPSZ];
char stemp1[TOPSZ];
char stemp2[TOPSZ];
char unique_id[30];
// Announce sensor
2020-02-06 02:29:44 +00:00
mqtt_data[0] = '\0'; // Clear retained message
2019-02-06 19:07:28 +00:00
// Clear or Set topic
snprintf_P(unique_id, sizeof(unique_id), PSTR("%06X_status"), ESP.getChipId());
2019-02-06 19:07:28 +00:00
snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/sensor/%s/config"), unique_id);
2020-02-06 02:29:44 +00:00
if (Settings.flag.hass_discovery)
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
char name[33 + 7]; // friendlyname(33) + " " + "status"
2019-02-06 19:07:28 +00:00
char prefix[TOPSZ];
char *state_topic = stemp1;
char *availability_topic = stemp2;
snprintf_P(name, sizeof(name), PSTR("%s status"), SettingsText(SET_FRIENDLYNAME1));
2019-02-06 19:07:28 +00:00
GetTopic_P(state_topic, TELE, mqtt_topic, PSTR(D_RSLT_HASS_STATE));
GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT);
2020-02-06 02:29:44 +00:00
Response_P(HASS_DISCOVER_BASE, name, state_topic, availability_topic);
TryResponseAppend_P(HASS_DISCOVER_SENSOR_HASS_STATUS, state_topic);
TryResponseAppend_P(HASS_DISCOVER_DEVICE_INFO, unique_id, ESP.getChipId(), WiFi.macAddress().c_str(),
2020-02-06 02:29:44 +00:00
SettingsText(SET_FRIENDLYNAME1), ModuleName().c_str(), my_version, my_image);
2020-02-06 16:32:54 +00:00
TryResponseAppend_P(PSTR("}"));
2019-02-06 19:07:28 +00:00
}
MqttPublish(stopic, true);
}
void HAssPublishStatus(void)
{
Response_P(PSTR("{\"" D_JSON_VERSION "\":\"%s%s\",\"" D_JSON_BUILDDATETIME "\":\"%s\","
2020-02-06 02:29:44 +00:00
"\"" D_JSON_COREVERSION "\":\"" ARDUINO_ESP8266_RELEASE "\",\"" D_JSON_SDKVERSION "\":\"%s\","
"\"" D_CMND_MODULE "\":\"%s\",\"" D_JSON_RESTARTREASON "\":\"%s\",\"" D_JSON_UPTIME "\":\"%s\","
"\"WiFi " D_JSON_LINK_COUNT "\":%d,\"WiFi " D_JSON_DOWNTIME "\":\"%s\",\"" D_JSON_MQTT_COUNT "\":%d,"
"\"" D_JSON_BOOTCOUNT "\":%d,\"" D_JSON_SAVECOUNT "\":%d,\"" D_CMND_IPADDRESS "\":\"%s\","
"\"" D_JSON_RSSI "\":\"%d\",\"LoadAvg\":%lu}"),
2019-03-08 15:38:36 +00:00
my_version, my_image, GetBuildDateAndTime().c_str(), ESP.getSdkVersion(), ModuleName().c_str(),
2019-03-11 17:29:39 +00:00
GetResetReason().c_str(), GetUptime().c_str(), WifiLinkCount(), WifiDowntime().c_str(), MqttConnectCount(),
2019-03-08 15:38:36 +00:00
Settings.bootcount, Settings.save_flag, WiFi.localIP().toString().c_str(),
WifiGetRssiAsQuality(WiFi.RSSI()), loop_load_avg);
2019-02-06 19:07:28 +00:00
MqttPublishPrefixTopic_P(TELE, PSTR(D_RSLT_HASS_STATE));
}
void HAssDiscovery(void)
{
// Configure Tasmota for default Home Assistant parameters to keep discovery message as short as possible
2020-02-06 02:29:44 +00:00
if (Settings.flag.hass_discovery)
{ // SetOption19 - Control Home Assistant automatic discovery (See SetOption59)
Settings.flag.mqtt_response = 0; // SetOption4 - Switch between MQTT RESULT or COMMAND - Response always as RESULT and not as uppercase command
Settings.flag.decimal_text = 1; // SetOption17 - Switch between decimal or hexadecimal output - Respond with decimal color values
Settings.flag3.hass_tele_on_power = 1; // SetOption59 - Send tele/%topic%/STATE in addition to stat/%topic%/RESULT - send tele/STATE message as stat/RESULT
2020-02-06 13:23:45 +00:00
Settings.light_scheme = 0; // To just control color it needs to be Scheme 0
}
2020-02-06 02:29:44 +00:00
if (Settings.flag.hass_discovery || (1 == hass_mode))
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
// Send info about relays and lights
2018-11-18 14:33:13 +00:00
HAssAnnounceRelayLight();
// Send info about buttons
2018-12-04 20:31:23 +00:00
HAssAnnounceButtons();
2018-11-18 14:33:13 +00:00
2018-12-04 20:31:23 +00:00
// Send info about switches
HAssAnnounceSwitches();
2018-11-18 14:33:13 +00:00
// Send info about sensors
HAssAnnounceSensors();
2019-02-06 19:07:28 +00:00
// Send info about status sensor
HAssAnnounceStatusSensor();
}
}
void HAssDiscover(void)
{
2020-02-06 02:29:44 +00:00
hass_mode = 1; // Force discovery
hass_init_step = 1; // Delayed discovery
}
void HAssAnyKey(void)
{
2020-02-06 02:29:44 +00:00
if (!Settings.flag.hass_discovery)
{
return;
} // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
uint32_t key = (XdrvMailbox.payload >> 16) & 0xFF;
uint32_t device = XdrvMailbox.payload & 0xFF;
uint32_t state = (XdrvMailbox.payload >> 8) & 0xFF;
char scommand[CMDSZ];
snprintf_P(scommand, sizeof(scommand), PSTR("%s%d"), (key) ? "SWITCH" : "BUTTON", device);
char stopic[TOPSZ];
2020-02-06 16:32:54 +00:00
2019-11-15 01:37:30 +00:00
GetTopic_P(stopic, STAT, mqtt_topic, scommand);
Response_P(S_JSON_COMMAND_SVALUE, PSTR(D_RSLT_STATE), GetStateText(state));
MqttPublish(stopic);
}
/*********************************************************************************************\
* Interface
\*********************************************************************************************/
bool Xdrv12(uint8_t function)
{
bool result = false;
2020-02-06 02:29:44 +00:00
if (Settings.flag.mqtt_enabled)
{ // SetOption3 - Enable MQTT
switch (function)
{
case FUNC_EVERY_SECOND:
if (hass_init_step)
{
hass_init_step--;
if (!hass_init_step)
{
HAssDiscovery(); // Scheduled discovery using available resources
}
2020-02-06 02:29:44 +00:00
}
else if (Settings.flag.hass_discovery && Settings.tele_period)
{ // SetOption19 - Control Home Assistantautomatic discovery (See SetOption59)
hass_tele_period++;
if (hass_tele_period >= Settings.tele_period)
{
hass_tele_period = 0;
mqtt_data[0] = '\0';
HAssPublishStatus();
}
}
break;
case FUNC_ANY_KEY:
HAssAnyKey();
break;
case FUNC_MQTT_INIT:
hass_mode = 0; // Discovery only if Settings.flag.hass_discovery is set
hass_init_step = 2; // Delayed discovery
break;
}
}
return result;
}
2020-02-06 02:29:44 +00:00
#endif // USE_HOME_ASSISTANT