registry: RangeController, ModeController, ToggleController with resources, presets and semantics
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>
This commit is contained in:
parent
c492ef74d1
commit
2558e21787
80 changed files with 3131 additions and 107 deletions
73
dist/esm/registry/interfaces/RangeController.js
vendored
Normal file
73
dist/esm/registry/interfaces/RangeController.js
vendored
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
import { UNITS_OF_MEASURE } from "../catalog.js";
|
||||
import { labels } from "../resources.js";
|
||||
import { s } from "../schema.js";
|
||||
import { semanticsOf } from "../semantics.js";
|
||||
import { DeclarationError, defineInterface } from "../types.js";
|
||||
const directives = {
|
||||
SetRangeValue: { name: "SetRangeValue", payload: s.object({ rangeValue: s.number() }) },
|
||||
AdjustRangeValue: {
|
||||
name: "AdjustRangeValue",
|
||||
payload: s.object({ rangeValueDelta: s.number(), rangeValueDeltaDefault: s.boolean() }),
|
||||
note: "rangeValueDeltaDefault is true when the user named no amount; rangeValueDelta is then the precision",
|
||||
},
|
||||
};
|
||||
// 0.1 + 0.2 is not 0.3: a value is on the grid when it is within a millionth of a step of it
|
||||
function onGrid(value, origin, step) {
|
||||
const steps = (value - origin) / step;
|
||||
return Math.abs(steps - Math.round(steps)) < 1e-6;
|
||||
}
|
||||
/**
|
||||
* A number in a range, under an instance name: the position of a blind, the speed of a fan. With nonControllable it
|
||||
* is a reading the user can ask for, like an air quality index.
|
||||
*/
|
||||
export const RangeController = defineInterface({
|
||||
namespace: "Alexa.RangeController",
|
||||
version: "3",
|
||||
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-rangecontroller.html",
|
||||
kind: "controller",
|
||||
tier: 1,
|
||||
instanced: true,
|
||||
properties: {
|
||||
rangeValue: { name: "rangeValue", value: s.number() },
|
||||
},
|
||||
directives,
|
||||
options: s.object({
|
||||
/** precision is the step of the range and what "turn up the fan speed" changes it by. */
|
||||
range: s.object({ min: s.number(), max: s.number(), precision: s.number({ gt: 0 }) }, { unknownKeys: "reject" }),
|
||||
unit: s.optional(s.oneOf(UNITS_OF_MEASURE, "a unit of measure like Alexa.Unit.Percent")),
|
||||
/** Names for values: "set the fan speed to maximum". */
|
||||
presets: s.optional(s.array(s.object({ value: s.number(), friendlyNames: labels }, { unknownKeys: "reject" }))),
|
||||
semantics: s.optional(semanticsOf({ directives, stateValue: s.number(), ranges: true })),
|
||||
}, { unknownKeys: "reject" }),
|
||||
// A capability declared the 1.x way may be without a range; check() says so, discovery lists what there is
|
||||
discovery({ options: { range, unit, presets } }) {
|
||||
const configuration = {
|
||||
...(range && { supportedRange: { minimumValue: range.min, maximumValue: range.max, precision: range.precision } }),
|
||||
...(unit && { unitOfMeasure: unit }),
|
||||
...(presets && { presets: presets.map(({ value, friendlyNames }) => ({ rangeValue: value, presetResources: { friendlyNames } })) }),
|
||||
};
|
||||
return Object.keys(configuration).length > 0 ? { configuration } : {};
|
||||
},
|
||||
validate(capability) {
|
||||
const { range: { min, max, precision }, presets = [], semantics } = capability.options;
|
||||
const inRange = (value) => value >= min && value <= max;
|
||||
if (max <= min)
|
||||
throw new DeclarationError(capability, `range.max ${max} is not above range.min ${min}`);
|
||||
for (const { value } of presets) {
|
||||
// alexa-rangecontroller.html, "Preset object": "minimum range value + (n x precision) where n is an integer"
|
||||
if (!inRange(value) || !onGrid(value, min, precision)) {
|
||||
throw new DeclarationError(capability, `the preset ${value} is not ${min} + n x ${precision}, up to ${max}`);
|
||||
}
|
||||
}
|
||||
for (const { directive } of semantics?.actionMappings ?? []) {
|
||||
const { rangeValue } = directive.payload ?? {};
|
||||
if (directive.name === "SetRangeValue" && !inRange(rangeValue)) {
|
||||
throw new DeclarationError(capability, `an action is mapped to SetRangeValue ${rangeValue}, the range is ${min} to ${max}`);
|
||||
}
|
||||
}
|
||||
},
|
||||
// alexa-rangecontroller.html, "SetRangeValue directive error handling": "If your error is safety related, respond
|
||||
// with an Alexa.Safety.ErrorResponse"
|
||||
errorNamespace: "Alexa.Safety",
|
||||
errorTypes: ["OBSTACLE_DETECTED", "SAFETY_BEAM_BREACHED"],
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue