/*
 * EMS-ESP - https://github.com/emsesp/EMS-ESP
 * Copyright 2020-2024  emsesp.org - proddy, MichaelDvP
 *
 * 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/>.
 */

#include "emsesp.h"

namespace emsesp {

WebCustomEntityService::WebCustomEntityService(AsyncWebServer * server, FS * fs, SecurityManager * securityManager)
    : _httpEndpoint(WebCustomEntity::read,
                    WebCustomEntity::update,
                    this,
                    server,
                    EMSESP_CUSTOMENTITY_SERVICE_PATH,
                    securityManager,
                    AuthenticationPredicates::IS_AUTHENTICATED)
    , _fsPersistence(WebCustomEntity::read, WebCustomEntity::update, this, fs, EMSESP_CUSTOMENTITY_FILE) {
}

// load the settings when the service starts
void WebCustomEntityService::begin() {
    _fsPersistence.readFromFS();
    // save a local pointer to the item list
    EMSESP::webCustomEntityService.read([&](WebCustomEntity & webEntity) { customEntityItems_ = &webEntity.customEntityItems; });
    EMSESP::logger().info("Starting Custom Entity service");
    char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
    snprintf(topic, sizeof(topic), "%s/#", F_(custom));
    Mqtt::subscribe(EMSdevice::DeviceType::CUSTOM, topic, nullptr); // use empty function callback
}

// this creates the entity file, saving it to the FS
// and also calls when the Entity web page is refreshed
void WebCustomEntity::read(WebCustomEntity & webEntity, JsonObject root) {
    JsonArray entity  = root["entities"].to<JsonArray>();
    uint8_t   counter = 0;
    for (CustomEntityItem & entityItem : webEntity.customEntityItems) {
        JsonObject ei    = entity.add<JsonObject>();
        ei["id"]         = counter++; // id is only used to render the table and must be unique
        ei["ram"]        = entityItem.ram;
        ei["device_id"]  = entityItem.device_id;
        ei["type_id"]    = entityItem.type_id;
        ei["offset"]     = entityItem.offset;
        ei["factor"]     = entityItem.factor;
        ei["name"]       = entityItem.name;
        ei["uom"]        = entityItem.value_type == DeviceValueType::BOOL ? 0 : entityItem.uom;
        ei["value_type"] = entityItem.value_type;
        ei["writeable"]  = entityItem.writeable;
        ei["hide"]       = entityItem.hide;
        EMSESP::webCustomEntityService.render_value(ei, entityItem, true, true);
    }
}

// call on initialization and also when the Entity web page is updated/saved
// this loads the data into the internal class
StateUpdateResult WebCustomEntity::update(JsonObject root, WebCustomEntity & webCustomEntity) {
    // reset everything to start fresh
    Command::erase_device_commands(EMSdevice::DeviceType::CUSTOM);
    JsonDocument doc;
    for (CustomEntityItem & entityItem : webCustomEntity.customEntityItems) {
        if (entityItem.raw) {
            delete[] entityItem.raw;
        }
        if (entityItem.ram) { // save name/value pairs for change checking
            doc[entityItem.name] = entityItem.value;
        }
    }
    webCustomEntity.customEntityItems.clear();
    EMSESP::webCustomEntityService.ha_reset();

    // rebuild the list
    if (root["entities"].is<JsonArray>()) {
        auto entities = root["entities"].as<JsonArray>();
        for (const JsonObject ei : entities) {
            auto entityItem       = CustomEntityItem();
            entityItem.ram        = ei["ram"];
            entityItem.device_id  = ei["device_id"]; // send as numeric, will be converted to string in web
            entityItem.type_id    = ei["type_id"];
            entityItem.offset     = ei["offset"];
            entityItem.factor     = ei["factor"];
            entityItem.name       = ei["name"].as<std::string>();
            entityItem.uom        = ei["uom"];
            entityItem.value_type = ei["value_type"];
            entityItem.writeable  = ei["writeable"];
            entityItem.hide       = ei["hide"] | false;
            entityItem.data       = ei["value"].as<std::string>();
            if (entityItem.ram == 1) {
                entityItem.device_id  = 0;
                entityItem.type_id    = 0;
                entityItem.value_type = DeviceValueType::STRING;
                entityItem.writeable  = true;
            }
            entityItem.raw = nullptr;
            if (entityItem.ram == 0 && entityItem.value_type == DeviceValueType::STRING) {
                entityItem.raw  = new uint8_t[(size_t)entityItem.factor + 1];
                entityItem.data = "";
                entityItem.uom  = 0;
            } else if (entityItem.value_type == DeviceValueType::BOOL) {
                entityItem.value = EMS_VALUE_DEFAULT_BOOL;
                entityItem.uom   = 0;
            } else if (entityItem.value_type == DeviceValueType::INT8) {
                entityItem.value = EMS_VALUE_DEFAULT_INT8;
            } else if (entityItem.value_type == DeviceValueType::UINT8) {
                entityItem.value = EMS_VALUE_DEFAULT_UINT8;
            } else if (entityItem.value_type == DeviceValueType::INT16) {
                entityItem.value = EMS_VALUE_DEFAULT_INT16;
            } else if (entityItem.value_type == DeviceValueType::UINT16) {
                entityItem.value = EMS_VALUE_DEFAULT_UINT16;
            } else if (entityItem.value_type == DeviceValueType::UINT24 || entityItem.value_type == DeviceValueType::TIME
                       || entityItem.value_type == DeviceValueType::UINT32) {
                entityItem.value = EMS_VALUE_DEFAULT_UINT24;
            }

            if (entityItem.factor == 0) {
                entityItem.factor = 1;
            }

            webCustomEntity.customEntityItems.push_back(entityItem); // add to list

            if (entityItem.writeable && !entityItem.name.empty()) {
                Command::add(
                    EMSdevice::DeviceType::CUSTOM,
                    webCustomEntity.customEntityItems.back().name.c_str(),
                    [webCustomEntity](const char * value, const int8_t id) {
                        return EMSESP::webCustomEntityService.command_setvalue(value, id, webCustomEntity.customEntityItems.back().name.c_str());
                    },
                    FL_(entity_cmd),
                    CommandFlag::ADMIN_ONLY);
            }

            if (entityItem.ram && doc[entityItem.name].is<JsonVariantConst>() && doc[entityItem.name] != entityItem.value) {
                char cmd[COMMAND_MAX_LENGTH];
                snprintf(cmd, sizeof(cmd), "%s/%s", F_(custom), entityItem.name.c_str());
                EMSESP::webSchedulerService.onChange(cmd);
            }
        }
    }
    return StateUpdateResult::CHANGED;
}

// set value by api command
bool WebCustomEntityService::command_setvalue(const char * value, const int8_t id, const char * name) {
    for (CustomEntityItem & entityItem : *customEntityItems_) {
        if (Helpers::toLower(entityItem.name) == Helpers::toLower(name)) {
            if (entityItem.ram == 1) {
                entityItem.data = value;
            } else if (entityItem.value_type == DeviceValueType::STRING) {
                auto      telegram = strdup(value);
                uint8_t   length   = strlen(telegram) / 3 + 1;
                uint8_t * data     = new uint8_t[length];
                uint8_t   count    = 0;
                char *    p        = strtok(telegram, " ,"); // delimiter
                while (p != nullptr && count < length) {
                    data[count++] = (uint8_t)strtol(p, 0, 16);
                    p             = strtok(nullptr, " ,");
                }
                free(telegram);
                uint8_t   offset = entityItem.offset;
                uint8_t * dat    = data;
                while (count > 0) {
                    uint8_t len = std::min((int)count, 25);
                    EMSESP::send_write_request(entityItem.type_id, entityItem.device_id, offset, dat, len, 0);
                    offset += len;
                    count -= len;
                    dat += len;
                }
                delete[] data;
                return true;
            } else if (entityItem.value_type == DeviceValueType::BOOL) {
                bool v;
                if (!Helpers::value2bool(value, v)) {
                    return false;
                }
                EMSESP::send_write_request(entityItem.type_id, entityItem.device_id, entityItem.offset, v ? (uint8_t)entityItem.factor : 0, 0);
            } else {
                float f;
                if (!Helpers::value2float(value, f)) {
                    return false;
                }
                int v = f / entityItem.factor;
                if (entityItem.value_type == DeviceValueType::UINT8 || entityItem.value_type == DeviceValueType::INT8) {
                    EMSESP::send_write_request(entityItem.type_id, entityItem.device_id, entityItem.offset, v, 0);
                } else if (entityItem.value_type == DeviceValueType::UINT16 || entityItem.value_type == DeviceValueType::INT16) {
                    uint8_t v1[2] = {(uint8_t)(v >> 8), (uint8_t)(v & 0xFF)};
                    EMSESP::send_write_request(entityItem.type_id, entityItem.device_id, entityItem.offset, v1, 2, 0);
                } else {
                    uint8_t v1[3] = {(uint8_t)(v >> 16), (uint8_t)((v & 0xFF00) >> 8), (uint8_t)(v & 0xFF)};
                    EMSESP::send_write_request(entityItem.type_id, entityItem.device_id, entityItem.offset, v1, 3, 0);
                }
            }

            publish_single(entityItem);
            if (EMSESP::mqtt_.get_publish_onchange(0)) {
                publish();
            }
            char cmd[COMMAND_MAX_LENGTH];
            snprintf(cmd, sizeof(cmd), "%s/%s", F_(custom), entityItem.name.c_str());
            EMSESP::webSchedulerService.onChange(cmd);
            return true;
        }
    }
    return false;
}

// output of a single value
// if add_uom is true it will add the UOM string to the value
void WebCustomEntityService::render_value(JsonObject output, CustomEntityItem & entity, const bool useVal, const bool web, const bool add_uom) {
    char        payload[20];
    std::string name = useVal ? "value" : entity.name;
    switch (entity.value_type) {
    case DeviceValueType::BOOL:
        if ((uint8_t)entity.value != EMS_VALUE_BOOL_NOTSET) {
            if (web) {
                output[name] = Helpers::render_boolean(payload, (uint8_t)entity.value, true);
            } else if (EMSESP::system_.bool_format() == BOOL_FORMAT_TRUEFALSE) {
                output[name] = (uint8_t)entity.value ? true : false;
            } else if (EMSESP::system_.bool_format() == BOOL_FORMAT_10) {
                output[name] = (uint8_t)entity.value ? 1 : 0;
            } else {
                output[name] = Helpers::render_boolean(payload, (uint8_t)entity.value);
            }
        }
        break;
    case DeviceValueType::INT8:
        if ((int8_t)entity.value != EMS_VALUE_INT8_NOTSET) {
            std::string v = Helpers::render_value(payload, entity.factor * (int8_t)entity.value, 2);
            output[name]  = add_uom ? serialized(v + ' ' + EMSdevice::uom_to_string(entity.uom)) : serialized(v);
        }
        break;
    case DeviceValueType::UINT8:
        if ((uint8_t)entity.value != EMS_VALUE_UINT8_NOTSET) {
            std::string v = Helpers::render_value(payload, entity.factor * (uint8_t)entity.value, 2);
            output[name]  = add_uom ? serialized(v + ' ' + EMSdevice::uom_to_string(entity.uom)) : serialized(v);
        }
        break;
    case DeviceValueType::INT16:
        if ((int16_t)entity.value != EMS_VALUE_INT16_NOTSET) {
            std::string v = Helpers::render_value(payload, entity.factor * (int16_t)entity.value, 2);
            output[name]  = add_uom ? serialized(v + ' ' + EMSdevice::uom_to_string(entity.uom)) : serialized(v);
        }
        break;
    case DeviceValueType::UINT16:
        if ((uint16_t)entity.value != EMS_VALUE_UINT16_NOTSET) {
            std::string v = Helpers::render_value(payload, entity.factor * (uint16_t)entity.value, 2);
            output[name]  = add_uom ? serialized(v + ' ' + EMSdevice::uom_to_string(entity.uom)) : serialized(v);
        }
        break;
    case DeviceValueType::UINT24:
    case DeviceValueType::TIME:
    case DeviceValueType::UINT32:
        if (entity.value != EMS_VALUE_UINT24_NOTSET) {
            std::string v = Helpers::render_value(payload, entity.factor * entity.value, 2);
            output[name]  = add_uom ? serialized(v + ' ' + EMSdevice::uom_to_string(entity.uom)) : serialized(v);
        }
        break;
    // case DeviceValueType::STRING:
    default:
        // if no type treat it as a string
        if (entity.data.length() > 0) {
            output[name] = add_uom ? entity.data + ' ' + EMSdevice::uom_to_string(entity.uom) : entity.data;
        }
        break;
    }
}

// display all custom entities
// adding each one, with UOM to a json object string
void WebCustomEntityService::show_values(JsonObject output) {
    for (CustomEntityItem & entity : *customEntityItems_) {
        render_value(output, entity, false, false, true); // with add_uom
    }
}

// process json output for info/commands and value_info
bool WebCustomEntityService::get_value_info(JsonObject output, const char * cmd) {
    // if no custom entries, return empty json
    // even if we're looking for a specific entity
    // https://github.com/emsesp/EMS-ESP32/issues/1297
    if (customEntityItems_->empty()) {
        return true;
    }

    // if it's info or values...
    if (!strlen(cmd) || !strcmp(cmd, F_(values)) || !strcmp(cmd, F_(info))) {
        // list all names
        for (CustomEntityItem & entity : *customEntityItems_) {
            if (!entity.hide) {
                render_value(output, entity);
            }
        }
        return true;
    }

    // list all entities
    if (!strcmp(cmd, F_(entities))) {
        for (auto & entity : *customEntityItems_) {
            auto nest = output[entity.name].to<JsonObject>();
            get_value_json(nest, entity);
        }
        return true;
    }

    // specific value info
    const char * attribute_s = Command::get_attribute(cmd);
    for (auto & entity : *customEntityItems_) {
        if (Helpers::toLower(entity.name) == cmd) {
            get_value_json(output, entity);
            return Command::set_attribute(output, cmd, attribute_s);
        }
    }
    return false; // not found
}

// build the json for specific entity
void WebCustomEntityService::get_value_json(JsonObject output, CustomEntityItem & entity) {
    output["name"]     = entity.name;
    output["fullname"] = entity.name;
    output["storage"]  = entity.ram ? "ram" : "ems";
    output["type"]     = entity.value_type == DeviceValueType::BOOL ? "boolean" : entity.value_type == DeviceValueType::STRING ? "string" : F_(number);
    // add uom state class and device class
    Mqtt::add_ha_uom(output, entity.value_type, entity.uom, nullptr, false);
    output["readable"]  = true;
    output["writeable"] = entity.writeable;
    output["visible"]   = true;
    if (entity.ram == 0) {
        output["device_id"] = Helpers::hextoa(entity.device_id);
        output["type_id"]   = Helpers::hextoa(entity.type_id);
        output["offset"]    = entity.offset;
        if (entity.value_type != DeviceValueType::BOOL && entity.value_type != DeviceValueType::STRING) {
            output["factor"] = entity.factor;
        } else if (entity.value_type == DeviceValueType::STRING) {
            output["bytes"] = (uint8_t)entity.factor;
        }
    }
    render_value(output, entity, true); // create the "value" field
}

// publish single value
void WebCustomEntityService::publish_single(CustomEntityItem & entity) {
    if (!Mqtt::enabled() || !Mqtt::publish_single() || entity.hide) {
        return;
    }

    char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
    if (Mqtt::publish_single2cmd()) {
        snprintf(topic, sizeof(topic), "%s/%s", F_(custom), entity.name.c_str());
    } else {
        snprintf(topic, sizeof(topic), "%s_data/%s", F_(custom), entity.name.c_str());
    }

    JsonDocument doc;
    JsonObject   output = doc.to<JsonObject>();
    render_value(output, entity, true);
    Mqtt::queue_publish(topic, output["value"].as<std::string>());
}

// publish to Mqtt
void WebCustomEntityService::publish(const bool force) {
    if (force) {
        ha_registered_ = false;
    }

    if (!Mqtt::enabled()) {
        return;
    }

    if (customEntityItems_->empty()) {
        return;
    }
    if (Mqtt::publish_single() && force) {
        for (CustomEntityItem & entityItem : *customEntityItems_) {
            publish_single(entityItem);
        }
    }

    JsonDocument doc;
    JsonObject   output     = doc.to<JsonObject>();
    bool         ha_created = ha_registered_;

    for (CustomEntityItem & entityItem : *customEntityItems_) {
        if (entityItem.hide) {
            continue;
        }
        render_value(output, entityItem);
        // create HA config
        if (Mqtt::ha_enabled() && !ha_registered_) {
            JsonDocument config;
            char         stat_t[50];
            snprintf(stat_t, sizeof(stat_t), "%s/%s_data", Mqtt::base().c_str(), F_(custom));
            config["stat_t"] = stat_t;

            char val_obj[50];
            char val_cond[65];
            snprintf(val_obj, sizeof(val_obj), "value_json['%s']", entityItem.name.c_str());
            snprintf(val_cond, sizeof(val_cond), "%s is defined", val_obj);
            // don't bother with value template conditions if using Domoticz which doesn't fully support MQTT Discovery
            if (Mqtt::discovery_type() == Mqtt::discoveryType::HOMEASSISTANT) {
                config["val_tpl"] = (std::string) "{{" + val_obj + " if " + val_cond + "}}";
            } else {
                config["val_tpl"] = (std::string) "{{" + val_obj + "}}";
            }

            char uniq_s[70];
            snprintf(uniq_s, sizeof(uniq_s), "%s_%s", F_(custom), entityItem.name.c_str());

            config["obj_id"]  = uniq_s;
            config["uniq_id"] = uniq_s; // same as object_id
            config["name"]    = entityItem.name.c_str();

            char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];

            if (entityItem.writeable) {
                if (entityItem.value_type == DeviceValueType::BOOL) {
                    snprintf(topic, sizeof(topic), "switch/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                } else if (entityItem.value_type == DeviceValueType::STRING) {
                    snprintf(topic, sizeof(topic), "sensor/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                } else if (Mqtt::discovery_type() == Mqtt::discoveryType::HOMEASSISTANT || Mqtt::discovery_type() == Mqtt::discoveryType::DOMOTICZ_LATEST) {
                    snprintf(topic, sizeof(topic), "number/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                } else {
                    snprintf(topic, sizeof(topic), "sensor/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                }
                char command_topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
                snprintf(command_topic, sizeof(command_topic), "%s/%s/%s", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                config["cmd_t"] = command_topic;
            } else {
                if (entityItem.value_type == DeviceValueType::BOOL) {
                    snprintf(topic, sizeof(topic), "binary_sensor/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                } else {
                    snprintf(topic, sizeof(topic), "sensor/%s/%s_%s/config", Mqtt::basename().c_str(), F_(custom), entityItem.name.c_str());
                }
            }

            if (entityItem.value_type == DeviceValueType::BOOL) {
                // applies to both Binary Sensor (read only) and a Switch (for a command)
                Mqtt::add_ha_bool(config);
            }

            Mqtt::add_ha_uom(config.as<JsonObject>(), entityItem.value_type, entityItem.uom); // add uom

            Mqtt::add_ha_sections_to_doc(F_(custom), stat_t, config, !ha_created, val_cond);

            ha_created |= Mqtt::queue_ha(topic, config.as<JsonObject>());
        }
    }

    ha_registered_ = ha_created;
    if (output.size() > 0) {
        char topic[Mqtt::MQTT_TOPIC_MAX_SIZE];
        snprintf(topic, sizeof(topic), "%s_data", F_(custom));
        Mqtt::queue_publish(topic, output);
    }
    // EMSESP::logger().debug("publish %d custom entities", output.size());
}

// count only entities with valid value or command to show in dashboard
uint8_t WebCustomEntityService::count_entities() {
    if (customEntityItems_->empty()) {
        return 0;
    }

    JsonDocument doc;
    JsonObject   output = doc.to<JsonObject>();
    uint8_t      count  = 0;

    for (CustomEntityItem & entity : *customEntityItems_) {
        render_value(output, entity);
        if (!entity.hide && (output[entity.name].is<JsonVariantConst>() || entity.writeable)) {
            count++;
        }
    }

    return count;
}

// send to dashboard, msgpack don't like serialized, use number
void WebCustomEntityService::generate_value_web(JsonObject output, const bool is_dashboard) {
    JsonArray nodes = output["nodes"].to<JsonArray>();
    uint8_t   index = 0;

    for (const CustomEntityItem & entity : *customEntityItems_) {
        if (entity.hide) {
            continue;
        }
        bool       include  = false;
        JsonObject root_obj = nodes.add<JsonObject>(); // create the object, we know there is a value

        JsonObject obj;
        if (is_dashboard) {
            root_obj["id"] = (EMSdevice::DeviceTypeUniqueID::CUSTOM_UID * 100) + index; // make unique
            obj            = root_obj["dv"].to<JsonObject>();
        } else {
            obj = root_obj;
        }

        obj["id"] = "00" + entity.name;
        if (entity.value_type != DeviceValueType::BOOL) {
            obj["u"] = entity.uom;
        }

        if (entity.writeable) {
            obj["c"] = entity.name;
            include  = true;
            if (entity.value_type != DeviceValueType::BOOL && entity.value_type != DeviceValueType::STRING) {
                char s[20];
                obj["s"] = Helpers::render_value(s, entity.factor, 1);
            }
        }

        switch (entity.value_type) {
        case DeviceValueType::BOOL: {
            char s[12];
            obj["v"] = Helpers::render_boolean(s, (uint8_t)entity.value, true);
            include  = true;

            JsonArray l = obj["l"].to<JsonArray>();
            l.add(Helpers::render_boolean(s, false, true));
            l.add(Helpers::render_boolean(s, true, true));
            break;
        }
        case DeviceValueType::INT8:
            if ((int8_t)entity.value != EMS_VALUE_INT8_NOTSET) {
                obj["v"] = Helpers::transformNumFloat(entity.factor * (int8_t)entity.value);
                include  = true;
            }
            break;
        case DeviceValueType::UINT8:
            if ((uint8_t)entity.value != EMS_VALUE_UINT8_NOTSET) {
                obj["v"] = Helpers::transformNumFloat(entity.factor * (uint8_t)entity.value);
                include  = true;
            }
            break;
        case DeviceValueType::INT16:
            if ((int16_t)entity.value != EMS_VALUE_INT16_NOTSET) {
                obj["v"] = Helpers::transformNumFloat(entity.factor * (int16_t)entity.value);
                include  = true;
            }
            break;
        case DeviceValueType::UINT16:
            if ((uint16_t)entity.value != EMS_VALUE_UINT16_NOTSET) {
                obj["v"] = Helpers::transformNumFloat(entity.factor * (uint16_t)entity.value);
                include  = true;
            }
            break;
        case DeviceValueType::UINT24:
        case DeviceValueType::TIME:
        case DeviceValueType::UINT32:
            if (entity.value != EMS_VALUE_UINT24_NOTSET) {
                obj["v"] = Helpers::transformNumFloat(entity.factor * entity.value);
                include  = true;
            }
            break;
        case DeviceValueType::STRING:
            if (entity.data.length() > 0) {
                obj["v"] = entity.data;
                include  = true;
            }
            break;
        default:
            break;
        }

        // show only entities with value or command
        if (include) {
            index++;
        } else {
            nodes.remove(index);
        }
    }
}

// fetch telegram, called from emsesp::fetch
void WebCustomEntityService::fetch() {
    const uint8_t len[] = {1, 1, 1, 2, 2, 3, 3, 4};

    for (auto const & entity : *customEntityItems_) {
        if (entity.device_id > 0 && entity.type_id > 0) { // this excludes also RAM type
            bool    needFetch  = true;
            uint8_t fetchblock = entity.type_id > 0x0FF ? 25 : 27;
            uint8_t start      = entity.offset % fetchblock;
            uint8_t stop       = (entity.offset + len[entity.value_type]) % fetchblock;
            bool    is_fetched = start < fetchblock && stop < fetchblock; // make sure the complete value is a a fetched block
            for (const auto & emsdevice : EMSESP::emsdevices) {
                if (emsdevice->is_device_id(entity.device_id) && emsdevice->is_fetch(entity.type_id)
                    && (is_fetched || entity.value_type == DeviceValueType::STRING)) {
                    needFetch = false;
                    break;
                }
            }
            if (needFetch) {
                EMSESP::send_read_request(entity.type_id,
                                          entity.device_id,
                                          entity.offset,
                                          entity.value_type == DeviceValueType::STRING ? (uint8_t)entity.factor : len[entity.value_type]);
            }
        }
    }
}

// called on process telegram, read from telegram
bool WebCustomEntityService::get_value(std::shared_ptr<const Telegram> telegram) {
    bool has_change = false;
    // read-length of BOOL, INT8, UINT8, INT16, UINT16, UINT24, TIME, UINT32
    const uint8_t len[] = {1, 1, 1, 2, 2, 3, 3, 4};
    for (auto & entity : *customEntityItems_) {
        if (entity.value_type == DeviceValueType::STRING && entity.raw && telegram->type_id == entity.type_id && telegram->src == entity.device_id
            && (telegram->offset >= entity.offset || entity.offset < telegram->offset + telegram->message_length)) {
            auto message_length = telegram->message_length;
            auto message_data   = telegram->message_data;
            auto offset         = telegram->offset - entity.offset;
            if (telegram->offset < entity.offset) {
                message_data = &telegram->message_data[entity.offset - telegram->offset];
                message_length -= entity.offset - telegram->offset;
                offset = 0;
            }
            auto length = std::min(offset + message_length, (int)entity.factor);
            auto rest   = std::min((int)entity.factor - offset, (int)message_length);
            if (rest > 0) {
                memcpy(&entity.raw[offset], message_data, rest);
                auto data = Helpers::data_to_hex(entity.raw, (uint8_t)length);
                if (entity.data != data && length == (int)entity.factor) {
                    entity.data = data;
                    if (Mqtt::publish_single()) {
                        publish_single(entity);
                    } else if (EMSESP::mqtt_.get_publish_onchange(0)) {
                        has_change = true;
                    }
                    char cmd[COMMAND_MAX_LENGTH];
                    snprintf(cmd, sizeof(cmd), "%s/%s", F_(custom), entity.name.c_str());
                    EMSESP::webSchedulerService.onChange(cmd);
                }
            }
        } else if (entity.value_type != DeviceValueType::STRING && telegram->type_id == entity.type_id && telegram->src == entity.device_id
                   && telegram->offset <= entity.offset && (telegram->offset + telegram->message_length) >= (entity.offset + len[entity.value_type])) {
            uint32_t value = 0;
            for (uint8_t i = 0; i < len[entity.value_type]; i++) {
                value = (value << 8) + telegram->message_data[i + entity.offset - telegram->offset];
            }
            // mask bits for bool values
            if (entity.value_type == DeviceValueType::BOOL && entity.factor > 0) {
                value = (value & (uint8_t)entity.factor) ? 1 : 0;
            }
            if (value != entity.value) {
                entity.value = value;
                if (Mqtt::publish_single()) {
                    publish_single(entity);
                } else if (EMSESP::mqtt_.get_publish_onchange(0)) {
                    has_change = true;
                }
                char cmd[COMMAND_MAX_LENGTH];
                snprintf(cmd, sizeof(cmd), "%s/%s", F_(custom), entity.name.c_str());
                EMSESP::webSchedulerService.onChange(cmd);
            }
            // EMSESP::logger().debug("custom entity %s received with value %d", entity.name.c_str(), (int)entity.val);
        }
    }

    if (has_change) {
        publish();
        return true;
    }

    return false;
}

// hard coded tests
// add the entity and also add the command for writeable entities
#ifdef EMSESP_TEST
void WebCustomEntityService::test() {
    update([&](WebCustomEntity & webCustomEntity) {
        webCustomEntity.customEntityItems.clear();
        auto entityItem = CustomEntityItem();

        // test 1
        entityItem.id         = 1;
        entityItem.ram        = 0;
        entityItem.device_id  = 8;
        entityItem.type_id    = 24;
        entityItem.offset     = 0;
        entityItem.factor     = 1;
        entityItem.name       = "test_custom";
        entityItem.uom        = 1;
        entityItem.value_type = 1;
        entityItem.writeable  = true;
        entityItem.data       = "70";
        webCustomEntity.customEntityItems.push_back(entityItem);
        Command::add(
            EMSdevice::DeviceType::CUSTOM,
            webCustomEntity.customEntityItems.back().name.c_str(),
            [webCustomEntity](const char * value, const int8_t id) {
                return EMSESP::webCustomEntityService.command_setvalue(value, id, webCustomEntity.customEntityItems.back().name.c_str());
            },
            FL_(entity_cmd),
            CommandFlag::ADMIN_ONLY);

        // test 2
        entityItem.id         = 2;
        entityItem.ram        = 0;
        entityItem.device_id  = 24;
        entityItem.type_id    = 677;
        entityItem.offset     = 3;
        entityItem.factor     = 1;
        entityItem.name       = "test_read_only";
        entityItem.uom        = 0;
        entityItem.value_type = 2;
        entityItem.writeable  = false;
        entityItem.data       = "48";
        webCustomEntity.customEntityItems.push_back(entityItem);

        // test 3
        entityItem.id         = 3;
        entityItem.ram        = 1;
        entityItem.device_id  = 0;
        entityItem.type_id    = 0;
        entityItem.offset     = 0;
        entityItem.factor     = 1;
        entityItem.name       = "test_ram";
        entityItem.uom        = 0;
        entityItem.value_type = 8;
        entityItem.writeable  = true;
        entityItem.data       = "14";
        webCustomEntity.customEntityItems.push_back(entityItem);
        Command::add(
            EMSdevice::DeviceType::CUSTOM,
            webCustomEntity.customEntityItems.back().name.c_str(),
            [webCustomEntity](const char * value, const int8_t id) {
                return EMSESP::webCustomEntityService.command_setvalue(value, id, webCustomEntity.customEntityItems.back().name.c_str());
            },
            FL_(entity_cmd),
            CommandFlag::ADMIN_ONLY);

        // test 4
        entityItem.id         = 4;
        entityItem.ram        = 1;
        entityItem.device_id  = 0;
        entityItem.type_id    = 0;
        entityItem.offset     = 0;
        entityItem.factor     = 1;
        entityItem.name       = "seltemp";
        entityItem.uom        = 0;
        entityItem.value_type = 8;
        entityItem.writeable  = true;
        entityItem.data       = "14";
        entityItem.value      = 12;
        webCustomEntity.customEntityItems.push_back(entityItem);
        Command::add(
            EMSdevice::DeviceType::CUSTOM,
            webCustomEntity.customEntityItems.back().name.c_str(),
            [webCustomEntity](const char * value, const int8_t id) {
                return EMSESP::webCustomEntityService.command_setvalue(value, id, webCustomEntity.customEntityItems.back().name.c_str());
            },
            FL_(entity_cmd),
            CommandFlag::ADMIN_ONLY);

        return StateUpdateResult::CHANGED; // persist the changes
    });
}
#endif

} // namespace emsesp