David
2558e21787
The three generic controllers are described in full and leave the stub table (62 stubs remain). A declaration
takes an instance name, friendly names from text() and asset(), and the options of the interface: range, unit and
presets for a range; supportedModes and ordered for a mode; semantics() for all three, with actions mapped to
directives and states mapped to a value or a range of values.
Refused at device.add(), each with the endpoint, interface and instance in the message: no instance name or no
friendly name; an instance declared twice; a first friendly name or a phrase used by another capability of the
endpoint; a reserved word, an asset id that is not in the catalog; range.max not above range.min; a preset off the
precision grid or outside the range; fewer than two modes or a mode listed twice; a mapping to a directive the
interface does not have, to a payload that does not fit, to a mode that is not listed, to AdjustMode on modes
that are not ordered; SetEcoOn, SetEcoOff, EcoOn and EcoOff on anything but a toggle.
For 1.x callers: Alexa.RangeController lists rangeValue (1.5.2 sent supported: []); addSupportedModes() announces
a mode given as a string as { value } and notes it, and takes { ordered: false } as a second argument, the default
stays true as 1.5.2 sent it (device.add() defaults to false). Declared the 1.x way, the zoo fan and curtain give
the same JSON as before.
Tests: the zoo blind, whose range, unit and semantics were written by hand into the JSON of 1.5.2, is declared
with device.add() and equals that JSON plus the Alexa capability; five capability objects of Amazon's examples
are reproduced the same way. 27 examples of four pages added. npm test: 108 pass (was 85) in 10.5-11.3 s, also on
Node 18.20.8 and 20.20.2.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
31 lines
1.3 KiB
JavaScript
31 lines
1.3 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.ToggleController = void 0;
|
|
const schema_js_1 = require("../schema.js");
|
|
const semantics_js_1 = require("../semantics.js");
|
|
const types_js_1 = require("../types.js");
|
|
const directives = {
|
|
TurnOn: { name: "TurnOn", payload: schema_js_1.s.object({}) },
|
|
TurnOff: { name: "TurnOff", payload: schema_js_1.s.object({}) },
|
|
};
|
|
/**
|
|
* Something that is on or off, under an instance name: the oscillation of a fan, the light of an oven. The one
|
|
* generic controller that Alexa hunches work with (SetEcoOn, SetEcoOff, EcoOn, EcoOff).
|
|
*/
|
|
exports.ToggleController = (0, types_js_1.defineInterface)({
|
|
namespace: "Alexa.ToggleController",
|
|
version: "3",
|
|
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-togglecontroller.html",
|
|
kind: "controller",
|
|
tier: 1,
|
|
instanced: true,
|
|
properties: {
|
|
toggleState: { name: "toggleState", value: schema_js_1.s.enum("ON", "OFF") },
|
|
},
|
|
directives,
|
|
options: schema_js_1.s.object({
|
|
semantics: schema_js_1.s.optional((0, semantics_js_1.semanticsOf)({ directives, stateValue: schema_js_1.s.enum("ON", "OFF"), hunches: true })),
|
|
}, { unknownKeys: "reject" }),
|
|
errorNamespace: "Alexa.Safety",
|
|
errorTypes: ["OBSTACLE_DETECTED", "SAFETY_BEAM_BREACHED"],
|
|
});
|