/* xdrv_12_home_assistant.ino - home assistant support for Sonoff-Tasmota Copyright (C) 2018 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 . */ #ifdef USE_HOME_ASSISTANT #define XDRV_12 12 const char HASS_DISCOVER_RELAY[] PROGMEM = "{\"name\":\"%s\"," // dualr2 1 "\"command_topic\":\"%s\"," // cmnd/dualr2/POWER2 "\"state_topic\":\"%s\"," // stat/dualr2/RESULT (implies "\"optimistic\":\"false\",") "\"value_template\":\"{{value_json.%s}}\"," // POWER2 "\"payload_off\":\"%s\"," // OFF "\"payload_on\":\"%s\"," // ON // "\"optimistic\":\"false\"," // false is Hass default when state_topic is set "\"availability_topic\":\"%s\"," // tele/dualr2/LWT "\"payload_available\":\"" D_ONLINE "\"," // Online "\"payload_not_available\":\"" D_OFFLINE "\""; // Offline const char HASS_DISCOVER_BUTTON[] PROGMEM = "{\"name\":\"%s\"," // dualr2 1 BTN "\"state_topic\":\"%s\"," // cmnd/dualr2/POWER (implies "\"optimistic\":\"false\",") // "\"value_template\":\"{{value_json.%s}}\"," // POWER2 "\"payload_on\":\"%s\"," // TOGGLE // "\"optimistic\":\"false\"," // false is Hass default when state_topic is set "\"availability_topic\":\"%s\"," // tele/dualr2/LWT "\"payload_available\":\"" D_ONLINE "\"," // Online "\"payload_not_available\":\"" D_OFFLINE "\"," // Offline "\"force_update\":true"; const char HASS_DISCOVER_LIGHT_DIMMER[] PROGMEM = "%s,\"brightness_command_topic\":\"%s\"," // cmnd/led2/Dimmer "\"brightness_state_topic\":\"%s\"," // stat/led2/RESULT "\"brightness_scale\":100," // 100% "\"on_command_type\":\"brightness\"," // power on (first), power on (last), no power on (brightness) "\"brightness_value_template\":\"{{value_json." D_CMND_DIMMER "}}\""; const char HASS_DISCOVER_LIGHT_COLOR[] PROGMEM = "%s,\"rgb_command_topic\":\"%s2\"," // cmnd/led2/Color2 "\"rgb_state_topic\":\"%s\"," // stat/led2/RESULT "\"rgb_value_template\":\"{{value_json." D_CMND_COLOR "}}\""; // "\"rgb_value_template\":\"{{value_json." D_CMND_COLOR " | join(',')}}\""; const char HASS_DISCOVER_LIGHT_CT[] PROGMEM = "%s,\"color_temp_command_topic\":\"%s\"," // cmnd/led2/CT "\"color_temp_state_topic\":\"%s\"," // stat/led2/RESULT "\"color_temp_value_template\":\"{{value_json." D_CMND_COLORTEMPERATURE "}}\""; /* const char HASS_DISCOVER_LIGHT_SCHEME[] PROGMEM = "%s,\"effect_command_topic\":\"%s\"," // cmnd/led2/Scheme "\"effect_state_topic\":\"%s\"," // stat/led2/RESULT "\"effect_value_template\":\"{{value_json." D_CMND_SCHEME "}}\"," "\"effect_list\":[\"0\",\"1\",\"2\",\"3\",\"4\"]"; // string list with reference to scheme parameter. Currently only supports numbers 0 to 11 as it make the mqtt string too long */ void HAssDiscoverRelay() { char sidx[8]; char stopic[TOPSZ]; bool is_light = false; bool is_topic_light = false; for (int i = 1; i <= MAX_RELAYS; i++) { is_light = ((i == devices_present) && (light_type)); is_topic_light = Settings.flag.hass_light || is_light; mqtt_data[0] = '\0'; // Clear retained message snprintf_P(sidx, sizeof(sidx), PSTR("_%d"), i); // Clear "other" topic first in case the device has been reconfigured snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/%s/%s%s/config"), (is_topic_light) ? "switch" : "light", mqtt_topic, sidx); MqttPublish(stopic, true); // Clear or Set topic snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/%s/%s%s/config"), (is_topic_light) ? "light" : "switch", mqtt_topic, sidx); if (Settings.flag.hass_discovery && (i <= devices_present)) { char name[33]; char value_template[33]; char command_topic[TOPSZ]; char state_topic[TOPSZ]; char availability_topic[TOPSZ]; if (i > MAX_FRIENDLYNAMES) { snprintf_P(name, sizeof(name), PSTR("%s %d"), Settings.friendlyname[0], i); } else { snprintf_P(name, sizeof(name), Settings.friendlyname[i -1]); } GetPowerDevice(value_template, i, sizeof(value_template), Settings.flag.device_index_enable); GetTopic_P(command_topic, CMND, mqtt_topic, value_template); GetTopic_P(state_topic, STAT, mqtt_topic, S_RSLT_RESULT); GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_RELAY, name, command_topic, state_topic, value_template, Settings.state_text[0], Settings.state_text[1], availability_topic); if (is_light) { char brightness_command_topic[TOPSZ]; GetTopic_P(brightness_command_topic, CMND, mqtt_topic, D_CMND_DIMMER); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_LIGHT_DIMMER, mqtt_data, brightness_command_topic, state_topic); if (light_subtype >= LST_RGB) { char rgb_command_topic[TOPSZ]; GetTopic_P(rgb_command_topic, CMND, mqtt_topic, D_CMND_COLOR); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_LIGHT_COLOR, mqtt_data, rgb_command_topic, state_topic); /* char effect_command_topic[TOPSZ]; GetTopic_P(effect_command_topic, CMND, mqtt_topic, D_CMND_SCHEME); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_LIGHT_SCHEME, mqtt_data, effect_command_topic, state_topic); */ } if ((LST_COLDWARM == light_subtype) || (LST_RGBWC == light_subtype)) { char color_temp_command_topic[TOPSZ]; GetTopic_P(color_temp_command_topic, CMND, mqtt_topic, D_CMND_COLORTEMPERATURE); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_LIGHT_CT, mqtt_data, color_temp_command_topic, state_topic); } } snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s}"), mqtt_data); } MqttPublish(stopic, true); } } void HAssDiscoverButton() { char sidx[8]; char stopic[TOPSZ]; char key_topic[sizeof(Settings.button_topic)]; // Send info about buttons char *tmp = Settings.button_topic; Format(key_topic, tmp, sizeof(key_topic)); if ((strlen(key_topic) != 0) && strcmp(key_topic, "0")) { for (byte button_index = 0; button_index < MAX_KEYS; button_index++) { uint8_t button_present = 0; if (!button_index && ((SONOFF_DUAL == Settings.module) || (CH4 == Settings.module))) { button_present = 1; } else { if (pin[GPIO_KEY1 + button_index] < 99) { button_present = 1; } } mqtt_data[0] = '\0'; // Clear retained message // Clear or Set topic snprintf_P(sidx, sizeof(sidx), PSTR("_%d"), button_index+1); snprintf_P(stopic, sizeof(stopic), PSTR(HOME_ASSISTANT_DISCOVERY_PREFIX "/%s/%s%s/config"), "binary_sensor", key_topic, sidx); if (Settings.flag.hass_discovery && button_present) { char name[33]; char value_template[33]; char state_topic[TOPSZ]; char availability_topic[TOPSZ]; if (button_index+1 > MAX_FRIENDLYNAMES) { snprintf_P(name, sizeof(name), PSTR("%s %d BTN"), Settings.friendlyname[0], button_index+1); } else { snprintf_P(name, sizeof(name), PSTR("%s BTN"), Settings.friendlyname[button_index]); } GetPowerDevice(value_template, button_index+1, sizeof(value_template), Settings.flag.device_index_enable); GetTopic_P(state_topic, CMND, key_topic, value_template); // State of button is sent as CMND TOGGLE GetTopic_P(availability_topic, TELE, mqtt_topic, S_LWT); snprintf_P(mqtt_data, sizeof(mqtt_data), HASS_DISCOVER_BUTTON, name, state_topic, Settings.state_text[2], availability_topic); snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s}"), mqtt_data); } MqttPublish(stopic, true); } } } void HAssDiscovery(uint8_t mode) { // Configure Tasmota for default Home Assistant parameters to keep discovery message as short as possible if (Settings.flag.hass_discovery) { Settings.flag.mqtt_response = 0; // Response always as RESULT and not as uppercase command Settings.flag.decimal_text = 1; // Respond with decimal color values // Settings.light_scheme = 0; // To just control color it needs to be Scheme 0 // strncpy_P(Settings.mqtt_fulltopic, PSTR("%prefix%/%topic%/"), sizeof(Settings.mqtt_fulltopic)); // Make MQTT topic as short as possible to make this process posible within MQTT_MAX_PACKET_SIZE } if (Settings.flag.hass_discovery || (1 == mode)) { // Send info about relays and lights HAssDiscoverRelay(); // Send info about buttons HAssDiscoverButton(); // TODO: Send info about switches // TODO: Send info about sensors } } /* #define D_CMND_HASSDISCOVER "HassDiscover" enum HassCommands { CMND_HASSDISCOVER }; const char kHassCommands[] PROGMEM = D_CMND_HASSDISCOVER ; boolean HassCommand() { char command[CMDSZ]; boolean serviced = true; int command_code = GetCommandCode(command, sizeof(command), XdrvMailbox.topic, kHassCommands); if (-1 == command_code) { serviced = false; // Unknown command } else if (CMND_HASSDISCOVER == command_code) { if (XdrvMailbox.data_len > 0) { switch (XdrvMailbox.payload) { case 0: // Off case 1: // On Settings.flag.hass_discovery = XdrvMailbox.payload; break; case 2: // Toggle Settings.flag.hass_discovery ^= 1; break; case 4: // Off case 5: // On Settings.flag.hass_light = XdrvMailbox.payload &1; break; case 6: // Toggle Settings.flag.hass_light ^= 1; break; } HAssDiscovery(1); } snprintf_P (mqtt_data, sizeof(mqtt_data), PSTR("{\"%s\":\"%s\",\"Force light\":\"%s\"}"), command, GetStateText(Settings.flag.hass_discovery), GetStateText(Settings.flag.hass_light)); } else serviced = false; // Unknown command return serviced; } */ /*********************************************************************************************\ * Interface \*********************************************************************************************/ boolean Xdrv12(byte function) { boolean result = false; if (Settings.flag.mqtt_enabled) { switch (function) { case FUNC_MQTT_INIT: HAssDiscovery(0); break; /* case FUNC_COMMAND: result = HassCommand(); break; */ } } return result; } #endif // USE_HOME_ASSISTANT