mirror of
https://github.com/meshtastic/firmware.git
synced 2026-01-03 08:30:45 +00:00
ecfaf3a095
* Allow observers to respond to AdminMessage requests
Ground work for CannedMessage getters and setters
* Enable CannedMessage config in apps for InkHUD devices
* Migrate the InkHUD::Events AdminModule observer
Use the new AdminModule_ObserverData struct
* Bare-bones NicheGraphics util to access canned messages
Handles loading and parsing. Handle admin messages for setting and getting.
* Send canned messages via on-screen menu
* Change ThreadedMessageApplet from Observer to Module API
Allows us to intercept locally generated packets ('loopbackOK = true'), to handle outgoing canned messages.
* Fix: crash getting empty canned message string via Client API
* Move file into Utils subdir
* Move an include statement from .cpp to .h
* Limit strncpy size of dest, not source
Wasn't critical in ths specific case, but definitely a mistake.
132 lines
4.9 KiB
C++
132 lines
4.9 KiB
C++
#ifdef MESHTASTIC_INCLUDE_INKHUD
|
|
|
|
/*
|
|
|
|
A quick and dirty alternative to storing "device only" settings using the protobufs
|
|
Convenient during development.
|
|
Potentially a polite option, to avoid polluting the generated code with values for obscure use cases like this.
|
|
|
|
The save / load mechanism is a shared NicheGraphics feature.
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "configuration.h"
|
|
|
|
#include "./InkHUD.h"
|
|
#include "graphics/niche/InkHUD/MessageStore.h"
|
|
#include "graphics/niche/Utils/FlashData.h"
|
|
|
|
namespace NicheGraphics::InkHUD
|
|
{
|
|
|
|
class Persistence
|
|
{
|
|
public:
|
|
static constexpr uint8_t MAX_TILES_GLOBAL = 4;
|
|
static constexpr uint8_t MAX_USERAPPLETS_GLOBAL = 16;
|
|
|
|
// Used to invalidate old settings, if needed
|
|
// Version 0 is reserved for testing, and will always load defaults
|
|
static constexpr uint32_t SETTINGS_VERSION = 2;
|
|
|
|
struct Settings {
|
|
struct Meta {
|
|
// Used to invalidate old savefiles, if we make breaking changes
|
|
uint32_t version = SETTINGS_VERSION;
|
|
} meta;
|
|
|
|
struct UserTiles {
|
|
// How many tiles are shown
|
|
uint8_t count = 1;
|
|
|
|
// Maximum amount of tiles for this display
|
|
uint8_t maxCount = 4;
|
|
|
|
// Which tile is focused (responding to user button input)
|
|
uint8_t focused = 0;
|
|
|
|
// Which applet is displayed on which tile
|
|
// Index of array: which tile, as indexed in WindowManager::userTiles
|
|
// Value of array: which applet, as indexed in InkHUD::userApplets
|
|
uint8_t displayedUserApplet[MAX_TILES_GLOBAL] = {0, 1, 2, 3};
|
|
} userTiles;
|
|
|
|
struct UserApplets {
|
|
// Which applets are running (either displayed, or in the background)
|
|
// Index of array: which applet, as indexed in InkHUD::userApplets
|
|
// Initial value is set by the "activeByDefault" parameter of InkHUD::addApplet, in setupNicheGraphics method
|
|
bool active[MAX_USERAPPLETS_GLOBAL]{false};
|
|
|
|
// Which user applets should be automatically shown when they have important data to show
|
|
// If none set, foreground applets should remain foreground without manual user input
|
|
// If multiple applets request this at once,
|
|
// priority is the order which they were passed to InkHUD::addApplets, in setupNicheGraphics method
|
|
bool autoshow[MAX_USERAPPLETS_GLOBAL]{false};
|
|
} userApplets;
|
|
|
|
// Features which the user can enable / disable via the on-screen menu
|
|
struct OptionalFeatures {
|
|
bool notifications = true;
|
|
bool batteryIcon = false;
|
|
} optionalFeatures;
|
|
|
|
// Some menu items may not be required, based on device / configuration
|
|
// We can enable them only when needed, to de-clutter the menu
|
|
struct OptionalMenuItems {
|
|
// If aux button is used to swap between tiles, we have no need for this menu item
|
|
bool nextTile = true;
|
|
|
|
// Used if backlight present, and not controlled by AUX button
|
|
// If this item is added to menu: backlight is always active when menu is open
|
|
// The added menu items then allows the user to "Keep Backlight On", globally.
|
|
bool backlight = false;
|
|
} optionalMenuItems;
|
|
|
|
// Allows tips to be run once only
|
|
struct Tips {
|
|
// Enables the longer "tutorial" shown only on first boot
|
|
// Once tutorial has been completed, it is no longer shown
|
|
bool firstBoot = true;
|
|
|
|
// User is advised to shut down before removing device power
|
|
// Once user executes a shutdown (either via menu or client app),
|
|
// this tip is no longer shown
|
|
bool safeShutdownSeen = false;
|
|
} tips;
|
|
|
|
// Rotation of the display
|
|
// Multiples of 90 degrees clockwise
|
|
// Most commonly: rotation is 0 when flex connector is oriented below display
|
|
uint8_t rotation = 0;
|
|
|
|
// How long do we consider another node to be "active"?
|
|
// Used when applets want to filter for "active nodes" only
|
|
uint32_t recentlyActiveSeconds = 2 * 60;
|
|
};
|
|
|
|
// Most recently received text message
|
|
// Value is updated by InkHUD::WindowManager, as a courtesy to applets
|
|
// Note: different from devicestate.rx_text_message,
|
|
// which may contain an *outgoing message* to broadcast
|
|
struct LatestMessage {
|
|
MessageStore::Message broadcast; // Most recent message received broadcast
|
|
MessageStore::Message dm; // Most recent received DM
|
|
bool wasBroadcast; // True if most recent broadcast is newer than most recent dm
|
|
};
|
|
|
|
void loadSettings();
|
|
void saveSettings();
|
|
void loadLatestMessage();
|
|
void saveLatestMessage();
|
|
|
|
// void printSettings(Settings *settings); // Debugging use only
|
|
|
|
Settings settings;
|
|
LatestMessage latestMessage;
|
|
};
|
|
|
|
} // namespace NicheGraphics::InkHUD
|
|
|
|
#endif |