registry: Lock, Color, ColorTemperature, Percentage, PowerLevel, Contact, Motion, Humidity

Eight descriptors written from their pages, each with its version, the value of its property and the payload of
every directive. Seven replace a stub; Alexa.HumiditySensor is new, as AlexaInterfaceType.HUMIDITY_SENSOR.
LockController is deferrable: defer() on a lock logs no warning.

A 1.x declaration of LockController, MotionSensor, PercentageController or PowerLevelController now lists its
property in discovery, where 1.5.2 listed none: the zoo's lock, motion sensor and heater come out as the JSON
Alexa accepted. A payload that does not fit (hue 361, 900 K) is answered with INVALID_VALUE.

48 examples of the eight pages are saved as fixtures. 191 tests pass, 168 before.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
David 2026-09-28 20:29:04 +00:00
parent feff828ec1
commit af1489696d
111 changed files with 2971 additions and 45 deletions

View file

@ -34,6 +34,8 @@ var AlexaInterfaceType;
AlexaInterfaceType["DOORBELL_EVENT_SOURCE"] = "Alexa.DoorbellEventSource"; AlexaInterfaceType["DOORBELL_EVENT_SOURCE"] = "Alexa.DoorbellEventSource";
AlexaInterfaceType["ENDPOINT_HEALTH"] = "Alexa.EndpointHealth"; AlexaInterfaceType["ENDPOINT_HEALTH"] = "Alexa.EndpointHealth";
AlexaInterfaceType["EQUALIZER_CONTROLLER"] = "Alexa.EqualizerController"; AlexaInterfaceType["EQUALIZER_CONTROLLER"] = "Alexa.EqualizerController";
/** Since 2.0. */
AlexaInterfaceType["HUMIDITY_SENSOR"] = "Alexa.HumiditySensor";
AlexaInterfaceType["INPUT_CONTROLLER"] = "Alexa.InputController"; AlexaInterfaceType["INPUT_CONTROLLER"] = "Alexa.InputController";
AlexaInterfaceType["INVENTORY_LEVEL_SENSOR"] = "Alexa.InventoryLevelSensor"; AlexaInterfaceType["INVENTORY_LEVEL_SENSOR"] = "Alexa.InventoryLevelSensor";
AlexaInterfaceType["INVENTORY_LEVEL_USAGE_SENSOR"] = "Alexa.InventoryLevelUsageSensor"; AlexaInterfaceType["INVENTORY_LEVEL_USAGE_SENSOR"] = "Alexa.InventoryLevelUsageSensor";

11
dist/cjs/index.js vendored
View file

