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
39
dist/esm/registry/interfaces/RangeController.d.ts
vendored
Normal file
39
dist/esm/registry/interfaces/RangeController.d.ts
vendored
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
/**
|
||||
* 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 declare const RangeController: import("../types.js").InterfaceDescriptor<{
|
||||
rangeValue: {
|
||||
name: string;
|
||||
value: import("../schema.js").Schema<number>;
|
||||
};
|
||||
}, {
|
||||
SetRangeValue: {
|
||||
name: string;
|
||||
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
|
||||
rangeValue: import("../schema.js").Schema<number>;
|
||||
}>>;
|
||||
};
|
||||
AdjustRangeValue: {
|
||||
name: string;
|
||||
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
|
||||
rangeValueDelta: import("../schema.js").Schema<number>;
|
||||
rangeValueDeltaDefault: import("../schema.js").Schema<boolean>;
|
||||
}>>;
|
||||
note: string;
|
||||
};
|
||||
}, import("../schema.js").InferShape<{
|
||||
/** precision is the step of the range and what "turn up the fan speed" changes it by. */
|
||||
range: import("../schema.js").Schema<import("../schema.js").InferShape<{
|
||||
min: import("../schema.js").Schema<number>;
|
||||
max: import("../schema.js").Schema<number>;
|
||||
precision: import("../schema.js").Schema<number>;
|
||||
}>>;
|
||||
unit: import("../schema.js").OptionalSchema<import("../catalog.js").UnitOfMeasure>;
|
||||
/** Names for values: "set the fan speed to maximum". */
|
||||
presets: import("../schema.js").OptionalSchema<import("../schema.js").InferShape<{
|
||||
value: import("../schema.js").Schema<number>;
|
||||
friendlyNames: import("../schema.js").Schema<import("../types.js").Label[]>;
|
||||
}>[]>;
|
||||
semantics: import("../schema.js").OptionalSchema<import("../types.js").Semantics>;
|
||||
}>, true>;
|
||||
Loading…
Add table
Add a link
Reference in a new issue