homebridge-yoto 0.0.31 → 0.0.33

package/AGENTS.md

@@ -1,138 +0,0 @@
-# Agent Development Notes
-
-This document contains patterns, conventions, and guidelines for developing the homebridge-yoto plugin.
-
-## Dont write summary markdown files unless asked to do so
-
-## JSDoc Typing Patterns
-
-### Use TypeScript-in-JavaScript (ts-in-js)
-
-All source files use `.js` extensions with JSDoc comments for type safety. This provides type checking without TypeScript compilation overhead.
-
-### Avoid `any` types
-
-Always provide specific types. Use `unknown` when the type is truly unknown, then narrow it with type guards.
-
-**Bad:**
-```javascript
-/**
- * @param {any} data
- */
-function processData(data) {
-  return data.value;
-}
-```
-
-**Good:**
-```javascript
-/**
- * @param {YotoDeviceStatus} status
- * @returns {number}
- */
-function getBatteryLevel(status) {
-  return status.batteryLevelPercentage;
-}
-```
-
-### Use @ts-expect-error over @ts-ignore
-
-When you must suppress a TypeScript error, use `@ts-expect-error` with a comment explaining why. This will error if the issue is fixed, prompting cleanup.
-
-**Bad:**
-```javascript
-// @ts-ignore
-const value = accessory.context.device.unknownProperty;
-```
-
-**Good:**
-```javascript
-// @ts-expect-error - API may return undefined for offline devices
-const lastSeen = accessory.context.device.lastSeenAt;
-```
-
-### Use newer @import syntax in jsdoc/ts-in-js for types only
-
-Import types using the `@import` JSDoc tag to avoid runtime imports of type-only dependencies.
-
-```javascript
-/** @import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, PlatformConfig, Service, Characteristic } from 'homebridge' */
-/** @import { YotoDevice, YotoDeviceStatus, YotoDeviceConfig } from './types.js' */
-
-/**
- * @param {Logger} log
- * @param {PlatformConfig} config
- * @param {API} api
- */
-export function YotoPlatform(log, config, api) {
-  this.log = log;
-  this.config = config;
-  this.api = api;
-}
-```
-
-### Import Consolidation
-
-Keep regular imports and type imports separate. Use single-line imports for types when possible.
-
-```javascript
-import { EventEmitter } from 'events';
-
-/** @import { YotoDevice } from './types.js' */
-/** @import { API, PlatformAccessory } from 'homebridge' */
-```
-
-## Event Pattern Preference
-
-### Use Aggregate Events with Exhaustive Type Narrowing
-
-The `yoto-nodejs-client` library should emit **only aggregate events** with `changedFields` arrays:
-
-- `statusUpdate` - passes `(status, source, changedFields[])`
-- `configUpdate` - passes `(config, changedFields[])`
-- `playbackUpdate` - passes `(playback, changedFields[])`
-
-**Do NOT create granular field events** like `volumeChanged`, `batteryLevelChanged`, etc.
-
-### Homebridge Plugin Pattern
-
-The plugin should use exhaustive switch statements to handle field updates:
-
-```javascript
-this.deviceModel.on('statusUpdate', (status, source, changedFields) => {
-  for (const field of changedFields) {
-    switch (field) {
-      case 'volume':
-        // Update volume characteristic
-        break
-      
-      case 'batteryLevelPercentage':
-        // Update battery characteristic
-        break
-      
-      // ... handle all fields
-      
-      case 'firmwareVersion':
-        // Empty case - available but not used yet
-        break
-      
-      default: {
-        // Exhaustive check - TypeScript error if field missed
-        const _exhaustive: never = field
-        break
-      }
-    }
-  }
-})
-```
-
-**Benefits:**
-- Fewer event listeners (3 instead of 20+)
-- Exhaustive TypeScript checking ensures all fields handled
-- Empty cases document available fields
-- Easy to extend - just fill in empty cases
-- Type-safe with proper field typing
-
-## Changelog Management
-
-**NEVER manually edit CHANGELOG.md**

package/CHANGELOG.md

