discovery: generate capability JSON from the registry
A capability is a descriptor plus what the endpoint declares (device/Capability.ts), and its discovery object is
generated from the two. The new API is bridge.addDevice({ endpointId, name, categories, ... }) and
device.add(PowerController, options): both throw a DeclarationError that names the endpoint, the interface and
the instance (device/validate.ts), and leave the bridge and the device as they were. AlexaInterface is the same
Capability with the 1.x methods on it; it, ActionMapping and the enums moved to src/compat/, Device to src/device/.
What a 1.x caller can observe:
- every endpoint ends with { type: "AlexaInterface", interface: "Alexa", version: "3" } (alexa-interface.html);
new Alex2MQTT(..., { alexaInterface: false }) leaves it out
- the fields of a capability object come in the order of Amazon's examples; their content is unchanged
- addCapability() with a name that is not an interface throws (1.5.2 announced it with the version "UNKNOWN")
- ActionMapping takes the payload as an object; a JSON string is parsed (1.5.2 sent the string), any other throws
- what Alexa would reject in a 1.x declaration is not refused: device.check() lists it and the bridge logs each
line once, as "warning: ..." through the log hook, when it answers a discovery
- a device whose JSON cannot be built is left out of the answer and reported as an error event
- PowerController and EndpointHealth are the descriptors and keep ON/OFF and OK/UNREACHABLE; PowerState is new
Tests: six zoo devices declared the 1.x way give the JSON that Alexa accepted from 1.5.2 on 2026-09-28, plus the
Alexa capability. npm test: 85 pass (was 57) in 10-12 s, also on Node 18.20.8 and 20.20.2.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
parent
aa0ffd64ea
commit
c492ef74d1
90 changed files with 5539 additions and 1760 deletions
253
test/device/discovery.test.js
Normal file
253
test/device/discovery.test.js
Normal file
|
|
@ -0,0 +1,253 @@
|
|||
"use strict";
|
||||
// The discovery JSON of an endpoint: generated from the descriptors of its capabilities, in the order they were
|
||||
// declared, with the capabilities the library adds at the end.
|
||||
const { test } = require("node:test");
|
||||
const assert = require("node:assert/strict");
|
||||
const {
|
||||
Alex2MQTT, ActionMapping, Alexa, AlexaActions, AlexaInterfaceType, BrightnessController, DisplayCategory, EndpointHealth,
|
||||
PowerController, TemperatureSensor, registry,
|
||||
} = require("alex2node");
|
||||
const interfaces = require("../fixtures/interfaces.js");
|
||||
const { endpoint } = require("../helpers/endpoint.js");
|
||||
const { capabilities, zoo } = require("../helpers/fixtures.js");
|
||||
const { setup, until } = require("../helpers/harness.js");
|
||||
|
||||
const ALEXA = { type: "AlexaInterface", interface: "Alexa", version: "3" };
|
||||
const names = (json) => json.capabilities.map((capability) => capability.interface);
|
||||
|
||||
// Ask as Alex2MQTT does and return the endpoints of the one answer.
|
||||
async function discover(alexa, root) {
|
||||
const before = alexa.on(`${root}/discover_r`).length;
|
||||
alexa.publish(`${root}/discover`, { namespace: "Alexa.Discovery", name: "Discover" });
|
||||
await until(() => alexa.on(`${root}/discover_r`).length === before + 1, 3000, "discovery reply");
|
||||
return alexa.on(`${root}/discover_r`)[before];
|
||||
}
|
||||
|
||||
for (const { namespace, page, declared } of interfaces) {
|
||||
test(`${namespace}: device.add() gives the capability object of ${page}.html`, () => {
|
||||
for (const { options, as: [example, n = 0] } of declared) {
|
||||
const capability = endpoint().add(registry.get(namespace), options);
|
||||
assert.deepEqual(capability.toJSON(), capabilities(page, namespace, example)[n], `${example}[${n}]`);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
test("the fields of a capability object are in the order of the examples: type, interface, version, properties", () => {
|
||||
const lamp = endpoint();
|
||||
lamp.add(PowerController, { proactivelyReported: true });
|
||||
assert.equal(
|
||||
JSON.stringify(lamp.getJSON().capabilities[0]),
|
||||
'{"type":"AlexaInterface","interface":"Alexa.PowerController","version":"3",'
|
||||
+ '"properties":{"supported":[{"name":"powerState"}],"proactivelyReported":true,"retrievable":true}}'
|
||||
);
|
||||
});
|
||||
|
||||
test("capabilities are listed as declared, the Alexa interface after them", () => {
|
||||
const thermostat = endpoint("thermo-1", "Thermostat", ["THERMOSTAT", "TEMPERATURE_SENSOR"]);
|
||||
thermostat.add(TemperatureSensor);
|
||||
thermostat.add(PowerController);
|
||||
thermostat.add(BrightnessController);
|
||||
assert.deepEqual(names(thermostat.getJSON()), ["Alexa.TemperatureSensor", "Alexa.PowerController", "Alexa.BrightnessController", "Alexa"]);
|
||||
assert.deepEqual(thermostat.getJSON().capabilities.at(-1), ALEXA);
|
||||
assert.deepEqual(thermostat.getCapabilities().map((capability) => capability.namespace), ["Alexa.TemperatureSensor", "Alexa.PowerController", "Alexa.BrightnessController"]);
|
||||
|
||||
// Declared by the device itself, it stays where it was declared and is listed once
|
||||
const lamp = endpoint();
|
||||
lamp.add(Alexa);
|
||||
lamp.add(PowerController);
|
||||
assert.deepEqual(names(lamp.getJSON()), ["Alexa", "Alexa.PowerController"]);
|
||||
});
|
||||
|
||||
test("defaults of a declaration: retrievable, not proactively reported, nonControllable left out unless given", () => {
|
||||
const lamp = endpoint();
|
||||
assert.deepEqual(lamp.add(PowerController).toJSON().properties, { supported: [{ name: "powerState" }], proactivelyReported: false, retrievable: true });
|
||||
assert.deepEqual(
|
||||
lamp.add(BrightnessController, { retrievable: false, proactivelyReported: true, nonControllable: true }).toJSON().properties,
|
||||
{ supported: [{ name: "brightness" }], proactivelyReported: true, retrievable: false, nonControllable: true }
|
||||
);
|
||||
assert.equal(lamp.add(TemperatureSensor, { nonControllable: false }).toJSON().properties.nonControllable, false);
|
||||
});
|
||||
|
||||
test("PowerController verificationsRequired: the directives Alexa asks the user to confirm", () => {
|
||||
const capability = endpoint().add(PowerController, { verificationsRequired: ["TurnOff"] });
|
||||
assert.deepEqual(capability.toJSON().verificationsRequired, [{ directive: "TurnOff", methods: [{ "@type": "Confirmation" }] }]);
|
||||
assert.equal("verificationsRequired" in endpoint().add(PowerController).toJSON(), false);
|
||||
});
|
||||
|
||||
test("1.x declarations are announced as 1.5.2 announced them, with the Alexa interface added", () => {
|
||||
const T = AlexaInterfaceType;
|
||||
// zoo.js, the devices whose discovery JSON 1.5.2 produced without corrections
|
||||
const declarations = {
|
||||
"zoo-dimmer": (device) => {
|
||||
device.addCapability(T.POWER_CONTROLLER, { proactivelyReported: true });
|
||||
device.addCapability(T.BRIGHTNESS_CONTROLLER, { proactivelyReported: true });
|
||||
},
|
||||
"zoo-thermostat": (device) => {
|
||||
device.addCapability(T.THERMOSTAT_CONTROLLER, { proactivelyReported: true });
|
||||
device.addCapability(T.TEMPERATURE_SENSOR, { proactivelyReported: true });
|
||||
},
|
||||
"zoo-curtain": (device) => {
|
||||
device.addCapability(T.POWER_CONTROLLER, { proactivelyReported: true });
|
||||
const toggle = device.addCapability(T.TOGGLE_CONTROLLER, { proactivelyReported: true, instance: "Zoo.Shade" });
|
||||
toggle.addFriendlyName("Shade", "en-US");
|
||||
toggle.addActionMapping(new ActionMapping([AlexaActions.Close], "TurnOn"));
|
||||
toggle.addActionMapping(new ActionMapping([AlexaActions.Open], "TurnOff"));
|
||||
},
|
||||
"zoo-fan": (device) => {
|
||||
device.addCapability(T.POWER_CONTROLLER, { proactivelyReported: true });
|
||||
const mode = device.addCapability(T.MODE_CONTROLLER, { proactivelyReported: true });
|
||||
mode.setInstance("Fan.Speed");
|
||||
mode.addFriendlyName("Speed", "en-US");
|
||||
mode.addSupportedModes(["Low", "Medium", "High"].map((text) => ({
|
||||
value: `Speed.${text}`,
|
||||
modeResources: { friendlyNames: [{ "@type": "text", value: { text, locale: "en-US" } }] },
|
||||
})));
|
||||
},
|
||||
"zoo-scene": (device) => device.addCapability(T.SCENE_CONTROLLER),
|
||||
"zoo-tv": (device) => {
|
||||
device.addCapability("Alexa.PowerController", { proactivelyReported: true });
|
||||
device.addCapability("Alexa.ChannelController", { proactivelyReported: true });
|
||||
},
|
||||
};
|
||||
for (const [endpointId, declare] of Object.entries(declarations)) {
|
||||
const accepted = zoo(endpointId);
|
||||
const device = endpoint(endpointId, accepted.friendlyName, accepted.displayCategories);
|
||||
device.setDescription(accepted.description);
|
||||
device.setManufacturerName(accepted.manufacturerName);
|
||||
device.setManufacturer(accepted.additionalAttributes.manufacturer);
|
||||
device.setModel(accepted.additionalAttributes.model);
|
||||
declare(device);
|
||||
assert.deepEqual(device.getJSON(), { ...accepted, capabilities: [...accepted.capabilities, ALEXA] }, endpointId);
|
||||
assert.deepEqual(device.check(), [], endpointId);
|
||||
}
|
||||
});
|
||||
|
||||
test("registerDevice: every endpoint ends with the Alexa interface; alexaInterface: false leaves it out", async () => {
|
||||
const { alexa, bridge } = await setup(Alex2MQTT, "root");
|
||||
const lamp = bridge.registerDevice("Lamp", "lamp-1", DisplayCategory.LIGHT);
|
||||
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
lamp.addCapability(AlexaInterfaceType.ENDPOINT_HEALTH);
|
||||
const scene = bridge.registerDevice("Evening", "scene-1", DisplayCategory.SCENE_TRIGGER);
|
||||
scene.addCapability(AlexaInterfaceType.SCENE_CONTROLLER);
|
||||
// A registerDevice() device gets no Alexa.EndpointHealth it did not declare
|
||||
const bare = bridge.registerDevice("Plug", "plug-1", DisplayCategory.SMARTPLUG);
|
||||
bare.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
|
||||
assert.deepEqual((await discover(alexa, "root")).map(names), [
|
||||
["Alexa.PowerController", "Alexa.EndpointHealth", "Alexa"],
|
||||
["Alexa.SceneController", "Alexa"],
|
||||
["Alexa.PowerController", "Alexa"],
|
||||
]);
|
||||
|
||||
const without = await setup(Alex2MQTT, "root-1x", { alexaInterface: false });
|
||||
without.bridge.registerDevice("Lamp", "lamp-1", DisplayCategory.LIGHT).addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
without.bridge.addDevice({ endpointId: "lamp-2", name: "Lamp Two", categories: ["LIGHT"], endpointHealth: false }).add(PowerController);
|
||||
assert.deepEqual((await discover(without.alexa, "root-1x")).map(names), [["Alexa.PowerController"], ["Alexa.PowerController"]]);
|
||||
});
|
||||
|
||||
test("addDevice: the fields of the definition reach discovery; the defaults are those of registerDevice", async () => {
|
||||
const { alexa, bridge } = await setup(Alex2MQTT, "root");
|
||||
bridge.addDevice({
|
||||
endpointId: "bedroom-blinds",
|
||||
name: "Bedroom Blinds",
|
||||
categories: ["INTERIOR_BLIND", DisplayCategory.OTHER],
|
||||
description: "Roller blind by Acme",
|
||||
manufacturerName: "Acme",
|
||||
manufacturer: "Acme Inc",
|
||||
model: "RB-2",
|
||||
serialNumber: "0042",
|
||||
firmwareVersion: "2.1.0",
|
||||
softwareVersion: "2.1.3",
|
||||
customIdentifier: "acme-rb2-0042",
|
||||
cookie: { room: "bedroom" },
|
||||
endpointHealth: false,
|
||||
});
|
||||
bridge.addDevice({ endpointId: "lamp-1", name: "Lamp", categories: ["LIGHT"], endpointHealth: false });
|
||||
const registered = bridge.registerDevice("Lamp", "lamp-2", DisplayCategory.LIGHT);
|
||||
|
||||
const [blinds, lamp] = await discover(alexa, "root");
|
||||
assert.deepEqual(blinds, {
|
||||
endpointId: "bedroom-blinds",
|
||||
friendlyName: "Bedroom Blinds",
|
||||
description: "Roller blind by Acme",
|
||||
manufacturerName: "Acme",
|
||||
displayCategories: ["INTERIOR_BLIND", "OTHER"],
|
||||
additionalAttributes: {
|
||||
manufacturer: "Acme Inc",
|
||||
model: "RB-2",
|
||||
serialNumber: "0042",
|
||||
firmwareVersion: "2.1.0",
|
||||
softwareVersion: "2.1.3",
|
||||
customIdentifier: "acme-rb2-0042",
|
||||
},
|
||||
cookie: { room: "bedroom" },
|
||||
capabilities: [ALEXA],
|
||||
});
|
||||
assert.deepEqual(lamp, { ...registered.getJSON(), endpointId: "lamp-1" });
|
||||
assert.equal("cookie" in lamp, false);
|
||||
});
|
||||
|
||||
test("addDevice: Alexa.EndpointHealth is listed for the device unless it declares one, opts out or is a scene", async () => {
|
||||
const { alexa, bridge } = await setup(Alex2MQTT, "root");
|
||||
bridge.addDevice({ endpointId: "lamp-1", name: "Lamp", categories: ["LIGHT"] }).add(PowerController);
|
||||
const reporting = bridge.addDevice({ endpointId: "lamp-2", name: "Lamp Two", categories: ["LIGHT"] });
|
||||
reporting.add(EndpointHealth, { proactivelyReported: true });
|
||||
reporting.add(PowerController);
|
||||
bridge.addDevice({ endpointId: "lamp-3", name: "Lamp Three", categories: ["LIGHT"], endpointHealth: false }).add(PowerController);
|
||||
bridge.addDevice({ endpointId: "scene-1", name: "Evening", categories: ["SCENE_TRIGGER"], description: "Evening scene" })
|
||||
.addCapability(AlexaInterfaceType.SCENE_CONTROLLER);
|
||||
|
||||
const [lamp, declared, optedOut, scene] = await discover(alexa, "root");
|
||||
assert.deepEqual(names(lamp), ["Alexa.PowerController", "Alexa.EndpointHealth", "Alexa"]);
|
||||
assert.deepEqual(lamp.capabilities[1], {
|
||||
type: "AlexaInterface",
|
||||
interface: "Alexa.EndpointHealth",
|
||||
version: "3.1",
|
||||
properties: { supported: [{ name: "connectivity" }], proactivelyReported: false, retrievable: true },
|
||||
});
|
||||
assert.deepEqual(names(declared), ["Alexa.EndpointHealth", "Alexa.PowerController", "Alexa"]);
|
||||
assert.equal(declared.capabilities[0].properties.proactivelyReported, true);
|
||||
assert.deepEqual(names(optedOut), ["Alexa.PowerController", "Alexa"]);
|
||||
assert.deepEqual(names(scene), ["Alexa.SceneController", "Alexa"]);
|
||||
});
|
||||
|
||||
test("discovery logs what check() says about the devices, each line once", async () => {
|
||||
const logged = [];
|
||||
const { alexa, bridge } = await setup(Alex2MQTT, "root", { log: (message) => logged.push(message) });
|
||||
const warnings = () => logged.filter((message) => message.startsWith("warning: "));
|
||||
const lamp = bridge.registerDevice("Dave's Lamp", "lamp-1", DisplayCategory.LIGHT);
|
||||
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
lamp.addCapability(AlexaInterfaceType.LOCK_CONTROLLER);
|
||||
bridge.registerDevice("Lamp", "lamp-2", DisplayCategory.LIGHT).addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
|
||||
// Announced all the same: 1.x announced it, and Alexa may have taken it
|
||||
const [first] = await discover(alexa, "root");
|
||||
assert.deepEqual(names(first), ["Alexa.PowerController", "Alexa.PowerController", "Alexa.LockController", "Alexa"]);
|
||||
assert.deepEqual(warnings(), [
|
||||
'warning: lamp-1: the name "Dave\'s Lamp" takes up to 256 letters, digits and spaces, no punctuation',
|
||||
"warning: lamp-1: Alexa.PowerController: the interface is declared twice",
|
||||
"warning: lamp-1: Alexa.LockController: no property list known, discovery lists it with no supported properties",
|
||||
]);
|
||||
|
||||
lamp.setName("Daves Lamp");
|
||||
bridge.registerDevice("Timer!", "lamp-3", DisplayCategory.LIGHT);
|
||||
await discover(alexa, "root");
|
||||
assert.deepEqual(warnings().slice(3), ['warning: lamp-3: the name "Timer!" takes up to 256 letters, digits and spaces, no punctuation']);
|
||||
});
|
||||
|
||||
test("a device that cannot be described is left out of the answer and reported; the others are announced", async () => {
|
||||
const { alexa, bridge } = await setup(Alex2MQTT, "root");
|
||||
const errors = [];
|
||||
bridge.on("error", (err) => errors.push(err.message));
|
||||
bridge.registerDevice("Lamp", "lamp-1", DisplayCategory.LIGHT).addCapability(AlexaInterfaceType.POWER_CONTROLLER);
|
||||
const lock = bridge.registerDevice("Front Door", "lock-1", DisplayCategory.SMARTLOCK);
|
||||
lock.addCapability(AlexaInterfaceType.LOCK_CONTROLLER).getJSON = () => { throw new TypeError("state is not defined"); };
|
||||
|
||||
assert.deepEqual((await discover(alexa, "root")).map((each) => each.endpointId), ["lamp-1"]);
|
||||
assert.deepEqual(errors, ["lock-1 is not in the discovery answer: state is not defined"]);
|
||||
|
||||
// Without an error listener the same discovery is answered and nothing is thrown
|
||||
bridge.removeAllListeners("error");
|
||||
assert.deepEqual((await discover(alexa, "root")).map((each) => each.endpointId), ["lamp-1"]);
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue