homebridge-frontier-silicon-plugin 1.0.3 → 1.2.0

package/CHANGELOG.md

@@ -4,17 +4,30 @@ All notable changes to this project are documented in this file.
 
 The format is based on Keep a Changelog, and this project follows Semantic Versioning.
 
+## [1.2.0] – 2025-12-28
+
+### Added
+- Station selection via HomeKit using preset-based switches.
+- Optional native HomeKit Speaker service alongside Apple Home volume slider.
+- Configurable station list in Homebridge UI mapped to radio presets.
+
+### Improved
+- Better HomeKit usability for audio devices.
+- Volume control remains visible in Apple Home while supporting proper audio semantics.
+
 ## [1.1.0] – 2025-12-28
 
+### Added
+1. Added an optional native HomeKit Speaker service for volume control using the Volume characteristic.
+2. Added configuration switches to expose the Speaker service and the Apple Home slider independently.
+
 ### Changed
-- Replaced the Lightbulb Brightness based volume control with a native HomeKit **Speaker** service.
-- Volume is now exposed using the official `Volume` characteristic.
-- Power and volume are logically separated, matching HomeKit audio device expectations.
+1. Volume can now be controlled through either the Speaker service, the Apple Home slider service, or both.
 
 ### Improved
-- More natural HomeKit UI for audio devices.
-- Better compatibility with HomeKit audio controls and third-party Home apps.
-- Non-linear volume mapping retained for precise low-volume control.
+1. Better compatibility with third party HomeKit apps via the Speaker service.
+2. Apple Home usability retained via the Brightness based slider.
+3. Non linear volume mapping remains for precise low volume control.
 
 ## [1.0.2] – 2025-12-28
 

package/config.schema.json

@@ -1,29 +1,111 @@
 {
-  "name": "homebridge-frontier-silicon-plugin",
-  "version": "1.0.0",
-  "description": "Homebridge plugin for Frontier Silicon FSAPI devices, power and volume with safe polling",
-  "license": "ISC",
-  "main": "index.js",
-  "keywords": [
-    "homebridge-pluginconfig.schema.json",
-    "homebridge",
-    "frontier",
-    "silicon",
-    "fsapi",
-    "internet-radio"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/boikedamhuis/homebridge-frontier-silicon"
-  },
-  "bugs": {
-    "url": "https://github.com/boikedamhuis/homebridge-frontier-silicon/issues"
+  "pluginAlias": "frontier-silicon",
+  "pluginType": "accessory",
+  "singular": false,
+  "headerDisplay": "Frontier Silicon FSAPI radios",
+  "footerDisplay": "Presets must be saved on the radio first. The plugin switches between preset numbers.",
+  "schema": {
+    "type": "object",
+    "required": ["name", "ip"],
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "Living Room Radio",
+        "description": "The name shown in HomeKit."
+      },
+      "ip": {
+        "title": "IP Address",
+        "type": "string",
+        "default": "192.168.1.50",
+        "description": "The IP address of the radio on your network.",
+        "pattern": "^(?:(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$"
+      },
+      "pin": {
+        "title": "FSAPI PIN",
+        "type": "string",
+        "default": "1234",
+        "description": "FSAPI PIN for the radio. Default is usually 1234."
+      },
+      "pollIntervalSeconds": {
+        "title": "Poll interval (seconds)",
+        "type": "integer",
+        "default": 5,
+        "minimum": 2,
+        "maximum": 120,
+        "description": "How often to poll the device for updates."
+      },
+      "enableVolume": {
+        "title": "Enable volume control",
+        "type": "boolean",
+        "default": true,
+        "description": "Enable volume support."
+      },
+      "exposeSpeakerService": {
+        "title": "Expose Speaker service",
+        "type": "boolean",
+        "default": true,
+        "description": "Adds a native HomeKit Speaker service using the Volume characteristic."
+      },
+      "exposeVolumeSlider": {
+        "title": "Expose Apple Home volume slider",
+        "type": "boolean",
+        "default": true,
+        "description": "Adds a Lightbulb Brightness slider for volume control that is visible in the Apple Home app."
+      },
+      "autoPowerOnOnPreset": {
+        "title": "Power on when selecting a station",
+        "type": "boolean",
+        "default": true,
+        "description": "When you turn on a station switch, the radio will be powered on first."
+      },
+      "stations": {
+        "title": "Stations",
+        "type": "array",
+        "description": "List of station switches mapped to preset numbers. Save the stations to presets on the radio first.",
+        "items": {
+          "type": "object",
+          "required": ["name", "preset"],
+          "properties": {
+            "name": {
+              "title": "Station name",
+              "type": "string",
+              "default": "Radio 2"
+            },
+            "preset": {
+              "title": "Preset number",
+              "type": "integer",
+              "default": 1,
+              "minimum": 0,
+              "maximum": 99
+            }
+          }
+        },
+        "default": []
+      }
+    }
   },
