Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

510 lines
16 KiB

6 years ago
6 years ago
6 years ago
  1. /*
  2. UTILS MODULE
  3. Copyright (C) 2017-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. */
  5. #include <Ticker.h>
  6. Ticker _defer_reset;
  7. String getIdentifier() {
  8. char buffer[20];
  9. snprintf_P(buffer, sizeof(buffer), PSTR("%s_%06X"), APP_NAME, ESP.getChipId());
  10. return String(buffer);
  11. }
  12. void setBoardName() {
  13. #ifndef ESPURNA_CORE
  14. setSetting("boardName", DEVICE_NAME);
  15. #endif
  16. }
  17. String getBoardName() {
  18. return getSetting("boardName", DEVICE_NAME);
  19. }
  20. String getCoreVersion() {
  21. String version = ESP.getCoreVersion();
  22. #ifdef ARDUINO_ESP8266_RELEASE
  23. if (version.equals("00000000")) {
  24. version = String(ARDUINO_ESP8266_RELEASE);
  25. }
  26. #endif
  27. return version;
  28. }
  29. String getCoreRevision() {
  30. #ifdef ARDUINO_ESP8266_GIT_VER
  31. return String(ARDUINO_ESP8266_GIT_VER);
  32. #else
  33. return String("");
  34. #endif
  35. }
  36. // WTF
  37. // Calling ESP.getFreeHeap() is making the system crash on a specific
  38. // AiLight bulb, but anywhere else...
  39. unsigned int getFreeHeap() {
  40. if (getSetting("wtfHeap", 0).toInt() == 1) return 9999;
  41. return ESP.getFreeHeap();
  42. }
  43. String buildTime() {
  44. const char time_now[] = __TIME__; // hh:mm:ss
  45. unsigned int hour = atoi(&time_now[0]);
  46. unsigned int minute = atoi(&time_now[3]);
  47. unsigned int second = atoi(&time_now[6]);
  48. const char date_now[] = __DATE__; // Mmm dd yyyy
  49. const char *months[] = {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
  50. unsigned int month = 0;
  51. for ( int i = 0; i < 12; i++ ) {
  52. if (strncmp(date_now, months[i], 3) == 0 ) {
  53. month = i + 1;
  54. break;
  55. }
  56. }
  57. unsigned int day = atoi(&date_now[3]);
  58. unsigned int year = atoi(&date_now[7]);
  59. char buffer[20];
  60. snprintf_P(
  61. buffer, sizeof(buffer), PSTR("%04d-%02d-%02d %02d:%02d:%02d"),
  62. year, month, day, hour, minute, second
  63. );
  64. return String(buffer);
  65. }
  66. unsigned long getUptime() {
  67. static unsigned long last_uptime = 0;
  68. static unsigned char uptime_overflows = 0;
  69. if (millis() < last_uptime) ++uptime_overflows;
  70. last_uptime = millis();
  71. unsigned long uptime_seconds = uptime_overflows * (UPTIME_OVERFLOW / 1000) + (last_uptime / 1000);
  72. return uptime_seconds;
  73. }
  74. #if HEARTBEAT_ENABLED
  75. void heartbeat() {
  76. unsigned long uptime_seconds = getUptime();
  77. unsigned int free_heap = getFreeHeap();
  78. #if MQTT_SUPPORT
  79. bool serial = !mqttConnected();
  80. #else
  81. bool serial = true;
  82. #endif
  83. // -------------------------------------------------------------------------
  84. // Serial
  85. // -------------------------------------------------------------------------
  86. if (serial) {
  87. DEBUG_MSG_P(PSTR("[MAIN] Uptime: %lu seconds\n"), uptime_seconds);
  88. DEBUG_MSG_P(PSTR("[MAIN] Free heap: %lu bytes\n"), free_heap);
  89. #if ADC_VCC_ENABLED
  90. DEBUG_MSG_P(PSTR("[MAIN] Power: %lu mV\n"), ESP.getVcc());
  91. #endif
  92. #if NTP_SUPPORT
  93. if (ntpSynced()) DEBUG_MSG_P(PSTR("[MAIN] Time: %s\n"), (char *) ntpDateTime().c_str());
  94. #endif
  95. }
  96. // -------------------------------------------------------------------------
  97. // MQTT
  98. // -------------------------------------------------------------------------
  99. #if MQTT_SUPPORT
  100. if (!serial) {
  101. #if (HEARTBEAT_REPORT_INTERVAL)
  102. mqttSend(MQTT_TOPIC_INTERVAL, HEARTBEAT_INTERVAL / 1000);
  103. #endif
  104. #if (HEARTBEAT_REPORT_APP)
  105. mqttSend(MQTT_TOPIC_APP, APP_NAME);
  106. #endif
  107. #if (HEARTBEAT_REPORT_VERSION)
  108. mqttSend(MQTT_TOPIC_VERSION, APP_VERSION);
  109. #endif
  110. #if (HEARTBEAT_REPORT_HOSTNAME)
  111. mqttSend(MQTT_TOPIC_HOSTNAME, getSetting("hostname").c_str());
  112. #endif
  113. #if (HEARTBEAT_REPORT_IP)
  114. mqttSend(MQTT_TOPIC_IP, getIP().c_str());
  115. #endif
  116. #if (HEARTBEAT_REPORT_MAC)
  117. mqttSend(MQTT_TOPIC_MAC, WiFi.macAddress().c_str());
  118. #endif
  119. #if (HEARTBEAT_REPORT_RSSI)
  120. mqttSend(MQTT_TOPIC_RSSI, String(WiFi.RSSI()).c_str());
  121. #endif
  122. #if (HEARTBEAT_REPORT_UPTIME)
  123. mqttSend(MQTT_TOPIC_UPTIME, String(uptime_seconds).c_str());
  124. #endif
  125. #if (HEARTBEAT_REPORT_DATETIME) && (NTP_SUPPORT)
  126. if (ntpSynced()) mqttSend(MQTT_TOPIC_DATETIME, ntpDateTime().c_str());
  127. #endif
  128. #if (HEARTBEAT_REPORT_FREEHEAP)
  129. mqttSend(MQTT_TOPIC_FREEHEAP, String(free_heap).c_str());
  130. #endif
  131. #if (HEARTBEAT_REPORT_RELAY)
  132. relayMQTT();
  133. #endif
  134. #if (LIGHT_PROVIDER != LIGHT_PROVIDER_NONE) & (HEARTBEAT_REPORT_LIGHT)
  135. lightMQTT();
  136. #endif
  137. #if (HEARTBEAT_REPORT_VCC)
  138. #if ADC_VCC_ENABLED
  139. mqttSend(MQTT_TOPIC_VCC, String(ESP.getVcc()).c_str());
  140. #endif
  141. #endif
  142. #if (HEARTBEAT_REPORT_STATUS)
  143. mqttSend(MQTT_TOPIC_STATUS, MQTT_STATUS_ONLINE, true);
  144. #endif
  145. }
  146. #endif
  147. // -------------------------------------------------------------------------
  148. // InfluxDB
  149. // -------------------------------------------------------------------------
  150. #if INFLUXDB_SUPPORT
  151. #if (HEARTBEAT_REPORT_UPTIME)
  152. idbSend(MQTT_TOPIC_UPTIME, String(uptime_seconds).c_str());
  153. #endif
  154. #if (HEARTBEAT_REPORT_FREEHEAP)
  155. idbSend(MQTT_TOPIC_FREEHEAP, String(free_heap).c_str());
  156. #endif
  157. #endif
  158. }
  159. #endif /// HEARTBEAT_ENABLED
  160. unsigned int sectors(size_t size) {
  161. return (int) (size + SPI_FLASH_SEC_SIZE - 1) / SPI_FLASH_SEC_SIZE;
  162. }
  163. void info() {
  164. DEBUG_MSG_P(PSTR("\n\n"));
  165. DEBUG_MSG_P(PSTR("[INIT] %s %s\n"), (char *) APP_NAME, (char *) APP_VERSION);
  166. DEBUG_MSG_P(PSTR("[INIT] %s\n"), (char *) APP_AUTHOR);
  167. DEBUG_MSG_P(PSTR("[INIT] %s\n\n"), (char *) APP_WEBSITE);
  168. DEBUG_MSG_P(PSTR("[INIT] CPU chip ID: 0x%06X\n"), ESP.getChipId());
  169. DEBUG_MSG_P(PSTR("[INIT] CPU frequency: %u MHz\n"), ESP.getCpuFreqMHz());
  170. DEBUG_MSG_P(PSTR("[INIT] SDK version: %s\n"), ESP.getSdkVersion());
  171. DEBUG_MSG_P(PSTR("[INIT] Core version: %s\n"), getCoreVersion().c_str());
  172. DEBUG_MSG_P(PSTR("[INIT] Core revision: %s\n"), getCoreRevision().c_str());
  173. DEBUG_MSG_P(PSTR("\n"));
  174. // -------------------------------------------------------------------------
  175. FlashMode_t mode = ESP.getFlashChipMode();
  176. DEBUG_MSG_P(PSTR("[INIT] Flash chip ID: 0x%06X\n"), ESP.getFlashChipId());
  177. DEBUG_MSG_P(PSTR("[INIT] Flash speed: %u Hz\n"), ESP.getFlashChipSpeed());
  178. DEBUG_MSG_P(PSTR("[INIT] Flash mode: %s\n"), mode == FM_QIO ? "QIO" : mode == FM_QOUT ? "QOUT" : mode == FM_DIO ? "DIO" : mode == FM_DOUT ? "DOUT" : "UNKNOWN");
  179. DEBUG_MSG_P(PSTR("\n"));
  180. DEBUG_MSG_P(PSTR("[INIT] Flash sector size: %8u bytes\n"), SPI_FLASH_SEC_SIZE);
  181. DEBUG_MSG_P(PSTR("[INIT] Flash size (CHIP): %8u bytes\n"), ESP.getFlashChipRealSize());
  182. DEBUG_MSG_P(PSTR("[INIT] Flash size (SDK): %8u bytes / %4d sectors\n"), ESP.getFlashChipSize(), sectors(ESP.getFlashChipSize()));
  183. DEBUG_MSG_P(PSTR("[INIT] Firmware size: %8u bytes / %4d sectors\n"), ESP.getSketchSize(), sectors(ESP.getSketchSize()));
  184. DEBUG_MSG_P(PSTR("[INIT] OTA size: %8u bytes / %4d sectors\n"), ESP.getFreeSketchSpace(), sectors(ESP.getFreeSketchSpace()));
  185. #if SPIFFS_SUPPORT
  186. FSInfo fs_info;
  187. bool fs = SPIFFS.info(fs_info);
  188. if (fs) {
  189. DEBUG_MSG_P(PSTR("[INIT] SPIFFS size: %8u bytes / %4d sectors\n"), fs_info.totalBytes, sectors(fs_info.totalBytes));
  190. }
  191. #else
  192. DEBUG_MSG_P(PSTR("[INIT] SPIFFS size: %8u bytes / %4d sectors\n"), 0, 0);
  193. #endif
  194. DEBUG_MSG_P(PSTR("[INIT] EEPROM size: %8u bytes / %4d sectors\n"), settingsMaxSize(), sectors(settingsMaxSize()));
  195. DEBUG_MSG_P(PSTR("[INIT] Empty space: %8u bytes / 4 sectors\n"), 4 * SPI_FLASH_SEC_SIZE);
  196. DEBUG_MSG_P(PSTR("\n"));
  197. // -------------------------------------------------------------------------
  198. #if SPIFFS_SUPPORT
  199. if (fs) {
  200. DEBUG_MSG_P(PSTR("[INIT] SPIFFS total size: %8u bytes\n"), fs_info.totalBytes);
  201. DEBUG_MSG_P(PSTR("[INIT] used size: %8u bytes\n"), fs_info.usedBytes);
  202. DEBUG_MSG_P(PSTR("[INIT] block size: %8u bytes\n"), fs_info.blockSize);
  203. DEBUG_MSG_P(PSTR("[INIT] page size: %8u bytes\n"), fs_info.pageSize);
  204. DEBUG_MSG_P(PSTR("[INIT] max files: %8u\n"), fs_info.maxOpenFiles);
  205. DEBUG_MSG_P(PSTR("[INIT] max length: %8u\n"), fs_info.maxPathLength);
  206. } else {
  207. DEBUG_MSG_P(PSTR("[INIT] No SPIFFS partition\n"));
  208. }
  209. DEBUG_MSG_P(PSTR("\n"));
  210. #endif
  211. // -------------------------------------------------------------------------
  212. #ifdef APP_BUILD_FLAGS
  213. DEBUG_MSG_P(PSTR("[INIT] BUILD_FLAGS: %s\n"), APP_BUILD_FLAGS);
  214. #endif
  215. DEBUG_MSG_P(PSTR("[INIT] BOARD: %s\n"), getBoardName().c_str());
  216. DEBUG_MSG_P(PSTR("[INIT] SUPPORT:"));
  217. #if ALEXA_SUPPORT
  218. DEBUG_MSG_P(PSTR(" ALEXA"));
  219. #endif
  220. #if BROKER_SUPPORT
  221. DEBUG_MSG_P(PSTR(" BROKER"));
  222. #endif
  223. #if DEBUG_SERIAL_SUPPORT
  224. DEBUG_MSG_P(PSTR(" DEBUG_SERIAL"));
  225. #endif
  226. #if DEBUG_TELNET_SUPPORT
  227. DEBUG_MSG_P(PSTR(" DEBUG_TELNET"));
  228. #endif
  229. #if DEBUG_UDP_SUPPORT
  230. DEBUG_MSG_P(PSTR(" DEBUG_UDP"));
  231. #endif
  232. #if DOMOTICZ_SUPPORT
  233. DEBUG_MSG_P(PSTR(" DOMOTICZ"));
  234. #endif
  235. #if HOMEASSISTANT_SUPPORT
  236. DEBUG_MSG_P(PSTR(" HOMEASSISTANT"));
  237. #endif
  238. #if I2C_SUPPORT
  239. DEBUG_MSG_P(PSTR(" I2C"));
  240. #endif
  241. #if INFLUXDB_SUPPORT
  242. DEBUG_MSG_P(PSTR(" INFLUXDB"));
  243. #endif
  244. #if LLMNR_SUPPORT
  245. DEBUG_MSG_P(PSTR(" LLMNR"));
  246. #endif
  247. #if MDNS_SERVER_SUPPORT
  248. DEBUG_MSG_P(PSTR(" MDNS_SERVER"));
  249. #endif
  250. #if MDNS_CLIENT_SUPPORT
  251. DEBUG_MSG_P(PSTR(" MDNS_CLIENT"));
  252. #endif
  253. #if NETBIOS_SUPPORT
  254. DEBUG_MSG_P(PSTR(" NETBIOS"));
  255. #endif
  256. #if NOFUSS_SUPPORT
  257. DEBUG_MSG_P(PSTR(" NOFUSS"));
  258. #endif
  259. #if NTP_SUPPORT
  260. DEBUG_MSG_P(PSTR(" NTP"));
  261. #endif
  262. #if RF_SUPPORT
  263. DEBUG_MSG_P(PSTR(" RF"));
  264. #endif
  265. #if SCHEDULER_SUPPORT
  266. DEBUG_MSG_P(PSTR(" SCHEDULER"));
  267. #endif
  268. #if SENSOR_SUPPORT
  269. DEBUG_MSG_P(PSTR(" SENSOR"));
  270. #endif
  271. #if SPIFFS_SUPPORT
  272. DEBUG_MSG_P(PSTR(" SPIFFS"));
  273. #endif
  274. #if SSDP_SUPPORT
  275. DEBUG_MSG_P(PSTR(" SSDP"));
  276. #endif
  277. #if TELNET_SUPPORT
  278. DEBUG_MSG_P(PSTR(" TELNET"));
  279. #endif
  280. #if TERMINAL_SUPPORT
  281. DEBUG_MSG_P(PSTR(" TERMINAL"));
  282. #endif
  283. #if THINGSPEAK_SUPPORT
  284. DEBUG_MSG_P(PSTR(" THINGSPEAK"));
  285. #endif
  286. #if UART_MQTT_SUPPORT
  287. DEBUG_MSG_P(PSTR(" UART_MQTT"));
  288. #endif
  289. #if WEB_SUPPORT
  290. DEBUG_MSG_P(PSTR(" WEB"));
  291. #endif
  292. #if SENSOR_SUPPORT
  293. DEBUG_MSG_P(PSTR("\n"));
  294. DEBUG_MSG_P(PSTR("[INIT] SENSORS:"));
  295. #if ANALOG_SUPPORT
  296. DEBUG_MSG_P(PSTR(" ANALOG"));
  297. #endif
  298. #if BMX280_SUPPORT
  299. DEBUG_MSG_P(PSTR(" BMX280"));
  300. #endif
  301. #if DALLAS_SUPPORT
  302. DEBUG_MSG_P(PSTR(" DALLAS"));
  303. #endif
  304. #if DHT_SUPPORT
  305. DEBUG_MSG_P(PSTR(" DHTXX"));
  306. #endif
  307. #if DIGITAL_SUPPORT
  308. DEBUG_MSG_P(PSTR(" DIGITAL"));
  309. #endif
  310. #if ECH1560_SUPPORT
  311. DEBUG_MSG_P(PSTR(" ECH1560"));
  312. #endif
  313. #if EMON_ADC121_SUPPORT
  314. DEBUG_MSG_P(PSTR(" EMON_ADC121"));
  315. #endif
  316. #if EMON_ADS1X15_SUPPORT
  317. DEBUG_MSG_P(PSTR(" EMON_ADX1X15"));
  318. #endif
  319. #if EMON_ANALOG_SUPPORT
  320. DEBUG_MSG_P(PSTR(" EMON_ANALOG"));
  321. #endif
  322. #if EVENTS_SUPPORT
  323. DEBUG_MSG_P(PSTR(" EVENTS"));
  324. #endif
  325. #if HLW8012_SUPPORT
  326. DEBUG_MSG_P(PSTR(" HLW8012"));
  327. #endif
  328. #if MHZ19_SUPPORT
  329. DEBUG_MSG_P(PSTR(" MHZ19"));
  330. #endif
  331. #if PMSX003_SUPPORT
  332. DEBUG_MSG_P(PSTR(" PMSX003"));
  333. #endif
  334. #if SHT3X_I2C_SUPPORT
  335. DEBUG_MSG_P(PSTR(" SHT3X_I2C"));
  336. #endif
  337. #if SI7021_SUPPORT
  338. DEBUG_MSG_P(PSTR(" SI7021"));
  339. #endif
  340. #if V9261F_SUPPORT
  341. DEBUG_MSG_P(PSTR(" V9261F"));
  342. #endif
  343. #endif // SENSOR_SUPPORT
  344. DEBUG_MSG_P(PSTR("\n\n"));
  345. // -------------------------------------------------------------------------
  346. unsigned char reason = resetReason();
  347. if (reason > 0) {
  348. char buffer[32];
  349. strcpy_P(buffer, custom_reset_string[reason-1]);
  350. DEBUG_MSG_P(PSTR("[INIT] Last reset reason: %s\n"), buffer);
  351. } else {
  352. DEBUG_MSG_P(PSTR("[INIT] Last reset reason: %s\n"), (char *) ESP.getResetReason().c_str());
  353. }
  354. DEBUG_MSG_P(PSTR("[INIT] Settings size: %u bytes\n"), settingsSize());
  355. DEBUG_MSG_P(PSTR("[INIT] Free heap: %u bytes\n"), getFreeHeap());
  356. #if ADC_VCC_ENABLED
  357. DEBUG_MSG_P(PSTR("[INIT] Power: %u mV\n"), ESP.getVcc());
  358. #endif
  359. DEBUG_MSG_P(PSTR("[INIT] Power saving delay value: %lu ms\n"), _loopDelay);
  360. #if SYSTEM_CHECK_ENABLED
  361. if (!systemCheck()) DEBUG_MSG_P(PSTR("\n[INIT] Device is in SAFE MODE\n"));
  362. #endif
  363. DEBUG_MSG_P(PSTR("\n"));
  364. }
  365. // -----------------------------------------------------------------------------
  366. // SSL
  367. // -----------------------------------------------------------------------------
  368. #if ASYNC_TCP_SSL_ENABLED
  369. bool sslCheckFingerPrint(const char * fingerprint) {
  370. return (strlen(fingerprint) == 59);
  371. }
  372. bool sslFingerPrintArray(const char * fingerprint, unsigned char * bytearray) {
  373. // check length (20 2-character digits ':' or ' ' separated => 20*2+19 = 59)
  374. if (!sslCheckFingerPrint(fingerprint)) return false;
  375. // walk the fingerprint
  376. for (unsigned int i=0; i<20; i++) {
  377. bytearray[i] = strtol(fingerprint + 3*i, NULL, 16);
  378. }
  379. return true;
  380. }
  381. bool sslFingerPrintChar(const char * fingerprint, char * destination) {
  382. // check length (20 2-character digits ':' or ' ' separated => 20*2+19 = 59)
  383. if (!sslCheckFingerPrint(fingerprint)) return false;
  384. // copy it
  385. strncpy(destination, fingerprint, 59);
  386. // walk the fingerprint replacing ':' for ' '
  387. for (unsigned char i = 0; i<59; i++) {
  388. if (destination[i] == ':') destination[i] = ' ';
  389. }
  390. return true;
  391. }
  392. #endif
  393. // -----------------------------------------------------------------------------
  394. // Reset
  395. // -----------------------------------------------------------------------------
  396. unsigned char resetReason() {
  397. static unsigned char status = 255;
  398. if (status == 255) {
  399. status = EEPROM.read(EEPROM_CUSTOM_RESET);
  400. if (status > 0) resetReason(0);
  401. if (status > CUSTOM_RESET_MAX) status = 0;
  402. }
  403. return status;
  404. }
  405. void resetReason(unsigned char reason) {
  406. EEPROM.write(EEPROM_CUSTOM_RESET, reason);
  407. EEPROM.commit();
  408. }
  409. void reset(unsigned char reason) {
  410. resetReason(reason);
  411. ESP.restart();
  412. }
  413. void deferredReset(unsigned long delay, unsigned char reason) {
  414. _defer_reset.once_ms(delay, reset, reason);
  415. }
  416. // -----------------------------------------------------------------------------
  417. char * ltrim(char * s) {
  418. char *p = s;
  419. while ((unsigned char) *p == ' ') ++p;
  420. return p;
  421. }
  422. double roundTo(double num, unsigned char positions) {
  423. double multiplier = 1;
  424. while (positions-- > 0) multiplier *= 10;
  425. return round(num * multiplier) / multiplier;
  426. }
  427. void nice_delay(unsigned long ms) {
  428. unsigned long start = millis();
  429. while (millis() - start < ms) delay(1);
  430. }