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>
43 lines
1.5 KiB
TypeScript
43 lines
1.5 KiB
TypeScript
import type { Schema } from "../schema.js";
|
|
import type { Label } from "../types.js";
|
|
/** One mode: its value and what the user calls it. */
|
|
export interface Mode {
|
|
value: string;
|
|
friendlyNames: Label[];
|
|
}
|
|
/**
|
|
* One of a list of values, under an instance name: the wash cycle of a washer, the position of a garage door. Amazon
|
|
* certifies a garage door only with this interface and the display category GARAGE_DOOR.
|
|
*/
|
|
export declare const ModeController: import("../types.js").InterfaceDescriptor<{
|
|
mode: {
|
|
name: string;
|
|
value: Schema<string | null>;
|
|
note: string;
|
|
};
|
|
}, {
|
|
SetMode: {
|
|
name: string;
|
|
payload: Schema<import("../schema.js").InferShape<{
|
|
mode: Schema<string>;
|
|
}>>;
|
|
};
|
|
AdjustMode: {
|
|
name: string;
|
|
payload: Schema<import("../schema.js").InferShape<{
|
|
modeDelta: import("../schema.js").OptionalSchema<number>;
|
|
}>>;
|
|
when: ({ options }: {
|
|
options: {
|
|
ordered?: boolean;
|
|
};
|
|
}) => boolean;
|
|
note: string;
|
|
};
|
|
}, import("../schema.js").InferShape<{
|
|
/** At least two. When the modes have an order, in increasing order. */
|
|
supportedModes: Schema<Mode[]>;
|
|
/** The modes have an order, cold to hot, and the user can say "increase": Alexa sends AdjustMode. Default: false. */
|
|
ordered: import("../schema.js").OptionalSchema<boolean>;
|
|
semantics: import("../schema.js").OptionalSchema<import("../types.js").Semantics>;
|
|
}>, true>;
|