-  "author": {
-    "name": "Boike Damhuis"
-  },
-  "engines": {
-    "node": ">=18.0.0",
-    "homebridge": ">=1.6.0"
+  "form": [
+    "name",
+    "ip",
+    "pin",
+    "pollIntervalSeconds",
+    "enableVolume",
+    "exposeSpeakerService",
+    "exposeVolumeSlider",
+    "autoPowerOnOnPreset",
+    {
+      "key": "stations",
+      "type": "array",
+      "title": "Stations",
+      "items": [
+        "stations[].name",
+        "stations[].preset"
+      ]
+    }
+  ],
+  "display": {
+    "name": "Frontier Silicon Radio",
+    "description": "Control power, volume, and station presets via FSAPI."
   }
 }

package/index.js

@@ -22,13 +22,20 @@ function FrontierSiliconAccessory(log, config) {
   this.pin = String(config.pin ?? "1234");
   this.pollIntervalSeconds = Number(config.pollIntervalSeconds ?? 5);
 
-  // Keep volume enabled by default. This now uses a Speaker service.
   this.enableVolume = config.enableVolume !== false;
 
-  this.lastKnownPower = null;
+  this.exposeSpeakerService = config.exposeSpeakerService !== false;
+  this.exposeVolumeSlider = config.exposeVolumeSlider !== false;
+
+  this.autoPowerOnOnPreset = config.autoPowerOnOnPreset !== false;
+
+  this.stations = Array.isArray(config.stations) ? config.stations : [];
 
-  // Store last known RADIO volume in device scale 0..100
+  this.lastKnownPower = null;
   this.lastKnownRadioVolume = null;
+  this.lastKnownPresetIndex = null;
+
+  this.isUpdatingStationSwitches = false;
 
   if (!this.ip) {
     this.log.warn("No ip configured, accessory will not work.");
@@ -45,40 +52,94 @@ function FrontierSiliconAccessory(log, config) {
     .setCharacteristic(Characteristic.Model, "FSAPI Radio")
     .setCharacteristic(Characteristic.SerialNumber, this.ip || "unknown");
 
-  // Power as Switch (kept as-is for maximum Home app compatibility)
   this.switchService = new Service.Switch(this.name);
   this.switchService
     .getCharacteristic(Characteristic.On)
     .on("get", this.handleGetPower.bind(this))
     .on("set", this.handleSetPower.bind(this));
 
-  // Speaker service for volume (and optional mute)
   if (this.enableVolume) {
-    this.speakerService = new Service.Speaker(this.name + " Speaker");
-
-    // Volume characteristic uses HomeKit scale 0..100
-    this.speakerService
-      .getCharacteristic(Characteristic.Volume)
-      .on("get", this.handleGetVolume.bind(this))
-      .on("set", this.handleSetVolume.bind(this));
-
-    // Optional mute support placeholder:
-    // If you want real mute later, we can map this to an FSAPI endpoint if available.
-    // For now, we expose mute but keep it non-functional (always false) to avoid confusion.
-    if (Characteristic.Mute) {
+    if (this.exposeSpeakerService) {
+      this.speakerService = new Service.Speaker(this.name + " Speaker");
+
       this.speakerService
-        .getCharacteristic(Characteristic.Mute)
-        .on("get", (cb) => cb(null, false))
+        .getCharacteristic(Characteristic.Volume)
+        .on("get", this.handleGetVolume.bind(this))
+        .on("set", this.handleSetVolume.bind(this));
+
+      if (Characteristic.Mute) {
+        this.speakerService
+          .getCharacteristic(Characteristic.Mute)
+          .on("get", (cb) => cb(null, false))
+          .on("set", (_val, cb) => cb(null));
+      }
+    }
+
+    if (this.exposeVolumeSlider) {
+      this.volumeSliderService = new Service.Lightbulb(this.name + " Volume");
+
+      this.volumeSliderService
+        .getCharacteristic(Characteristic.On)
+        .on("get", (cb) => cb(null, true))
         .on("set", (_val, cb) => cb(null));
+
+      this.volumeSliderService
+        .getCharacteristic(Characteristic.Brightness)
+        .on("get", this.handleGetVolume.bind(this))
+        .on("set", this.handleSetVolume.bind(this));
     }
   }
 
+  this.stationServices = [];
+  this.stationServiceByPreset = new Map();
+
+  this.buildStationServices();
+
   this.startPolling();
 }
 
+FrontierSiliconAccessory.prototype.buildStationServices = function () {
+  if (!Array.isArray(this.stations) || this.stations.length === 0) return;
+
+  const seenSubtypes = new Set();
+
+  for (const s of this.stations) {
+    if (!s || typeof s !== "object") continue;
+
+    const stationName = String(s.name ?? "").trim();
+    const preset = Number(s.preset);
+
+    if (!stationName) continue;
+    if (!Number.isFinite(preset)) continue;
+
+    const subtype = "preset_" + String(Math.trunc(preset));
+    if (seenSubtypes.has(subtype)) continue;
+    seenSubtypes.add(subtype);
+
+    const sw = new Service.Switch(stationName, subtype);
+
+    sw.getCharacteristic(Characteristic.On)
+      .on("get", (cb) => {
+        const isOn = this.lastKnownPresetIndex === Math.trunc(preset);
+        cb(null, isOn);
+      })
+      .on("set", (value, cb) => {
+        this.handleSetStationPreset(Math.trunc(preset), !!value, cb);
+      });
+
+    this.stationServices.push({ preset: Math.trunc(preset), name: stationName, service: sw });
+    this.stationServiceByPreset.set(Math.trunc(preset), sw);
+  }
+};
+
 FrontierSiliconAccessory.prototype.getServices = function () {
   const services = [this.informationService, this.switchService];
+
   if (this.enableVolume && this.speakerService) services.push(this.speakerService);
+  if (this.enableVolume && this.volumeSliderService) services.push(this.volumeSliderService);
+
+  for (const s of this.stationServices) services.push(s.service);
+
   return services;
 };
 
@@ -121,7 +182,6 @@ FrontierSiliconAccessory.prototype.handleGetVolume = async function (callback) {
 };
 
 FrontierSiliconAccessory.prototype.handleSetVolume = async function (value, callback) {
-  // Non linear mapping so low slider values are much softer
   const radioVol = homekitToRadioVolume(value);
 
   try {
@@ -134,6 +194,55 @@ FrontierSiliconAccessory.prototype.handleSetVolume = async function (value, call
   }
 };
 
+FrontierSiliconAccessory.prototype.handleSetStationPreset = async function (preset, turnOn, callback) {
+  if (this.isUpdatingStationSwitches) {
+    callback(null);
+    return;
+  }
+
+  if (!turnOn) {
+    callback(null);
+    this.syncStationSwitchesFromPreset(this.lastKnownPresetIndex);
+    return;
+  }
+
+  try {
+    if (this.autoPowerOnOnPreset) {
+      try {
+        await this.client.setPower(true);
+        this.lastKnownPower = true;
+        this.switchService.getCharacteristic(Characteristic.On).updateValue(true);
+      } catch (_e) {
+      }
+    }
+
+    await this.client.setPresetIndex(preset);
+    this.lastKnownPresetIndex = preset;
+
+    this.syncStationSwitchesFromPreset(preset);
+    callback(null);
+  } catch (err) {
+    this.log.warn("Preset set failed.", toMsg(err));
+    callback(null);
+    this.syncStationSwitchesFromPreset(this.lastKnownPresetIndex);
+  }
+};
+
+FrontierSiliconAccessory.prototype.syncStationSwitchesFromPreset = function (presetIndex) {
+  if (!this.stationServices || this.stationServices.length === 0) return;
+
+  this.isUpdatingStationSwitches = true;
+
+  try {
+    for (const s of this.stationServices) {
+      const shouldBeOn = presetIndex === s.preset;
+      s.service.getCharacteristic(Characteristic.On).updateValue(shouldBeOn);
+    }
+  } finally {
+    this.isUpdatingStationSwitches = false;
+  }
+};
+
 FrontierSiliconAccessory.prototype.startPolling = function () {
   if (!this.ip) return;
 
@@ -150,20 +259,38 @@ FrontierSiliconAccessory.prototype.startPolling = function () {
       if (this.log.debug) this.log.debug("Polling power failed.", toMsg(err));
     }
 
-    if (this.enableVolume && this.speakerService) {
+    if (this.enableVolume) {
       try {
         const radioVol = await this.client.getVolume();
         if (this.lastKnownRadioVolume !== radioVol) {
           this.lastKnownRadioVolume = radioVol;
+
           const homekitVol = radioToHomekitVolume(radioVol);
-          this.speakerService
-            .getCharacteristic(Characteristic.Volume)
-            .updateValue(homekitVol);
+
+          if (this.speakerService) {
+            this.speakerService.getCharacteristic(Characteristic.Volume).updateValue(homekitVol);
+          }
+
+          if (this.volumeSliderService) {
+            this.volumeSliderService.getCharacteristic(Characteristic.Brightness).updateValue(homekitVol);
+          }
         }
       } catch (err) {
         if (this.log.debug) this.log.debug("Polling volume failed.", toMsg(err));
       }
     }
+
+    if (this.stationServices && this.stationServices.length > 0) {
+      try {
+        const preset = await this.client.getPresetIndex();
+        if (Number.isFinite(preset) && this.lastKnownPresetIndex !== preset) {
+          this.lastKnownPresetIndex = preset;
+          this.syncStationSwitchesFromPreset(preset);
+        }
+      } catch (err) {
+        if (this.log.debug) this.log.debug("Polling preset failed.", toMsg(err));
+      }
+    }
   };
 
   tick();
@@ -201,14 +328,20 @@ FsApiClient.prototype.setVolume = async function (volume) {
   await this.fetchText("/fsapi/SET/netRemote.sys.audio.volume?value=" + v);
 };
 
+FsApiClient.prototype.getPresetIndex = async function () {
+  const text = await this.fetchText("/fsapi/GET/netRemote.sys.preset.index");
+  const value = parseFsapiValue(text);
+  const n = Number(value);
+  return Number.isFinite(n) ? Math.trunc(n) : null;
+};
+
+FsApiClient.prototype.setPresetIndex = async function (preset) {
+  await this.fetchText("/fsapi/SET/netRemote.sys.preset.index?value=" + encodeURIComponent(String(preset)));
+};
+
 FsApiClient.prototype.fetchText = async function (pathAndQuery) {
   const joiner = pathAndQuery.includes("?") ? "&" : "?";
-  const url =
-    this.baseUrl +
-    pathAndQuery +
-    joiner +
-    "pin=" +
-    encodeURIComponent(this.pin);
+  const url = this.baseUrl + pathAndQuery + joiner + "pin=" + encodeURIComponent(this.pin);
 
   const controller = new AbortController();
   const t = setTimeout(() => controller.abort(), this.timeoutMs);
@@ -266,10 +399,6 @@ function toMsg(err) {
   return String(err);
 }
 
-// Non linear volume mapping
-// HomeKit slider 0..100 is mapped to device volume 0..100
-// Low slider values become much softer, high end remains reachable
-
 function homekitToRadioVolume(homekitValue) {
   const x = clampInt(Number(homekitValue), 0, 100) / 100;
   return clampInt(Math.round(Math.pow(x, 2) * 100), 0, 100);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-frontier-silicon-plugin",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "description": "Homebridge plugin for Frontier Silicon FSAPI devices, power and volume with safe polling",
   "license": "ISC",
   "main": "index.js",