Formatted

This commit is contained in:
Indu Prakash
2022-10-14 21:08:38 -05:00
parent 7562fd9049
commit fd4aaeef13
9 changed files with 3541 additions and 3464 deletions

View File

@@ -16,36 +16,36 @@ Sensor - https://www.home-assistant.io/integrations/sensor.mqtt/
//CFG_GetShortDeviceName and clientId so it needs to be bigger than them. +64 for light/switch/etc.
static char g_hassBuffer[CGF_MQTT_CLIENT_ID_SIZE + 64];
static char *STATE_TOPIC_KEY = "stat_t";
static char *COMMAND_TOPIC_KEY = "cmd_t";
static char* STATE_TOPIC_KEY = "stat_t";
static char* COMMAND_TOPIC_KEY = "cmd_t";
/// @brief Populates HomeAssistant unique id for the entity.
/// @param type Entity type
/// @param index Entity index (Ignored for RGB)
/// @param uniq_id Array to populate (should be of size HASS_UNIQUE_ID_SIZE)
void hass_populate_unique_id(ENTITY_TYPE type, int index, char *uniq_id){
//https://developers.home-assistant.io/docs/entity_registry_index/#unique-id-requirements
//mentions that mac can be used for unique_id and deviceName contains that.
const char *longDeviceName = CFG_GetDeviceName();
switch(type){
case ENTITY_LIGHT_PWM:
sprintf(uniq_id,"%s_%s_%d", longDeviceName, "light", index);
break;
void hass_populate_unique_id(ENTITY_TYPE type, int index, char* uniq_id) {
//https://developers.home-assistant.io/docs/entity_registry_index/#unique-id-requirements
//mentions that mac can be used for unique_id and deviceName contains that.
const char* longDeviceName = CFG_GetDeviceName();
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
sprintf(uniq_id,"%s_%s", longDeviceName, "light");
break;
case ENTITY_RELAY:
sprintf(uniq_id,"%s_%s_%d", longDeviceName, "relay", index);
break;
switch (type) {
case ENTITY_LIGHT_PWM:
sprintf(uniq_id, "%s_%s_%d", longDeviceName, "light", index);
break;
case ENTITY_SENSOR:
sprintf(uniq_id,"%s_%s_%d", longDeviceName, "sensor", index);
break;
}
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
sprintf(uniq_id, "%s_%s", longDeviceName, "light");
break;
case ENTITY_RELAY:
sprintf(uniq_id, "%s_%s_%d", longDeviceName, "relay", index);
break;
case ENTITY_SENSOR:
sprintf(uniq_id, "%s_%s_%d", longDeviceName, "sensor", index);
break;
}
}
/// @brief Prints HomeAssistant unique id for the entity.
@@ -53,52 +53,52 @@ void hass_populate_unique_id(ENTITY_TYPE type, int index, char *uniq_id){
/// @param fmt
/// @param type Entity type
/// @param index Entity index
void hass_print_unique_id(http_request_t *request, const char *fmt, ENTITY_TYPE type, int index){
char uniq_id[HASS_UNIQUE_ID_SIZE];
hass_populate_unique_id(type, index, uniq_id);
hprintf128(request, fmt, uniq_id);
void hass_print_unique_id(http_request_t* request, const char* fmt, ENTITY_TYPE type, int index) {
char uniq_id[HASS_UNIQUE_ID_SIZE];
hass_populate_unique_id(type, index, uniq_id);
hprintf128(request, fmt, uniq_id);
}
/// @brief Populates HomeAssistant device configuration MQTT channel e.g. switch/enbrighten_9de8f9_relay_0/config.
/// @param type Entity type
/// @param uniq_id Entity unique id
/// @param info Device info
void hass_populate_device_config_channel(ENTITY_TYPE type, char *uniq_id, HassDeviceInfo *info){
switch(type){
case ENTITY_LIGHT_PWM:
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
sprintf(info->channel, "light/%s/config", uniq_id);
break;
case ENTITY_RELAY:
sprintf(info->channel, "switch/%s/config", uniq_id);
break;
case ENTITY_SENSOR:
sprintf(info->channel, "sensor/%s/config", uniq_id);
break;
}
void hass_populate_device_config_channel(ENTITY_TYPE type, char* uniq_id, HassDeviceInfo* info) {
switch (type) {
case ENTITY_LIGHT_PWM:
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
sprintf(info->channel, "light/%s/config", uniq_id);
break;
case ENTITY_RELAY:
sprintf(info->channel, "switch/%s/config", uniq_id);
break;
case ENTITY_SENSOR:
sprintf(info->channel, "sensor/%s/config", uniq_id);
break;
}
}
/// @brief Builds HomeAssistant device discovery info. The caller needs to free the returned pointer.
/// @param ids
cJSON *hass_build_device_node(cJSON *ids) {
cJSON *dev = cJSON_CreateObject();
cJSON_AddItemToObject(dev, "ids", ids); //identifiers
cJSON_AddStringToObject(dev, "name", CFG_GetShortDeviceName());
cJSON* hass_build_device_node(cJSON* ids) {
cJSON* dev = cJSON_CreateObject();
cJSON_AddItemToObject(dev, "ids", ids); //identifiers
cJSON_AddStringToObject(dev, "name", CFG_GetShortDeviceName());
#ifdef USER_SW_VER
cJSON_AddStringToObject(dev, "sw", USER_SW_VER); //sw_version
#endif
#ifdef USER_SW_VER
cJSON_AddStringToObject(dev, "sw", USER_SW_VER); //sw_version
#endif
cJSON_AddStringToObject(dev, "mf", MANUFACTURER); //manufacturer
cJSON_AddStringToObject(dev, "mdl", PLATFORM_MCU_NAME); //Using chipset for model
cJSON_AddStringToObject(dev, "mf", MANUFACTURER); //manufacturer
cJSON_AddStringToObject(dev, "mdl", PLATFORM_MCU_NAME); //Using chipset for model
sprintf(g_hassBuffer,"http://%s/index",HAL_GetMyIPString());
cJSON_AddStringToObject(dev, "cu", g_hassBuffer); //configuration_url
return dev;
sprintf(g_hassBuffer, "http://%s/index", HAL_GetMyIPString());
cJSON_AddStringToObject(dev, "cu", g_hassBuffer); //configuration_url
return dev;
}
/// @brief Initializes HomeAssistant device discovery storage with common values.
@@ -107,162 +107,162 @@ cJSON *hass_build_device_node(cJSON *ids) {
/// @param payload_on
/// @param payload_off
/// @return
HassDeviceInfo *hass_init_device_info(ENTITY_TYPE type, int index, char *payload_on, char *payload_off){
HassDeviceInfo *info = os_malloc(sizeof(HassDeviceInfo));
addLogAdv(LOG_INFO, LOG_FEATURE_HASS, "hass_init_device_info=%p", info);
hass_populate_unique_id(type, index, info->unique_id);
hass_populate_device_config_channel(type, info->unique_id, info);
info->ids = cJSON_CreateArray();
cJSON_AddItemToArray(info->ids, cJSON_CreateString(CFG_GetDeviceName()));
HassDeviceInfo* hass_init_device_info(ENTITY_TYPE type, int index, char* payload_on, char* payload_off) {
HassDeviceInfo* info = os_malloc(sizeof(HassDeviceInfo));
addLogAdv(LOG_INFO, LOG_FEATURE_HASS, "hass_init_device_info=%p", info);
info->device = hass_build_device_node(info->ids);
hass_populate_unique_id(type, index, info->unique_id);
hass_populate_device_config_channel(type, info->unique_id, info);
info->root = cJSON_CreateObject();
cJSON_AddItemToObject(info->root, "dev", info->device); //device
switch(type){
case ENTITY_LIGHT_PWM:
case ENTITY_RELAY:
sprintf(g_hassBuffer,"%s %i",CFG_GetShortDeviceName(),index);
break;
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
//There can only be one RGB so we can skip including index in the name
sprintf(g_hassBuffer,"%s",CFG_GetShortDeviceName());
break;
case ENTITY_SENSOR:
info->ids = cJSON_CreateArray();
cJSON_AddItemToArray(info->ids, cJSON_CreateString(CFG_GetDeviceName()));
info->device = hass_build_device_node(info->ids);
info->root = cJSON_CreateObject();
cJSON_AddItemToObject(info->root, "dev", info->device); //device
switch (type) {
case ENTITY_LIGHT_PWM:
case ENTITY_RELAY:
sprintf(g_hassBuffer, "%s %i", CFG_GetShortDeviceName(), index);
break;
case ENTITY_LIGHT_RGB:
case ENTITY_LIGHT_RGBCW:
//There can only be one RGB so we can skip including index in the name
sprintf(g_hassBuffer, "%s", CFG_GetShortDeviceName());
break;
case ENTITY_SENSOR:
#ifndef OBK_DISABLE_ALL_DRIVERS
sprintf(g_hassBuffer,"%s %s",CFG_GetShortDeviceName(), sensor_mqttNames[index]);
sprintf(g_hassBuffer, "%s %s", CFG_GetShortDeviceName(), sensor_mqttNames[index]);
#endif
break;
}
cJSON_AddStringToObject(info->root, "name", g_hassBuffer);
break;
}
cJSON_AddStringToObject(info->root, "name", g_hassBuffer);
cJSON_AddStringToObject(info->root, "~", CFG_GetMQTTClientId()); //base topic
cJSON_AddStringToObject(info->root, "~", CFG_GetMQTTClientId()); //base topic
cJSON_AddStringToObject(info->root, "avty_t", "~/connected"); //availability_topic, `online` value is broadcasted
cJSON_AddStringToObject(info->root, "avty_t", "~/connected"); //availability_topic, `online` value is broadcasted
cJSON_AddStringToObject(info->root, "pl_on", payload_on); //payload_on
cJSON_AddStringToObject(info->root, "pl_off", payload_off); //payload_off
cJSON_AddStringToObject(info->root, "pl_on", payload_on); //payload_on
cJSON_AddStringToObject(info->root, "pl_off", payload_off); //payload_off
cJSON_AddStringToObject(info->root, "uniq_id", info->unique_id); //unique_id
cJSON_AddStringToObject(info->root, "uniq_id", info->unique_id); //unique_id
addLogAdv(LOG_DEBUG, LOG_FEATURE_HASS, "root=%p", info->root);
return info;
addLogAdv(LOG_DEBUG, LOG_FEATURE_HASS, "root=%p", info->root);
return info;
}
/// @brief Initializes HomeAssistant relay device discovery storage.
/// @param index
/// @return
HassDeviceInfo *hass_init_relay_device_info(int index){
HassDeviceInfo *info = hass_init_device_info(ENTITY_RELAY, index, "1", "0");
cJSON_AddNumberToObject(info->root, "qos", 1);
HassDeviceInfo* hass_init_relay_device_info(int index) {
HassDeviceInfo* info = hass_init_device_info(ENTITY_RELAY, index, "1", "0");
cJSON_AddNumberToObject(info->root, "qos", 1);
sprintf(g_hassBuffer,"~/%i/get",index);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer); //state_topic
sprintf(g_hassBuffer,"~/%i/set",index);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
sprintf(g_hassBuffer, "~/%i/get", index);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer); //state_topic
sprintf(g_hassBuffer, "~/%i/set", index);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
return info;
return info;
}
/// @brief Initializes HomeAssistant light device discovery storage.
/// @param type
/// @param index Ignored for RGB, for sensor this corresponds to sensor_mqttNames.
/// @return
HassDeviceInfo *hass_init_light_device_info(ENTITY_TYPE type, int index){
const char *clientId = CFG_GetMQTTClientId();
HassDeviceInfo *info = NULL;
HassDeviceInfo* hass_init_light_device_info(ENTITY_TYPE type, int index) {
const char* clientId = CFG_GetMQTTClientId();
HassDeviceInfo* info = NULL;
switch(type){
case ENTITY_LIGHT_RGBCW:
case ENTITY_LIGHT_RGB:
info = hass_init_device_info(type, index, "1", "0");
switch (type) {
case ENTITY_LIGHT_RGBCW:
case ENTITY_LIGHT_RGB:
info = hass_init_device_info(type, index, "1", "0");
cJSON_AddStringToObject(info->root, "rgb_cmd_tpl","{{'#%02x%02x%02x0000'|format(red,green,blue)}}"); //rgb_command_template
cJSON_AddStringToObject(info->root, "rgb_val_tpl","{{value[1:3]|int(base=16)}},{{value[3:5]|int(base=16)}},{{value[5:7]|int(base=16)}}"); //rgb_value_template
cJSON_AddStringToObject(info->root, "rgb_cmd_tpl", "{{'#%02x%02x%02x0000'|format(red,green,blue)}}"); //rgb_command_template
cJSON_AddStringToObject(info->root, "rgb_val_tpl", "{{value[1:3]|int(base=16)}},{{value[3:5]|int(base=16)}},{{value[5:7]|int(base=16)}}"); //rgb_value_template
cJSON_AddStringToObject(info->root, "rgb_stat_t", "~/led_basecolor_rgb/get"); //rgb_state_topic
sprintf(g_hassBuffer,"cmnd/%s/led_basecolor_rgb",clientId);
cJSON_AddStringToObject(info->root, "rgb_cmd_t", g_hassBuffer); //rgb_command_topic
cJSON_AddStringToObject(info->root, "rgb_stat_t", "~/led_basecolor_rgb/get"); //rgb_state_topic
sprintf(g_hassBuffer, "cmnd/%s/led_basecolor_rgb", clientId);
cJSON_AddStringToObject(info->root, "rgb_cmd_t", g_hassBuffer); //rgb_command_topic
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, "~/led_enableAll/get"); //state_topic
sprintf(g_hassBuffer,"cmnd/%s/led_enableAll",clientId);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, "~/led_enableAll/get"); //state_topic
sprintf(g_hassBuffer, "cmnd/%s/led_enableAll", clientId);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
cJSON_AddStringToObject(info->root, "bri_stat_t", "~/led_dimmer/get"); //brightness_state_topic
sprintf(g_hassBuffer,"cmnd/%s/led_dimmer",clientId);
cJSON_AddStringToObject(info->root, "bri_cmd_t", g_hassBuffer); //brightness_command_topic
cJSON_AddStringToObject(info->root, "bri_stat_t", "~/led_dimmer/get"); //brightness_state_topic
sprintf(g_hassBuffer, "cmnd/%s/led_dimmer", clientId);
cJSON_AddStringToObject(info->root, "bri_cmd_t", g_hassBuffer); //brightness_command_topic
cJSON_AddNumberToObject(info->root, "bri_scl", 100); //brightness_scale
cJSON_AddNumberToObject(info->root, "bri_scl", 100); //brightness_scale
if (type == ENTITY_LIGHT_RGBCW){
sprintf(g_hassBuffer,"cmnd/%s/led_temperature",clientId);
cJSON_AddStringToObject(info->root, "clr_temp_cmd_t", g_hassBuffer); //color_temp_command_topic
if (type == ENTITY_LIGHT_RGBCW) {
sprintf(g_hassBuffer, "cmnd/%s/led_temperature", clientId);
cJSON_AddStringToObject(info->root, "clr_temp_cmd_t", g_hassBuffer); //color_temp_command_topic
cJSON_AddStringToObject(info->root, "clr_temp_stat_t", "~/led_temperature/get"); //color_temp_state_topic
}
cJSON_AddStringToObject(info->root, "clr_temp_stat_t", "~/led_temperature/get"); //color_temp_state_topic
}
break;
break;
case ENTITY_LIGHT_PWM:
info = hass_init_device_info(type, index, "99", "0");
cJSON_AddStringToObject(info->root, "on_cmd_type", "brightness"); //on_command_type
cJSON_AddNumberToObject(info->root, "bri_scl", 99); //brightness_scale
cJSON_AddBoolToObject(info->root, "opt", cJSON_True); //optimistic
cJSON_AddNumberToObject(info->root, "qos", 1);
cJSON_AddStringToObject(info->root, "bri_stat_t", "~/led_dimmer/get"); //brightness_state_topic
sprintf(g_hassBuffer,"cmnd/%s/led_dimmer",clientId);
cJSON_AddStringToObject(info->root, "bri_cmd_t", g_hassBuffer); //brightness_command_topic
case ENTITY_LIGHT_PWM:
info = hass_init_device_info(type, index, "99", "0");
cJSON_AddStringToObject(info->root, "on_cmd_type", "brightness"); //on_command_type
cJSON_AddNumberToObject(info->root, "bri_scl", 99); //brightness_scale
cJSON_AddBoolToObject(info->root, "opt", cJSON_True); //optimistic
cJSON_AddNumberToObject(info->root, "qos", 1);
sprintf(g_hassBuffer,"~/%i/get",index);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer); //state_topic
sprintf(g_hassBuffer,"~/%i/set",index);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
cJSON_AddStringToObject(info->root, "bri_stat_t", "~/led_dimmer/get"); //brightness_state_topic
sprintf(g_hassBuffer, "cmnd/%s/led_dimmer", clientId);
cJSON_AddStringToObject(info->root, "bri_cmd_t", g_hassBuffer); //brightness_command_topic
break;
case ENTITY_SENSOR:
sprintf(g_hassBuffer, "~/%i/get", index);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer); //state_topic
sprintf(g_hassBuffer, "~/%i/set", index);
cJSON_AddStringToObject(info->root, COMMAND_TOPIC_KEY, g_hassBuffer); //command_topic
break;
case ENTITY_SENSOR:
#ifndef OBK_DISABLE_ALL_DRIVERS
info = hass_init_device_info(type, index, "1", "0");
info = hass_init_device_info(type, index, "1", "0");
//https://developers.home-assistant.io/docs/core/entity/sensor/#available-device-classes
//device_class automatically assigns unit,icon
cJSON_AddStringToObject(info->root, "dev_cla", sensor_mqttNames[index]); //device_class=voltage,current,power
sprintf(g_hassBuffer,"%s/%s/get",clientId,sensor_mqttNames[index]);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer);
//https://developers.home-assistant.io/docs/core/entity/sensor/#available-device-classes
//device_class automatically assigns unit,icon
cJSON_AddStringToObject(info->root, "dev_cla", sensor_mqttNames[index]); //device_class=voltage,current,power
sprintf(g_hassBuffer, "%s/%s/get", clientId, sensor_mqttNames[index]);
cJSON_AddStringToObject(info->root, STATE_TOPIC_KEY, g_hassBuffer);
#endif
break;
break;
default:
addLogAdv(LOG_ERROR, LOG_FEATURE_HASS, "Unsupported light type %s", type);
}
return info;
default:
addLogAdv(LOG_ERROR, LOG_FEATURE_HASS, "Unsupported light type %s", type);
}
return info;
}
/// @brief Returns the discovery JSON.
/// @param info
/// @return
char *hass_build_discovery_json(HassDeviceInfo *info){
cJSON_PrintPreallocated(info->root, info->json, HASS_JSON_SIZE, 0);
return info->json;
char* hass_build_discovery_json(HassDeviceInfo* info) {
cJSON_PrintPreallocated(info->root, info->json, HASS_JSON_SIZE, 0);
return info->json;
}
/// @brief Release allocated memory.
/// @param info
void hass_free_device_info(HassDeviceInfo *info){
if (info == NULL) return;
addLogAdv(LOG_DEBUG, LOG_FEATURE_HASS, "hass_free_device_info \r\n");
if (info->root != NULL){
cJSON_Delete(info->root);
}
void hass_free_device_info(HassDeviceInfo* info) {
if (info == NULL) return;
addLogAdv(LOG_DEBUG, LOG_FEATURE_HASS, "hass_free_device_info \r\n");
os_free(info);
if (info->root != NULL) {
cJSON_Delete(info->root);
}
os_free(info);
}