UITask.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811
  1. #include "UITask.h"
  2. #include <helpers/TxtDataHelpers.h>
  3. #include "../MyMesh.h"
  4. #include "target.h"
  5. #ifndef AUTO_OFF_MILLIS
  6. #define AUTO_OFF_MILLIS 15000 // 15 seconds
  7. #endif
  8. #define BOOT_SCREEN_MILLIS 3000 // 3 seconds
  9. #ifdef PIN_STATUS_LED
  10. #define LED_ON_MILLIS 20
  11. #define LED_ON_MSG_MILLIS 200
  12. #define LED_CYCLE_MILLIS 4000
  13. #endif
  14. #define LONG_PRESS_MILLIS 1200
  15. #ifndef UI_RECENT_LIST_SIZE
  16. #define UI_RECENT_LIST_SIZE 4
  17. #endif
  18. #define PRESS_LABEL "long press"
  19. #include "icons.h"
  20. class SplashScreen : public UIScreen {
  21. UITask* _task;
  22. unsigned long dismiss_after;
  23. char _version_info[12];
  24. public:
  25. SplashScreen(UITask* task) : _task(task) {
  26. // strip off dash and commit hash by changing dash to null terminator
  27. // e.g: v1.2.3-abcdef -> v1.2.3
  28. const char *ver = FIRMWARE_VERSION;
  29. const char *dash = strchr(ver, '-');
  30. int len = dash ? dash - ver : strlen(ver);
  31. if (len >= sizeof(_version_info)) len = sizeof(_version_info) - 1;
  32. memcpy(_version_info, ver, len);
  33. _version_info[len] = 0;
  34. dismiss_after = millis() + BOOT_SCREEN_MILLIS;
  35. }
  36. int render(DisplayDriver& display) override {
  37. // meshcore logo
  38. display.setColor(DisplayDriver::BLUE);
  39. int logoWidth = 128;
  40. display.drawXbm((display.width() - logoWidth) / 2, 3, meshcore_logo, logoWidth, 13);
  41. // version info
  42. display.setColor(DisplayDriver::LIGHT);
  43. display.setTextSize(2);
  44. display.drawTextCentered(display.width()/2, 22, _version_info);
  45. display.setTextSize(1);
  46. display.drawTextCentered(display.width()/2, 42, FIRMWARE_BUILD_DATE);
  47. return 1000;
  48. }
  49. void poll() override {
  50. if (millis() >= dismiss_after) {
  51. _task->gotoHomeScreen();
  52. }
  53. }
  54. };
  55. class HomeScreen : public UIScreen {
  56. enum HomePage {
  57. FIRST,
  58. RECENT,
  59. RADIO,
  60. BLUETOOTH,
  61. ADVERT,
  62. #if UI_SENSORS_PAGE == 1
  63. SENSORS,
  64. #endif
  65. SHUTDOWN,
  66. Count // keep as last
  67. };
  68. UITask* _task;
  69. mesh::RTCClock* _rtc;
  70. SensorManager* _sensors;
  71. NodePrefs* _node_prefs;
  72. uint8_t _page;
  73. bool _shutdown_init;
  74. AdvertPath recent[UI_RECENT_LIST_SIZE];
  75. void renderBatteryIndicator(DisplayDriver& display, uint16_t batteryMilliVolts) {
  76. // Convert millivolts to percentage
  77. const int minMilliVolts = 3000; // Minimum voltage (e.g., 3.0V)
  78. const int maxMilliVolts = 4200; // Maximum voltage (e.g., 4.2V)
  79. int batteryPercentage = ((batteryMilliVolts - minMilliVolts) * 100) / (maxMilliVolts - minMilliVolts);
  80. if (batteryPercentage < 0) batteryPercentage = 0; // Clamp to 0%
  81. if (batteryPercentage > 100) batteryPercentage = 100; // Clamp to 100%
  82. // battery icon
  83. int iconWidth = 24;
  84. int iconHeight = 10;
  85. int iconX = display.width() - iconWidth - 5; // Position the icon near the top-right corner
  86. int iconY = 0;
  87. display.setColor(DisplayDriver::GREEN);
  88. // battery outline
  89. display.drawRect(iconX, iconY, iconWidth, iconHeight);
  90. // battery "cap"
  91. display.fillRect(iconX + iconWidth, iconY + (iconHeight / 4), 3, iconHeight / 2);
  92. // fill the battery based on the percentage
  93. int fillWidth = (batteryPercentage * (iconWidth - 4)) / 100;
  94. display.fillRect(iconX + 2, iconY + 2, fillWidth, iconHeight - 4);
  95. }
  96. CayenneLPP sensors_lpp;
  97. int sensors_nb = 0;
  98. bool sensors_scroll = false;
  99. int sensors_scroll_offset = 0;
  100. int next_sensors_refresh = 0;
  101. void refresh_sensors() {
  102. if (millis() > next_sensors_refresh) {
  103. sensors_lpp.reset();
  104. sensors_nb = 0;
  105. sensors_lpp.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  106. sensors.querySensors(0xFF, sensors_lpp);
  107. LPPReader reader (sensors_lpp.getBuffer(), sensors_lpp.getSize());
  108. uint8_t channel, type;
  109. while(reader.readHeader(channel, type)) {
  110. reader.skipData(type);
  111. sensors_nb ++;
  112. }
  113. sensors_scroll = sensors_nb > UI_RECENT_LIST_SIZE;
  114. #if AUTO_OFF_MILLIS > 0
  115. next_sensors_refresh = millis() + 5000; // refresh sensor values every 5 sec
  116. #else
  117. next_sensors_refresh = millis() + 60000; // refresh sensor values every 1 min
  118. #endif
  119. }
  120. }
  121. public:
  122. HomeScreen(UITask* task, mesh::RTCClock* rtc, SensorManager* sensors, NodePrefs* node_prefs)
  123. : _task(task), _rtc(rtc), _sensors(sensors), _node_prefs(node_prefs), _page(0),
  124. _shutdown_init(false), sensors_lpp(200) { }
  125. void poll() override {
  126. if (_shutdown_init && !_task->isButtonPressed()) { // must wait for USR button to be released
  127. _task->shutdown();
  128. }
  129. }
  130. int render(DisplayDriver& display) override {
  131. char tmp[80];
  132. // node name
  133. display.setTextSize(1);
  134. display.setColor(DisplayDriver::GREEN);
  135. char filtered_name[sizeof(_node_prefs->node_name)];
  136. display.translateUTF8ToBlocks(filtered_name, _node_prefs->node_name, sizeof(filtered_name));
  137. display.setCursor(0, 0);
  138. display.print(filtered_name);
  139. // battery voltage
  140. renderBatteryIndicator(display, _task->getBattMilliVolts());
  141. // curr page indicator
  142. int y = 14;
  143. int x = display.width() / 2 - 25;
  144. for (uint8_t i = 0; i < HomePage::Count; i++, x += 10) {
  145. if (i == _page) {
  146. display.fillRect(x-1, y-1, 3, 3);
  147. } else {
  148. display.fillRect(x, y, 1, 1);
  149. }
  150. }
  151. if (_page == HomePage::FIRST) {
  152. display.setColor(DisplayDriver::YELLOW);
  153. display.setTextSize(2);
  154. sprintf(tmp, "MSG: %d", _task->getMsgCount());
  155. display.drawTextCentered(display.width() / 2, 20, tmp);
  156. if (_task->hasConnection()) {
  157. display.setColor(DisplayDriver::GREEN);
  158. display.setTextSize(1);
  159. display.drawTextCentered(display.width() / 2, 43, "< Connected >");
  160. } else if (the_mesh.getBLEPin() != 0) { // BT pin
  161. display.setColor(DisplayDriver::RED);
  162. display.setTextSize(2);
  163. sprintf(tmp, "Pin:%d", the_mesh.getBLEPin());
  164. display.drawTextCentered(display.width() / 2, 43, tmp);
  165. }
  166. } else if (_page == HomePage::RECENT) {
  167. the_mesh.getRecentlyHeard(recent, UI_RECENT_LIST_SIZE);
  168. display.setColor(DisplayDriver::GREEN);
  169. int y = 20;
  170. for (int i = 0; i < UI_RECENT_LIST_SIZE; i++, y += 11) {
  171. auto a = &recent[i];
  172. if (a->name[0] == 0) continue; // empty slot
  173. int secs = _rtc->getCurrentTime() - a->recv_timestamp;
  174. if (secs < 60) {
  175. sprintf(tmp, "%ds", secs);
  176. } else if (secs < 60*60) {
  177. sprintf(tmp, "%dm", secs / 60);
  178. } else {
  179. sprintf(tmp, "%dh", secs / (60*60));
  180. }
  181. int timestamp_width = display.getTextWidth(tmp);
  182. int max_name_width = display.width() - timestamp_width - 1;
  183. char filtered_recent_name[sizeof(a->name)];
  184. display.translateUTF8ToBlocks(filtered_recent_name, a->name, sizeof(filtered_recent_name));
  185. display.drawTextEllipsized(0, y, max_name_width, filtered_recent_name);
  186. display.setCursor(display.width() - timestamp_width - 1, y);
  187. display.print(tmp);
  188. }
  189. } else if (_page == HomePage::RADIO) {
  190. display.setColor(DisplayDriver::YELLOW);
  191. display.setTextSize(1);
  192. // freq / sf
  193. display.setCursor(0, 20);
  194. sprintf(tmp, "FQ: %06.3f SF: %d", _node_prefs->freq, _node_prefs->sf);
  195. display.print(tmp);
  196. display.setCursor(0, 31);
  197. sprintf(tmp, "BW: %03.2f CR: %d", _node_prefs->bw, _node_prefs->cr);
  198. display.print(tmp);
  199. // tx power, noise floor
  200. display.setCursor(0, 42);
  201. sprintf(tmp, "TX: %ddBm", _node_prefs->tx_power_dbm);
  202. display.print(tmp);
  203. display.setCursor(0, 53);
  204. sprintf(tmp, "Noise floor: %d", radio_driver.getNoiseFloor());
  205. display.print(tmp);
  206. } else if (_page == HomePage::BLUETOOTH) {
  207. display.setColor(DisplayDriver::GREEN);
  208. display.drawXbm((display.width() - 32) / 2, 18,
  209. _task->isSerialEnabled() ? bluetooth_on : bluetooth_off,
  210. 32, 32);
  211. display.setTextSize(1);
  212. display.drawTextCentered(display.width() / 2, 64 - 11, "toggle: " PRESS_LABEL);
  213. } else if (_page == HomePage::ADVERT) {
  214. display.setColor(DisplayDriver::GREEN);
  215. display.drawXbm((display.width() - 32) / 2, 18, advert_icon, 32, 32);
  216. display.drawTextCentered(display.width() / 2, 64 - 11, "advert: " PRESS_LABEL);
  217. #if UI_SENSORS_PAGE == 1
  218. } else if (_page == HomePage::SENSORS) {
  219. int y = 18;
  220. refresh_sensors();
  221. char buf[30];
  222. char name[30];
  223. LPPReader r(sensors_lpp.getBuffer(), sensors_lpp.getSize());
  224. for (int i = 0; i < sensors_scroll_offset; i++) {
  225. uint8_t channel, type;
  226. r.readHeader(channel, type);
  227. r.skipData(type);
  228. }
  229. for (int i = 0; i < (sensors_scroll?UI_RECENT_LIST_SIZE:sensors_nb); i++) {
  230. uint8_t channel, type;
  231. if (!r.readHeader(channel, type)) { // reached end, reset
  232. r.reset();
  233. r.readHeader(channel, type);
  234. }
  235. display.setCursor(0, y);
  236. float v;
  237. switch (type) {
  238. case LPP_GPS: // GPS
  239. float lat, lon, alt;
  240. r.readGPS(lat, lon, alt);
  241. strcpy(name, "gps"); sprintf(buf, "%.4f %.4f", lat, lon);
  242. break;
  243. case LPP_VOLTAGE:
  244. r.readVoltage(v);
  245. strcpy(name, "voltage"); sprintf(buf, "%6.2f", v);
  246. break;
  247. case LPP_CURRENT:
  248. r.readCurrent(v);
  249. strcpy(name, "current"); sprintf(buf, "%.3f", v);
  250. break;
  251. case LPP_TEMPERATURE:
  252. r.readTemperature(v);
  253. strcpy(name, "temperature"); sprintf(buf, "%.2f", v);
  254. break;
  255. case LPP_RELATIVE_HUMIDITY:
  256. r.readRelativeHumidity(v);
  257. strcpy(name, "humidity"); sprintf(buf, "%.2f", v);
  258. break;
  259. case LPP_BAROMETRIC_PRESSURE:
  260. r.readPressure(v);
  261. strcpy(name, "pressure"); sprintf(buf, "%.2f", v);
  262. break;
  263. case LPP_ALTITUDE:
  264. r.readAltitude(v);
  265. strcpy(name, "altitude"); sprintf(buf, "%.0f", v);
  266. break;
  267. case LPP_POWER:
  268. r.readPower(v);
  269. strcpy(name, "power"); sprintf(buf, "%6.2f", v);
  270. break;
  271. default:
  272. r.skipData(type);
  273. strcpy(name, "unk"); sprintf(buf, "");
  274. }
  275. display.setCursor(0, y);
  276. display.print(name);
  277. display.setCursor(
  278. display.width()-display.getTextWidth(buf)-1, y
  279. );
  280. display.print(buf);
  281. y = y + 12;
  282. }
  283. if (sensors_scroll) sensors_scroll_offset = (sensors_scroll_offset+1)%sensors_nb;
  284. else sensors_scroll_offset = 0;
  285. #endif
  286. } else if (_page == HomePage::SHUTDOWN) {
  287. display.setColor(DisplayDriver::GREEN);
  288. display.setTextSize(1);
  289. if (_shutdown_init) {
  290. display.drawTextCentered(display.width() / 2, 34, "hibernating...");
  291. } else {
  292. display.drawXbm((display.width() - 32) / 2, 18, power_icon, 32, 32);
  293. display.drawTextCentered(display.width() / 2, 64 - 11, "hibernate: " PRESS_LABEL);
  294. }
  295. }
  296. return 5000; // next render after 5000 ms
  297. }
  298. bool handleInput(char c) override {
  299. if (c == KEY_LEFT || c == KEY_PREV) {
  300. _page = (_page + HomePage::Count - 1) % HomePage::Count;
  301. return true;
  302. }
  303. if (c == KEY_NEXT || c == KEY_RIGHT) {
  304. _page = (_page + 1) % HomePage::Count;
  305. if (_page == HomePage::RECENT) {
  306. _task->showAlert("Recent adverts", 800);
  307. }
  308. return true;
  309. }
  310. if (c == KEY_ENTER && _page == HomePage::BLUETOOTH) {
  311. if (_task->isSerialEnabled()) { // toggle Bluetooth on/off
  312. _task->disableSerial();
  313. } else {
  314. _task->enableSerial();
  315. }
  316. return true;
  317. }
  318. if (c == KEY_ENTER && _page == HomePage::ADVERT) {
  319. _task->notify(UIEventType::ack);
  320. if (the_mesh.advert()) {
  321. _task->showAlert("Advert sent!", 1000);
  322. } else {
  323. _task->showAlert("Advert failed..", 1000);
  324. }
  325. return true;
  326. }
  327. #if UI_SENSORS_PAGE == 1
  328. if (c == KEY_ENTER && _page == HomePage::SENSORS) {
  329. _task->toggleGPS();
  330. next_sensors_refresh=0;
  331. return true;
  332. }
  333. #endif
  334. if (c == KEY_ENTER && _page == HomePage::SHUTDOWN) {
  335. _shutdown_init = true; // need to wait for button to be released
  336. return true;
  337. }
  338. return false;
  339. }
  340. };
  341. class MsgPreviewScreen : public UIScreen {
  342. UITask* _task;
  343. mesh::RTCClock* _rtc;
  344. struct MsgEntry {
  345. uint32_t timestamp;
  346. char origin[62];
  347. char msg[78];
  348. };
  349. #define MAX_UNREAD_MSGS 32
  350. int num_unread;
  351. MsgEntry unread[MAX_UNREAD_MSGS];
  352. public:
  353. MsgPreviewScreen(UITask* task, mesh::RTCClock* rtc) : _task(task), _rtc(rtc) { num_unread = 0; }
  354. void addPreview(uint8_t path_len, const char* from_name, const char* msg) {
  355. if (num_unread >= MAX_UNREAD_MSGS) return; // full
  356. auto p = &unread[num_unread++];
  357. p->timestamp = _rtc->getCurrentTime();
  358. if (path_len == 0xFF) {
  359. sprintf(p->origin, "(D) %s:", from_name);
  360. } else {
  361. sprintf(p->origin, "(%d) %s:", (uint32_t) path_len, from_name);
  362. }
  363. StrHelper::strncpy(p->msg, msg, sizeof(p->msg));
  364. }
  365. int render(DisplayDriver& display) override {
  366. char tmp[16];
  367. display.setCursor(0, 0);
  368. display.setTextSize(1);
  369. display.setColor(DisplayDriver::GREEN);
  370. sprintf(tmp, "Unread: %d", num_unread);
  371. display.print(tmp);
  372. auto p = &unread[0];
  373. int secs = _rtc->getCurrentTime() - p->timestamp;
  374. if (secs < 60) {
  375. sprintf(tmp, "%ds", secs);
  376. } else if (secs < 60*60) {
  377. sprintf(tmp, "%dm", secs / 60);
  378. } else {
  379. sprintf(tmp, "%dh", secs / (60*60));
  380. }
  381. display.setCursor(display.width() - display.getTextWidth(tmp) - 2, 0);
  382. display.print(tmp);
  383. display.drawRect(0, 11, display.width(), 1); // horiz line
  384. display.setCursor(0, 14);
  385. display.setColor(DisplayDriver::YELLOW);
  386. char filtered_origin[sizeof(p->origin)];
  387. display.translateUTF8ToBlocks(filtered_origin, p->origin, sizeof(filtered_origin));
  388. display.print(filtered_origin);
  389. display.setCursor(0, 25);
  390. display.setColor(DisplayDriver::LIGHT);
  391. char filtered_msg[sizeof(p->msg)];
  392. display.translateUTF8ToBlocks(filtered_msg, p->msg, sizeof(filtered_msg));
  393. display.printWordWrap(filtered_msg, display.width());
  394. #if AUTO_OFF_MILLIS==0 // probably e-ink
  395. return 10000; // 10 s
  396. #else
  397. return 1000; // next render after 1000 ms
  398. #endif
  399. }
  400. bool handleInput(char c) override {
  401. if (c == KEY_NEXT || c == KEY_RIGHT) {
  402. num_unread--;
  403. if (num_unread == 0) {
  404. _task->gotoHomeScreen();
  405. } else {
  406. // delete first/curr item from unread queue
  407. for (int i = 0; i < num_unread; i++) {
  408. unread[i] = unread[i + 1];
  409. }
  410. }
  411. return true;
  412. }
  413. if (c == KEY_ENTER) {
  414. num_unread = 0; // clear unread queue
  415. _task->gotoHomeScreen();
  416. return true;
  417. }
  418. return false;
  419. }
  420. };
  421. void UITask::begin(DisplayDriver* display, SensorManager* sensors, NodePrefs* node_prefs) {
  422. _display = display;
  423. _sensors = sensors;
  424. _auto_off = millis() + AUTO_OFF_MILLIS;
  425. #if defined(PIN_USER_BTN)
  426. user_btn.begin();
  427. #endif
  428. #if defined(PIN_USER_BTN_ANA)
  429. analog_btn.begin();
  430. #endif
  431. _node_prefs = node_prefs;
  432. if (_display != NULL) {
  433. _display->turnOn();
  434. }
  435. #ifdef PIN_BUZZER
  436. buzzer.begin();
  437. #endif
  438. #ifdef PIN_VIBRATION
  439. vibration.begin();
  440. #endif
  441. ui_started_at = millis();
  442. _alert_expiry = 0;
  443. splash = new SplashScreen(this);
  444. home = new HomeScreen(this, &rtc_clock, sensors, node_prefs);
  445. msg_preview = new MsgPreviewScreen(this, &rtc_clock);
  446. setCurrScreen(splash);
  447. }
  448. void UITask::showAlert(const char* text, int duration_millis) {
  449. strcpy(_alert, text);
  450. _alert_expiry = millis() + duration_millis;
  451. }
  452. void UITask::notify(UIEventType t) {
  453. #if defined(PIN_BUZZER)
  454. switch(t){
  455. case UIEventType::contactMessage:
  456. // gemini's pick
  457. buzzer.play("MsgRcv3:d=4,o=6,b=200:32e,32g,32b,16c7");
  458. break;
  459. case UIEventType::channelMessage:
  460. buzzer.play("kerplop:d=16,o=6,b=120:32g#,32c#");
  461. break;
  462. case UIEventType::ack:
  463. buzzer.play("ack:d=32,o=8,b=120:c");
  464. break;
  465. case UIEventType::roomMessage:
  466. case UIEventType::newContactMessage:
  467. case UIEventType::none:
  468. default:
  469. break;
  470. }
  471. #endif
  472. #ifdef PIN_VIBRATION
  473. // Trigger vibration for all UI events except none
  474. if (t != UIEventType::none) {
  475. vibration.trigger();
  476. }
  477. #endif
  478. }
  479. void UITask::msgRead(int msgcount) {
  480. _msgcount = msgcount;
  481. if (msgcount == 0) {
  482. gotoHomeScreen();
  483. }
  484. }
  485. void UITask::newMsg(uint8_t path_len, const char* from_name, const char* text, int msgcount) {
  486. _msgcount = msgcount;
  487. ((MsgPreviewScreen *) msg_preview)->addPreview(path_len, from_name, text);
  488. setCurrScreen(msg_preview);
  489. if (_display != NULL) {
  490. if (!_display->isOn()) _display->turnOn();
  491. _auto_off = millis() + AUTO_OFF_MILLIS; // extend the auto-off timer
  492. _next_refresh = 100; // trigger refresh
  493. }
  494. }
  495. void UITask::userLedHandler() {
  496. #ifdef PIN_STATUS_LED
  497. int cur_time = millis();
  498. if (cur_time > next_led_change) {
  499. if (led_state == 0) {
  500. led_state = 1;
  501. if (_msgcount > 0) {
  502. last_led_increment = LED_ON_MSG_MILLIS;
  503. } else {
  504. last_led_increment = LED_ON_MILLIS;
  505. }
  506. next_led_change = cur_time + last_led_increment;
  507. } else {
  508. led_state = 0;
  509. next_led_change = cur_time + LED_CYCLE_MILLIS - last_led_increment;
  510. }
  511. digitalWrite(PIN_STATUS_LED, led_state);
  512. }
  513. #endif
  514. }
  515. void UITask::setCurrScreen(UIScreen* c) {
  516. curr = c;
  517. _next_refresh = 100;
  518. }
  519. /*
  520. hardware-agnostic pre-shutdown activity should be done here
  521. */
  522. void UITask::shutdown(bool restart){
  523. #ifdef PIN_BUZZER
  524. /* note: we have a choice here -
  525. we can do a blocking buzzer.loop() with non-deterministic consequences
  526. or we can set a flag and delay the shutdown for a couple of seconds
  527. while a non-blocking buzzer.loop() plays out in UITask::loop()
  528. */
  529. buzzer.shutdown();
  530. uint32_t buzzer_timer = millis(); // fail-safe shutdown
  531. while (buzzer.isPlaying() && (millis() - 2500) < buzzer_timer)
  532. buzzer.loop();
  533. #endif // PIN_BUZZER
  534. if (restart) {
  535. _board->reboot();
  536. } else {
  537. _display->turnOff();
  538. _board->powerOff();
  539. }
  540. }
  541. bool UITask::isButtonPressed() const {
  542. #ifdef PIN_USER_BTN
  543. return user_btn.isPressed();
  544. #else
  545. return false;
  546. #endif
  547. }
  548. void UITask::loop() {
  549. char c = 0;
  550. #if defined(PIN_USER_BTN)
  551. int ev = user_btn.check();
  552. if (ev == BUTTON_EVENT_CLICK) {
  553. c = checkDisplayOn(KEY_NEXT);
  554. } else if (ev == BUTTON_EVENT_LONG_PRESS) {
  555. c = handleLongPress(KEY_ENTER);
  556. } else if (ev == BUTTON_EVENT_DOUBLE_CLICK) {
  557. c = handleDoubleClick(KEY_PREV);
  558. } else if (ev == BUTTON_EVENT_TRIPLE_CLICK) {
  559. c = handleTripleClick(KEY_SELECT);
  560. }
  561. #endif
  562. #if defined(WIO_TRACKER_L1)
  563. ev = joystick_left.check();
  564. if (ev == BUTTON_EVENT_CLICK) {
  565. c = checkDisplayOn(KEY_LEFT);
  566. } else if (ev == BUTTON_EVENT_LONG_PRESS) {
  567. c = handleLongPress(KEY_LEFT);
  568. }
  569. ev = joystick_right.check();
  570. if (ev == BUTTON_EVENT_CLICK) {
  571. c = checkDisplayOn(KEY_RIGHT);
  572. } else if (ev == BUTTON_EVENT_LONG_PRESS) {
  573. c = handleLongPress(KEY_RIGHT);
  574. }
  575. #endif
  576. #if defined(PIN_USER_BTN_ANA)
  577. ev = analog_btn.check();
  578. if (ev == BUTTON_EVENT_CLICK) {
  579. c = checkDisplayOn(KEY_NEXT);
  580. } else if (ev == BUTTON_EVENT_LONG_PRESS) {
  581. c = handleLongPress(KEY_ENTER);
  582. } else if (ev == BUTTON_EVENT_DOUBLE_CLICK) {
  583. c = handleDoubleClick(KEY_PREV);
  584. } else if (ev == BUTTON_EVENT_TRIPLE_CLICK) {
  585. c = handleTripleClick(KEY_SELECT);
  586. }
  587. #endif
  588. #if defined(DISP_BACKLIGHT) && defined(BACKLIGHT_BTN)
  589. if (millis() > next_backlight_btn_check) {
  590. bool touch_state = digitalRead(PIN_BUTTON2);
  591. digitalWrite(DISP_BACKLIGHT, !touch_state);
  592. next_backlight_btn_check = millis() + 300;
  593. }
  594. #endif
  595. if (c != 0 && curr) {
  596. curr->handleInput(c);
  597. _auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
  598. _next_refresh = 100; // trigger refresh
  599. }
  600. userLedHandler();
  601. #ifdef PIN_BUZZER
  602. if (buzzer.isPlaying()) buzzer.loop();
  603. #endif
  604. if (curr) curr->poll();
  605. if (_display != NULL && _display->isOn()) {
  606. if (millis() >= _next_refresh && curr) {
  607. _display->startFrame();
  608. int delay_millis = curr->render(*_display);
  609. if (millis() < _alert_expiry) { // render alert popup
  610. _display->setTextSize(1);
  611. int y = _display->height() / 3;
  612. int p = _display->height() / 32;
  613. _display->setColor(DisplayDriver::DARK);
  614. _display->fillRect(p, y, _display->width() - p*2, y);
  615. _display->setColor(DisplayDriver::LIGHT); // draw box border
  616. _display->drawRect(p, y, _display->width() - p*2, y);
  617. _display->drawTextCentered(_display->width() / 2, y + p*3, _alert);
  618. _next_refresh = _alert_expiry; // will need refresh when alert is dismissed
  619. } else {
  620. _next_refresh = millis() + delay_millis;
  621. }
  622. _display->endFrame();
  623. }
  624. #if AUTO_OFF_MILLIS > 0
  625. if (millis() > _auto_off) {
  626. _display->turnOff();
  627. }
  628. #endif
  629. }
  630. #ifdef PIN_VIBRATION
  631. vibration.loop();
  632. #endif
  633. #ifdef AUTO_SHUTDOWN_MILLIVOLTS
  634. if (millis() > next_batt_chck) {
  635. uint16_t milliVolts = getBattMilliVolts();
  636. if (milliVolts > 0 && milliVolts < AUTO_SHUTDOWN_MILLIVOLTS) {
  637. // show low battery shutdown alert
  638. // we should only do this for eink displays, which will persist after power loss
  639. #if defined(THINKNODE_M1) || defined(LILYGO_TECHO)
  640. if (_display != NULL) {
  641. _display->startFrame();
  642. _display->setTextSize(2);
  643. _display->setColor(DisplayDriver::RED);
  644. _display->drawTextCentered(_display->width() / 2, 20, "Low Battery.");
  645. _display->drawTextCentered(_display->width() / 2, 40, "Shutting Down!");
  646. _display->endFrame();
  647. }
  648. #endif
  649. shutdown();
  650. }
  651. next_batt_chck = millis() + 8000;
  652. }
  653. #endif
  654. }
  655. char UITask::checkDisplayOn(char c) {
  656. if (_display != NULL) {
  657. if (!_display->isOn()) {
  658. _display->turnOn(); // turn display on and consume event
  659. c = 0;
  660. }
  661. _auto_off = millis() + AUTO_OFF_MILLIS; // extend auto-off timer
  662. _next_refresh = 0; // trigger refresh
  663. }
  664. return c;
  665. }
  666. char UITask::handleLongPress(char c) {
  667. if (millis() - ui_started_at < 8000) { // long press in first 8 seconds since startup -> CLI/rescue
  668. the_mesh.enterCLIRescue();
  669. c = 0; // consume event
  670. }
  671. return c;
  672. }
  673. char UITask::handleDoubleClick(char c) {
  674. MESH_DEBUG_PRINTLN("UITask: double click triggered");
  675. checkDisplayOn(c);
  676. return c;
  677. }
  678. char UITask::handleTripleClick(char c) {
  679. MESH_DEBUG_PRINTLN("UITask: triple click triggered");
  680. checkDisplayOn(c);
  681. toggleBuzzer();
  682. c = 0;
  683. return c;
  684. }
  685. void UITask::toggleGPS() {
  686. if (_sensors != NULL) {
  687. // toggle GPS on/off
  688. int num = _sensors->getNumSettings();
  689. for (int i = 0; i < num; i++) {
  690. if (strcmp(_sensors->getSettingName(i), "gps") == 0) {
  691. if (strcmp(_sensors->getSettingValue(i), "1") == 0) {
  692. _sensors->setSettingValue("gps", "0");
  693. notify(UIEventType::ack);
  694. showAlert("GPS: Disabled", 800);
  695. } else {
  696. _sensors->setSettingValue("gps", "1");
  697. notify(UIEventType::ack);
  698. showAlert("GPS: Enabled", 800);
  699. }
  700. _next_refresh = 0;
  701. break;
  702. }
  703. }
  704. }
  705. }
  706. void UITask::toggleBuzzer() {
  707. // Toggle buzzer quiet mode
  708. #ifdef PIN_BUZZER
  709. if (buzzer.isQuiet()) {
  710. buzzer.quiet(false);
  711. notify(UIEventType::ack);
  712. showAlert("Buzzer: ON", 800);
  713. } else {
  714. buzzer.quiet(true);
  715. showAlert("Buzzer: OFF", 800);
  716. }
  717. _next_refresh = 0; // trigger refresh
  718. #endif
  719. }