diff --git a/PRIVACY b/PRIVACY new file mode 100644 index 00000000..7dd0c33a --- /dev/null +++ b/PRIVACY @@ -0,0 +1,63 @@ +# Faceclaw Privacy Policy + +Faceclaw is a privacy-conscious app. + +## Audio + +Faceclaw allows users to transcribe audio (for use with the voice assistant, +the Transcribe app, typing into Terminal, and other apps). The default setting +is that this is done using an on-device model running on your phone. If an +on-device model is selected, audio never leaves your device, and is not stored +after it is processed. + +Users can also provide their own API key for a third-party transcription +service such as OpenAI Whisper or ElevenLabs, which may offer better accuracy. +Faceclaw never transmits audio to any party other than a user-selected +transcription service. If a third-party transcription service is selected, +audio will be sent to that third party, is linked to the account with which +that API key was created, and is subject to that party's privacy and retention +policies: + + OpenAI: https://openai.com/policies/row-privacy-policy/ + ElevenLabs: https://elevenlabs.io/privacy-policy + +Third party data retention and privacy policies may differ based on the API +key provided. API keys are part of a relationship between the user and the API +provider; Faceclaw does not manage accounts or process billing information. + + +## AI Assistant Transcripts + +Faceclaw has a builtin AI voice assistant. Using the voice assistant requires +providing an API key for a model provider such as Anthropic or OpenAI. Prompts +and responses are subject to that model provider's privacy policy: + + OpenAI: https://openai.com/policies/row-privacy-policy/ + Anthropic: https://www.anthropic.com/legal/privacy + +AI conversation histories and memory files may be stored on your phone. +Faceclaw does not transmit voice-assistant prompts or responses to any party +other than a user-selected AI model provider. The voice assistant is given +tools with which it is able to access most things on the user's phone, +including all content displayed on the glasses, location, notifications, and +content accessible through the Terminal app. + +The AI assistant can take actions on the user's behalf, including sharing any +information it has access to. The user is responsible for any instructions +they give it. + + +## Location + +Faceclaw has a builtin Navigate app, which provides turn-by-turn directions. +Using the Navigate app requires providing an API key for Mapbox. While the +Navigate app is active, the user's exact location and selected destination are +transmitted to Mapbox, and are subject to Mapbox's privacy policy. + + Mapbox: https://www.mapbox.com/legal/privacy + +The Weather app will retrieve the user's coarse location, and will use it to +query a third-party weather information provider. + + + diff --git a/README b/README index 50c95d68..e5e36ae1 100644 --- a/README +++ b/README @@ -9,15 +9,6 @@ glasses. The Android app itself can install and uninstall the custom firmware; it downloads the stock firmware from Even and applies patches generated from https://github.com/jimrandomh/g2flash. -THIS IS AN UNFINISHED DEVELOPMENT PROTOTYPE; IF YOU DON'T HAVE ANY PROGRAMMING -EXPERIENCE, OR YOU AREN'T COMFORTABLE EDITING, COMPILING, AND SIDELOADING AN -ANDROID APPLICATION YOURSELF, OR YOU DON'T HAVE AN ANDROID DEVICE TO RUN IT -ON, THIS IS NOT FOR YOU. - -The name Faceclaw implies plans to integrate this with OpenClaw. These plans -have not yet been iplemented. If you want to use OpenClaw with Even Realities G2 -smart glasses today, consider using OcuClaw (which is an Even Hub app) instead. - ## Installation diff --git a/app/ui/dashboard/settings-menus.ts b/app/ui/dashboard/settings-menus.ts index 90a05627..db9a64d5 100644 --- a/app/ui/dashboard/settings-menus.ts +++ b/app/ui/dashboard/settings-menus.ts @@ -1,6 +1,10 @@ +import { knownFolders } from "@nativescript/core"; import { getDefaultSmallFont } from "../../graphics/bdffont"; import type { GrayImage } from "../../graphics/image"; import { getDashboardLogo } from "../../graphics/logo"; +import { wrapText } from "../../graphics/textwrap"; +import { TextViewerLayer } from "../apps/text-viewer"; +import type { MenuItem } from "../menu"; import { shell } from "../shell/shell"; import { anthropicApiKeySetting, @@ -100,7 +104,13 @@ function settingsSections(): SettingsSection[] { }, { label: "About", - items: [], + // The version/license blurb (renderDetail) draws above the bundled + // project docs, in both the preview and the focused states. + items: [ + bundledDocMenuItem("README", "README"), + bundledDocMenuItem("LICENSE", "License"), + bundledDocMenuItem("PRIVACY", "Privacy policy"), + ], renderDetail: renderAbout, }, { @@ -119,7 +129,27 @@ function settingsSections(): SettingsSection[] { ]; } -function renderAbout(args: { image: GrayImage; x: number; y: number; width: number }): void { +/** A row that opens one of the project docs (copied into the bundle under + * about/ by webpack.config.js) in the paged text viewer. */ +function bundledDocMenuItem(fileName: string, label: string): MenuItem { + return { + label, + onSelect: (ctx) => { + ctx.stack.push(new TextViewerLayer(readBundledDoc(fileName), label)); + }, + }; +} + +function readBundledDoc(fileName: string): string { + try { + const text = knownFolders.currentApp().getFile(`about/${fileName}`).readTextSync(); + return text || `(${fileName} is missing from this build)`; + } catch { + return `(${fileName} is missing from this build)`; + } +} + +function renderAbout(args: { image: GrayImage; x: number; y: number; width: number }): number { const { image, x, y, width } = args; const font = getDefaultSmallFont(); const logo = getDashboardLogo(); @@ -128,13 +158,12 @@ function renderAbout(args: { image: GrayImage; x: number; y: number; width: numb } const textX = logo ? x + logo.width + 12 : x; image.drawText(font, textX, y + 8, "Faceclaw", 220); - image.drawText(font, textX, y + 24, "v0.2.0", 170); - image.drawTextWrapped({ - font, - x, - y: y + 64, - width, - text: "By James Babcock. Distributed under the GNU General Public License, version 3.", - value: 170, - }); + image.drawText(font, textX, y + 24, "v0.3.0", 170); + const blurb = "By James Babcock. Distributed under the GNU General Public License, version 3."; + const blurbY = y + Math.max(64, logo ? logo.height + 12 : 0); + const blurbLines = wrapText(font, blurb, width); + for (let i = 0; i < blurbLines.length; i++) { + image.drawText(font, x, blurbY + i * font.lineHeight, blurbLines[i]!, 170); + } + return blurbY - y + blurbLines.length * font.lineHeight + 10; } diff --git a/app/ui/dashboard/settings-panel.ts b/app/ui/dashboard/settings-panel.ts index 9744c36b..45592613 100644 --- a/app/ui/dashboard/settings-panel.ts +++ b/app/ui/dashboard/settings-panel.ts @@ -9,8 +9,10 @@ import { shell } from "../shell/shell"; /** * One left-column entry. `items` are the right-column rows (reusing the shared - * MenuItem builders). `renderDetail`, when set, replaces the row list with - * custom informational content (e.g. About) and makes the pane non-interactive. + * MenuItem builders). `renderDetail`, when set, draws custom informational + * content (e.g. About) at the top of the pane and returns the pixel height it + * consumed; the row list renders below it. Returning nothing claims the whole + * pane (an info-only section). */ export type SettingsSection = { label: string; @@ -22,7 +24,7 @@ export type SettingsSection = { width: number; height: number; ctx: LayerContext; - }) => void; + }) => number | void; }; const PAD = 8; @@ -94,9 +96,12 @@ export class SettingsPanelLayer implements Layer { // Right column: the highlighted section's contents. const rightX = divX + 14; const rightW = width - rightX - PAD; + let rightTop = top; if (section.renderDetail) { - section.renderDetail({ image, x: rightX, y: top, width: rightW, height: listBottom - top, ctx }); - } else if (rightItems.length) { + const used = section.renderDetail({ image, x: rightX, y: top, width: rightW, height: listBottom - top, ctx }); + rightTop = typeof used === "number" ? Math.min(top + used, listBottom) : listBottom; + } + if (rightItems.length && rightTop < listBottom) { // Once focus is in the right column, the bottom of the pane shows the // selected item's extended description (when it has one), with the row // list shrunk to make room. @@ -106,11 +111,11 @@ export class SettingsPanelLayer implements Layer { : []; const descriptionH = descriptionLines.length ? descriptionLines.length * font.lineHeight + 10 : 0; const rightListBottom = listBottom - descriptionH; - const rightRows = Math.max(1, ((rightListBottom - top) / ROW_H) | 0); + const rightRows = Math.max(1, ((rightListBottom - rightTop) / ROW_H) | 0); this.rightScroll = clampScroll(this.rightIndex, this.rightScroll, rightRows, rightItems.length); for (let i = this.rightScroll; i < Math.min(rightItems.length, this.rightScroll + rightRows); i++) { const item = rightItems[i]!; - const rowY = top + (i - this.rightScroll) * ROW_H; + const rowY = rightTop + (i - this.rightScroll) * ROW_H; // A selection only appears once focus is in the right column; before // that the pane is a preview of what tapping would open. const selected = this.focus === "right" && i === this.rightIndex;