forked from Blendman974/faceclaw
EvenHub extensions: Fonts, window icons, touch-start events
This commit is contained in:
1 parent
4ee0af86cc
commit
84baee9c76
25 files changed
+1884
-127
No files matched your search
@@ -261,6 +261,168 @@ tool's `handler` runs in the app when the assistant calls it.
|
||||
|
||||
`void`
|
||||
|
||||
##### addTouchDownListener()
|
||||
|
||||
```ts
|
||||
addTouchDownListener(listener): () => void;
|
||||
```
|
||||
|
||||
Receive touch-downs: the moment a finger touches the ring or the watch's
|
||||
touchpad, before Faceclaw knows whether it will become a tap, a scroll or
|
||||
a hold. The interpreted gesture still arrives afterwards as the usual
|
||||
stock event. Use it where latency matters, as in games.
|
||||
|
||||
Touch-downs arrive only while the app's window has input focus. The
|
||||
glasses' own touchpads don't report them.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| `listener` | (`event`) => `void` | Called on each touch-down. |
|
||||
|
||||
###### Returns
|
||||
|
||||
A function that unsubscribes `listener`.
|
||||
|
||||
() => `void`
|
||||
|
||||
##### addTextInputListener()
|
||||
|
||||
```ts
|
||||
addTextInputListener(listener): () => void;
|
||||
```
|
||||
|
||||
Receive text the user sends to the app. While at least one listener is
|
||||
registered and the app is in the foreground, Faceclaw offers the app as
|
||||
the "Type Into App" destination of its voice dialog, the phone keyboard
|
||||
and the watch.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| `listener` | (`event`) => `void` | Called with each piece of text. |
|
||||
|
||||
###### Returns
|
||||
|
||||
A function that unsubscribes `listener`.
|
||||
|
||||
() => `void`
|
||||
|
||||
##### startVoiceInput()
|
||||
|
||||
```ts
|
||||
startVoiceInput(): Promise<boolean>;
|
||||
```
|
||||
|
||||
Open Faceclaw's voice dialog for this app. When the user sends the
|
||||
dictation with Type Into App, it arrives at the text-input listeners.
|
||||
|
||||
###### Returns
|
||||
|
||||
`Promise`\<`boolean`\>
|
||||
|
||||
A promise that resolves to true if the dialog is opening, or
|
||||
false if it can't open: there is no text-input listener, the app isn't
|
||||
in the foreground, voice input is unavailable, or another dialog is up.
|
||||
|
||||
##### setWindowIcon()
|
||||
|
||||
```ts
|
||||
setWindowIcon(icon): Promise<void>;
|
||||
```
|
||||
|
||||
Replace the app's icon in the app switcher, or pass `null` to go back to
|
||||
the package's icon. See [WindowIconImage](#windowiconimage) for the format.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type |
|
||||
| ------ | ------ |
|
||||
| `icon` | [`WindowIconImage`](#windowiconimage) \| `null` |
|
||||
|
||||
###### Returns
|
||||
|
||||
`Promise`\<`void`\>
|
||||
|
||||
A promise that resolves once the icon is set, and rejects if the
|
||||
image is malformed or larger than 256×256.
|
||||
|
||||
##### setAttention()
|
||||
|
||||
```ts
|
||||
setAttention(attention): void;
|
||||
```
|
||||
|
||||
Show or clear the attention dot on the app's switcher icon, for example
|
||||
when something new arrives while the app is in the background. The dot
|
||||
stays until the app clears it or closes.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type |
|
||||
| ------ | ------ |
|
||||
| `attention` | `boolean` |
|
||||
|
||||
###### Returns
|
||||
|
||||
`void`
|
||||
|
||||
##### setKeepScreenOn()
|
||||
|
||||
```ts
|
||||
setKeepScreenOn(keepOn): void;
|
||||
```
|
||||
|
||||
Stop the glasses display from turning off for inactivity while the app is
|
||||
in the foreground, as a teleprompter or navigation app needs. It has no
|
||||
effect while another window is in front, and the user can still turn the
|
||||
display off. Pass `false` to restore the normal timeout.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type |
|
||||
| ------ | ------ |
|
||||
| `keepOn` | `boolean` |
|
||||
|
||||
###### Returns
|
||||
|
||||
`void`
|
||||
|
||||
##### getFonts()
|
||||
|
||||
```ts
|
||||
getFonts(): Promise<FaceclawFontFamily[]>;
|
||||
```
|
||||
|
||||
List the font families available for [FaceclawFont.family](#property-family),
|
||||
including any the user has installed.
|
||||
|
||||
###### Returns
|
||||
|
||||
`Promise`\<[`FaceclawFontFamily`](#faceclawfontfamily)[]\>
|
||||
|
||||
##### measureText()
|
||||
|
||||
```ts
|
||||
measureText(text, font?): Promise<TextMeasurement>;
|
||||
```
|
||||
|
||||
Measure text as a container with this font would draw it, for example to
|
||||
size a text container or centre a label.
|
||||
|
||||
###### Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| `text` | `string` | The text. Lines split at `\n` are measured separately. |
|
||||
| `font?` | [`FaceclawFont`](#faceclawfont) | The font to measure in. Unlike a container's font, it isn't combined with a layout default. Omit it to measure in the stock font. |
|
||||
|
||||
###### Returns
|
||||
|
||||
`Promise`\<[`TextMeasurement`](#textmeasurement)\>
|
||||
|
||||
***
|
||||
|
||||
### getFaceclawExtensions()
|
||||
@@ -278,7 +440,7 @@ script runs.
|
||||
|
||||
[`FaceclawExtensions`](#faceclawextensions) \| `null`
|
||||
|
||||
## Window lifecycle
|
||||
## Window
|
||||
|
||||
### WindowLifecycleEventType
|
||||
|
||||
@@ -312,51 +474,107 @@ Payload of a [FaceclawExtensions.addWindowLifecycleListener](#addwindowlifecycle
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-type"></a> `type` | [`WindowLifecycleEventType`](#windowlifecycleeventtype) | Which transition happened. |
|
||||
|
||||
## API keys
|
||||
***
|
||||
|
||||
### ApiKeyService
|
||||
### WindowIconImage
|
||||
|
||||
```ts
|
||||
type ApiKeyService = "openai" | "anthropic" | "soniox" | "elevenlabs" | "mapbox";
|
||||
```
|
||||
An image for [FaceclawExtensions.setWindowIcon](#setwindowicon). An `ImageData` (from
|
||||
a canvas's `getImageData`) fits this shape and can be passed directly.
|
||||
|
||||
Third-party services whose API keys the user may have configured in Faceclaw.
|
||||
|
||||
## Buzzer
|
||||
|
||||
### BuzzerStep
|
||||
|
||||
One step of a piezo-buzzer tone sequence. The G2 has a single monophonic PWM
|
||||
buzzer, and the firmware plays a sequence's steps back to back on its own timer.
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Default value | Description |
|
||||
| ------ | ------ | ------ | ------ |
|
||||
| <a id="property-freq"></a> `freq` | `number` | `undefined` | Tone frequency in Hz. The piezo is loudest around 1–4 kHz and faint below about 150 Hz. |
|
||||
| <a id="property-ms"></a> `ms` | `number` | `undefined` | Step duration in milliseconds (1–65535). |
|
||||
| <a id="property-duty"></a> `duty?` | `number` | `50` | PWM duty cycle, 0–100. Use `duty: 0` for a rest (silence) lasting `ms`. |
|
||||
|
||||
## Compass
|
||||
|
||||
### CompassReading
|
||||
|
||||
A magnetometer heading sample from [FaceclawExtensions.addCompassListener](#addcompasslistener).
|
||||
All headings are in degrees clockwise, in the range [0, 360).
|
||||
|
||||
Prefer `trueHeadingDegrees` when it is present, then `magneticHeadingDegrees`.
|
||||
If `wearerCalibrated` is false, treat both as relative headings, or let the
|
||||
user zero them.
|
||||
Draw it like Faceclaw's own icons: light strokes on black. Brightness is
|
||||
coverage, so black is transparent, and Faceclaw inverts the icon for the
|
||||
selected window. The switcher draws icons at about 32×32; larger images are
|
||||
scaled down to fit, keeping their aspect ratio.
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-headingdegrees"></a> `headingDegrees` | `number` | Raw magnetic heading as reported by the glasses, with no correction for how they sit on the wearer's head. It is kept for apps that zero it themselves. |
|
||||
| <a id="property-magneticheadingdegrees"></a> `magneticHeadingDegrees` | `number` | Magnetic heading corrected by the wearer's calibration offset from Faceclaw's Compass app. Equal to `headingDegrees` until the wearer calibrates. |
|
||||
| <a id="property-wearercalibrated"></a> `wearerCalibrated` | `boolean` | Whether the wearer has calibrated the compass in Faceclaw's Compass app. Only trust `magneticHeadingDegrees` and `trueHeadingDegrees` as absolute headings when this is true. |
|
||||
| <a id="property-declinationdegrees"></a> `declinationDegrees?` | `number` | Local magnetic declination in degrees (east positive), computed from the phone's location and the World Magnetic Model. Absent when Faceclaw has no location fix or no location permission. |
|
||||
| <a id="property-trueheadingdegrees"></a> `trueHeadingDegrees?` | `number` | `magneticHeadingDegrees` plus declination. Absent when `declinationDegrees` is. |
|
||||
| <a id="property-width"></a> `width` | `number` | Width in pixels, 1–256. |
|
||||
| <a id="property-height"></a> `height` | `number` | Height in pixels, 1–256. |
|
||||
| <a id="property-data"></a> `data` | `ArrayLike`\<`number`\> | Pixels in rows from the top left: either `width * height` grayscale values (0–255), or `width * height * 4` RGBA values, which Faceclaw converts to grayscale (luminance times alpha). |
|
||||
|
||||
## Input
|
||||
|
||||
### InputSource
|
||||
|
||||
```ts
|
||||
type InputSource = "ring" | "left-touchpad" | "right-touchpad" | "watch";
|
||||
```
|
||||
|
||||
The device an input came from:
|
||||
|
||||
- `ring`: the Even R1 ring (or the ring pad in Faceclaw's phone app).
|
||||
- `left-touchpad` / `right-touchpad`: the touch areas on the glasses' arms.
|
||||
- `watch`: Faceclaw's Wear OS watch remote (or the watch pad in Faceclaw's
|
||||
phone app).
|
||||
|
||||
***
|
||||
|
||||
### TouchDownEvent
|
||||
|
||||
A touch-down, from [FaceclawExtensions.addTouchDownListener](#addtouchdownlistener).
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-source"></a> `source` | [`InputSource`](#inputsource) | Which device was touched. Currently always `ring` or `watch`: the glasses' touchpads don't report touch-down. |
|
||||
| <a id="property-timestampms"></a> `timestampMs` | `number` | When Faceclaw received the touch, in milliseconds since the epoch (comparable with `Date.now()`). |
|
||||
|
||||
***
|
||||
|
||||
### getInputSource()
|
||||
|
||||
```ts
|
||||
function getInputSource(event): InputSource | null;
|
||||
```
|
||||
|
||||
Which device produced a stock EvenHub gesture event, or `null` if Faceclaw
|
||||
didn't say.
|
||||
|
||||
The stock `eventSource` field only knows the stock devices, so Faceclaw
|
||||
reports the watch there as the ring. Faceclaw adds the real device to the
|
||||
event's raw JSON as `faceclawInputSource`, and this function reads it. Pass
|
||||
the event object your `onEvenHubEvent` handler receives.
|
||||
|
||||
Faceclaw adds the field to clicks, double-clicks, long-presses and their
|
||||
releases, and scrolls, in both `sysEvent` and `listEvent`. It is missing when
|
||||
the glasses don't report a scroll's source, on non-gesture events, and in
|
||||
every other host.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Parameter | Type |
|
||||
| ------ | ------ |
|
||||
| `event` | \| \{ `jsonData?`: `Record`\<`string`, `unknown`\>; \} \| `null` \| `undefined` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`InputSource`](#inputsource) \| `null`
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
bridge.onEvenHubEvent((event) => {
|
||||
if (event.sysEvent && getInputSource(event) === "watch") {
|
||||
// ...
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## Text input
|
||||
|
||||
### TextInputEvent
|
||||
|
||||
Text sent to the app, from [FaceclawExtensions.addTextInputListener](#addtextinputlistener).
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-text"></a> `text` | `string` | The finished text: a whole dictation, or a typed entry. |
|
||||
| <a id="property-submit"></a> `submit?` | `boolean` | Present when the sender said whether to submit the text (`true`, like pressing Enter after it) or only insert it (`false`). Faceclaw's remote-input tool sets it; dictation and the phone keyboard leave it out. |
|
||||
|
||||
## Extended layout
|
||||
|
||||
@@ -383,8 +601,8 @@ classes can be passed directly. In practice you should set `containerID`,
|
||||
| <a id="property-containername"></a> `containerName?` | `string` | Container name. `preserve` matches containers across layouts by name. |
|
||||
| <a id="property-xposition"></a> `xPosition?` | `number` | Left edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-yposition"></a> `yPosition?` | `number` | Top edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-width"></a> `width?` | `number` | Width in pixels. |
|
||||
| <a id="property-height"></a> `height?` | `number` | Height in pixels. |
|
||||
| <a id="property-width-2"></a> `width?` | `number` | Width in pixels. |
|
||||
| <a id="property-height-1"></a> `height?` | `number` | Height in pixels. |
|
||||
| <a id="property-zorderindex"></a> `zOrderIndex?` | `number` | Stacking order: higher values draw on top. |
|
||||
| <a id="property-iseventcapture"></a> `isEventCapture?` | `number` \| `boolean` | When set to `1`/`true`, this container receives the app's tap and scroll events. Exactly one text or list container per layout should capture events. |
|
||||
| <a id="property-preserve"></a> `preserve?` | `boolean` | When true, inherit content (text, image pixels, or list items and selection) from the container of the same kind and `containerName` in the previous layout. Otherwise the container starts blank. |
|
||||
@@ -407,8 +625,8 @@ A text container. The fields match the stock SDK's `TextContainerProperty`, plus
|
||||
| <a id="property-containername-1"></a> `containerName?` | `string` | `undefined` | Container name. `preserve` matches containers across layouts by name. |
|
||||
| <a id="property-xposition-1"></a> `xPosition?` | `number` | `undefined` | Left edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-yposition-1"></a> `yPosition?` | `number` | `undefined` | Top edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-width-1"></a> `width?` | `number` | `undefined` | Width in pixels. |
|
||||
| <a id="property-height-1"></a> `height?` | `number` | `undefined` | Height in pixels. |
|
||||
| <a id="property-width-3"></a> `width?` | `number` | `undefined` | Width in pixels. |
|
||||
| <a id="property-height-2"></a> `height?` | `number` | `undefined` | Height in pixels. |
|
||||
| <a id="property-zorderindex-1"></a> `zOrderIndex?` | `number` | `undefined` | Stacking order: higher values draw on top. |
|
||||
| <a id="property-iseventcapture-1"></a> `isEventCapture?` | `number` \| `boolean` | `undefined` | When set to `1`/`true`, this container receives the app's tap and scroll events. Exactly one text or list container per layout should capture events. |
|
||||
| <a id="property-preserve-1"></a> `preserve?` | `boolean` | `undefined` | When true, inherit content (text, image pixels, or list items and selection) from the container of the same kind and `containerName` in the previous layout. Otherwise the container starts blank. |
|
||||
@@ -418,6 +636,7 @@ A text container. The fields match the stock SDK's `TextContainerProperty`, plus
|
||||
| <a id="property-bordercolor"></a> `borderColor?` | `number` | `undefined` | Accepted for compatibility with stock payloads. Faceclaw currently ignores it. |
|
||||
| <a id="property-borderradius"></a> `borderRadius?` | `number` | `undefined` | Border corner radius in pixels. |
|
||||
| <a id="property-paddinglength"></a> `paddingLength?` | `number` | `undefined` | Padding between the border and the text, in pixels. |
|
||||
| <a id="property-font"></a> `font?` | [`FaceclawFont`](#faceclawfont) | `undefined` | The text's font. Its fields override the layout's [FaceclawLayout.font](#property-font-2) one by one. With neither, the text is in the stock firmware font. |
|
||||
|
||||
***
|
||||
|
||||
@@ -469,8 +688,8 @@ A list container. The fields match the stock SDK's `ListContainerProperty`, plus
|
||||
| <a id="property-containername-2"></a> `containerName?` | `string` | Container name. `preserve` matches containers across layouts by name. |
|
||||
| <a id="property-xposition-2"></a> `xPosition?` | `number` | Left edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-yposition-2"></a> `yPosition?` | `number` | Top edge in pixels on the 576×452 canvas. |
|
||||
| <a id="property-width-2"></a> `width?` | `number` | Width in pixels. |
|
||||
| <a id="property-height-2"></a> `height?` | `number` | Height in pixels. |
|
||||
| <a id="property-width-4"></a> `width?` | `number` | Width in pixels. |
|
||||
| <a id="property-height-3"></a> `height?` | `number` | Height in pixels. |
|
||||
| <a id="property-zorderindex-2"></a> `zOrderIndex?` | `number` | Stacking order: higher values draw on top. |
|
||||
| <a id="property-iseventcapture-2"></a> `isEventCapture?` | `number` \| `boolean` | When set to `1`/`true`, this container receives the app's tap and scroll events. Exactly one text or list container per layout should capture events. |
|
||||
| <a id="property-preserve-2"></a> `preserve?` | `boolean` | When true, inherit content (text, image pixels, or list items and selection) from the container of the same kind and `containerName` in the previous layout. Otherwise the container starts blank. |
|
||||
@@ -479,6 +698,7 @@ A list container. The fields match the stock SDK's `ListContainerProperty`, plus
|
||||
| <a id="property-bordercolor-1"></a> `borderColor?` | `number` | Accepted for compatibility with stock payloads. Faceclaw currently ignores it. |
|
||||
| <a id="property-borderradius-1"></a> `borderRadius?` | `number` | Border corner radius in pixels. |
|
||||
| <a id="property-paddinglength-1"></a> `paddingLength?` | `number` | Padding between the border and the items, in pixels. |
|
||||
| <a id="property-font-1"></a> `font?` | [`FaceclawFont`](#faceclawfont) | The items' font. Its fields override the layout's [FaceclawLayout.font](#property-font-2) one by one. With neither, the items are in the stock firmware font. Each row is the font's line height plus 12 pixels. |
|
||||
|
||||
***
|
||||
|
||||
@@ -512,6 +732,8 @@ classes, with three differences:
|
||||
- Each container may set `preserve: true` to inherit its content from the
|
||||
same-named container in the previous layout.
|
||||
|
||||
Text and list containers can also use other fonts (see [FaceclawFont](#faceclawfont)).
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
@@ -521,6 +743,110 @@ classes, with three differences:
|
||||
| <a id="property-listobject"></a> `listObject?` | [`FaceclawListContainer`](#faceclawlistcontainer)[] | List containers. |
|
||||
| <a id="property-menuobject"></a> `menuObject?` | [`FaceclawMenu`](#faceclawmenu) | The page's contextual menu. Omit it to clear any previous menu. |
|
||||
| <a id="property-containertotalnum"></a> `containerTotalNum?` | `number` | Accepted for compatibility with stock payloads and ignored: there is no container limit. |
|
||||
| <a id="property-font-2"></a> `font?` | [`FaceclawFont`](#faceclawfont) | The default font for every text and list container in the layout. |
|
||||
|
||||
## Fonts
|
||||
|
||||
### FaceclawFont
|
||||
|
||||
A font for text and list containers in an extended layout, from
|
||||
[FaceclawLayout.font](#property-font-2) and the containers' own `font`. A container
|
||||
that has no font, and whose layout has none, uses the stock firmware font.
|
||||
|
||||
Available families (see [FaceclawExtensions.getFonts](#getfonts)):
|
||||
|
||||
- `Roboto`, `Inter`, `Montserrat` and `Roboto Mono`: bundled TrueType
|
||||
fonts in weights 300, 400 and 700, at any size.
|
||||
- `Terminus`: a monospace bitmap font, in sizes 12, 14, 16, 18, 20, 22, 24,
|
||||
28 and 32, and weights 400 and 700.
|
||||
- `EvenHub`: the stock firmware font, 20px only. Use it to bring back the
|
||||
stock font for one container when the layout sets another.
|
||||
- Any font the user has installed in Faceclaw.
|
||||
|
||||
Text in the stock font wraps exactly as on the stock firmware. Text in
|
||||
other fonts wraps with Faceclaw's own line breaking.
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Default value | Description |
|
||||
| ------ | ------ | ------ | ------ |
|
||||
| <a id="property-family"></a> `family?` | `string` | `"Roboto"` | Font family, matched without regard to case, spaces or punctuation. An unknown family falls back to Roboto. |
|
||||
| <a id="property-size"></a> `size?` | `number` | `20` | Size in pixels: the em size, as in CSS `font-size`. A line is somewhat taller; [FaceclawExtensions.measureText](#measuretext) reports its height. 6–128. Bitmap families use their nearest size. |
|
||||
| <a id="property-weight"></a> `weight?` | `number` \| `"normal"` \| `"bold"` | `400` | Weight, 100–900, where `"normal"` is 400 and `"bold"` is 700. The nearest weight the family has is used, as CSS chooses it. |
|
||||
|
||||
***
|
||||
|
||||
### FaceclawFontFamily
|
||||
|
||||
A font family Faceclaw can draw, from [FaceclawExtensions.getFonts](#getfonts).
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-family-1"></a> `family` | `string` | The name to use as [FaceclawFont.family](#property-family). |
|
||||
| <a id="property-weights"></a> `weights` | `number`[] | The weights the family has, lightest first. |
|
||||
| <a id="property-sizes"></a> `sizes?` | `number`[] | For a bitmap family, the sizes it has. Absent for a scalable family, which takes any size. |
|
||||
| <a id="property-monospace"></a> `monospace` | `boolean` | Whether every character has the same width. |
|
||||
|
||||
***
|
||||
|
||||
### TextMeasurement
|
||||
|
||||
The size of some text, from [FaceclawExtensions.measureText](#measuretext).
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-width-1"></a> `width` | `number` | Width in pixels of the widest line (lines are split at `\n`). |
|
||||
| <a id="property-lineheight"></a> `lineHeight` | `number` | Height in pixels of one line. A text container advances by this much per line. |
|
||||
|
||||
## API keys
|
||||
|
||||
### ApiKeyService
|
||||
|
||||
```ts
|
||||
type ApiKeyService = "openai" | "anthropic" | "soniox" | "elevenlabs" | "mapbox";
|
||||
```
|
||||
|
||||
Third-party services whose API keys the user may have configured in Faceclaw.
|
||||
|
||||
## Buzzer
|
||||
|
||||
### BuzzerStep
|
||||
|
||||
One step of a piezo-buzzer tone sequence. The G2 has a single monophonic PWM
|
||||
buzzer, and the firmware plays a sequence's steps back to back on its own timer.
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Default value | Description |
|
||||
| ------ | ------ | ------ | ------ |
|
||||
| <a id="property-freq"></a> `freq` | `number` | `undefined` | Tone frequency in Hz. The piezo is loudest around 1–4 kHz and faint below about 150 Hz. |
|
||||
| <a id="property-ms"></a> `ms` | `number` | `undefined` | Step duration in milliseconds (1–65535). |
|
||||
| <a id="property-duty"></a> `duty?` | `number` | `50` | PWM duty cycle, 0–100. Use `duty: 0` for a rest (silence) lasting `ms`. |
|
||||
|
||||
## Compass
|
||||
|
||||
### CompassReading
|
||||
|
||||
A magnetometer heading sample from [FaceclawExtensions.addCompassListener](#addcompasslistener).
|
||||
All headings are in degrees clockwise, in the range [0, 360).
|
||||
|
||||
Prefer `trueHeadingDegrees` when it is present, then `magneticHeadingDegrees`.
|
||||
If `wearerCalibrated` is false, treat both as relative headings, or let the
|
||||
user zero them.
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------ | ------ | ------ |
|
||||
| <a id="property-headingdegrees"></a> `headingDegrees` | `number` | Raw magnetic heading as reported by the glasses, with no correction for how they sit on the wearer's head. It is kept for apps that zero it themselves. |
|
||||
| <a id="property-magneticheadingdegrees"></a> `magneticHeadingDegrees` | `number` | Magnetic heading corrected by the wearer's calibration offset from Faceclaw's Compass app. Equal to `headingDegrees` until the wearer calibrates. |
|
||||
| <a id="property-wearercalibrated"></a> `wearerCalibrated` | `boolean` | Whether the wearer has calibrated the compass in Faceclaw's Compass app. Only trust `magneticHeadingDegrees` and `trueHeadingDegrees` as absolute headings when this is true. |
|
||||
| <a id="property-declinationdegrees"></a> `declinationDegrees?` | `number` | Local magnetic declination in degrees (east positive), computed from the phone's location and the World Magnetic Model. Absent when Faceclaw has no location fix or no location permission. |
|
||||
| <a id="property-trueheadingdegrees"></a> `trueHeadingDegrees?` | `number` | `magneticHeadingDegrees` plus declination. Absent when `declinationDegrees` is. |
|
||||
|
||||
## Assistant tools
|
||||
|
||||
|
||||
Reference in new issue
Block a user