Files
faceclaw/app/ui/dashboard-settings.ts
T
James Babcock 9fbb985db6 Add initial voice-command support
Adds a single wakeword-style voice command, "screen on", and deals with
all the wiring and permissions that entails. Currently this only
supports using the phone's mic (or a bluetooth headset), not the G2 mic.
2026-04-27 16:45:09 -07:00

258 lines
8.4 KiB
TypeScript

import { ApplicationSettings } from "@nativescript/core";
export type DashboardSlotId = "bottom-left" | "bottom-right";
export type DashboardPluginId = "blank" | "input-debug-log" | "music-controller" | "nightscout";
export type DashboardSlotConfig = Record<DashboardSlotId, DashboardPluginId>;
export type NightscoutSettings = {
siteUrl: string;
apiToken: string;
};
export type SystemCardSettings = {
showFaceclawLogo: boolean;
showBatteryIndicators: boolean;
showAndroidNotifications: boolean;
showSignalStrength: boolean;
};
export type SystemCardSettingKey = keyof SystemCardSettings;
export type ScreenTimeoutSetting = "15s" | "30s" | "1m" | "never";
export type WakeModeSetting = "tiled" | "synchronized";
export const DEFAULT_SYSTEM_CARD_NAME = "Faceclaw";
export const DEFAULT_SCREEN_TIMEOUT: ScreenTimeoutSetting = "30s";
export const DEFAULT_WAKE_MODE: WakeModeSetting = "tiled";
export const DEFAULT_VOICE_CONTROL_ENABLED = false;
const SYSTEM_CARD_NAME_KEY = "dashboard.systemCardName";
const SCREEN_TIMEOUT_KEY = "display.screenTimeout";
const WAKE_MODE_KEY = "display.wakeMode";
const VOICE_CONTROL_ENABLED_KEY = "voice.enabled";
const SYSTEM_CARD_SETTING_KEYS: Record<SystemCardSettingKey, string> = {
showFaceclawLogo: "dashboard.systemCard.showFaceclawLogo",
showBatteryIndicators: "dashboard.systemCard.showBatteryIndicators",
showAndroidNotifications: "dashboard.systemCard.showAndroidNotifications",
showSignalStrength: "dashboard.systemCard.showSignalStrength",
};
const NIGHTSCOUT_SITE_URL_KEY = "integrations.nightscout.siteUrl";
const NIGHTSCOUT_API_TOKEN_KEY = "integrations.nightscout.apiToken";
const SLOT_KEYS: Record<DashboardSlotId, string> = {
"bottom-left": "dashboard.slot.bottomLeft",
"bottom-right": "dashboard.slot.bottomRight",
};
const KNOWN_PLUGIN_IDS = new Set<DashboardPluginId>([
"blank",
"input-debug-log",
"music-controller",
"nightscout",
]);
const DEFAULT_SLOT_CONFIG: DashboardSlotConfig = {
"bottom-left": "input-debug-log",
"bottom-right": "blank",
};
const DEFAULT_SYSTEM_CARD_SETTINGS: SystemCardSettings = {
showFaceclawLogo: true,
showBatteryIndicators: true,
showAndroidNotifications: true,
showSignalStrength: true,
};
export function getDashboardSlotIds(): DashboardSlotId[] {
return ["bottom-left", "bottom-right"];
}
export function getDefaultDashboardSlotConfig(): DashboardSlotConfig {
return { ...DEFAULT_SLOT_CONFIG };
}
export function loadDashboardSlotConfig(): DashboardSlotConfig {
const config = getDefaultDashboardSlotConfig();
for (const slot of getDashboardSlotIds()) {
const stored = ApplicationSettings.getString(SLOT_KEYS[slot], config[slot]);
config[slot] = normalizePluginId(stored, config[slot]);
}
return config;
}
export function saveDashboardSlotPlugin(slot: DashboardSlotId, pluginId: DashboardPluginId): void {
ApplicationSettings.setString(SLOT_KEYS[slot], pluginId);
}
export function saveDashboardSlotConfig(config: DashboardSlotConfig): void {
for (const slot of getDashboardSlotIds()) {
saveDashboardSlotPlugin(slot, config[slot]);
}
}
export function loadSystemCardName(): string {
return normalizeSystemCardName(ApplicationSettings.getString(SYSTEM_CARD_NAME_KEY, DEFAULT_SYSTEM_CARD_NAME));
}
export function saveSystemCardName(name: string): string {
const normalized = normalizeSystemCardName(name);
ApplicationSettings.setString(SYSTEM_CARD_NAME_KEY, normalized);
return normalized;
}
export function loadSystemCardSettings(): SystemCardSettings {
return {
showFaceclawLogo: ApplicationSettings.getBoolean(
SYSTEM_CARD_SETTING_KEYS.showFaceclawLogo,
DEFAULT_SYSTEM_CARD_SETTINGS.showFaceclawLogo,
),
showBatteryIndicators: ApplicationSettings.getBoolean(
SYSTEM_CARD_SETTING_KEYS.showBatteryIndicators,
DEFAULT_SYSTEM_CARD_SETTINGS.showBatteryIndicators,
),
showAndroidNotifications: ApplicationSettings.getBoolean(
SYSTEM_CARD_SETTING_KEYS.showAndroidNotifications,
DEFAULT_SYSTEM_CARD_SETTINGS.showAndroidNotifications,
),
showSignalStrength: ApplicationSettings.getBoolean(
SYSTEM_CARD_SETTING_KEYS.showSignalStrength,
DEFAULT_SYSTEM_CARD_SETTINGS.showSignalStrength,
),
};
}
export function saveSystemCardSetting(key: SystemCardSettingKey, value: boolean): void {
ApplicationSettings.setBoolean(SYSTEM_CARD_SETTING_KEYS[key], value);
}
export function loadScreenTimeoutSetting(): ScreenTimeoutSetting {
return normalizeScreenTimeoutSetting(ApplicationSettings.getString(SCREEN_TIMEOUT_KEY, DEFAULT_SCREEN_TIMEOUT));
}
export function saveScreenTimeoutSetting(value: ScreenTimeoutSetting): ScreenTimeoutSetting {
const normalized = normalizeScreenTimeoutSetting(value);
ApplicationSettings.setString(SCREEN_TIMEOUT_KEY, normalized);
return normalized;
}
export function loadWakeModeSetting(): WakeModeSetting {
return normalizeWakeModeSetting(ApplicationSettings.getString(WAKE_MODE_KEY, DEFAULT_WAKE_MODE));
}
export function saveWakeModeSetting(value: WakeModeSetting): WakeModeSetting {
const normalized = normalizeWakeModeSetting(value);
ApplicationSettings.setString(WAKE_MODE_KEY, normalized);
return normalized;
}
export function loadVoiceControlEnabled(): boolean {
return ApplicationSettings.getBoolean(VOICE_CONTROL_ENABLED_KEY, DEFAULT_VOICE_CONTROL_ENABLED);
}
export function saveVoiceControlEnabled(value: boolean): boolean {
ApplicationSettings.setBoolean(VOICE_CONTROL_ENABLED_KEY, value);
return value;
}
export function nextScreenTimeoutSetting(value: ScreenTimeoutSetting): ScreenTimeoutSetting {
switch (value) {
case "15s":
return "30s";
case "30s":
return "1m";
case "1m":
return "never";
case "never":
default:
return "15s";
}
}
export function screenTimeoutMs(value: ScreenTimeoutSetting): number | null {
switch (value) {
case "15s":
return 15_000;
case "30s":
return 30_000;
case "1m":
return 60_000;
case "never":
return null;
}
}
export function screenTimeoutLabel(value: ScreenTimeoutSetting): string {
return value === "never" ? "Never" : value;
}
export function nextWakeModeSetting(value: WakeModeSetting): WakeModeSetting {
return value === "tiled" ? "synchronized" : "tiled";
}
export function wakeModeLabel(value: WakeModeSetting): string {
return value === "tiled" ? "Tiled" : "Synchronized";
}
export function loadNightscoutSettings(): NightscoutSettings {
return {
siteUrl: normalizeNightscoutSiteUrl(ApplicationSettings.getString(NIGHTSCOUT_SITE_URL_KEY, "")),
apiToken: normalizeNightscoutApiToken(ApplicationSettings.getString(NIGHTSCOUT_API_TOKEN_KEY, "")),
};
}
export function saveNightscoutSiteUrl(siteUrl: string): string {
const normalized = normalizeNightscoutSiteUrl(siteUrl);
ApplicationSettings.setString(NIGHTSCOUT_SITE_URL_KEY, normalized);
return normalized;
}
export function saveNightscoutApiToken(apiToken: string): string {
const normalized = normalizeNightscoutApiToken(apiToken);
ApplicationSettings.setString(NIGHTSCOUT_API_TOKEN_KEY, normalized);
return normalized;
}
export function isNightscoutSettingsConfigured(settings = loadNightscoutSettings()): boolean {
return settings.siteUrl.length > 0 && settings.apiToken.length > 0;
}
export function normalizePluginId(
value: string | null | undefined,
fallback: DashboardPluginId = "blank",
): DashboardPluginId {
if (value && KNOWN_PLUGIN_IDS.has(value as DashboardPluginId)) {
return value as DashboardPluginId;
}
return fallback;
}
function normalizeSystemCardName(name: string | null | undefined): string {
const normalized = (name ?? "").replace(/[\x00-\x1f]+/g, " ").replace(/\s+/g, " ").trim();
return normalized;
}
function normalizeNightscoutSiteUrl(siteUrl: string | null | undefined): string {
return (siteUrl ?? "").replace(/[\x00-\x1f]+/g, "").trim().replace(/\/+$/, "");
}
function normalizeNightscoutApiToken(apiToken: string | null | undefined): string {
return (apiToken ?? "").replace(/[\x00-\x1f]+/g, "").trim();
}
function normalizeScreenTimeoutSetting(value: string | null | undefined): ScreenTimeoutSetting {
switch (value) {
case "15s":
case "30s":
case "1m":
case "never":
return value;
default:
return DEFAULT_SCREEN_TIMEOUT;
}
}
function normalizeWakeModeSetting(value: string | null | undefined): WakeModeSetting {
switch (value) {
case "tiled":
case "synchronized":
return value;
default:
return DEFAULT_WAKE_MODE;
}
}