@ -36,7 +36,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod }; return (mod && mod.__esModule) ? mod : { "default": mod };
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
exports.AlexaErrorResponse = exports.AlexaStatusMessage = exports.ThermostatMode = exports.TemperatureSensorScale = exports.PowerState = exports.DisplayCategory = exports.AlexaInterfaceType = exports.AlexaErrorType = exports.AlexaActions = exports.ActionMapping = exports.AlexaInterface = exports.MemoryPublisher = exports.topics = exports.property = exports.StateBuilder = exports.MessageError = exports.AlexaErrors = exports.AlexaError = exports.messages = exports.DisplayCategories = exports.States = exports.Actions = exports.Units = exports.Assets = exports.SemanticsBuilder = exports.semantics = exports.text = exports.asset = exports.EndpointHealth = exports.PowerController = exports.ToggleController = exports.TemperatureSensor = exports.RangeController = exports.ModeController = exports.BrightnessController = exports.Alexa = exports.SchemaError = exports.DeclarationError = exports.registry = exports.Capability = exports.Device = exports.DEFAULT_HOST = exports.Alex2MQTT = void 0; exports.AlexaStatusMessage = exports.ThermostatMode = exports.TemperatureSensorScale = exports.PowerState = exports.DisplayCategory = exports.AlexaInterfaceType = exports.AlexaErrorType = exports.AlexaActions = exports.ActionMapping = exports.AlexaInterface = exports.MemoryPublisher = exports.topics = exports.property = exports.StateBuilder = exports.MessageError = exports.AlexaErrors = exports.AlexaError = exports.messages = exports.DisplayCategories = exports.States = exports.Actions = exports.Units = exports.Assets = exports.SemanticsBuilder = exports.semantics = exports.text = exports.asset = exports.EndpointHealth = exports.PowerController = exports.ToggleController = exports.TemperatureSensor = exports.RangeController = exports.PowerLevelController = exports.PercentageController = exports.MotionSensor = exports.ModeController = exports.LockController = exports.HumiditySensor = exports.ContactSensor = exports.ColorTemperatureController = exports.ColorController = exports.BrightnessController = exports.Alexa = exports.SchemaError = exports.DeclarationError = exports.registry = exports.Capability = exports.Device = exports.DEFAULT_HOST = exports.Alex2MQTT = void 0;
exports.AlexaErrorResponse = void 0;
// Relative specifiers carry ".js": Node's ES module loader resolves no extension, and TypeScript maps it back to the .ts. // Relative specifiers carry ".js": Node's ES module loader resolves no extension, and TypeScript maps it back to the .ts.
var Alex2Node_js_1 = require("./Alex2Node.js"); var Alex2Node_js_1 = require("./Alex2Node.js");
Object.defineProperty(exports, "Alex2MQTT", { enumerable: true, get: function () { return __importDefault(Alex2Node_js_1).default; } }); Object.defineProperty(exports, "Alex2MQTT", { enumerable: true, get: function () { return __importDefault(Alex2Node_js_1).default; } });
@ -53,7 +54,15 @@ Object.defineProperty(exports, "SchemaError", { enumerable: true, get: function
var index_js_2 = require("./registry/index.js"); var index_js_2 = require("./registry/index.js");
Object.defineProperty(exports, "Alexa", { enumerable: true, get: function () { return index_js_2.Alexa; } }); Object.defineProperty(exports, "Alexa", { enumerable: true, get: function () { return index_js_2.Alexa; } });
Object.defineProperty(exports, "BrightnessController", { enumerable: true, get: function () { return index_js_2.BrightnessController; } }); Object.defineProperty(exports, "BrightnessController", { enumerable: true, get: function () { return index_js_2.BrightnessController; } });
Object.defineProperty(exports, "ColorController", { enumerable: true, get: function () { return index_js_2.ColorController; } });
Object.defineProperty(exports, "ColorTemperatureController", { enumerable: true, get: function () { return index_js_2.ColorTemperatureController; } });
Object.defineProperty(exports, "ContactSensor", { enumerable: true, get: function () { return index_js_2.ContactSensor; } });
Object.defineProperty(exports, "HumiditySensor", { enumerable: true, get: function () { return index_js_2.HumiditySensor; } });
Object.defineProperty(exports, "LockController", { enumerable: true, get: function () { return index_js_2.LockController; } });
Object.defineProperty(exports, "ModeController", { enumerable: true, get: function () { return index_js_2.ModeController; } }); Object.defineProperty(exports, "ModeController", { enumerable: true, get: function () { return index_js_2.ModeController; } });
Object.defineProperty(exports, "MotionSensor", { enumerable: true, get: function () { return index_js_2.MotionSensor; } });
Object.defineProperty(exports, "PercentageController", { enumerable: true, get: function () { return index_js_2.PercentageController; } });
Object.defineProperty(exports, "PowerLevelController", { enumerable: true, get: function () { return index_js_2.PowerLevelController; } });
Object.defineProperty(exports, "RangeController", { enumerable: true, get: function () { return index_js_2.RangeController; } }); Object.defineProperty(exports, "RangeController", { enumerable: true, get: function () { return index_js_2.RangeController; } });
Object.defineProperty(exports, "TemperatureSensor", { enumerable: true, get: function () { return index_js_2.TemperatureSensor; } }); Object.defineProperty(exports, "TemperatureSensor", { enumerable: true, get: function () { return index_js_2.TemperatureSensor; } });
Object.defineProperty(exports, "ToggleController", { enumerable: true, get: function () { return index_js_2.ToggleController; } }); Object.defineProperty(exports, "ToggleController", { enumerable: true, get: function () { return index_js_2.ToggleController; } });

View file

@ -14,18 +14,34 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
exports.SchemaError = exports.s = exports.defineInterface = exports.DeclarationError = exports.SemanticsBuilder = exports.semantics = exports.text = exports.asset = exports.ToggleController = exports.TemperatureSensor = exports.RangeController = exports.PowerController = exports.ModeController = exports.EndpointHealth = exports.BrightnessController = exports.Alexa = exports.registry = void 0; exports.SchemaError = exports.s = exports.defineInterface = exports.DeclarationError = exports.SemanticsBuilder = exports.semantics = exports.text = exports.asset = exports.ToggleController = exports.TemperatureSensor = exports.RangeController = exports.PowerLevelController = exports.PowerController = exports.PercentageController = exports.MotionSensor = exports.ModeController = exports.LockController = exports.HumiditySensor = exports.EndpointHealth = exports.ContactSensor = exports.ColorTemperatureController = exports.ColorController = exports.BrightnessController = exports.Alexa = exports.registry = void 0;
// The interfaces the library knows, by namespace. // The interfaces the library knows, by namespace.
const Alexa_js_1 = require("./interfaces/Alexa.js"); const Alexa_js_1 = require("./interfaces/Alexa.js");
Object.defineProperty(exports, "Alexa", { enumerable: true, get: function () { return Alexa_js_1.Alexa; } }); Object.defineProperty(exports, "Alexa", { enumerable: true, get: function () { return Alexa_js_1.Alexa; } });
const BrightnessController_js_1 = require("./interfaces/BrightnessController.js"); const BrightnessController_js_1 = require("./interfaces/BrightnessController.js");
Object.defineProperty(exports, "BrightnessController", { enumerable: true, get: function () { return BrightnessController_js_1.BrightnessController; } }); Object.defineProperty(exports, "BrightnessController", { enumerable: true, get: function () { return BrightnessController_js_1.BrightnessController; } });
const ColorController_js_1 = require("./interfaces/ColorController.js");
Object.defineProperty(exports, "ColorController", { enumerable: true, get: function () { return ColorController_js_1.ColorController; } });
const ColorTemperatureController_js_1 = require("./interfaces/ColorTemperatureController.js");
Object.defineProperty(exports, "ColorTemperatureController", { enumerable: true, get: function () { return ColorTemperatureController_js_1.ColorTemperatureController; } });
const ContactSensor_js_1 = require("./interfaces/ContactSensor.js");
Object.defineProperty(exports, "ContactSensor", { enumerable: true, get: function () { return ContactSensor_js_1.ContactSensor; } });
const EndpointHealth_js_1 = require("./interfaces/EndpointHealth.js"); const EndpointHealth_js_1 = require("./interfaces/EndpointHealth.js");
Object.defineProperty(exports, "EndpointHealth", { enumerable: true, get: function () { return EndpointHealth_js_1.EndpointHealth; } }); Object.defineProperty(exports, "EndpointHealth", { enumerable: true, get: function () { return EndpointHealth_js_1.EndpointHealth; } });
const HumiditySensor_js_1 = require("./interfaces/HumiditySensor.js");
Object.defineProperty(exports, "HumiditySensor", { enumerable: true, get: function () { return HumiditySensor_js_1.HumiditySensor; } });
const LockController_js_1 = require("./interfaces/LockController.js");
Object.defineProperty(exports, "LockController", { enumerable: true, get: function () { return LockController_js_1.LockController; } });
const ModeController_js_1 = require("./interfaces/ModeController.js"); const ModeController_js_1 = require("./interfaces/ModeController.js");
Object.defineProperty(exports, "ModeController", { enumerable: true, get: function () { return ModeController_js_1.ModeController; } }); Object.defineProperty(exports, "ModeController", { enumerable: true, get: function () { return ModeController_js_1.ModeController; } });
const MotionSensor_js_1 = require("./interfaces/MotionSensor.js");
Object.defineProperty(exports, "MotionSensor", { enumerable: true, get: function () { return MotionSensor_js_1.MotionSensor; } });
const PercentageController_js_1 = require("./interfaces/PercentageController.js");
Object.defineProperty(exports, "PercentageController", { enumerable: true, get: function () { return PercentageController_js_1.PercentageController; } });
const PowerController_js_1 = require("./interfaces/PowerController.js"); const PowerController_js_1 = require("./interfaces/PowerController.js");
Object.defineProperty(exports, "PowerController", { enumerable: true, get: function () { return PowerController_js_1.PowerController; } }); Object.defineProperty(exports, "PowerController", { enumerable: true, get: function () { return PowerController_js_1.PowerController; } });
const PowerLevelController_js_1 = require("./interfaces/PowerLevelController.js");
Object.defineProperty(exports, "PowerLevelController", { enumerable: true, get: function () { return PowerLevelController_js_1.PowerLevelController; } });
const RangeController_js_1 = require("./interfaces/RangeController.js"); const RangeController_js_1 = require("./interfaces/RangeController.js");
Object.defineProperty(exports, "RangeController", { enumerable: true, get: function () { return RangeController_js_1.RangeController; } }); Object.defineProperty(exports, "RangeController", { enumerable: true, get: function () { return RangeController_js_1.RangeController; } });
const TemperatureSensor_js_1 = require("./interfaces/TemperatureSensor.js"); const TemperatureSensor_js_1 = require("./interfaces/TemperatureSensor.js");
@ -37,9 +53,17 @@ const types_js_1 = require("./types.js");
const described = [ const described = [
Alexa_js_1.Alexa, Alexa_js_1.Alexa,
BrightnessController_js_1.BrightnessController, BrightnessController_js_1.BrightnessController,
ColorController_js_1.ColorController,
ColorTemperatureController_js_1.ColorTemperatureController,
ContactSensor_js_1.ContactSensor,
EndpointHealth_js_1.EndpointHealth, EndpointHealth_js_1.EndpointHealth,
HumiditySensor_js_1.HumiditySensor,
LockController_js_1.LockController,
ModeController_js_1.ModeController, ModeController_js_1.ModeController,
MotionSensor_js_1.MotionSensor,
PercentageController_js_1.PercentageController,
PowerController_js_1.PowerController, PowerController_js_1.PowerController,
PowerLevelController_js_1.PowerLevelController,
RangeController_js_1.RangeController, RangeController_js_1.RangeController,
TemperatureSensor_js_1.TemperatureSensor, TemperatureSensor_js_1.TemperatureSensor,
ToggleController_js_1.ToggleController, ToggleController_js_1.ToggleController,

View file

@ -0,0 +1,29 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ColorController = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
// alexa-property-schemas.html, "Color"
const color = schema_js_1.s.object({
hue: schema_js_1.s.number({ min: 0, max: 360 }),
saturation: schema_js_1.s.number({ min: 0, max: 1 }),
brightness: schema_js_1.s.number({ min: 0, max: 1 }),
});
/**
* A light changes its hue and saturation and keeps the brightness it has: "ignore the brightness value of 1 in the
* directive" (alexa-colorcontroller.html, "SetColor directive example").
*/
exports.ColorController = (0, types_js_1.defineInterface)({
namespace: "Alexa.ColorController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colorcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
color: { name: "color", value: color },
},
directives: {
SetColor: { name: "SetColor", payload: schema_js_1.s.object({ color }) },
},
});

View file

@ -0,0 +1,28 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ColorTemperatureController = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
// alexa-colortemperaturecontroller.html, "Reportable properties": "Valid values range from 1,000 to 10,000"
const kelvin = schema_js_1.s.number({ min: 1000, max: 10000, integer: true });
/**
* The white of a tunable light. Alexa asks for 2200 (warm), 2700 (soft), 4000 (white), 5500 (daylight) and 7000
* (cool); a light that cannot show the value takes the nearest it can. A light that shows a colour answers
* NOT_SUPPORTED_IN_CURRENT_MODE with currentDeviceMode COLOR.
*/
exports.ColorTemperatureController = (0, types_js_1.defineInterface)({
namespace: "Alexa.ColorTemperatureController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colortemperaturecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
colorTemperatureInKelvin: { name: "colorTemperatureInKelvin", value: kelvin },
},
directives: {
SetColorTemperature: { name: "SetColorTemperature", payload: schema_js_1.s.object({ colorTemperatureInKelvin: kelvin }) },
IncreaseColorTemperature: { name: "IncreaseColorTemperature", payload: schema_js_1.s.object({}), note: "towards cool" },
DecreaseColorTemperature: { name: "DecreaseColorTemperature", payload: schema_js_1.s.object({}), note: "towards warm" },
},
});

View file

@ -0,0 +1,21 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ContactSensor = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/**
* DETECTED is open: the two pieces of the sensor are apart. A sensor that cannot answer ReportState sends a
* ChangeReport right after discovery, so that the Alexa app shows its state (alexa-contactsensor.html).
*/
exports.ContactSensor = (0, types_js_1.defineInterface)({
namespace: "Alexa.ContactSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-contactsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: schema_js_1.s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,18 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.HumiditySensor = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/** The value is an object, { value: 45.5 }, as the reports of alexa-humiditysensor.html print it. */
exports.HumiditySensor = (0, types_js_1.defineInterface)({
namespace: "Alexa.HumiditySensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-humiditysensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
relativeHumidity: { name: "relativeHumidity", value: schema_js_1.s.object({ value: schema_js_1.s.number({ min: 0, max: 100 }) }) },
},
directives: {},
});

View file

@ -0,0 +1,29 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.LockController = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/**
* A lock that takes more than five seconds answers with a DeferredResponse first and the Response when the bolt has
* moved (alexa-lockcontroller.html, "Lock response"). The user enables unlocking by voice per device, in the Alexa app.
*/
exports.LockController = (0, types_js_1.defineInterface)({
namespace: "Alexa.LockController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-lockcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
lockState: {
name: "lockState",
value: schema_js_1.s.enum("LOCKED", "UNLOCKED", "JAMMED"),
note: "JAMMED: the mechanism can reach neither LOCKED nor UNLOCKED",
},
},
directives: {
Lock: { name: "Lock", payload: schema_js_1.s.object({}) },
Unlock: { name: "Unlock", payload: schema_js_1.s.object({}) },
},
deferrable: true,
});

View file

@ -0,0 +1,21 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MotionSensor = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/**
* "When a motion sensor changes to DETECTED, and then changes to NOT_DETECTED, you must wait at least 30 seconds
* before sending the second change report" (alexa-motionsensor.html, "Change reporting").
*/
exports.MotionSensor = (0, types_js_1.defineInterface)({
namespace: "Alexa.MotionSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-motionsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: schema_js_1.s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,30 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PercentageController = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/**
* For a device no other interface fits: "Use this interface only if there isn't a more specific controller
* interface that applies to your device" (alexa-percentagecontroller.html).
*/
exports.PercentageController = (0, types_js_1.defineInterface)({
namespace: "Alexa.PercentageController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-percentagecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
percentage: { name: "percentage", value: schema_js_1.s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPercentage: {
name: "SetPercentage",
payload: schema_js_1.s.object({ percentage: schema_js_1.s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPercentage: {
name: "AdjustPercentage",
payload: schema_js_1.s.object({ percentageDelta: schema_js_1.s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -0,0 +1,27 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PowerLevelController = void 0;
const schema_js_1 = require("../schema.js");
const types_js_1 = require("../types.js");
/** The power of a device as a percentage, a dimmer switch for one (alexa-powerlevelcontroller.html). */
exports.PowerLevelController = (0, types_js_1.defineInterface)({
namespace: "Alexa.PowerLevelController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-powerlevelcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
powerLevel: { name: "powerLevel", value: schema_js_1.s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPowerLevel: {
name: "SetPowerLevel",
payload: schema_js_1.s.object({ powerLevel: schema_js_1.s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPowerLevel: {
name: "AdjustPowerLevel",
payload: schema_js_1.s.object({ powerLevelDelta: schema_js_1.s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -21,11 +21,8 @@ const TABLE = [
["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES], ["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES],
["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"], ["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"],
["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"], ["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"],
["Alexa.ColorController", "3", ["color"], "alexa-colorcontroller.html"],
["Alexa.ColorTemperatureController", "3", ["colorTemperatureInKelvin"], "alexa-colortemperaturecontroller.html"],
["Alexa.Commissionable", "1", [], "alexa-commissionable.html"], ["Alexa.Commissionable", "1", [], "alexa-commissionable.html"],
["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"], ["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"],
["Alexa.ContactSensor", "3", ["detectionState"], "alexa-contactsensor.html"],
["Alexa.Cooking", "1", [], "alexa-cooking.html"], ["Alexa.Cooking", "1", [], "alexa-cooking.html"],
["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"], ["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"],
["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"], ["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"],
@ -44,15 +41,11 @@ const TABLE = [
["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"], ["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"],
["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"], ["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"],
["Alexa.Launcher", "1.1", [], "alexa-launcher.html"], ["Alexa.Launcher", "1.1", [], "alexa-launcher.html"],
["Alexa.LockController", "3", [], "alexa-lockcontroller.html"],
["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"], ["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"],
["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"], ["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"],
["Alexa.Media.Search", "1", [], "alexa-media-search.html"], ["Alexa.Media.Search", "1", [], "alexa-media-search.html"],
["Alexa.MotionSensor", "3", [], "alexa-motionsensor.html"],
["Alexa.PercentageController", "3", [], "alexa-percentagecontroller.html"],
["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"],
["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"],
["Alexa.PowerLevelController", "3", [], "alexa-powerlevelcontroller.html"],
["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"], ["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"],
["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"], ["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"],
["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"], ["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"],

View file

@ -27,6 +27,8 @@ export declare enum AlexaInterfaceType {
DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource", DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource",
ENDPOINT_HEALTH = "Alexa.EndpointHealth", ENDPOINT_HEALTH = "Alexa.EndpointHealth",
EQUALIZER_CONTROLLER = "Alexa.EqualizerController", EQUALIZER_CONTROLLER = "Alexa.EqualizerController",
/** Since 2.0. */
HUMIDITY_SENSOR = "Alexa.HumiditySensor",
INPUT_CONTROLLER = "Alexa.InputController", INPUT_CONTROLLER = "Alexa.InputController",
INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor", INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor",
INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor", INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor",

View file

@ -31,6 +31,8 @@ export var AlexaInterfaceType;
AlexaInterfaceType["DOORBELL_EVENT_SOURCE"] = "Alexa.DoorbellEventSource"; AlexaInterfaceType["DOORBELL_EVENT_SOURCE"] = "Alexa.DoorbellEventSource";
AlexaInterfaceType["ENDPOINT_HEALTH"] = "Alexa.EndpointHealth"; AlexaInterfaceType["ENDPOINT_HEALTH"] = "Alexa.EndpointHealth";
AlexaInterfaceType["EQUALIZER_CONTROLLER"] = "Alexa.EqualizerController"; AlexaInterfaceType["EQUALIZER_CONTROLLER"] = "Alexa.EqualizerController";
/** Since 2.0. */
AlexaInterfaceType["HUMIDITY_SENSOR"] = "Alexa.HumiditySensor";
AlexaInterfaceType["INPUT_CONTROLLER"] = "Alexa.InputController"; AlexaInterfaceType["INPUT_CONTROLLER"] = "Alexa.InputController";
AlexaInterfaceType["INVENTORY_LEVEL_SENSOR"] = "Alexa.InventoryLevelSensor"; AlexaInterfaceType["INVENTORY_LEVEL_SENSOR"] = "Alexa.InventoryLevelSensor";
AlexaInterfaceType["INVENTORY_LEVEL_USAGE_SENSOR"] = "Alexa.InventoryLevelUsageSensor"; AlexaInterfaceType["INVENTORY_LEVEL_USAGE_SENSOR"] = "Alexa.InventoryLevelUsageSensor";

2
dist/esm/index.d.ts vendored
View file

@ -5,7 +5,7 @@ export type { EndpointDefinition, EndpointJson } from "./device/Device.js";
export { Capability } from "./device/Capability.js"; export { Capability } from "./device/Capability.js";
export type { CapabilityJson, CommonOptions, Declaration } from "./device/Capability.js"; export type { CapabilityJson, CommonOptions, Declaration } from "./device/Capability.js";
export { registry, DeclarationError, SchemaError } from "./registry/index.js"; export { registry, DeclarationError, SchemaError } from "./registry/index.js";
export { Alexa, BrightnessController, ModeController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js"; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js";
export { PowerController, EndpointHealth } from "./compat/enums.js"; export { PowerController, EndpointHealth } from "./compat/enums.js";
export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js"; export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js";
export { ASSETS as Assets, UNITS_OF_MEASURE as Units, ACTIONS as Actions, STATES as States, DISPLAY_CATEGORIES as DisplayCategories, } from "./registry/index.js"; export { ASSETS as Assets, UNITS_OF_MEASURE as Units, ACTIONS as Actions, STATES as States, DISPLAY_CATEGORIES as DisplayCategories, } from "./registry/index.js";

2
dist/esm/index.js vendored
View file

@ -4,7 +4,7 @@ export { default as Device } from "./device/Device.js";
export { Capability } from "./device/Capability.js"; export { Capability } from "./device/Capability.js";
// The interfaces, for device.add(), and the registry that holds them by name // The interfaces, for device.add(), and the registry that holds them by name
export { registry, DeclarationError, SchemaError } from "./registry/index.js"; export { registry, DeclarationError, SchemaError } from "./registry/index.js";
export { Alexa, BrightnessController, ModeController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js"; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js";
export { PowerController, EndpointHealth } from "./compat/enums.js"; export { PowerController, EndpointHealth } from "./compat/enums.js";
export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js"; export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js";
// The vocabularies of the Smart Home API // The vocabularies of the Smart Home API

View file

@ -1,8 +1,16 @@
import { Alexa } from "./interfaces/Alexa.js"; import { Alexa } from "./interfaces/Alexa.js";
import { BrightnessController } from "./interfaces/BrightnessController.js"; import { BrightnessController } from "./interfaces/BrightnessController.js";
import { ColorController } from "./interfaces/ColorController.js";
import { ColorTemperatureController } from "./interfaces/ColorTemperatureController.js";
import { ContactSensor } from "./interfaces/ContactSensor.js";
import { EndpointHealth } from "./interfaces/EndpointHealth.js"; import { EndpointHealth } from "./interfaces/EndpointHealth.js";
import { HumiditySensor } from "./interfaces/HumiditySensor.js";
import { LockController } from "./interfaces/LockController.js";
import { ModeController } from "./interfaces/ModeController.js"; import { ModeController } from "./interfaces/ModeController.js";
import { MotionSensor } from "./interfaces/MotionSensor.js";
import { PercentageController } from "./interfaces/PercentageController.js";
import { PowerController } from "./interfaces/PowerController.js"; import { PowerController } from "./interfaces/PowerController.js";
import { PowerLevelController } from "./interfaces/PowerLevelController.js";
import { RangeController } from "./interfaces/RangeController.js"; import { RangeController } from "./interfaces/RangeController.js";
import { TemperatureSensor } from "./interfaces/TemperatureSensor.js"; import { TemperatureSensor } from "./interfaces/TemperatureSensor.js";
import { ToggleController } from "./interfaces/ToggleController.js"; import { ToggleController } from "./interfaces/ToggleController.js";
@ -15,7 +23,7 @@ export declare const registry: {
/** Every descriptor, ordered by namespace. */ /** Every descriptor, ordered by namespace. */
list(): AnyDescriptor[]; list(): AnyDescriptor[];
}; };
export { Alexa, BrightnessController, EndpointHealth, ModeController, PowerController, RangeController, TemperatureSensor, ToggleController, }; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, EndpointHealth, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, };
export type { Mode } from "./interfaces/ModeController.js"; export type { Mode } from "./interfaces/ModeController.js";
export { asset, text } from "./resources.js"; export { asset, text } from "./resources.js";
export { semantics, SemanticsBuilder } from "./semantics.js"; export { semantics, SemanticsBuilder } from "./semantics.js";

View file

@ -1,9 +1,17 @@
// The interfaces the library knows, by namespace. // The interfaces the library knows, by namespace.
import { Alexa } from "./interfaces/Alexa.js"; import { Alexa } from "./interfaces/Alexa.js";
import { BrightnessController } from "./interfaces/BrightnessController.js"; import { BrightnessController } from "./interfaces/BrightnessController.js";
import { ColorController } from "./interfaces/ColorController.js";
import { ColorTemperatureController } from "./interfaces/ColorTemperatureController.js";
import { ContactSensor } from "./interfaces/ContactSensor.js";
import { EndpointHealth } from "./interfaces/EndpointHealth.js"; import { EndpointHealth } from "./interfaces/EndpointHealth.js";
import { HumiditySensor } from "./interfaces/HumiditySensor.js";
import { LockController } from "./interfaces/LockController.js";
import { ModeController } from "./interfaces/ModeController.js"; import { ModeController } from "./interfaces/ModeController.js";
import { MotionSensor } from "./interfaces/MotionSensor.js";
import { PercentageController } from "./interfaces/PercentageController.js";
import { PowerController } from "./interfaces/PowerController.js"; import { PowerController } from "./interfaces/PowerController.js";
import { PowerLevelController } from "./interfaces/PowerLevelController.js";
import { RangeController } from "./interfaces/RangeController.js"; import { RangeController } from "./interfaces/RangeController.js";
import { TemperatureSensor } from "./interfaces/TemperatureSensor.js"; import { TemperatureSensor } from "./interfaces/TemperatureSensor.js";
import { ToggleController } from "./interfaces/ToggleController.js"; import { ToggleController } from "./interfaces/ToggleController.js";
@ -12,9 +20,17 @@ import { DeclarationError } from "./types.js";
const described = [ const described = [
Alexa, Alexa,
BrightnessController, BrightnessController,
ColorController,
ColorTemperatureController,
ContactSensor,
EndpointHealth, EndpointHealth,
HumiditySensor,
LockController,
ModeController, ModeController,
MotionSensor,
PercentageController,
PowerController, PowerController,
PowerLevelController,
RangeController, RangeController,
TemperatureSensor, TemperatureSensor,
ToggleController, ToggleController,
@ -43,7 +59,7 @@ export const registry = {
return [...descriptors.values()].sort((a, b) => (a.namespace < b.namespace ? -1 : 1)); return [...descriptors.values()].sort((a, b) => (a.namespace < b.namespace ? -1 : 1));
}, },
}; };
export { Alexa, BrightnessController, EndpointHealth, ModeController, PowerController, RangeController, TemperatureSensor, ToggleController, }; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, EndpointHealth, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, };
export { asset, text } from "./resources.js"; export { asset, text } from "./resources.js";
export { semantics, SemanticsBuilder } from "./semantics.js"; export { semantics, SemanticsBuilder } from "./semantics.js";
export { DeclarationError, defineInterface } from "./types.js"; export { DeclarationError, defineInterface } from "./types.js";

View file

@ -0,0 +1,25 @@
/**
* A light changes its hue and saturation and keeps the brightness it has: "ignore the brightness value of 1 in the
* directive" (alexa-colorcontroller.html, "SetColor directive example").
*/
export declare const ColorController: import("../types.js").InterfaceDescriptor<{
color: {
name: string;
value: import("../schema.js").Schema<import("../schema.js").InferShape<{
hue: import("../schema.js").Schema<number>;
saturation: import("../schema.js").Schema<number>;
brightness: import("../schema.js").Schema<number>;
}>>;
};
}, {
SetColor: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
color: import("../schema.js").Schema<import("../schema.js").InferShape<{
hue: import("../schema.js").Schema<number>;
saturation: import("../schema.js").Schema<number>;
brightness: import("../schema.js").Schema<number>;
}>>;
}>>;
};
}, {}, false>;

View file

@ -0,0 +1,26 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
// alexa-property-schemas.html, "Color"
const color = s.object({
hue: s.number({ min: 0, max: 360 }),
saturation: s.number({ min: 0, max: 1 }),
brightness: s.number({ min: 0, max: 1 }),
});
/**
* A light changes its hue and saturation and keeps the brightness it has: "ignore the brightness value of 1 in the
* directive" (alexa-colorcontroller.html, "SetColor directive example").
*/
export const ColorController = defineInterface({
namespace: "Alexa.ColorController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colorcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
color: { name: "color", value: color },
},
directives: {
SetColor: { name: "SetColor", payload: s.object({ color }) },
},
});

View file

@ -0,0 +1,28 @@
/**
* The white of a tunable light. Alexa asks for 2200 (warm), 2700 (soft), 4000 (white), 5500 (daylight) and 7000
* (cool); a light that cannot show the value takes the nearest it can. A light that shows a colour answers
* NOT_SUPPORTED_IN_CURRENT_MODE with currentDeviceMode COLOR.
*/
export declare const ColorTemperatureController: import("../types.js").InterfaceDescriptor<{
colorTemperatureInKelvin: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
colorTemperatureInKelvin: import("../schema.js").Schema<number>;
}>>;
};
IncreaseColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
note: string;
};
DecreaseColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
note: string;
};
}, {}, false>;

View file

@ -0,0 +1,25 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
// alexa-colortemperaturecontroller.html, "Reportable properties": "Valid values range from 1,000 to 10,000"
const kelvin = s.number({ min: 1000, max: 10000, integer: true });
/**
* The white of a tunable light. Alexa asks for 2200 (warm), 2700 (soft), 4000 (white), 5500 (daylight) and 7000
* (cool); a light that cannot show the value takes the nearest it can. A light that shows a colour answers
* NOT_SUPPORTED_IN_CURRENT_MODE with currentDeviceMode COLOR.
*/
export const ColorTemperatureController = defineInterface({
namespace: "Alexa.ColorTemperatureController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colortemperaturecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
colorTemperatureInKelvin: { name: "colorTemperatureInKelvin", value: kelvin },
},
directives: {
SetColorTemperature: { name: "SetColorTemperature", payload: s.object({ colorTemperatureInKelvin: kelvin }) },
IncreaseColorTemperature: { name: "IncreaseColorTemperature", payload: s.object({}), note: "towards cool" },
DecreaseColorTemperature: { name: "DecreaseColorTemperature", payload: s.object({}), note: "towards warm" },
},
});

View file

@ -0,0 +1,10 @@
/**
* DETECTED is open: the two pieces of the sensor are apart. A sensor that cannot answer ReportState sends a
* ChangeReport right after discovery, so that the Alexa app shows its state (alexa-contactsensor.html).
*/
export declare const ContactSensor: import("../types.js").InterfaceDescriptor<{
detectionState: {
name: string;
value: import("../schema.js").EnumSchema<"DETECTED" | "NOT_DETECTED">;
};
}, {}, {}, false>;

View file

@ -0,0 +1,18 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* DETECTED is open: the two pieces of the sensor are apart. A sensor that cannot answer ReportState sends a
* ChangeReport right after discovery, so that the Alexa app shows its state (alexa-contactsensor.html).
*/
export const ContactSensor = defineInterface({
namespace: "Alexa.ContactSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-contactsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,9 @@
/** The value is an object, { value: 45.5 }, as the reports of alexa-humiditysensor.html print it. */
export declare const HumiditySensor: import("../types.js").InterfaceDescriptor<{
relativeHumidity: {
name: string;
value: import("../schema.js").Schema<import("../schema.js").InferShape<{
value: import("../schema.js").Schema<number>;
}>>;
};
}, {}, {}, false>;

View file

@ -0,0 +1,15 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/** The value is an object, { value: 45.5 }, as the reports of alexa-humiditysensor.html print it. */
export const HumiditySensor = defineInterface({
namespace: "Alexa.HumiditySensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-humiditysensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
relativeHumidity: { name: "relativeHumidity", value: s.object({ value: s.number({ min: 0, max: 100 }) }) },
},
directives: {},
});

View file

@ -0,0 +1,20 @@
/**
* A lock that takes more than five seconds answers with a DeferredResponse first and the Response when the bolt has
* moved (alexa-lockcontroller.html, "Lock response"). The user enables unlocking by voice per device, in the Alexa app.
*/
export declare const LockController: import("../types.js").InterfaceDescriptor<{
lockState: {
name: string;
value: import("../schema.js").EnumSchema<"LOCKED" | "UNLOCKED" | "JAMMED">;
note: string;
};
}, {
Lock: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
};
Unlock: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
};
}, {}, false>;

View file

@ -0,0 +1,26 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* A lock that takes more than five seconds answers with a DeferredResponse first and the Response when the bolt has
* moved (alexa-lockcontroller.html, "Lock response"). The user enables unlocking by voice per device, in the Alexa app.
*/
export const LockController = defineInterface({
namespace: "Alexa.LockController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-lockcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
lockState: {
name: "lockState",
value: s.enum("LOCKED", "UNLOCKED", "JAMMED"),
note: "JAMMED: the mechanism can reach neither LOCKED nor UNLOCKED",
},
},
directives: {
Lock: { name: "Lock", payload: s.object({}) },
Unlock: { name: "Unlock", payload: s.object({}) },
},
deferrable: true,
});

View file

@ -0,0 +1,10 @@
/**
* "When a motion sensor changes to DETECTED, and then changes to NOT_DETECTED, you must wait at least 30 seconds
* before sending the second change report" (alexa-motionsensor.html, "Change reporting").
*/
export declare const MotionSensor: import("../types.js").InterfaceDescriptor<{
detectionState: {
name: string;
value: import("../schema.js").EnumSchema<"DETECTED" | "NOT_DETECTED">;
};
}, {}, {}, false>;

View file

@ -0,0 +1,18 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* "When a motion sensor changes to DETECTED, and then changes to NOT_DETECTED, you must wait at least 30 seconds
* before sending the second change report" (alexa-motionsensor.html, "Change reporting").
*/
export const MotionSensor = defineInterface({
namespace: "Alexa.MotionSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-motionsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,23 @@
/**
* For a device no other interface fits: "Use this interface only if there isn't a more specific controller
* interface that applies to your device" (alexa-percentagecontroller.html).
*/
export declare const PercentageController: import("../types.js").InterfaceDescriptor<{
percentage: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetPercentage: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
percentage: import("../schema.js").Schema<number>;
}>>;
};
AdjustPercentage: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
percentageDelta: import("../schema.js").Schema<number>;
}>>;
};
}, {}, false>;

View file

@ -0,0 +1,27 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* For a device no other interface fits: "Use this interface only if there isn't a more specific controller
* interface that applies to your device" (alexa-percentagecontroller.html).
*/
export const PercentageController = defineInterface({
namespace: "Alexa.PercentageController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-percentagecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
percentage: { name: "percentage", value: s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPercentage: {
name: "SetPercentage",
payload: s.object({ percentage: s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPercentage: {
name: "AdjustPercentage",
payload: s.object({ percentageDelta: s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -0,0 +1,20 @@
/** The power of a device as a percentage, a dimmer switch for one (alexa-powerlevelcontroller.html). */
export declare const PowerLevelController: import("../types.js").InterfaceDescriptor<{
powerLevel: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetPowerLevel: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
powerLevel: import("../schema.js").Schema<number>;
}>>;
};
AdjustPowerLevel: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
powerLevelDelta: import("../schema.js").Schema<number>;
}>>;
};
}, {}, false>;

View file

@ -0,0 +1,24 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/** The power of a device as a percentage, a dimmer switch for one (alexa-powerlevelcontroller.html). */
export const PowerLevelController = defineInterface({
namespace: "Alexa.PowerLevelController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-powerlevelcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
powerLevel: { name: "powerLevel", value: s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPowerLevel: {
name: "SetPowerLevel",
payload: s.object({ powerLevel: s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPowerLevel: {
name: "AdjustPowerLevel",
payload: s.object({ powerLevelDelta: s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -18,11 +18,8 @@ const TABLE = [
["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES], ["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES],
["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"], ["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"],
["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"], ["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"],
["Alexa.ColorController", "3", ["color"], "alexa-colorcontroller.html"],
["Alexa.ColorTemperatureController", "3", ["colorTemperatureInKelvin"], "alexa-colortemperaturecontroller.html"],
["Alexa.Commissionable", "1", [], "alexa-commissionable.html"], ["Alexa.Commissionable", "1", [], "alexa-commissionable.html"],
["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"], ["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"],
["Alexa.ContactSensor", "3", ["detectionState"], "alexa-contactsensor.html"],
["Alexa.Cooking", "1", [], "alexa-cooking.html"], ["Alexa.Cooking", "1", [], "alexa-cooking.html"],
["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"], ["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"],
["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"], ["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"],
@ -41,15 +38,11 @@ const TABLE = [
["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"], ["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"],
["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"], ["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"],
["Alexa.Launcher", "1.1", [], "alexa-launcher.html"], ["Alexa.Launcher", "1.1", [], "alexa-launcher.html"],
["Alexa.LockController", "3", [], "alexa-lockcontroller.html"],
["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"], ["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"],
["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"], ["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"],
["Alexa.Media.Search", "1", [], "alexa-media-search.html"], ["Alexa.Media.Search", "1", [], "alexa-media-search.html"],
["Alexa.MotionSensor", "3", [], "alexa-motionsensor.html"],
["Alexa.PercentageController", "3", [], "alexa-percentagecontroller.html"],
["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"],
["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"],
["Alexa.PowerLevelController", "3", [], "alexa-powerlevelcontroller.html"],
["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"], ["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"],
["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"], ["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"],
["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"], ["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"],

View file

@ -27,6 +27,8 @@ export declare enum AlexaInterfaceType {
DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource", DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource",
ENDPOINT_HEALTH = "Alexa.EndpointHealth", ENDPOINT_HEALTH = "Alexa.EndpointHealth",
EQUALIZER_CONTROLLER = "Alexa.EqualizerController", EQUALIZER_CONTROLLER = "Alexa.EqualizerController",
/** Since 2.0. */
HUMIDITY_SENSOR = "Alexa.HumiditySensor",
INPUT_CONTROLLER = "Alexa.InputController", INPUT_CONTROLLER = "Alexa.InputController",
INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor", INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor",
INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor", INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor",

View file

@ -5,7 +5,7 @@ export type { EndpointDefinition, EndpointJson } from "./device/Device.js";
export { Capability } from "./device/Capability.js"; export { Capability } from "./device/Capability.js";
export type { CapabilityJson, CommonOptions, Declaration } from "./device/Capability.js"; export type { CapabilityJson, CommonOptions, Declaration } from "./device/Capability.js";
export { registry, DeclarationError, SchemaError } from "./registry/index.js"; export { registry, DeclarationError, SchemaError } from "./registry/index.js";
export { Alexa, BrightnessController, ModeController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js"; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, } from "./registry/index.js";
export { PowerController, EndpointHealth } from "./compat/enums.js"; export { PowerController, EndpointHealth } from "./compat/enums.js";
export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js"; export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js";
export { ASSETS as Assets, UNITS_OF_MEASURE as Units, ACTIONS as Actions, STATES as States, DISPLAY_CATEGORIES as DisplayCategories, } from "./registry/index.js"; export { ASSETS as Assets, UNITS_OF_MEASURE as Units, ACTIONS as Actions, STATES as States, DISPLAY_CATEGORIES as DisplayCategories, } from "./registry/index.js";

View file

@ -1,8 +1,16 @@
import { Alexa } from "./interfaces/Alexa.js"; import { Alexa } from "./interfaces/Alexa.js";
import { BrightnessController } from "./interfaces/BrightnessController.js"; import { BrightnessController } from "./interfaces/BrightnessController.js";
import { ColorController } from "./interfaces/ColorController.js";
import { ColorTemperatureController } from "./interfaces/ColorTemperatureController.js";
import { ContactSensor } from "./interfaces/ContactSensor.js";
import { EndpointHealth } from "./interfaces/EndpointHealth.js"; import { EndpointHealth } from "./interfaces/EndpointHealth.js";
import { HumiditySensor } from "./interfaces/HumiditySensor.js";
import { LockController } from "./interfaces/LockController.js";
import { ModeController } from "./interfaces/ModeController.js"; import { ModeController } from "./interfaces/ModeController.js";
import { MotionSensor } from "./interfaces/MotionSensor.js";
import { PercentageController } from "./interfaces/PercentageController.js";
import { PowerController } from "./interfaces/PowerController.js"; import { PowerController } from "./interfaces/PowerController.js";
import { PowerLevelController } from "./interfaces/PowerLevelController.js";
import { RangeController } from "./interfaces/RangeController.js"; import { RangeController } from "./interfaces/RangeController.js";
import { TemperatureSensor } from "./interfaces/TemperatureSensor.js"; import { TemperatureSensor } from "./interfaces/TemperatureSensor.js";
import { ToggleController } from "./interfaces/ToggleController.js"; import { ToggleController } from "./interfaces/ToggleController.js";
@ -15,7 +23,7 @@ export declare const registry: {
/** Every descriptor, ordered by namespace. */ /** Every descriptor, ordered by namespace. */
list(): AnyDescriptor[]; list(): AnyDescriptor[];
}; };
export { Alexa, BrightnessController, EndpointHealth, ModeController, PowerController, RangeController, TemperatureSensor, ToggleController, }; export { Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, EndpointHealth, HumiditySensor, LockController, ModeController, MotionSensor, PercentageController, PowerController, PowerLevelController, RangeController, TemperatureSensor, ToggleController, };
export type { Mode } from "./interfaces/ModeController.js"; export type { Mode } from "./interfaces/ModeController.js";
export { asset, text } from "./resources.js"; export { asset, text } from "./resources.js";
export { semantics, SemanticsBuilder } from "./semantics.js"; export { semantics, SemanticsBuilder } from "./semantics.js";

View file

@ -0,0 +1,25 @@
/**
* A light changes its hue and saturation and keeps the brightness it has: "ignore the brightness value of 1 in the
* directive" (alexa-colorcontroller.html, "SetColor directive example").
*/
export declare const ColorController: import("../types.js").InterfaceDescriptor<{
color: {
name: string;
value: import("../schema.js").Schema<import("../schema.js").InferShape<{
hue: import("../schema.js").Schema<number>;
saturation: import("../schema.js").Schema<number>;
brightness: import("../schema.js").Schema<number>;
}>>;
};
}, {
SetColor: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
color: import("../schema.js").Schema<import("../schema.js").InferShape<{
hue: import("../schema.js").Schema<number>;
saturation: import("../schema.js").Schema<number>;
brightness: import("../schema.js").Schema<number>;
}>>;
}>>;
};
}, {}, false>;

View file

@ -0,0 +1,28 @@
/**
* The white of a tunable light. Alexa asks for 2200 (warm), 2700 (soft), 4000 (white), 5500 (daylight) and 7000
* (cool); a light that cannot show the value takes the nearest it can. A light that shows a colour answers
* NOT_SUPPORTED_IN_CURRENT_MODE with currentDeviceMode COLOR.
*/
export declare const ColorTemperatureController: import("../types.js").InterfaceDescriptor<{
colorTemperatureInKelvin: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
colorTemperatureInKelvin: import("../schema.js").Schema<number>;
}>>;
};
IncreaseColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
note: string;
};
DecreaseColorTemperature: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
note: string;
};
}, {}, false>;

View file

@ -0,0 +1,10 @@
/**
* DETECTED is open: the two pieces of the sensor are apart. A sensor that cannot answer ReportState sends a
* ChangeReport right after discovery, so that the Alexa app shows its state (alexa-contactsensor.html).
*/
export declare const ContactSensor: import("../types.js").InterfaceDescriptor<{
detectionState: {
name: string;
value: import("../schema.js").EnumSchema<"DETECTED" | "NOT_DETECTED">;
};
}, {}, {}, false>;

View file

@ -0,0 +1,9 @@
/** The value is an object, { value: 45.5 }, as the reports of alexa-humiditysensor.html print it. */
export declare const HumiditySensor: import("../types.js").InterfaceDescriptor<{
relativeHumidity: {
name: string;
value: import("../schema.js").Schema<import("../schema.js").InferShape<{
value: import("../schema.js").Schema<number>;
}>>;
};
}, {}, {}, false>;

View file

@ -0,0 +1,20 @@
/**
* A lock that takes more than five seconds answers with a DeferredResponse first and the Response when the bolt has
* moved (alexa-lockcontroller.html, "Lock response"). The user enables unlocking by voice per device, in the Alexa app.
*/
export declare const LockController: import("../types.js").InterfaceDescriptor<{
lockState: {
name: string;
value: import("../schema.js").EnumSchema<"LOCKED" | "UNLOCKED" | "JAMMED">;
note: string;
};
}, {
Lock: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
};
Unlock: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{}>>;
};
}, {}, false>;

View file

@ -0,0 +1,10 @@
/**
* "When a motion sensor changes to DETECTED, and then changes to NOT_DETECTED, you must wait at least 30 seconds
* before sending the second change report" (alexa-motionsensor.html, "Change reporting").
*/
export declare const MotionSensor: import("../types.js").InterfaceDescriptor<{
detectionState: {
name: string;
value: import("../schema.js").EnumSchema<"DETECTED" | "NOT_DETECTED">;
};
}, {}, {}, false>;

View file

@ -0,0 +1,23 @@
/**
* For a device no other interface fits: "Use this interface only if there isn't a more specific controller
* interface that applies to your device" (alexa-percentagecontroller.html).
*/
export declare const PercentageController: import("../types.js").InterfaceDescriptor<{
percentage: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetPercentage: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
percentage: import("../schema.js").Schema<number>;
}>>;
};
AdjustPercentage: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
percentageDelta: import("../schema.js").Schema<number>;
}>>;
};
}, {}, false>;

View file

@ -0,0 +1,20 @@
/** The power of a device as a percentage, a dimmer switch for one (alexa-powerlevelcontroller.html). */
export declare const PowerLevelController: import("../types.js").InterfaceDescriptor<{
powerLevel: {
name: string;
value: import("../schema.js").Schema<number>;
};
}, {
SetPowerLevel: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
powerLevel: import("../schema.js").Schema<number>;
}>>;
};
AdjustPowerLevel: {
name: string;
payload: import("../schema.js").Schema<import("../schema.js").InferShape<{
powerLevelDelta: import("../schema.js").Schema<number>;
}>>;
};
}, {}, false>;

View file

@ -31,6 +31,8 @@ export enum AlexaInterfaceType {
DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource", DOORBELL_EVENT_SOURCE = "Alexa.DoorbellEventSource",
ENDPOINT_HEALTH = "Alexa.EndpointHealth", ENDPOINT_HEALTH = "Alexa.EndpointHealth",
EQUALIZER_CONTROLLER = "Alexa.EqualizerController", EQUALIZER_CONTROLLER = "Alexa.EqualizerController",
/** Since 2.0. */
HUMIDITY_SENSOR = "Alexa.HumiditySensor",
INPUT_CONTROLLER = "Alexa.InputController", INPUT_CONTROLLER = "Alexa.InputController",
INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor", INVENTORY_LEVEL_SENSOR = "Alexa.InventoryLevelSensor",
INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor", INVENTORY_LEVEL_USAGE_SENSOR = "Alexa.InventoryLevelUsageSensor",

View file

@ -9,7 +9,9 @@ export type { CapabilityJson, CommonOptions, Declaration } from "./device/Capabi
// The interfaces, for device.add(), and the registry that holds them by name // The interfaces, for device.add(), and the registry that holds them by name
export { registry, DeclarationError, SchemaError } from "./registry/index.js"; export { registry, DeclarationError, SchemaError } from "./registry/index.js";
export { export {
Alexa, BrightnessController, ModeController, RangeController, TemperatureSensor, ToggleController, Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, HumiditySensor, LockController,
ModeController, MotionSensor, PercentageController, PowerLevelController, RangeController, TemperatureSensor,
ToggleController,
} from "./registry/index.js"; } from "./registry/index.js";
export { PowerController, EndpointHealth } from "./compat/enums.js"; export { PowerController, EndpointHealth } from "./compat/enums.js";
export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js"; export { asset, text, semantics, SemanticsBuilder } from "./registry/index.js";

View file

@ -1,9 +1,17 @@
// The interfaces the library knows, by namespace. // The interfaces the library knows, by namespace.
import { Alexa } from "./interfaces/Alexa.js"; import { Alexa } from "./interfaces/Alexa.js";
import { BrightnessController } from "./interfaces/BrightnessController.js"; import { BrightnessController } from "./interfaces/BrightnessController.js";
import { ColorController } from "./interfaces/ColorController.js";
import { ColorTemperatureController } from "./interfaces/ColorTemperatureController.js";
import { ContactSensor } from "./interfaces/ContactSensor.js";
import { EndpointHealth } from "./interfaces/EndpointHealth.js"; import { EndpointHealth } from "./interfaces/EndpointHealth.js";
import { HumiditySensor } from "./interfaces/HumiditySensor.js";
import { LockController } from "./interfaces/LockController.js";
import { ModeController } from "./interfaces/ModeController.js"; import { ModeController } from "./interfaces/ModeController.js";
import { MotionSensor } from "./interfaces/MotionSensor.js";
import { PercentageController } from "./interfaces/PercentageController.js";
import { PowerController } from "./interfaces/PowerController.js"; import { PowerController } from "./interfaces/PowerController.js";
import { PowerLevelController } from "./interfaces/PowerLevelController.js";
import { RangeController } from "./interfaces/RangeController.js"; import { RangeController } from "./interfaces/RangeController.js";
import { TemperatureSensor } from "./interfaces/TemperatureSensor.js"; import { TemperatureSensor } from "./interfaces/TemperatureSensor.js";
import { ToggleController } from "./interfaces/ToggleController.js"; import { ToggleController } from "./interfaces/ToggleController.js";
@ -14,9 +22,17 @@ import type { AnyDescriptor } from "./types.js";
const described: readonly AnyDescriptor[] = [ const described: readonly AnyDescriptor[] = [
Alexa, Alexa,
BrightnessController, BrightnessController,
ColorController,
ColorTemperatureController,
ContactSensor,
EndpointHealth, EndpointHealth,
HumiditySensor,
LockController,
ModeController, ModeController,
MotionSensor,
PercentageController,
PowerController, PowerController,
PowerLevelController,
RangeController, RangeController,
TemperatureSensor, TemperatureSensor,
ToggleController, ToggleController,
@ -49,8 +65,9 @@ export const registry = {
}; };
export { export {
Alexa, BrightnessController, EndpointHealth, ModeController, PowerController, RangeController, TemperatureSensor, Alexa, BrightnessController, ColorController, ColorTemperatureController, ContactSensor, EndpointHealth, HumiditySensor,
ToggleController, LockController, ModeController, MotionSensor, PercentageController, PowerController, PowerLevelController, RangeController,
TemperatureSensor, ToggleController,
}; };
export type { Mode } from "./interfaces/ModeController.js"; export type { Mode } from "./interfaces/ModeController.js";
export { asset, text } from "./resources.js"; export { asset, text } from "./resources.js";

View file

@ -0,0 +1,28 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
// alexa-property-schemas.html, "Color"
const color = s.object({
hue: s.number({ min: 0, max: 360 }),
saturation: s.number({ min: 0, max: 1 }),
brightness: s.number({ min: 0, max: 1 }),
});
/**
* A light changes its hue and saturation and keeps the brightness it has: "ignore the brightness value of 1 in the
* directive" (alexa-colorcontroller.html, "SetColor directive example").
*/
export const ColorController = defineInterface({
namespace: "Alexa.ColorController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colorcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
color: { name: "color", value: color },
},
directives: {
SetColor: { name: "SetColor", payload: s.object({ color }) },
},
});

View file

@ -0,0 +1,27 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
// alexa-colortemperaturecontroller.html, "Reportable properties": "Valid values range from 1,000 to 10,000"
const kelvin = s.number({ min: 1000, max: 10000, integer: true });
/**
* The white of a tunable light. Alexa asks for 2200 (warm), 2700 (soft), 4000 (white), 5500 (daylight) and 7000
* (cool); a light that cannot show the value takes the nearest it can. A light that shows a colour answers
* NOT_SUPPORTED_IN_CURRENT_MODE with currentDeviceMode COLOR.
*/
export const ColorTemperatureController = defineInterface({
namespace: "Alexa.ColorTemperatureController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-colortemperaturecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
colorTemperatureInKelvin: { name: "colorTemperatureInKelvin", value: kelvin },
},
directives: {
SetColorTemperature: { name: "SetColorTemperature", payload: s.object({ colorTemperatureInKelvin: kelvin }) },
IncreaseColorTemperature: { name: "IncreaseColorTemperature", payload: s.object({}), note: "towards cool" },
DecreaseColorTemperature: { name: "DecreaseColorTemperature", payload: s.object({}), note: "towards warm" },
},
});

View file

@ -0,0 +1,19 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* DETECTED is open: the two pieces of the sensor are apart. A sensor that cannot answer ReportState sends a
* ChangeReport right after discovery, so that the Alexa app shows its state (alexa-contactsensor.html).
*/
export const ContactSensor = defineInterface({
namespace: "Alexa.ContactSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-contactsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,16 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/** The value is an object, { value: 45.5 }, as the reports of alexa-humiditysensor.html print it. */
export const HumiditySensor = defineInterface({
namespace: "Alexa.HumiditySensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-humiditysensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
relativeHumidity: { name: "relativeHumidity", value: s.object({ value: s.number({ min: 0, max: 100 }) }) },
},
directives: {},
});

View file

@ -0,0 +1,27 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* A lock that takes more than five seconds answers with a DeferredResponse first and the Response when the bolt has
* moved (alexa-lockcontroller.html, "Lock response"). The user enables unlocking by voice per device, in the Alexa app.
*/
export const LockController = defineInterface({
namespace: "Alexa.LockController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-lockcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
lockState: {
name: "lockState",
value: s.enum("LOCKED", "UNLOCKED", "JAMMED"),
note: "JAMMED: the mechanism can reach neither LOCKED nor UNLOCKED",
},
},
directives: {
Lock: { name: "Lock", payload: s.object({}) },
Unlock: { name: "Unlock", payload: s.object({}) },
},
deferrable: true,
});

View file

@ -0,0 +1,19 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* "When a motion sensor changes to DETECTED, and then changes to NOT_DETECTED, you must wait at least 30 seconds
* before sending the second change report" (alexa-motionsensor.html, "Change reporting").
*/
export const MotionSensor = defineInterface({
namespace: "Alexa.MotionSensor",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-motionsensor.html",
kind: "sensor",
tier: 1,
instanced: false,
properties: {
detectionState: { name: "detectionState", value: s.enum("DETECTED", "NOT_DETECTED") },
},
directives: {},
});

View file

@ -0,0 +1,28 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/**
* For a device no other interface fits: "Use this interface only if there isn't a more specific controller
* interface that applies to your device" (alexa-percentagecontroller.html).
*/
export const PercentageController = defineInterface({
namespace: "Alexa.PercentageController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-percentagecontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
percentage: { name: "percentage", value: s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPercentage: {
name: "SetPercentage",
payload: s.object({ percentage: s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPercentage: {
name: "AdjustPercentage",
payload: s.object({ percentageDelta: s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -0,0 +1,25 @@
import { s } from "../schema.js";
import { defineInterface } from "../types.js";
/** The power of a device as a percentage, a dimmer switch for one (alexa-powerlevelcontroller.html). */
export const PowerLevelController = defineInterface({
namespace: "Alexa.PowerLevelController",
version: "3",
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-powerlevelcontroller.html",
kind: "controller",
tier: 1,
instanced: false,
properties: {
powerLevel: { name: "powerLevel", value: s.number({ min: 0, max: 100, integer: true }) },
},
directives: {
SetPowerLevel: {
name: "SetPowerLevel",
payload: s.object({ powerLevel: s.number({ min: 0, max: 100, integer: true }) }),
},
AdjustPowerLevel: {
name: "AdjustPowerLevel",
payload: s.object({ powerLevelDelta: s.number({ min: -100, max: 100, integer: true }) }),
},
},
});

View file

@ -24,11 +24,8 @@ const TABLE: readonly Row[] = [
["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES], ["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES],
["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"], ["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"],
["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"], ["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"],
["Alexa.ColorController", "3", ["color"], "alexa-colorcontroller.html"],
["Alexa.ColorTemperatureController", "3", ["colorTemperatureInKelvin"], "alexa-colortemperaturecontroller.html"],
["Alexa.Commissionable", "1", [], "alexa-commissionable.html"], ["Alexa.Commissionable", "1", [], "alexa-commissionable.html"],
["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"], ["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"],
["Alexa.ContactSensor", "3", ["detectionState"], "alexa-contactsensor.html"],
["Alexa.Cooking", "1", [], "alexa-cooking.html"], ["Alexa.Cooking", "1", [], "alexa-cooking.html"],
["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"], ["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"],
["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"], ["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"],
@ -47,15 +44,11 @@ const TABLE: readonly Row[] = [
["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"], ["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"],
["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"], ["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"],
["Alexa.Launcher", "1.1", [], "alexa-launcher.html"], ["Alexa.Launcher", "1.1", [], "alexa-launcher.html"],
["Alexa.LockController", "3", [], "alexa-lockcontroller.html"],
["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"], ["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"],
["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"], ["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"],
["Alexa.Media.Search", "1", [], "alexa-media-search.html"], ["Alexa.Media.Search", "1", [], "alexa-media-search.html"],
["Alexa.MotionSensor", "3", [], "alexa-motionsensor.html"],
["Alexa.PercentageController", "3", [], "alexa-percentagecontroller.html"],
["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"],
["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"], ["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"],
["Alexa.PowerLevelController", "3", [], "alexa-powerlevelcontroller.html"],
["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"], ["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"],
["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"], ["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"],
["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"], ["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"],

View file

@ -131,6 +131,23 @@ test("1.x declarations are announced as 1.5.2 announced them, with the Alexa int
} }
}); });
test("1.x declarations of the zoo's lock, motion sensor and heater list their properties, which 1.5.2 left to the caller", () => {
const T = AlexaInterfaceType;
const declarations = {
"zoo-lock": [T.LOCK_CONTROLLER],
"zoo-motion": [T.MOTION_SENSOR],
"zoo-heater": [T.POWER_CONTROLLER, T.POWER_LEVEL_CONTROLLER],
"zoo-color-lamp": [T.POWER_CONTROLLER, T.BRIGHTNESS_CONTROLLER, T.COLOR_CONTROLLER],
"zoo-warm-lamp": [T.POWER_CONTROLLER, T.COLOR_TEMPERATURE_CONTROLLER],
};
for (const [endpointId, types] of Object.entries(declarations)) {
const device = likeTheZoo(endpointId);
for (const type of types) device.addCapability(type, { proactivelyReported: true });
assert.deepEqual(device.getJSON().capabilities, [...zoo(endpointId).capabilities, ALEXA], endpointId);
assert.deepEqual(device.check(), [], endpointId);
}
});
test("a RangeController blind declared with device.add() is the zoo's blind, whose JSON was written by hand", () => { test("a RangeController blind declared with device.add() is the zoo's blind, whose JSON was written by hand", () => {
const blinds = likeTheZoo("zoo-blinds"); const blinds = likeTheZoo("zoo-blinds");
blinds.add(RangeController, { blinds.add(RangeController, {
@ -329,16 +346,16 @@ test("discovery logs what check() says about the devices, each line once", async
const lamp = bridge.registerDevice("Dave's Lamp", "lamp-1", DisplayCategory.LIGHT); const lamp = bridge.registerDevice("Dave's Lamp", "lamp-1", DisplayCategory.LIGHT);
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER); lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER); lamp.addCapability(AlexaInterfaceType.POWER_CONTROLLER);
lamp.addCapability(AlexaInterfaceType.LOCK_CONTROLLER); lamp.addCapability(AlexaInterfaceType.KEYPAD_CONTROLLER);
bridge.registerDevice("Lamp", "lamp-2", DisplayCategory.LIGHT).addCapability(AlexaInterfaceType.POWER_CONTROLLER); bridge.registerDevice("Lamp", "lamp-2", DisplayCategory.LIGHT).addCapability(AlexaInterfaceType.POWER_CONTROLLER);
// Announced all the same: 1.x announced it, and Alexa may have taken it // Announced all the same: 1.x announced it, and Alexa may have taken it
const [first] = await discover(alexa, "root"); const [first] = await discover(alexa, "root");
assert.deepEqual(names(first), ["Alexa.PowerController", "Alexa.PowerController", "Alexa.LockController", "Alexa"]); assert.deepEqual(names(first), ["Alexa.PowerController", "Alexa.PowerController", "Alexa.KeypadController", "Alexa"]);
assert.deepEqual(warnings(), [ assert.deepEqual(warnings(), [
'warning: lamp-1: the name "Dave\'s Lamp" takes up to 256 letters, digits and spaces, no punctuation', 'warning: lamp-1: the name "Dave\'s Lamp" takes up to 256 letters, digits and spaces, no punctuation',
"warning: lamp-1: Alexa.PowerController: the interface is declared twice", "warning: lamp-1: Alexa.PowerController: the interface is declared twice",
"warning: lamp-1: Alexa.LockController: no property list known, discovery lists it with no supported properties", "warning: lamp-1: Alexa.KeypadController: no property list known, discovery lists it with no supported properties",
]); ]);
lamp.setName("Daves Lamp"); lamp.setName("Daves Lamp");

View file

@ -295,12 +295,12 @@ test("a phrase is mapped once on an endpoint, across its Range, Mode and Toggle
test("a stub is declared like any interface and checked for nothing but being declared twice", () => { test("a stub is declared like any interface and checked for nothing but being declared twice", () => {
const lock = endpoint("lock-1", "Front Door", ["SMARTLOCK"]); const lock = endpoint("lock-1", "Front Door", ["SMARTLOCK"]);
const capability = lock.add(registry.get("Alexa.LockController"), { proactivelyReported: true }); const capability = lock.add(registry.get("Alexa.KeypadController"), { proactivelyReported: true });
assert.deepEqual(capability.toJSON(), { assert.deepEqual(capability.toJSON(), {
type: "AlexaInterface", type: "AlexaInterface",
interface: "Alexa.LockController", interface: "Alexa.KeypadController",
version: "3", version: "1",
properties: { supported: [], proactivelyReported: true, retrievable: true }, properties: { supported: [], proactivelyReported: true, retrievable: true },
}); });
assert.equal(refused(() => lock.add(registry.get("Alexa.LockController"))).message, "lock-1: Alexa.LockController: the interface is declared twice"); assert.equal(refused(() => lock.add(registry.get("Alexa.KeypadController"))).message, "lock-1: Alexa.KeypadController: the interface is declared twice");
}); });

View file

@ -0,0 +1,82 @@
"use strict";
// The interfaces of test/fixtures/interfaces.js, given the directives of their pages: the handler gets the payload as
// the page prints it, and a payload that does not fit is answered with INVALID_VALUE without the handler.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const { Alex2MQTT, LockController, MemoryPublisher, PowerLevelController, registry } = require("alex2node");
const interfaces = require("../fixtures/interfaces.js");
const { doc, examples } = require("../helpers/fixtures.js");
const { directive } = require("../helpers/harness.js");
function bridgeWithout() {
const sent = new MemoryPublisher();
const logged = [];
const bridge = new Alex2MQTT("u", "p", "root", false, { publisher: sent, log: (line) => logged.push(line) });
const device = bridge.addDevice({ endpointId: "device-1", name: "Device", categories: ["OTHER"] });
let count = 0;
// The examples of a page share one message id and one correlation token
const receive = ({ header, payload }) => {
count += 1;
const unique = { ...header, messageId: `message-${count}`, correlationToken: `ct-${count}` };
const message = { header: unique, endpoint: { endpointId: "device-1" }, payload };
return bridge.receive("root/device-1/alexaDirective", JSON.stringify(message));
};
/** What was published, as [the last part of the topic, the namespace and the name of the event, its payload]. */
const answers = () => sent.published.map(({ topic, message: { event } }) => [topic.split("/").pop(), event.header.namespace, event.header.name, event.payload]);
return { device, sent, logged, receive, answers };
}
for (const { namespace, page, declared, refused } of interfaces.filter((entry) => entry.refused)) {
test(`${namespace}: the directives of ${page}.html reach the handler, a payload that does not fit is answered with INVALID_VALUE`, async () => {
const { device, receive, answers } = bridgeWithout();
const seen = [];
device.add(registry.get(namespace), declared[0].options).on("*", (ctx) => {
seen.push([ctx.name, ctx.payload]);
return ctx.respond();
});
const printed = examples(page, ".directive").map((name) => doc(page, name).directive);
for (const example of printed) await receive(example);
assert.deepEqual(seen, printed.map(({ header, payload }) => [header.name, payload]));
assert.deepEqual(answers(), printed.map(() => ["alexaResponce", "Alexa", "Response", {}]));
for (const [name, payload] of refused) await receive(directive(namespace, name, "device-1", "ct-1", payload));
assert.deepEqual(
answers().slice(printed.length),
refused.map(([, , message]) => ["alexaResponce", "Alexa", "ErrorResponse", { type: "INVALID_VALUE", message }])
);
assert.equal(seen.length, printed.length, "the handler is not called with a payload that does not fit");
});
}
test("Alexa.LockController: a slow lock defers without a warning, and answers as the page does", async () => {
const { device, sent, logged, receive, answers } = bridgeWithout();
const lock = device.add(LockController);
lock.on("Lock", async (ctx) => {
await ctx.defer(15);
return ctx.respond((s) => s.set(lock, "lockState", "LOCKED"));
});
const level = device.add(PowerLevelController);
level.on("SetPowerLevel", async (ctx) => {
await ctx.defer();
return ctx.respond((s) => s.set(level, "powerLevel", ctx.payload.powerLevel));
});
await receive(doc("alexa-lockcontroller", "Lock.directive").directive);
const deferred = doc("alexa-lockcontroller", "Lock-slow.deferred");
const answer = doc("alexa-lockcontroller", "Lock-slow.response");
assert.deepEqual(answers(), [
["alexaResponce", "Alexa", "DeferredResponse", deferred.event.payload],
["deferredResponse", "Alexa", "Response", answer.event.payload],
]);
assert.equal("context" in sent.published[0].message, false);
const [{ namespace, name, value }] = answer.context.properties;
const reported = sent.published[1].message.context.properties.find((property) => property.namespace === namespace);
assert.deepEqual([reported.name, reported.value], [name, value]);
// The page of the PowerLevelController has no DeferredResponse
await receive(doc("alexa-powerlevelcontroller", "SetPowerLevel.directive").directive);
assert.deepEqual(logged.filter((line) => line.includes("DeferredResponse")), [
"warning: Amazon documents no DeferredResponse for Alexa.PowerLevelController, Alexa may not wait for the answer",
]);
});

View file

@ -0,0 +1,46 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.ColorController",
"name": "color",
"value": {
"hue": 280,
"saturation": 0.9,
"brightness": 0.9
},
"timeOfSample": "2024-02-03T16:17:00.00Z",
"uncertaintyInMilliseconds": 500
}
]
}
}
},
"context": {
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-02-03T16:15:00.00Z",
"uncertaintyInMilliseconds": 0
}
}

View file

@ -0,0 +1,26 @@
{
"directive": {
"header": {
"namespace": "Alexa.ColorController",
"name": "SetColor",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {
"color": {
"hue": 350.5,
"saturation": 0.7138,
"brightness": 0.6524
}
}
}
}

View file

@ -0,0 +1,34 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorController",
"name": "color",
"value": {
"hue": 350.5,
"saturation": 0.7138,
"brightness": 0.6524
},
"timeOfSample": "2019-07-03T16:20:50Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

View file

@ -0,0 +1,34 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorController",
"name": "color",
"value": {
"hue": 350.5,
"saturation": 0.7138,
"brightness": 0.6524
},
"timeOfSample": "2019-07-03T16:20:50Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

View file

@ -0,0 +1,78 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer of the endpoint",
"description": "Description to be shown in the Alexa app",
"friendlyName": "Living Room light",
"displayCategories": [
"LIGHT"
],
"additionalAttributes": {
"manufacturer": "Manufacturer of the endpoint",
"model": "Model of the device",
"customIdentifier": "Optional custom identifier for the device"
},
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{
"name": "powerState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ColorController",
"version": "3",
"properties": {
"supported": [
{
"name": "color"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,46 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.ColorTemperatureController",
"name": "colorTemperatureInKelvin",
"value": 4000,
"timeOfSample": "2024-02-03T16:1519:20.00Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {
"properties": [
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-02-03T16:15:00.00Z",
"uncertaintyInMilliseconds": 100
}
]
}
}

View file

@ -0,0 +1,20 @@
{
"directive": {
"header": {
"namespace": "Alexa.ColorTemperatureController",
"name": "DecreaseColorTemperature",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorTemperatureController",
"name": "colorTemperatureInKelvin",
"value": 2200,
"timeOfSample": "2020-02-03T16:21:10.02Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

View file

@ -0,0 +1,20 @@
{
"directive": {
"header": {
"namespace": "Alexa.ColorTemperatureController",
"name": "IncreaseColorTemperature",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorTemperatureController",
"name": "colorTemperatureInKelvin",
"value": 7000,
"timeOfSample": "2020-02-03T16:21:10.02Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

View file

@ -0,0 +1,22 @@
{
"directive": {
"header": {
"namespace": "Alexa.ColorTemperatureController",
"name": "SetColorTemperature",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {
"colorTemperatureInKelvin": 5500
}
}
}

View file

@ -0,0 +1,39 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorTemperatureController",
"name": "colorTemperatureInKelvin",
"value": 5500,
"timeOfSample": "2020-02-03T16:21:10.02Z",
"uncertaintyInMilliseconds": 500
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2020-02-03T16:20:50Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,39 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ColorTemperatureController",
"name": "colorTemperatureInKelvin",
"value": 2200,
"timeOfSample": "2024-02-03T16:18:10.00Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-02-03T16:15:00.00Z",
"uncertaintyInMilliseconds": 100
}
]
}
}

View file

@ -0,0 +1,78 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer of the endpoint",
"description": "Description to be shown in the Alexa app",
"friendlyName": "Device name, displayed in the Alexa app",
"displayCategories": [
"LIGHT"
],
"additionalAttributes": {
"manufacturer": "Manufacturer of the endpoint",
"model": "Model of the device",
"customIdentifier": "Optional custom identifier for the device"
},
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{
"name": "powerState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ColorTemperatureController",
"version": "3",
"properties": {
"supported": [
{
"name": "colorTemperatureInKelvin"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3.1",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,46 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.ContactSensor",
"name": "detectionState",
"value": "DETECTED",
"timeOfSample": "2018-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {
"properties": [
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2017-02-03T16:08:15.02Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,39 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.ContactSensor",
"name": "detectionState",
"value": "NOT_DETECTED",
"timeOfSample": "2017-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2017-02-03T16:08:15.02Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,59 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer of the endpoint",
"description": "Smart Sensor by Sensor Maker",
"friendlyName": "Bedroom window",
"displayCategories": [
"CONTACT_SENSOR"
],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.ContactSensor",
"version": "3",
"properties": {
"supported": [
{
"name": "detectionState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,58 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "a unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "an OAuth2 bearer token"
},
"endpointId": "endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PERIODIC_POLL"
},
"properties": [
{
"namespace": "Alexa.HumiditySensor",
"name": "relativeHumidity",
"value": {
"value": 92.5
},
"timeOfSample": "2023-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {
"properties": [
{
"namespace": "Alexa.TemperatureSensor",
"name": "temperature",
"value": {
"value": 19.9,
"scale": "CELSIUS"
},
"timeOfSample": "2023-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2022-06-03T16:20:50Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,51 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "a unique identifier, preferably a version 4 UUID",
"correlationToken": "an opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "an OAuth2 bearer token"
},
"endpointId": "endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.HumiditySensor",
"name": "relativeHumidity",
"value": {
"value": 89
},
"timeOfSample": "2023-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.TemperatureSensor",
"name": "temperature",
"value": {
"value": 19.9,
"scale": "CELSIUS"
},
"timeOfSample": "2023-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2023-02-03T16:20:50Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,80 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer name of the endpoint",
"description": "Description to be shown in the Alexa app",
"friendlyName": "Weather station",
"displayCategories": [
"TEMPERATURE_SENSOR"
],
"additionalAttributes": {
"manufacturer": "Manufacturer name of the endpoint",
"model": "Model of the device",
"serialNumber": "Serial number of the device",
"firmwareVersion": "Firmware version of the device",
"softwareVersion": "Software version of the device",
"customIdentifier": "Optional custom identifier for the device"
},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.HumiditySensor",
"version": "3",
"properties": {
"supported": [
{
"name": "relativeHumidity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.TemperatureSensor",
"version": "3",
"properties": {
"supported": [
{
"name": "temperature"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3.2",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,42 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "LOCKED",
"timeOfSample": "2017-02-03T16:20:50Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}
},
"context": {
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2017-02-03T06:18:00Z",
"uncertaintyInMilliseconds": 0
}
}

View file

@ -0,0 +1,14 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "DeferredResponse",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"payload": {
"estimatedDeferralInSeconds": 15
}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "LOCKED",
"timeOfSample": "2017-02-03T16:20:00.00Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,20 @@
{
"directive": {
"header": {
"namespace": "Alexa.LockController",
"name": "Lock",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "LOCKED",
"timeOfSample": "2017-02-03T16:20:00.00Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "JAMMED",
"timeOfSample": "2017-02-03T16:20:00.00Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,14 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "DeferredResponse",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"payload": {
"estimatedDeferralInSeconds": 20
}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "UNLOCKED",
"timeOfSample": "2017-02-03T16:20:00.00Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,20 @@
{
"directive": {
"header": {
"namespace": "Alexa.LockController",
"name": "Unlock",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.LockController",
"name": "lockState",
"value": "UNLOCKED",
"timeOfSample": "2017-02-03T16:20:00.00Z",
"uncertaintyInMilliseconds": 1000
}
]
}
}

View file

@ -0,0 +1,59 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer of the endpoint",
"description": "Description to be shown in the Alexa app",
"friendlyName": "Your device name, displayed in the Alexa app, for example Front Door>",
"displayCategories": [
"SMARTLOCK"
],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.LockController",
"version": "3",
"properties": {
"supported": [
{
"name": "lockState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,46 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.MotionSensor",
"name": "detectionState",
"value": "DETECTED",
"timeOfSample": "2024-07-03T10:20:50.52Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {
"properties": [
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-07-03T10:11:50.52Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,39 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.MotionSensor",
"name": "detectionState",
"value": "NOT_DETECTED",
"timeOfSample": "2024-07-03T10:20:50.52Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-07-03T09:56:50.12Z",
"uncertaintyInMilliseconds": 0
}
]
}
}

View file

@ -0,0 +1,59 @@
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "Unique identifier, preferably a version 4 UUID"
},
"payload": {
"endpoints": [
{
"endpointId": "Unique ID of the endpoint",
"manufacturerName": "Manufacturer of the endpoint",
"description": "Smart Sensor by Sensor Maker",
"friendlyName": "Front door",
"displayCategories": [
"MOTION_SENSOR"
],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.MotionSensor",
"version": "3",
"properties": {
"supported": [
{
"name": "detectionState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3.1",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}

View file

@ -0,0 +1,22 @@
{
"directive": {
"header": {
"namespace": "Alexa.PercentageController",
"name": "AdjustPercentage",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {
"percentageDelta": -20
}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.PercentageController",
"name": "percentage",
"value": 54,
"timeOfSample": "2017-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

View file

@ -0,0 +1,42 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "Unique identifier, preferably a version 4 UUID",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {
"change": {
"cause": {
"type": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.PercentageController",
"name": "percentage",
"value": 65,
"timeOfSample": "2024-05-01T19:20:05.05Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {
"namespace": "Alexa.EndpointHealth",
"name": "connectivity",
"value": {
"value": "OK"
},
"timeOfSample": "2024-05-01T19:10:22.05Z",
"uncertaintyInMilliseconds": 0
}
}

View file

@ -0,0 +1,22 @@
{
"directive": {
"header": {
"namespace": "Alexa.PercentageController",
"name": "SetPercentage",
"messageId": "Unique version 4 UUID",
"correlationToken": "Opaque correlation token",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID",
"cookie": {}
},
"payload": {
"percentage": 74
}
}
}

View file

@ -0,0 +1,30 @@
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "Unique identifier, preferably a version 4 UUID",
"correlationToken": "Opaque correlation token that matches the request",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "OAuth2.0 bearer token"
},
"endpointId": "Endpoint ID"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.PercentageController",
"name": "percentage",
"value": 74,
"timeOfSample": "2017-02-03T16:20:50.52Z",
"uncertaintyInMilliseconds": 500
}
]
}
}

Some files were not shown because too many files have changed in this diff Show more