yoto-nodejs-client 0.0.1 → 0.0.2

package/lib/mqtt/client.d.ts

@@ -1,4 +1,23 @@
+/**
+ * Yoto MQTT Client class
+ * @extends EventEmitter
+ *
+ * @fires YotoMqttClient#events
+ * @fires YotoMqttClient#status
+ * @fires YotoMqttClient#response
+ * @fires YotoMqttClient#connected
+ * @fires YotoMqttClient#disconnected
+ * @fires YotoMqttClient#reconnecting
+ * @fires YotoMqttClient#error
+ */
 export class YotoMqttClient extends EventEmitter<any> {
+    /**
+     * Create a Yoto MQTT client
+     * @param {MqttClient} mqttClient - Underlying MQTT client
+     * @param {string} deviceId - Device ID
+     * @param {Object} [options] - Client options
+     * @param {boolean} [options.autoSubscribe=true] - Auto-subscribe to device topics on connect
+     */
     constructor(mqttClient: MqttClient, deviceId: string, options?: {
         autoSubscribe?: boolean | undefined;
     });
@@ -16,17 +35,78 @@ export class YotoMqttClient extends EventEmitter<any> {
         bluetoothAudioSource: typeof import("./commands.js").createBluetoothAudioSourceCommand;
         displayPreview: typeof import("./commands.js").createDisplayPreviewCommand;
     };
+    /**
+     * Get current connection state
+     * @returns {YotoMqttConnectionState}
+     */
     get state(): YotoMqttConnectionState;
+    /**
+     * Check if client is connected
+     * @returns {boolean}
+     */
     get connected(): boolean;
+    /**
+     * Connect to MQTT broker
+     * @returns {Promise<void>}
+     */
     connect(): Promise<void>;
+    /**
+     * Disconnect from MQTT broker
+     * @returns {Promise<void>}
+     */
     disconnect(): Promise<void>;
+    /**
+     * Request current events from device
+     * @returns {Promise<void>}
+     */
     requestEvents(): Promise<void>;
+    /**
+     * Request current status from device
+     * @returns {Promise<void>}
+     */
     requestStatus(): Promise<void>;
+    /**
+     * Set device volume
+     * @param {number} volume - Volume level [0-100]
+     * @returns {Promise<void>}
+     */
     setVolume(volume: number): Promise<void>;
+    /**
+     * Set ambient light color
+     * @param {number} r - Red intensity [0-255]
+     * @param {number} g - Green intensity [0-255]
+     * @param {number} b - Blue intensity [0-255]
+     * @returns {Promise<void>}
+     */
     setAmbient(r: number, g: number, b: number): Promise<void>;
+    /**
+     * Set ambient light color from hex
+     * @param {string} hexColor - Hex color string (e.g., "#FF0000")
+     * @returns {Promise<void>}
+     */
     setAmbientHex(hexColor: string): Promise<void>;
+    /**
+     * Set sleep timer
+     * @param {number} seconds - Timer duration in seconds (0 to disable)
+     * @returns {Promise<void>}
+     */
     setSleepTimer(seconds: number): Promise<void>;
+    /**
+     * Reboot device
+     * @returns {Promise<void>}
+     */
     reboot(): Promise<void>;
+    /**
+     * Start card playback
+     * @param {Object} options - Card start options
+     * @param {string} options.uri - Card URI (e.g., "https://yoto.io/<cardID>")
+     * @param {string} [options.chapterKey] - Chapter to start from
+     * @param {string} [options.trackKey] - Track to start from
+     * @param {number} [options.secondsIn] - Playback start offset in seconds
+     * @param {number} [options.cutOff] - Playback stop offset in seconds
+     * @param {boolean} [options.anyButtonStop] - Whether button press stops playback
+     * @returns {Promise<void>}
+     */
     startCard(options: {
         uri: string;
         chapterKey?: string | undefined;
@@ -35,9 +115,31 @@ export class YotoMqttClient extends EventEmitter<any> {
         cutOff?: number | undefined;
         anyButtonStop?: boolean | undefined;
     }): Promise<void>;
+    /**
+     * Stop card playback
+     * @returns {Promise<void>}
+     */
     stopCard(): Promise<void>;
+    /**
+     * Pause card playback
+     * @returns {Promise<void>}
+     */
     pauseCard(): Promise<void>;
+    /**
+     * Resume card playback
+     * @returns {Promise<void>}
+     */
     resumeCard(): Promise<void>;
+    /**
+     * Turn Bluetooth on
+     * @param {Object} [options] - Bluetooth options
+     * @param {string} [options.action] - Bluetooth action
+     * @param {boolean | string} [options.mode] - Bluetooth mode
+     * @param {number} [options.rssi] - RSSI threshold
+     * @param {string} [options.name] - Target device name
+     * @param {string} [options.mac] - Target device MAC
+     * @returns {Promise<void>}
+     */
     bluetoothOn(options?: {
         action?: string | undefined;
         mode?: string | boolean | undefined;
@@ -45,13 +147,49 @@ export class YotoMqttClient extends EventEmitter<any> {
         name?: string | undefined;
         mac?: string | undefined;
     }): Promise<void>;
+    /**
+     * Turn Bluetooth off
+     * @returns {Promise<void>}
+     */
     bluetoothOff(): Promise<void>;
+    /**
+     * Enable Bluetooth speaker mode
+     * @returns {Promise<void>}
+     */
     bluetoothSpeakerMode(): Promise<void>;
+    /**
+     * Enable Bluetooth audio source mode
+     * @returns {Promise<void>}
+     */
     bluetoothAudioSourceMode(): Promise<void>;
+    /**
+     * Delete all Bluetooth bonds
+     * @returns {Promise<void>}
+     */
     bluetoothDeleteBonds(): Promise<void>;
+    /**
+     * Connect to Bluetooth device
+     * @returns {Promise<void>}
+     */
     bluetoothConnect(): Promise<void>;
+    /**
+     * Disconnect Bluetooth device
+     * @returns {Promise<void>}
+     */
     bluetoothDisconnect(): Promise<void>;
+    /**
+     * Get Bluetooth state
+     * @returns {Promise<void>}
+     */
     bluetoothGetState(): Promise<void>;
+    /**
+     * Preview display icon
+     * @param {Object} options - Display preview options
+     * @param {string} options.uri - Icon URI
+     * @param {number} options.timeout - Display duration in seconds
+     * @param {boolean} options.animated - Whether icon is animated
+     * @returns {Promise<void>}
+     */
     displayPreview(options: {
         uri: string;
         timeout: number;
@@ -59,52 +197,188 @@ export class YotoMqttClient extends EventEmitter<any> {
     }): Promise<void>;
     #private;
 }
+/**
+ * Events message from device
+ * Note: Messages are partial - only changed fields are included
+ */
 export type YotoEventsMessage = {
+    /**
+     * - Repeat all tracks
+     */
     repeatAll?: boolean;
+    /**
+     * - Whether streaming
+     */
     streaming?: boolean;
+    /**
+     * - Current volume level
+     */
     volume?: number;
+    /**
+     * - Maximum volume level
+     */
     volumeMax?: number;
+    /**
+     * - Playback waiting
+     */
     playbackWait?: boolean;
+    /**
+     * - Sleep timer active
+     */
     sleepTimerActive?: boolean;
+    /**
+     * - Unix timestamp
+     */
     eventUtc?: number;
+    /**
+     * - Track duration in seconds
+     */
     trackLength?: number;
+    /**
+     * - Current position in seconds
+     */
     position?: number;
+    /**
+     * - Currently playing card ID
+     */
     cardId?: string;
+    /**
+     * - Source of playback (e.g., "card", "remote", "MQTT")
+     */
     source?: string;
+    /**
+     * - ISO8601 format timestamp
+     */
     cardUpdatedAt?: string;
+    /**
+     * - Current chapter title
+     */
     chapterTitle?: string;
+    /**
+     * - Current chapter key
+     */
     chapterKey?: string;
+    /**
+     * - Current track title
+     */
     trackTitle?: string;
+    /**
+     * - Current track key
+     */
     trackKey?: string;
+    /**
+     * - Playback status (e.g., "playing", "paused", "stopped")
+     */
     playbackStatus?: string;
+    /**
+     * - Seconds remaining on sleep timer
+     */
     sleepTimerSeconds?: number;
 };
+/**
+ * Status message from device
+ */
 export type YotoStatusMessage = {
+    /**
+     * - Status message version
+     */
     statusVersion: number;
+    /**
+     * - Firmware version
+     */
     fwVersion: string;
+    /**
+     * - Product type identifier
+     */
     productType: string;
+    /**
+     * - Battery level percentage
+     */
     batteryLevel: number;
+    /**
+     * - Ambient light sensor reading
+     */
     als: number;
+    /**
+     * - Free disk space
+     */
     freeDisk: number;
+    /**
+     * - Shutdown timeout in seconds
+     */
     shutdownTimeout: number;
+    /**
+     * - DBAT timeout
+     */
     dbatTimeout: number;
+    /**
+     * - Charging state (0 or 1)
+     */
     charging: number;
+    /**
+     * - Active card ID
+     */
     activeCard: string;
+    /**
+     * - Card insertion state
+     */
     cardInserted: number;
+    /**
+     * - Playing status code
+     */
     playingStatus: number;
+    /**
+     * - Headphones connected
+     */
     headphones: boolean;
+    /**
+     * - Current display brightness
+     */
     dnowBrightness: number;
+    /**
+     * - Day brightness setting
+     */
     dayBright: number;
+    /**
+     * - Night brightness setting
+     */
     nightBright: number;
+    /**
+     * - Bluetooth headphones enabled
+     */
     bluetoothHp: boolean;
+    /**
+     * - Current volume
+     */
     volume: number;
+    /**
+     * - User volume setting
+     */
     userVolume: number;
+    /**
+     * - Time format preference
+     */
     timeFormat: "12" | "24";
+    /**
+     * - Nightlight mode setting
+     */
     nightlightMode: string;
+    /**
+     * - Temperature reading
+     */
     temp: string;
+    /**
+     * - Day mode (0 or 1)
+     */
     day: number;
 };
+/**
+ * Response message from device
+ */
 export type YotoResponseMessage = {
+    /**
+     * - Status object with dynamic resource keys
+     */
     status: {
         volume?: "OK" | "FAIL" | undefined;
         ambients?: "OK" | "FAIL" | undefined;
@@ -118,6 +392,9 @@ export type YotoResponseMessage = {
         sleepTimer: "OK" | "FAIL";
     };
 };
+/**
+ * MQTT connection state
+ */
 export type YotoMqttConnectionState = "disconnected" | "connected" | "reconnecting";
 import { EventEmitter } from 'events';
 import type { MqttClient } from 'mqtt';

package/lib/mqtt/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["client.js"],"names":[],"mappings":"AAgIA;IAQE,wBALW,UAAU,YACV,MAAM,YAEd;QAA0B,aAAa;KACzC,EAaA;IATC,uBAA4B;IAC5B,iBAAwB;IACxB,uBAAoD;IAMpD;;;;;;;;;;MAAwB;IAO1B,aAFa,uBAAuB,CAMnC;IAMD,iBAFa,OAAO,CAInB;IA2GD,WAFa,OAAO,CAAC,IAAI,CAAC,CA8BzB;IAMD,cAFa,OAAO,CAAC,IAAI,CAAC,CAiBzB;IA4BD,iBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,iBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAOD,kBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IASD,cALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAOD,wBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAOD,uBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAMD,UAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAaD,mBARG;QAAwB,GAAG,EAAnB,MAAM;QACW,UAAU;QACV,QAAQ;QACR,SAAS;QACT,MAAM;QACL,aAAa;KACvC,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;IAMD,YAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,aAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,cAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAYD,sBAPG;QAAyB,MAAM;QACI,IAAI;QACd,IAAI;QACJ,IAAI;QACJ,GAAG;KAC5B,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;IAMD,gBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,wBAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAMD,4BAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAMD,wBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,oBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,uBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAMD,qBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAUD,wBALG;QAAwB,GAAG,EAAnB,MAAM;QACU,OAAO,EAAvB,MAAM;QACW,QAAQ,EAAzB,OAAO;KACf,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;;CACF;;gBAzhBa,OAAO;gBACP,OAAO;aACP,MAAM;gBACN,MAAM;mBACN,OAAO;uBACP,OAAO;eACP,MAAM;kBACN,MAAM;eACN,MAAM;aACN,MAAM;aACN,MAAM;oBACN,MAAM;mBACN,MAAM;iBACN,MAAM;iBACN,MAAM;eACN,MAAM;qBACN,MAAM;wBACN,MAAM;;;mBAON,MAAM;eACN,MAAM;iBACN,MAAM;kBACN,MAAM;SACN,MAAM;cACN,MAAM;qBACN,MAAM;iBACN,MAAM;cACN,MAAM;gBACN,MAAM;kBACN,MAAM;mBACN,MAAM;gBACN,OAAO;oBACP,MAAM;eACN,MAAM;iBACN,MAAM;iBACN,OAAO;YACP,MAAM;gBACN,MAAM;gBACN,IAAI,GAAG,IAAI;oBACX,MAAM;UACN,MAAM;SACN,MAAM;;;YAQjB;QAAkC,MAAM;QACN,QAAQ;QACR,IAAI;QACJ,MAAM;QACN,MAAM;QACN,SAAS;QACT,OAAO;QACP,MAAM;QACd,QAAQ,EAAvB,MAAM;QACgB,UAAU,EAAhC,IAAI,GAAG,MAAM;KAE1B;;sCAIY,cAAc,GAAG,WAAW,GAAG,cAAc;6BAG7B,QAAQ;gCAhFN,MAAM"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["client.js"],"names":[],"mappings":"AAoHA;;;;;;;;;;;GAWG;AACH;IACE;;;;;;OAMG;IACH,wBALW,UAAU,YACV,MAAM,YAEd;QAA0B,aAAa;KACzC,EAaA;IATC,uBAA4B;IAC5B,iBAAwB;IACxB,uBAAoD;IAMpD;;;;;;;;;;MAAwB;IAG1B;;;OAGG;IACH,aAFa,uBAAuB,CAMnC;IAED;;;OAGG;IACH,iBAFa,OAAO,CAInB;IAuGD;;;OAGG;IACH,WAFa,OAAO,CAAC,IAAI,CAAC,CA8BzB;IAED;;;OAGG;IACH,cAFa,OAAO,CAAC,IAAI,CAAC,CAiBzB;IAwBD;;;OAGG;IACH,iBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,iBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;;;OAMG;IACH,cALW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,wBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;;OAIG;IACH,uBAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,UAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;;;;;;;;OAUG;IACH,mBARG;QAAwB,GAAG,EAAnB,MAAM;QACW,UAAU;QACV,QAAQ;QACR,SAAS;QACT,MAAM;QACL,aAAa;KACvC,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,YAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,aAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,cAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;;;;;;;OASG;IACH,sBAPG;QAAyB,MAAM;QACI,IAAI;QACd,IAAI;QACJ,IAAI;QACJ,GAAG;KAC5B,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,gBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,wBAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,4BAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,wBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,uBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,qBAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;;;;;OAOG;IACH,wBALG;QAAwB,GAAG,EAAnB,MAAM;QACU,OAAO,EAAvB,MAAM;QACW,QAAQ,EAAzB,OAAO;KACf,GAAU,OAAO,CAAC,IAAI,CAAC,CAMzB;;CACF;;;;;;;;;gBAzhBa,OAAO;;;;gBACP,OAAO;;;;aACP,MAAM;;;;gBACN,MAAM;;;;mBACN,OAAO;;;;uBACP,OAAO;;;;eACP,MAAM;;;;kBACN,MAAM;;;;eACN,MAAM;;;;aACN,MAAM;;;;aACN,MAAM;;;;oBACN,MAAM;;;;mBACN,MAAM;;;;iBACN,MAAM;;;;iBACN,MAAM;;;;eACN,MAAM;;;;qBACN,MAAM;;;;wBACN,MAAM;;;;;;;;;mBAON,MAAM;;;;eACN,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;;;;SACN,MAAM;;;;cACN,MAAM;;;;qBACN,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;gBACN,MAAM;;;;kBACN,MAAM;;;;mBACN,MAAM;;;;gBACN,OAAO;;;;oBACP,MAAM;;;;eACN,MAAM;;;;iBACN,MAAM;;;;iBACN,OAAO;;;;YACP,MAAM;;;;gBACN,MAAM;;;;gBACN,IAAI,GAAG,IAAI;;;;oBACX,MAAM;;;;UACN,MAAM;;;;SACN,MAAM;;;;;;;;;YAQjB;QAAkC,MAAM;QACN,QAAQ;QACR,IAAI;QACJ,MAAM;QACN,MAAM;QACN,SAAS;QACT,OAAO;QACP,MAAM;QACd,QAAQ,EAAvB,MAAM;QACgB,UAAU,EAAhC,IAAI,GAAG,MAAM;KAE1B;;;;;sCAIY,cAAc,GAAG,WAAW,GAAG,cAAc;6BAG7B,QAAQ;gCAhFN,MAAM"}

package/lib/mqtt/commands.d.ts

@@ -1,7 +1,100 @@
+/**
+ * MQTT Command Builders for Yoto Players
+ *
+ * Type-safe builders for constructing MQTT command payloads
+ * @see https://yoto.dev/players-mqtt/
+ */
+/**
+ * Volume command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommandvolumeset
+ * @typedef {Object} YotoVolumeCommand
+ * @property {number} volume - Volume level [0-100]
+ */
+/**
+ * Ambient light command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommandambientsset
+ * @typedef {Object} YotoAmbientCommand
+ * @property {number} r - Red intensity [0-255]
+ * @property {number} g - Green intensity [0-255]
+ * @property {number} b - Blue intensity [0-255]
+ */
+/**
+ * Sleep timer command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommandsleep-timerset
+ * @typedef {Object} YotoSleepTimerCommand
+ * @property {number} seconds - Timer duration in seconds (0 to disable)
+ */
+/**
+ * Card start command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommandcardstart
+ * @typedef {Object} YotoCardStartCommand
+ * @property {string} uri - Card URI (e.g., "https://yoto.io/<cardID>")
+ * @property {string} [chapterKey] - Chapter to start from
+ * @property {string} [trackKey] - Track to start from
+ * @property {number} [secondsIn] - Playback start offset in seconds
+ * @property {number} [cutOff] - Playback stop offset in seconds
+ * @property {boolean} [anyButtonStop] - Whether button press stops playback
+ */
+/**
+ * Bluetooth command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommandbluetooth
+ * @typedef {Object} YotoBluetoothCommand
+ * @property {string} [action] - Bluetooth action (e.g., "on")
+ * @property {boolean | string} [mode] - Bluetooth mode (true for audio source, "bt_speaker" for sink)
+ * @property {number} [rssi] - RSSI threshold for auto-connect
+ * @property {string} [name] - Target Bluetooth device name
+ * @property {string} [mac] - Target Bluetooth MAC address
+ */
+/**
+ * Display preview command payload
+ * @see https://yoto.dev/players-mqtt/mqtt-docs/#deviceidcommanddisplaypreview
+ * @typedef {Object} YotoDisplayPreviewCommand
+ * @property {string} uri - Filepath to icon asset
+ * @property {number} timeout - Display duration in seconds
+ * @property {0 | 1} animated - Whether icon is animated (1) or static (0)
+ */
+/**
+ * Create a volume set command
+ * @param {number} volume - Volume level [0-100]
+ * @returns {YotoVolumeCommand}
+ * @throws {Error} If volume is out of range
+ */
 export function createVolumeCommand(volume: number): YotoVolumeCommand;
+/**
+ * Create an ambient light set command
+ * @param {number} r - Red intensity [0-255]
+ * @param {number} g - Green intensity [0-255]
+ * @param {number} b - Blue intensity [0-255]
+ * @returns {YotoAmbientCommand}
+ * @throws {Error} If any color value is out of range
+ */
 export function createAmbientCommand(r: number, g: number, b: number): YotoAmbientCommand;
+/**
+ * Create an ambient light command from hex color
+ * @param {string} hexColor - Hex color string (e.g., "#FF0000" or "FF0000")
+ * @returns {YotoAmbientCommand}
+ * @throws {Error} If hex color is invalid
+ */
 export function createAmbientCommandFromHex(hexColor: string): YotoAmbientCommand;
+/**
+ * Create a sleep timer set command
+ * @param {number} seconds - Timer duration in seconds (0 to disable)
+ * @returns {YotoSleepTimerCommand}
+ * @throws {Error} If seconds is negative
+ */
 export function createSleepTimerCommand(seconds: number): YotoSleepTimerCommand;
+/**
+ * Create a card start command
+ * @param {Object} options - Card start options
+ * @param {string} options.uri - Card URI (e.g., "https://yoto.io/<cardID>")
+ * @param {string} [options.chapterKey] - Chapter to start from
+ * @param {string} [options.trackKey] - Track to start from
+ * @param {number} [options.secondsIn] - Playback start offset in seconds
+ * @param {number} [options.cutOff] - Playback stop offset in seconds
+ * @param {boolean} [options.anyButtonStop] - Whether button press stops playback
+ * @returns {YotoCardStartCommand}
+ * @throws {Error} If uri is missing
+ */
 export function createCardStartCommand(options: {
     uri: string;
     chapterKey?: string | undefined;
@@ -10,6 +103,16 @@ export function createCardStartCommand(options: {
     cutOff?: number | undefined;
     anyButtonStop?: boolean | undefined;
 }): YotoCardStartCommand;
+/**
+ * Create a bluetooth on command
+ * @param {Object} [options] - Bluetooth options
+ * @param {string} [options.action] - Bluetooth action (e.g., "on")
+ * @param {boolean | string} [options.mode] - Bluetooth mode (true for audio source, "bt_speaker" for sink)
+ * @param {number} [options.rssi] - RSSI threshold for auto-connect
+ * @param {string} [options.name] - Target Bluetooth device name
+ * @param {string} [options.mac] - Target Bluetooth MAC address
+ * @returns {YotoBluetoothCommand}
+ */
 export function createBluetoothOnCommand(options?: {
     action?: string | undefined;
     mode?: string | boolean | undefined;
@@ -17,8 +120,25 @@ export function createBluetoothOnCommand(options?: {
     name?: string | undefined;
     mac?: string | undefined;
 }): YotoBluetoothCommand;
+/**
+ * Create a bluetooth speaker mode command
+ * @returns {YotoBluetoothCommand}
+ */
 export function createBluetoothSpeakerCommand(): YotoBluetoothCommand;
+/**
+ * Create a bluetooth audio source mode command
+ * @returns {YotoBluetoothCommand}
+ */
 export function createBluetoothAudioSourceCommand(): YotoBluetoothCommand;
+/**
+ * Create a display preview command
+ * @param {Object} options - Display preview options
+ * @param {string} options.uri - Filepath to icon asset
+ * @param {number} options.timeout - Display duration in seconds
+ * @param {boolean} options.animated - Whether icon is animated
+ * @returns {YotoDisplayPreviewCommand}
+ * @throws {Error} If uri or timeout is missing
+ */
 export function createDisplayPreviewCommand(options: {
     uri: string;
     timeout: number;
@@ -35,35 +155,110 @@ export namespace commands {
     export { createBluetoothAudioSourceCommand as bluetoothAudioSource };
     export { createDisplayPreviewCommand as displayPreview };
 }
+/**
+ * Volume command payload
+ */
 export type YotoVolumeCommand = {
+    /**
+     * - Volume level [0-100]
+     */
     volume: number;
 };
+/**
+ * Ambient light command payload
+ */
 export type YotoAmbientCommand = {
+    /**
+     * - Red intensity [0-255]
+     */
     r: number;
+    /**
+     * - Green intensity [0-255]
+     */
     g: number;
+    /**
+     * - Blue intensity [0-255]
+     */
     b: number;
 };
+/**
+ * Sleep timer command payload
+ */
 export type YotoSleepTimerCommand = {
+    /**
+     * - Timer duration in seconds (0 to disable)
+     */
     seconds: number;
 };
+/**
+ * Card start command payload
+ */
 export type YotoCardStartCommand = {
+    /**
+     * - Card URI (e.g., "https://yoto.io/<cardID>")
+     */
     uri: string;
+    /**
+     * - Chapter to start from
+     */
     chapterKey?: string;
+    /**
+     * - Track to start from
+     */
     trackKey?: string;
+    /**
+     * - Playback start offset in seconds
+     */
     secondsIn?: number;
+    /**
+     * - Playback stop offset in seconds
+     */
     cutOff?: number;
+    /**
+     * - Whether button press stops playback
+     */
     anyButtonStop?: boolean;
 };
+/**
+ * Bluetooth command payload
+ */
 export type YotoBluetoothCommand = {
+    /**
+     * - Bluetooth action (e.g., "on")
+     */
     action?: string;
+    /**
+     * - Bluetooth mode (true for audio source, "bt_speaker" for sink)
+     */
     mode?: boolean | string;
+    /**
+     * - RSSI threshold for auto-connect
+     */
     rssi?: number;
+    /**
+     * - Target Bluetooth device name
+     */
     name?: string;
+    /**
+     * - Target Bluetooth MAC address
+     */
     mac?: string;
 };
+/**
+ * Display preview command payload
+ */
 export type YotoDisplayPreviewCommand = {
+    /**
+     * - Filepath to icon asset
+     */
     uri: string;
+    /**
+     * - Display duration in seconds
+     */
     timeout: number;
+    /**
+     * - Whether icon is animated (1) or static (0)
+     */
     animated: 0 | 1;
 };
 //# sourceMappingURL=commands.d.ts.map

package/lib/mqtt/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["commands.js"],"names":[],"mappings":"AAwEA,4CAJW,MAAM,GACJ,iBAAiB,CAS7B;AAUD,wCANW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,kBAAkB,CAS9B;AAQD,sDAJW,MAAM,GACJ,kBAAkB,CAgB9B;AAQD,iDAJW,MAAM,GACJ,qBAAqB,CASjC;AAcD,gDATG;IAAwB,GAAG,EAAnB,MAAM;IACW,UAAU;IACV,QAAQ;IACR,SAAS;IACT,MAAM;IACL,aAAa;CACvC,GAAU,oBAAoB,CAkBhC;AAYD,mDAPG;IAAyB,MAAM;IACI,IAAI;IACd,IAAI;IACJ,IAAI;IACJ,GAAG;CAC5B,GAAU,oBAAoB,CAahC;AAMD,iDAFa,oBAAoB,CAIhC;AAMD,qDAFa,oBAAoB,CAIhC;AAWD,qDANG;IAAwB,GAAG,EAAnB,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,QAAQ,EAAzB,OAAO;CACf,GAAU,yBAAyB,CAiBrC;;;;;;;;;;;;;YA/Ma,MAAM;;;OAON,MAAM;OACN,MAAM;OACN,MAAM;;;aAON,MAAM;;;SAON,MAAM;iBACN,MAAM;eACN,MAAM;gBACN,MAAM;aACN,MAAM;oBACN,OAAO;;;aAOP,MAAM;WACN,OAAO,GAAG,MAAM;WAChB,MAAM;WACN,MAAM;UACN,MAAM;;;SAON,MAAM;aACN,MAAM;cACN,CAAC,GAAG,CAAC"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["commands.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,4CAJW,MAAM,GACJ,iBAAiB,CAS7B;AAED;;;;;;;GAOG;AACH,wCANW,MAAM,KACN,MAAM,KACN,MAAM,GACJ,kBAAkB,CAS9B;AAED;;;;;GAKG;AACH,sDAJW,MAAM,GACJ,kBAAkB,CAgB9B;AAED;;;;;GAKG;AACH,iDAJW,MAAM,GACJ,qBAAqB,CASjC;AAED;;;;;;;;;;;GAWG;AACH,gDATG;IAAwB,GAAG,EAAnB,MAAM;IACW,UAAU;IACV,QAAQ;IACR,SAAS;IACT,MAAM;IACL,aAAa;CACvC,GAAU,oBAAoB,CAkBhC;AAED;;;;;;;;;GASG;AACH,mDAPG;IAAyB,MAAM;IACI,IAAI;IACd,IAAI;IACJ,IAAI;IACJ,GAAG;CAC5B,GAAU,oBAAoB,CAahC;AAED;;;GAGG;AACH,iDAFa,oBAAoB,CAIhC;AAED;;;GAGG;AACH,qDAFa,oBAAoB,CAIhC;AAED;;;;;;;;GAQG;AACH,qDANG;IAAwB,GAAG,EAAnB,MAAM;IACU,OAAO,EAAvB,MAAM;IACW,QAAQ,EAAzB,OAAO;CACf,GAAU,yBAAyB,CAiBrC;;;;;;;;;;;;;;;;;;;YA/Ma,MAAM;;;;;;;;;OAON,MAAM;;;;OACN,MAAM;;;;OACN,MAAM;;;;;;;;;aAON,MAAM;;;;;;;;;SAON,MAAM;;;;iBACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;oBACN,OAAO;;;;;;;;;aAOP,MAAM;;;;WACN,OAAO,GAAG,MAAM;;;;WAChB,MAAM;;;;WACN,MAAM;;;;UACN,MAAM;;;;;;;;;SAON,MAAM;;;;aACN,MAAM;;;;cACN,CAAC,GAAG,CAAC"}