UITask.cpp 25 KB

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