David
c492ef74d1
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>
38 lines
2.2 KiB
JavaScript
38 lines
2.2 KiB
JavaScript
// The ES module build, imported the way an ES module consumer writes it, on the broker: a build that loads but
|
|
// cannot reach mqtt or one of its own files fails here.
|
|
import { test } from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import { Alex2MQTT, AlexaInterfaceType, DisplayCategory, EndpointHealth, PowerController } from "alex2node";
|
|
import harness from "./helpers/harness.js";
|
|
|
|
const { setup, directive, until, UUID_V4 } = harness;
|
|
|
|
test("import { Alex2MQTT } from \"alex2node\": discovery, a directive and a change report on the ES module build", async () => {
|
|
const { alexa, bridge } = await setup(Alex2MQTT, "root");
|
|
const lamp = bridge.registerDevice("Lamp", "lamp-1", DisplayCategory.LIGHT);
|
|
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER, { proactivelyReported: true });
|
|
lamp.addCapability(AlexaInterfaceType.ENDPOINT_HEALTH);
|
|
lamp.on("Event", (request) => {
|
|
lamp.getStatusMessage(request.header.correlationToken, true)
|
|
.addHealthProp(EndpointHealth.OK)
|
|
.addPowerControllerProp(PowerController.ON)
|
|
.send();
|
|
});
|
|
|
|
alexa.publish("root/discover", { namespace: "Alexa.Discovery", name: "Discover" });
|
|
await until(() => alexa.on("root/discover_r").length === 1, 3000, "discovery reply");
|
|
const [endpoints] = alexa.on("root/discover_r");
|
|
assert.deepEqual(endpoints.map((e) => e.endpointId), ["lamp-1"]);
|
|
assert.deepEqual(endpoints[0].capabilities.map((c) => c.interface), ["Alexa.PowerController", "Alexa.EndpointHealth", "Alexa"]);
|
|
|
|
alexa.send("root", directive("Alexa.PowerController", "TurnOn", "lamp-1", "ct1"));
|
|
await until(() => alexa.on("root/lamp-1/alexaResponce").length === 1, 3000, "directive response");
|
|
const [response] = alexa.on("root/lamp-1/alexaResponce");
|
|
assert.equal(response.event.header.name, "Response");
|
|
assert.equal(response.event.header.correlationToken, "ct1");
|
|
assert.match(response.event.header.messageId, UUID_V4);
|
|
|
|
assert.equal(await lamp.getChangeReport().addPowerControllerProp(PowerController.OFF).send(), "root/changeReport");
|
|
await until(() => alexa.on("root/changeReport").length === 1, 3000, "change report");
|
|
assert.equal(alexa.on("root/changeReport")[0].event.payload.change.properties[0].value, "OFF");
|
|
});
|