#pragma once #include #include #include #include "PeriodicTask.h" #include "TypedQueue.h" #include "lock.h" #include "power.h" #include namespace meshtastic { // Forward declarations class Screen; /// Handles gathering and displaying debug information. class DebugInfo { public: DebugInfo(const DebugInfo &) = delete; DebugInfo &operator=(const DebugInfo &) = delete; /// Sets user statistics. void setNodeNumbersStatus(int online, int total) { LockGuard guard(&lock); nodesOnline = online; nodesTotal = total; } /// Sets the name of the channel. void setChannelNameStatus(const char *name) { LockGuard guard(&lock); channelName = name; } /// Sets battery/charging/etc status. // void setPowerStatus(const PowerStatus &status) { LockGuard guard(&lock); powerStatus = status; } /// Sets GPS status. // // If this function never gets called, we assume GPS does not exist on this // device. // TODO(girts): figure out what the format should be. void setGPSStatus(const char *status) { LockGuard guard(&lock); gpsStatus = status; } private: friend Screen; DebugInfo() {} /// Renders the debug screen. void drawFrame(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y); int nodesOnline = 0; int nodesTotal = 0; PowerStatus powerStatus; std::string channelName; std::string gpsStatus; /// Protects all of internal state. Lock lock; }; /// Deals with showing things on the screen of the device. // // Other than setup(), this class is thread-safe. All state-changing calls are // queued and executed when the main loop calls us. // // This class is thread-safe (as long as drawFrame is not called multiple times // simultaneously). class Screen : public PeriodicTask { public: Screen(uint8_t address, int sda = -1, int scl = -1); Screen(const Screen &) = delete; Screen &operator=(const Screen &) = delete; /// Initializes the UI, turns on the display, starts showing boot screen. // // Not thread safe - must be called before any other methods are called. void setup(); /// Turns the screen on/off. void setOn(bool on) { if (!on) handleSetOn( false); // We handle off commands immediately, because they might be called because the CPU is shutting down else enqueueCmd(CmdItem{.cmd = on ? Cmd::SET_ON : Cmd::SET_OFF}); } /// Handles a button press. void onPress() { enqueueCmd(CmdItem{.cmd = Cmd::ON_PRESS}); } /// Starts showing the Bluetooth PIN screen. // // Switches over to a static frame showing the Bluetooth pairing screen // with the PIN. void startBluetoothPinScreen(uint32_t pin) { CmdItem cmd; cmd.cmd = Cmd::START_BLUETOOTH_PIN_SCREEN; cmd.bluetooth_pin = pin; enqueueCmd(cmd); } /// Stops showing the bluetooth PIN screen. void stopBluetoothPinScreen() { enqueueCmd(CmdItem{.cmd = Cmd::STOP_BLUETOOTH_PIN_SCREEN}); } /// Stops showing the boot screen. void stopBootScreen() { enqueueCmd(CmdItem{.cmd = Cmd::STOP_BOOT_SCREEN}); } /// Writes a string to the screen. void print(const char *text) { CmdItem cmd; cmd.cmd = Cmd::PRINT; // TODO(girts): strdup() here is scary, but we can't use std::string as // FreeRTOS queue is just dumbly copying memory contents. It would be // nice if we had a queue that could copy objects by value. cmd.print_text = strdup(text); if (!enqueueCmd(cmd)) { free(cmd.print_text); } } /// Returns a handle to the DebugInfo screen. // // Use this handle to set things like battery status, user count, GPS status, etc. DebugInfo *debug() { return &debugInfo; } protected: /// Updates the UI. // // Called periodically from the main loop. void doTask() final; private: enum class Cmd { INVALID, SET_ON, SET_OFF, ON_PRESS, START_BLUETOOTH_PIN_SCREEN, STOP_BLUETOOTH_PIN_SCREEN, STOP_BOOT_SCREEN, PRINT, }; struct CmdItem { Cmd cmd; union { uint32_t bluetooth_pin; char *print_text; }; }; /// Enques given command item to be processed by main loop(). bool enqueueCmd(const CmdItem &cmd) { if (!useDisplay) return true; // claim success if our display is not in use else { bool success = cmdQueue.enqueue(cmd, 0); setPeriod(1); // handle ASAP return success; } } // Implementations of various commands, called from doTask(). void handleSetOn(bool on); void handleOnPress(); void handleStartBluetoothPinScreen(uint32_t pin); void handlePrint(const char *text); /// Rebuilds our list of frames (screens) to default ones. void setFrames(); /// Called when debug screen is to be drawn, calls through to debugInfo.drawFrame. static void drawDebugInfoTrampoline(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y); /// Queue of commands to execute in doTask. TypedQueue cmdQueue; /// Whether we are using a display bool useDisplay = false; /// Whether the display is currently powered bool screenOn = false; // Whether we are showing the regular screen (as opposed to booth screen or // Bluetooth PIN screen) bool showingNormalScreen = false; /// Holds state for debug information DebugInfo debugInfo; /// Display device SSD1306Wire dispdev; /// UI helper for rendering to frames and switching between them OLEDDisplayUi ui; }; } // namespace meshtastic