andry/EMS-ESP32
1
0
Fork 0
mirror of https://github.com/emsesp/EMS-ESP32.git synced 2025-12-06 15:59:52 +03:00
Code Issues Packages Projects Releases Wiki Activity

#1860 camelCase system/info

Browse Source
This commit is contained in:
proddy
2024-07-25 12:52:22 +02:00
parent 1eb903d228
commit 141fa3c953
2 changed files with 133 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG_LATEST.md
View File

@@ -2,12 +2,12 @@
## [3.7.0] ## [3.7.0]
## **IMPORTANT! BREAKING CHANGES** ## **IMPORTANT! BREAKING CHANGES with 3.6.5**
- new device WATER shows dhw entities from MM100 and SM100 in dhw setting - new device WATER shows dhw entities from MM100 and SM100 in dhw setting
- renamed WWC to DHW, always create DHW nests/topics, remove ww prefix from mqtt names [#1634](https://github.com/emsesp/EMS-ESP32/issues/1634) - renamed WWC to DHW, always create DHW nests/topics, remove ww prefix from mqtt names [#1634](https://github.com/emsesp/EMS-ESP32/issues/1634)
- change temperaturesensor id to underscore - change temperaturesensor id to underscore
- system/info API command has the word 'Info' removed from the object name for each section (E.g. 'Network Info' is now just 'Network') - system/info API command has it's JSON keys and names changed to camelCase
## Added ## Added
@@ -52,3 +52,4 @@
- Include TXT file along with the generated CSV for Device Data export/download - Include TXT file along with the generated CSV for Device Data export/download
- thermostat/remotetemp as command [#1835](https://github.com/emsesp/EMS-ESP32/discussions/1835) - thermostat/remotetemp as command [#1835](https://github.com/emsesp/EMS-ESP32/discussions/1835)
- temperaturesensor id notation with underscore [#1794](https://github.com/emsesp/EMS-ESP32/discussions/1794) - temperaturesensor id notation with underscore [#1794](https://github.com/emsesp/EMS-ESP32/discussions/1794)
- Change key-names in JSON to be compliant and consistent [#1860](https://github.com/emsesp/EMS-ESP32/issues/1860)

228
src/system.cpp
View File

@@ -1358,30 +1358,29 @@ bool System::get_value_info(JsonObject root, const char * command) {
// export status information including the device information // export status information including the device information
// http://ems-esp/api/system/info // http://ems-esp/api/system/info
// TODO camelCase - #1860
bool System::command_info(const char * value, const int8_t id, JsonObject output) { bool System::command_info(const char * value, const int8_t id, JsonObject output) {
JsonObject node; JsonObject node;
// System // System
node = output["System"].to<JsonObject>(); node = output["system"].to<JsonObject>();
node["version"] = EMSESP_APP_VERSION; node["version"] = EMSESP_APP_VERSION;
node["uptime"] = uuid::log::format_timestamp_ms(uuid::get_uptime_ms(), 3); node["uptime"] = uuid::log::format_timestamp_ms(uuid::get_uptime_ms(), 3);
node["uptime (seconds)"] = uuid::get_uptime_sec(); node["uptimeSec"] = uuid::get_uptime_sec();
#ifndef EMSESP_STANDALONE #ifndef EMSESP_STANDALONE
node["platform"] = EMSESP_PLATFORM; node["platform"] = EMSESP_PLATFORM;
node["arduino"] = ARDUINO_VERSION; node["arduino"] = ARDUINO_VERSION;
node["sdk"] = ESP.getSdkVersion(); node["sdk"] = ESP.getSdkVersion();
node["free mem"] = getHeapMem(); node["freMem"] = getHeapMem();
node["max alloc"] = getMaxAllocMem(); node["maxAlloc"] = getMaxAllocMem();
node["free caps"] = heap_caps_get_free_size(MALLOC_CAP_8BIT) / 1024; // includes heap and psram node["freeCaps"] = heap_caps_get_free_size(MALLOC_CAP_8BIT) / 1024; // includes heap and psram
node["used app"] = EMSESP::system_.appUsed(); // kilobytes node["usedApp"] = EMSESP::system_.appUsed(); // kilobytes
node["free app"] = EMSESP::system_.appFree(); // kilobytes node["freeApp"] = EMSESP::system_.appFree(); // kilobytes
node["partition"] = esp_ota_get_running_partition()->label; node["partition"] = esp_ota_get_running_partition()->label;
#endif #endif
node["reset reason"] = EMSESP::system_.reset_reason(0) + " / " + EMSESP::system_.reset_reason(1); node["resetReason"] = EMSESP::system_.reset_reason(0) + " / " + EMSESP::system_.reset_reason(1);
// Network Status // Network Status
node = output["Network"].to<JsonObject>(); node = output["network"].to<JsonObject>();
#ifndef EMSESP_STANDALONE #ifndef EMSESP_STANDALONE
if (EMSESP::system_.ethernet_connected()) { if (EMSESP::system_.ethernet_connected()) {
node["network"] = "Ethernet"; node["network"] = "Ethernet";
@@ -1415,201 +1414,202 @@ bool System::command_info(const char * value, const int8_t id, JsonObject output
if (WiFi.status() == WL_CONNECTED && !settings.bssid.isEmpty()) { if (WiFi.status() == WL_CONNECTED && !settings.bssid.isEmpty()) {
node["BSSID"] = "set"; // we don't disclose the name node["BSSID"] = "set"; // we don't disclose the name
} }
node["TxPower setting"] = settings.tx_power; node["TxPowerSetting"] = settings.tx_power;
node["static ip config"] = settings.staticIPConfig; node["staticIP"] = settings.staticIPConfig;
node["low bandwidth"] = settings.bandwidth20; node["lowBandwidth"] = settings.bandwidth20;
node["disable sleep"] = settings.nosleep; node["disableSleep"] = settings.nosleep;
node["enable MDNS"] = settings.enableMDNS; node["enableMDNS"] = settings.enableMDNS;
node["enable CORS"] = settings.enableCORS; node["enableCORS"] = settings.enableCORS;
if (settings.enableCORS) { if (settings.enableCORS) {
node["CORS origin"] = settings.CORSOrigin; node["CORSOrigin"] = settings.CORSOrigin;
} }
}); });
#ifndef EMSESP_STANDALONE #ifndef EMSESP_STANDALONE
EMSESP::esp8266React.getAPSettingsService()->read([&](APSettings & settings) { EMSESP::esp8266React.getAPSettingsService()->read([&](APSettings & settings) {
const char * pM[] = {"always", "disconnected", "never"}; const char * pM[] = {"always", "disconnected", "never"};
node["AP provision mode"] = pM[settings.provisionMode]; node["APProvisionMode"] = pM[settings.provisionMode];
node["AP security"] = settings.password.length() ? "wpa2" : "open"; node["APSecurity"] = settings.password.length() ? "wpa2" : "open";
node["AP ssid"] = settings.ssid; node["APSSID"] = settings.ssid;
}); });
#endif #endif
// NTP status // NTP status
node = output["NTP"].to<JsonObject>(); node = output["ntp"].to<JsonObject>();
#ifndef EMSESP_STANDALONE #ifndef EMSESP_STANDALONE
node["NTP status"] = EMSESP::system_.ntp_connected() ? "connected" : "disconnected"; node["NTPStatus"] = EMSESP::system_.ntp_connected() ? "connected" : "disconnected";
EMSESP::esp8266React.getNTPSettingsService()->read([&](NTPSettings & settings) { EMSESP::esp8266React.getNTPSettingsService()->read([&](NTPSettings & settings) {
node["enabled"] = settings.enabled; node["enabled"] = settings.enabled;
node["server"] = settings.server; node["server"] = settings.server;
node["tz label"] = settings.tzLabel; node["tzLabel"] = settings.tzLabel;
// node["tz format"] = settings.tzFormat; // node["tz format"] = settings.tzFormat;
}); });
#endif #endif
// MQTT Status // MQTT Status
node = output["MQTT"].to<JsonObject>(); node = output["mqtt"].to<JsonObject>();
node["MQTT status"] = Mqtt::connected() ? F_(connected) : F_(disconnected); node["MQTTStatus"] = Mqtt::connected() ? F_(connected) : F_(disconnected);
if (Mqtt::enabled()) { if (Mqtt::enabled()) {
node["MQTT publishes"] = Mqtt::publish_count(); node["MQTTPublishes"] = Mqtt::publish_count();
node["MQTT queued"] = Mqtt::publish_queued(); node["MQTTQueued"] = Mqtt::publish_queued();
node["MQTT publish fails"] = Mqtt::publish_fails(); node["MQTTPublishFails"] = Mqtt::publish_fails();
node["MQTT connects"] = Mqtt::connect_count(); node["MQTTConnects"] = Mqtt::connect_count();
} }
EMSESP::esp8266React.getMqttSettingsService()->read([&](MqttSettings & settings) { EMSESP::esp8266React.getMqttSettingsService()->read([&](MqttSettings & settings) {
node["enabled"] = settings.enabled; node["enabled"] = settings.enabled;
node["client id"] = settings.clientId; node["clientID"] = settings.clientId;
node["keep alive"] = settings.keepAlive; node["keepAlive"] = settings.keepAlive;
node["clean session"] = settings.cleanSession; node["cleanSession"] = settings.cleanSession;
node["entity format"] = settings.entity_format; node["entityFormat"] = settings.entity_format;
node["base"] = settings.base; node["base"] = settings.base;
node["discovery prefix"] = settings.discovery_prefix; node["discoveryPrefix"] = settings.discovery_prefix;
node["discovery type"] = settings.discovery_type; node["discoveryType"] = settings.discovery_type;
node["nested format"] = settings.nested_format; node["nestedFormat"] = settings.nested_format;
node["ha enabled"] = settings.ha_enabled; node["haEnabled"] = settings.ha_enabled;
node["mqtt qos"] = settings.mqtt_qos; node["mqttQos"] = settings.mqtt_qos;
node["mqtt retain"] = settings.mqtt_retain; node["mqttRetain"] = settings.mqtt_retain;
node["publish time heartbeat"] = settings.publish_time_heartbeat; node["publishTimeHeartbeat"] = settings.publish_time_heartbeat;
node["publish time boiler"] = settings.publish_time_boiler; node["publishTimeBoiler"] = settings.publish_time_boiler;
node["publish time thermostat"] = settings.publish_time_thermostat; node["publishTimeThermostat"] = settings.publish_time_thermostat;
node["publish time solar"] = settings.publish_time_solar; node["publishTimeSolar"] = settings.publish_time_solar;
node["publish time mixer"] = settings.publish_time_mixer; node["publishTimeMixer"] = settings.publish_time_mixer;
node["publish time water"] = settings.publish_time_water; node["publishTimeWater"] = settings.publish_time_water;
node["publish time other"] = settings.publish_time_other; node["publishTimeOther"] = settings.publish_time_other;
node["publish time sensor"] = settings.publish_time_sensor; node["publishTimeSensor"] = settings.publish_time_sensor;
node["publish single"] = settings.publish_single; node["publishSingle"] = settings.publish_single;
node["publish2command"] = settings.publish_single2cmd; node["publish2command"] = settings.publish_single2cmd;
node["send response"] = settings.send_response; node["sendResponse"] = settings.send_response;
}); });
// Syslog Status // Syslog Status
node = output["Syslog"].to<JsonObject>(); node = output["syslog"].to<JsonObject>();
node["enabled"] = EMSESP::system_.syslog_enabled_; node["enabled"] = EMSESP::system_.syslog_enabled_;
#ifndef EMSESP_STANDALONE #ifndef EMSESP_STANDALONE
if (EMSESP::system_.syslog_enabled_) { if (EMSESP::system_.syslog_enabled_) {
node["syslog started"] = syslog_.started(); node["syslogStarted"] = syslog_.started();
node["syslog level"] = FL_(list_syslog_level)[syslog_.log_level() + 1]; node["syslogLevel"] = FL_(list_syslog_level)[syslog_.log_level() + 1];
node["syslog ip"] = syslog_.ip(); node["syslogIP"] = syslog_.ip();
node["syslog queue"] = syslog_.queued(); node["syslogQueue"] = syslog_.queued();
} }
#endif #endif
// Sensor Status // Sensor Status
node = output["Sensor"].to<JsonObject>(); node = output["sensor"].to<JsonObject>();
if (EMSESP::sensor_enabled()) { if (EMSESP::sensor_enabled()) {
node["temperature sensors"] = EMSESP::temperaturesensor_.no_sensors(); node["temperatureSensors"] = EMSESP::temperaturesensor_.no_sensors();
node["temperature sensor reads"] = EMSESP::temperaturesensor_.reads(); node["temperatureSensorReads"] = EMSESP::temperaturesensor_.reads();
node["temperature sensor fails"] = EMSESP::temperaturesensor_.fails(); node["temperatureSensorFails"] = EMSESP::temperaturesensor_.fails();
} }
if (EMSESP::analog_enabled()) { if (EMSESP::analog_enabled()) {
node["analog sensors"] = EMSESP::analogsensor_.no_sensors(); node["analogSensors"] = EMSESP::analogsensor_.no_sensors();
node["analog sensor reads"] = EMSESP::analogsensor_.reads(); node["analogSensorReads"] = EMSESP::analogsensor_.reads();
node["analog sensor fails"] = EMSESP::analogsensor_.fails(); node["analogSensorFails"] = EMSESP::analogsensor_.fails();
} }
// API Status // API Status
node = output["API"].to<JsonObject>(); node = output["api"].to<JsonObject>();
node["API calls"] = WebAPIService::api_count(); node["APICalls"] = WebAPIService::api_count();
node["API fails"] = WebAPIService::api_fails(); node["APIFails"] = WebAPIService::api_fails();
// EMS Bus Status // EMS Bus Status
node = output["Bus"].to<JsonObject>(); node = output["bus"].to<JsonObject>();
switch (EMSESP::bus_status()) { switch (EMSESP::bus_status()) {
case EMSESP::BUS_STATUS_OFFLINE: case EMSESP::BUS_STATUS_OFFLINE:
node["bus status"] = "disconnected"; node["busStatus"] = "disconnected";
break; break;
case EMSESP::BUS_STATUS_TX_ERRORS: case EMSESP::BUS_STATUS_TX_ERRORS:
node["bus status"] = "connected, tx issues - try a different Tx Mode"; node["busStatus"] = "connected, tx issues - try a different Tx Mode";
break; break;
case EMSESP::BUS_STATUS_CONNECTED: case EMSESP::BUS_STATUS_CONNECTED:
node["bus status"] = "connected"; node["busStatus"] = "connected";
break; break;
default: default:
node["bus status"] = "unknown"; node["busStatus"] = "unknown";
break; break;
} }
// if (EMSESP::bus_status() != EMSESP::BUS_STATUS_OFFLINE) { // if (EMSESP::bus_status() != EMSESP::BUS_STATUS_OFFLINE) {
node["bus protocol"] = EMSbus::is_ht3() ? "HT3" : "Buderus"; node["busProtocol"] = EMSbus::is_ht3() ? "HT3" : "Buderus";
node["bus telegrams received (rx)"] = EMSESP::rxservice_.telegram_count(); node["busTelegramsReceived"] = EMSESP::rxservice_.telegram_count();
node["bus reads (tx)"] = EMSESP::txservice_.telegram_read_count(); node["busReads"] = EMSESP::txservice_.telegram_read_count();
node["bus writes (tx)"] = EMSESP::txservice_.telegram_write_count(); node["busWrites"] = EMSESP::txservice_.telegram_write_count();
node["bus incomplete telegrams"] = EMSESP::rxservice_.telegram_error_count(); node["busIncompleteTelegrams"] = EMSESP::rxservice_.telegram_error_count();
node["bus reads failed"] = EMSESP::txservice_.telegram_read_fail_count(); node["busReadsFailed"] = EMSESP::txservice_.telegram_read_fail_count();
node["bus writes failed"] = EMSESP::txservice_.telegram_write_fail_count(); node["busWritesFailed"] = EMSESP::txservice_.telegram_write_fail_count();
node["bus rx line quality"] = EMSESP::rxservice_.quality(); node["busRxLineQuality"] = EMSESP::rxservice_.quality();
node["bus tx line quality"] = (EMSESP::txservice_.read_quality() + EMSESP::txservice_.read_quality()) / 2; node["busTxLineQuality"] = (EMSESP::txservice_.read_quality() + EMSESP::txservice_.read_quality()) / 2;
// } // }
// Settings // Settings
node = output["Settings"].to<JsonObject>(); node = output["settings"].to<JsonObject>();
EMSESP::webSettingsService.read([&](WebSettings & settings) { EMSESP::webSettingsService.read([&](WebSettings & settings) {
node["board profile"] = settings.board_profile; node["boardProfile"] = settings.board_profile;
node["locale"] = settings.locale; node["locale"] = settings.locale;
node["tx mode"] = settings.tx_mode; node["txMode"] = settings.tx_mode;
node["ems bus id"] = settings.ems_bus_id; node["emsBusID"] = settings.ems_bus_id;
node["shower timer"] = settings.shower_timer; node["showerTimer"] = settings.shower_timer;
node["shower min duration"] = settings.shower_min_duration; // seconds node["showerMinDuration"] = settings.shower_min_duration; // seconds
node["shower alert"] = settings.shower_alert; node["showerAlert"] = settings.shower_alert;
if (settings.shower_alert) { if (settings.shower_alert) {
node["shower alert coldshot"] = settings.shower_alert_coldshot; // seconds node["showerAlertColdshot"] = settings.shower_alert_coldshot; // seconds
node["shower alert trigger"] = settings.shower_alert_trigger; // minutes node["showerAlertTrigger"] = settings.shower_alert_trigger; // minutes
} }
if (settings.board_profile == "CUSTOM") { if (settings.board_profile == "CUSTOM") {
node["phy type"] = settings.phy_type; node["phyType"] = settings.phy_type;
if (settings.phy_type != PHY_type::PHY_TYPE_NONE) { if (settings.phy_type != PHY_type::PHY_TYPE_NONE) {
node["eth power"] = settings.eth_power; node["ethPower"] = settings.eth_power;
node["eth phy addr"] = settings.eth_phy_addr; node["ethPhyAddr"] = settings.eth_phy_addr;
node["eth clock_mode"] = settings.eth_clock_mode; node["ethClockMmode"] = settings.eth_clock_mode;
} }
node["rx gpio"] = settings.rx_gpio; node["rxGPIO"] = settings.rx_gpio;
node["tx gpio"] = settings.tx_gpio; node["txGPIO"] = settings.tx_gpio;
node["dallas gpio"] = settings.dallas_gpio; node["dallasGPIO"] = settings.dallas_gpio;
node["pbutton gpio"] = settings.pbutton_gpio; node["pbuttonGPIO"] = settings.pbutton_gpio;
node["led gpio"] = settings.led_gpio; node["ledGPIO"] = settings.led_gpio;
} }
node["hide led"] = settings.hide_led; node["hideLed"] = settings.hide_led;
node["notoken api"] = settings.notoken_api; node["noTokenApi"] = settings.notoken_api;
node["readonly mode"] = settings.readonly_mode; node["readonlyMode"] = settings.readonly_mode;
node["fahrenheit"] = settings.fahrenheit; node["fahrenheit"] = settings.fahrenheit;
node["dallas parasite"] = settings.dallas_parasite; node["dallasParasite"] = settings.dallas_parasite;
node["bool format"] = settings.bool_format; node["boolFormat"] = settings.bool_format;
node["bool dashboard"] = settings.bool_dashboard; node["boolDashboard"] = settings.bool_dashboard;
node["enum format"] = settings.enum_format; node["enumFormat"] = settings.enum_format;
node["analog enabled"] = settings.analog_enabled; node["analogEnabled"] = settings.analog_enabled;
node["telnet enabled"] = settings.telnet_enabled; node["telnetEnabled"] = settings.telnet_enabled;
node["max web log buffer"] = settings.weblog_buffer; node["maxWebLogBuffer"] = settings.weblog_buffer;
node["web log buffer"] = EMSESP::webLogService.num_log_messages(); node["webLogBuffer"] = EMSESP::webLogService.num_log_messages();
node["modbusEnabled"] = settings.modbus_enabled;
}); });
// Devices - show EMS devices if we have any // Devices - show EMS devices if we have any
if (!EMSESP::emsdevices.empty()) { if (!EMSESP::emsdevices.empty()) {
JsonArray devices = output["Devices"].to<JsonArray>(); JsonArray devices = output["devices"].to<JsonArray>();
for (const auto & device_class : EMSFactory::device_handlers()) { for (const auto & device_class : EMSFactory::device_handlers()) {
for (const auto & emsdevice : EMSESP::emsdevices) { for (const auto & emsdevice : EMSESP::emsdevices) {
if (emsdevice && (emsdevice->device_type() == device_class.first)) { if (emsdevice && (emsdevice->device_type() == device_class.first)) {
JsonObject obj = devices.add<JsonObject>(); JsonObject obj = devices.add<JsonObject>();
obj["type"] = emsdevice->device_type_name(); // non translated name obj["type"] = emsdevice->device_type_name(); // non translated name
obj["name"] = emsdevice->name(); // custom name obj["name"] = emsdevice->name(); // custom name
obj["device id"] = Helpers::hextoa(emsdevice->device_id()); obj["deviceID"] = Helpers::hextoa(emsdevice->device_id());
obj["product id"] = emsdevice->product_id(); obj["productID"] = emsdevice->product_id();
obj["brand"] = emsdevice->brand_to_char(); obj["brand"] = emsdevice->brand_to_char();
obj["version"] = emsdevice->version(); obj["version"] = emsdevice->version();
obj["entities"] = emsdevice->count_entities(); obj["entities"] = emsdevice->count_entities();
char result[500]; char result[500];
(void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::RECEIVED); (void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::RECEIVED);
if (result[0] != '\0') { if (result[0] != '\0') {
obj["handlers received"] = result; // don't show handlers if there aren't any obj["handlersReceived"] = result; // don't show handlers if there aren't any
} }
(void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::FETCHED); (void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::FETCHED);
if (result[0] != '\0') { if (result[0] != '\0') {
obj["handlers fetched"] = result; obj["handlersFetched"] = result;
} }
(void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::PENDING); (void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::PENDING);
if (result[0] != '\0') { if (result[0] != '\0') {
obj["handlers pending"] = result; obj["handlersPending"] = result;
} }
(void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::IGNORED); (void)emsdevice->show_telegram_handlers(result, sizeof(result), EMSdevice::Handlers::IGNORED);
if (result[0] != '\0') { if (result[0] != '\0') {
obj["handlers ignored"] = result; obj["handlersIgnored"] = result;
} }
} }
} }