@@ -1,16 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
-
-## 0.0.31
-
-### Commits
-
-- init [`88b35b6`](https://github.com/bcomnes/homebridge-yoto/commit/88b35b695166c6f5c3e3ec381c4afb52940a369b)
-- WIP [`cf0e5c8`](https://github.com/bcomnes/homebridge-yoto/commit/cf0e5c85df5984eb7fe10a2118de08990d875337)
-- Implement against client [`27d4fae`](https://github.com/bcomnes/homebridge-yoto/commit/27d4fae930a84f12a4671d3cd129c299505e398b)

package/CONTRIBUTING.md

@@ -1,34 +0,0 @@
-# Contributing
-
-## Releasing
-
-Changelog and releasing are automated with npm scripts and actions. To create a release:
-
-- Navigate to the Actions tab.
-- Select the `npm bump` action.
-- Trigger the action, specifying the semantic version bump that is needed.
-- Changelog, GitHub release, and npm publish are handled by the action.
-- An in-depth review of this system is documented here: [bret.io/projects/package-automation](https://bret.io/projects/package-automation/).
-
-If for some reason this isn't working or a local release is preferred, follow these steps:
-
-- Ensure a clean working git workspace.
-- Run `npm version {patch, minor, major}`.
-  - This will update the version number and generate the changelog.
-- Run `npm publish`.
-  - This will push your local git branch and tags to the default remote, perform a [gh-release](https://ghub.io/gh-release), and create an npm publication.
-
-## Guidelines
-
-- Patches, ideas, and changes are welcome.
-- Fixes are almost always welcome.
-- Features are sometimes welcome.
-  - Please open an issue to discuss the idea prior to spending lots of time on the problem.
-  - It may be rejected.
-  - If you don't want to wait for the discussion to commence and you really want to jump into the implementation work, be prepared to fork the project if the idea is respectfully declined.
-- Try to stay within the style of the existing code.
-- All tests must pass.
-- Additional features or code paths must be tested.
-- Aim for 100% test coverage.
-- Questions are welcome. However, unless there is an official support contract established between the maintainers and the requester, support is not guaranteed.
-- Contributors reserve the right to walk away from this project at any moment, with or without notice.

package/NOTES.md

@@ -1,87 +0,0 @@
-Homebridge Notes

-http://bee.local:8581/login
-
-
-- Instance: https://homebridge.io
-- Homepage: https://homebridge.io
-- Plugin Docs: https://developers.homebridge.io/#/
-- Wiki: https://github.com/homebridge/homebridge/wiki
-- Homebridge package: https://github.com/homebridge/homebridge
-- Plugins Repo: https://github.com/homebridge/plugins
-- Plugin UI Utils: https://github.com/homebridge/plugin-ui-utils
-- HAP Client: https://github.com/homebridge/hap-client
-- HAP-NodeJS: https://github.com/homebridge/HAP-NodeJS
-- HAP-NodeJS JSDocs: https://developers.homebridge.io/HAP-NodeJS/modules.html
-- Old docs?: https://github.com/homebridge/documentation
-- PLugin Tempalte: https://github.com/homebridge/homebridge-plugin-template
-- Template lib helper thing: https://github.com/ebaauw/homebridge-lib 
-- Ring: https://github.com/homebridge-plugins/homebridge-meross/blob/9ea479ea94a8cfa8dce9051976fafb8308faae85/lib/platform.js#L1037
-- Scoped Plugins (Reference) https://github.com/homebridge/plugins/wiki/Scoped-Plugins#available-plugins
-- https://github.com/homebridge-plugins/homebridge-rainbird/blob/latest/src/platform.ts
-- https://github.com/homebridge-plugins/homebridge-unifi-network
-
-
-Yoto Docs:

-- https://yoto.dev/get-started/start-here/
-- https://yoto.dev/api/
-- https://yoto.space/developers
-- https://yoto.space/developers/post/home-assistant-integration-Ao9OxbsMDBqaG9I
-- https://github.com/yotoplay/examples
-- https://github.com/yotoplay/twine-to-yoto
-
-MQTT
-- MQTT: https://github.com/mqttjs/MQTT.js
-- https://mqtt.org
-- https://www.emqx.com/en/blog/the-easiest-guide-to-getting-started-with-mqtt
-- https://aws.amazon.com/what-is/mqtt/
-- https://en.wikipedia.org/wiki/MQTT
--
-
-- https://github.com/ebaauw/homebridge-zp/issues/10#issuecomment-270743358
-
-
-- Implement a improved config type, and populate it.
-- Audit the set functions in hb, make sure the client works/helps with that. 
-- Clean up unused vars and config
-- Audit online/offline config set methods
-
-
-[12/26/2025, 4:05:52 PM] [homebridge-yoto] Device discovered: GGs Boombox (y29sZvOdk63vN50Qed5eH4Y0)
-[12/26/2025, 4:05:52 PM] [homebridge-yoto] Adding new accessory: GGs Boombox
-[12/26/2025, 4:05:52 PM] [homebridge-yoto] [Accessory] Setting up GGs Boombox
-[GGs Boombox@GGs Boombox@Status Active] Characteristic not in required or optional characteristic section for service SmartSpeaker. Adding anyway.
-[GGs Boombox@GGs Boombox Battery@Status Active] Characteristic not in required or optional characteristic section for service Battery. Adding anyway.
-[12/26/2025, 4:05:52 PM] [homebridge-yoto] [Accessory] ✓ GGs Boombox ready
-[12/26/2025, 4:05:52 PM] [homebridge-yoto] Publishing new external accessory: GGs Boombox
-[12/26/2025, 4:05:52 PM] GGs Boombox 55FC is running on port 45125.
-[12/26/2025, 4:05:52 PM] Please add [GGs Boombox 55FC] manually in Home app. Setup Code: 547-78-744
-[12/26/2025, 4:05:54 PM] [homebridge-yoto] Device discovered: Gigis mini (y2JVD5AxvJEeaK1g6nvBWkej)
-[12/26/2025, 4:05:54 PM] [homebridge-yoto] Adding new accessory: Gigis mini
-[12/26/2025, 4:05:54 PM] [homebridge-yoto] [Accessory] Setting up Gigis mini
-[Gigis mini@Gigis mini@Status Active] Characteristic not in required or optional characteristic section for service SmartSpeaker. Adding anyway.
-[Gigis mini@Gigis mini Battery@Status Active] Characteristic not in required or optional characteristic section for service Battery. Adding anyway.
-[12/26/2025, 4:05:54 PM] [homebridge-yoto] [Accessory] ✓ Gigis mini ready
-[12/26/2025, 4:05:54 PM] [homebridge-yoto] Publishing new external accessory: Gigis mini
-[12/26/2025, 4:05:54 PM] Gigis mini 8D02 is running on port 38987.
-[12/26/2025, 4:05:54 PM] Please add [Gigis mini 8D02] manually in Home app. Setup Code: 547-78-744
-[12/26/2025, 4:05:55 PM] [homebridge-yoto] Device discovered: Otto's mini  (y2iYT7ItkMRWbuMzTDuGjgmS)
-[12/26/2025, 4:05:55 PM] [homebridge-yoto] Adding new accessory: Otto's mini 
-[12/26/2025, 4:05:55 PM] [homebridge-yoto] [Accessory] Setting up Otto's mini 
-[Otto's mini @Otto's mini @Status Active] Characteristic not in required or optional characteristic section for service SmartSpeaker. Adding anyway.
-[Otto's mini @Otto's mini  Battery@Status Active] Characteristic not in required or optional characteristic section for service Battery. Adding anyway.
-[12/26/2025, 4:05:55 PM] [homebridge-yoto] [Accessory] ✓ Otto's mini  ready
-[12/26/2025, 4:05:55 PM] [homebridge-yoto] Publishing new external accessory: Otto's mini 
-[12/26/2025, 4:05:55 PM] Otto's mini  024E is running on port 33839.
-[12/26/2025, 4:05:55 PM] Please add [Otto's mini  024E] manually in Home app. Setup Code: 547-78-744
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] Device discovered: Ottos Boombox (y2knTzvDkKVtvnhl09z9bWfe)
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] Adding new accessory: Ottos Boombox
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] [Accessory] Setting up Ottos Boombox
-[Ottos Boombox@Ottos Boombox@Status Active] Characteristic not in required or optional characteristic section for service SmartSpeaker. Adding anyway.
-[Ottos Boombox@Ottos Boombox Battery@Status Active] Characteristic not in required or optional characteristic section for service Battery. Adding anyway.
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] [Accessory] ✓ Ottos Boombox ready
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] Publishing new external accessory: Ottos Boombox
-[12/26/2025, 4:05:57 PM] [homebridge-yoto] ✓ Yoto account started with 4 device(s)
-[12/26/2025, 4:05:57 PM] Ottos Boombox 3486 is running on port 37845.
-[12/26/2025, 4:05:57 PM] Please add [Ottos Boombox 3486] manually in Home app. Setup Code: 547-78-744
-[12/26/2025, 4:05:59 PM] [homebridge-yoto] This plugin generated a warning from the characteristic 'Brightness': characteristic was supplied illegal value: number 255 exceeded maximum of 100. See https://homebridge.io/w/JtMGR for more info.
-[12/26/2025, 4:05:59 PM] [homebridge-yoto] This plugin generated a warning from the characteristic 'Brightness': characteristic was supplied illegal value: number 255 exceeded maximum of 100. See https://homebridge.io/w/JtMGR for more info.