/* * 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 . */ #ifndef WebCustomizationService_h #define WebCustomizationService_h #define EMSESP_CUSTOMIZATION_FILE "/config/emsespCustomization.json" // GET #define EMSESP_DEVICE_ENTITIES_PATH "/rest/deviceEntities" // POST #define EMSESP_CUSTOMIZATION_ENTITIES_PATH "/rest/customizationEntities" #define EMSESP_RESET_CUSTOMIZATION_SERVICE_PATH "/rest/resetCustomizations" #define EMSESP_WRITE_DEVICE_NAME_PATH "/rest/writeDeviceName" namespace emsesp { // Customization for temperature sensor class SensorCustomization { public: std::string id; std::string name; uint16_t offset; }; class AnalogCustomization { public: uint8_t gpio; std::string name; double offset; double factor; uint8_t uom; // 0 is none int8_t type; // -1 is for deletion // used for removing from a list bool operator==(const AnalogCustomization & a) const { return gpio == a.gpio; } bool operator!=(const AnalogCustomization & a) const { return !operator==(a); } }; // we use product_id and device_id to make the device unique class EntityCustomization { public: uint8_t product_id; // device's product id uint8_t device_id; // device's device id std::string custom_name; // custom device name std::vector entity_ids; // array of entity ids with masks and optional custom fullname }; class WebCustomization { public: std::list sensorCustomizations; // for sensor names and offsets std::list analogCustomizations; // for analog sensors std::list entityCustomizations; // for a list of entities that have a special mask set static void read(WebCustomization & customizations, JsonObject root); static StateUpdateResult update(JsonObject root, WebCustomization & customizations); private: static bool _start; }; class WebCustomizationService : public StatefulService { public: WebCustomizationService(AsyncWebServer * server, FS * fs, SecurityManager * securityManager); void begin(); #if defined(EMSESP_TEST) void test(); #endif // make all functions public so we can test in the debug and standalone mode #ifndef EMSESP_STANDALONE private: #endif FSPersistence _fsPersistence; // GET void device_entities(AsyncWebServerRequest * request); // POST void customization_entities(AsyncWebServerRequest * request, JsonVariant json); void writeDeviceName(AsyncWebServerRequest * request, JsonVariant json); void reset_customization(AsyncWebServerRequest * request); // command }; } // namespace emsesp #endif