David
c492ef74d1
A capability is a descriptor plus what the endpoint declares (device/Capability.ts), and its discovery object is
generated from the two. The new API is bridge.addDevice({ endpointId, name, categories, ... }) and
device.add(PowerController, options): both throw a DeclarationError that names the endpoint, the interface and
the instance (device/validate.ts), and leave the bridge and the device as they were. AlexaInterface is the same
Capability with the 1.x methods on it; it, ActionMapping and the enums moved to src/compat/, Device to src/device/.
What a 1.x caller can observe:
- every endpoint ends with { type: "AlexaInterface", interface: "Alexa", version: "3" } (alexa-interface.html);
new Alex2MQTT(..., { alexaInterface: false }) leaves it out
- the fields of a capability object come in the order of Amazon's examples; their content is unchanged
- addCapability() with a name that is not an interface throws (1.5.2 announced it with the version "UNKNOWN")
- ActionMapping takes the payload as an object; a JSON string is parsed (1.5.2 sent the string), any other throws
- what Alexa would reject in a 1.x declaration is not refused: device.check() lists it and the bridge logs each
line once, as "warning: ..." through the log hook, when it answers a discovery
- a device whose JSON cannot be built is left out of the answer and reported as an error event
- PowerController and EndpointHealth are the descriptors and keep ON/OFF and OK/UNREACHABLE; PowerState is new
Tests: six zoo devices declared the 1.x way give the JSON that Alexa accepted from 1.5.2 on 2026-09-28, plus the
Alexa capability. npm test: 85 pass (was 57) in 10-12 s, also on Node 18.20.8 and 20.20.2.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
117 lines
7.7 KiB
JavaScript
117 lines
7.7 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.STUBS = void 0;
|
|
// Interfaces without a descriptor of their own. A stub names the interface with the version and the properties
|
|
// alex2node 1.5.2 put in discovery, so an endpoint that declares one is announced as before. Nothing about it is
|
|
// checked, and the version is the one 1.5.2 sent, which is not always the one on the page of the interface
|
|
// (Alexa.Speaker is "3" there). A row leaves this table when a descriptor is written from that page.
|
|
const schema_js_1 = require("../schema.js");
|
|
const DEVICE_APIS = "https://developer.amazon.com/docs/alexaplus/device-apis";
|
|
const LIST_OF_INTERFACES = `${DEVICE_APIS}/list-of-interfaces.html`;
|
|
// "As of August 7, 2026, Automotive skills and the associated Alexa.AuthorizationController and
|
|
// Alexa.Automotive.VehicleData APIs are no longer available."
|
|
const DEPRECATED_FEATURES = "https://developer.amazon.com/en-US/docs/alexa/ask-overviews/deprecated-features.html";
|
|
const TABLE = [
|
|
["Alexa.ApplicationStateReporter", "1", [], "https://developer.amazon.com/docs/alexaplus/alexa-voice-service/alexa-applicationstatereporter.html"],
|
|
["Alexa.Audio.PlayQueue", "1", [], "alexa-audio-playqueue.html"],
|
|
["Alexa.AuthorizationController", "1", [], DEPRECATED_FEATURES],
|
|
["Alexa.AutomationManagement", "1", ["automationStatuses"], "alexa-automationmanagement.html"],
|
|
["Alexa.Automotive.VehicleData", "1", [], DEPRECATED_FEATURES],
|
|
// 1.5.2 announced the version "UNKNOWN"; 1.7 is what the list of interfaces gives
|
|
["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES],
|
|
["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.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.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"],
|
|
["Alexa.ContactSensor", "3", ["detectionState"], "alexa-contactsensor.html"],
|
|
["Alexa.Cooking", "1", [], "alexa-cooking.html"],
|
|
["Alexa.Cooking.FoodTemperatureController", "1", [], "alexa-cooking-foodtemperaturecontroller.html"],
|
|
["Alexa.Cooking.FoodTemperatureSensor", "1", [], "alexa-cooking-foodtemperaturesensor.html"],
|
|
["Alexa.Cooking.PresetController", "1", [], "alexa-cooking-presetcontroller.html"],
|
|
["Alexa.Cooking.TemperatureController", "1", [], "alexa-cooking-temperaturecontroller.html"],
|
|
["Alexa.Cooking.TemperatureSensor", "1", [], "alexa-cooking-temperaturesensor.html"],
|
|
["Alexa.Cooking.TimeController", "1", [], "alexa-cooking-timecontroller.html"],
|
|
["Alexa.DataController", "1", [], "alexa-datacontroller.html"],
|
|
["Alexa.DeviceUsage.Estimation", "1", [], "alexa-deviceusage-estimation.html"],
|
|
["Alexa.DeviceUsage.Meter", "1", [], "alexa-deviceusage-meter.html"],
|
|
["Alexa.DoorbellEventSource", "3", [], "alexa-doorbelleventsource.html"],
|
|
["Alexa.EqualizerController", "1", [], "alexa-equalizercontroller.html"],
|
|
["Alexa.InputController", "3", [], "alexa-inputcontroller.html"],
|
|
["Alexa.InventoryLevelSensor", "1", [], "alexa-inventorylevelsensor.html"],
|
|
["Alexa.InventoryLevelUsageSensor", "1", [], "alexa-inventorylevelusagesensor.html"],
|
|
["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"],
|
|
["Alexa.KeypadController", "1", [], "alexa-keypadcontroller.html"],
|
|
["Alexa.Launcher", "1.1", [], "alexa-launcher.html"],
|
|
["Alexa.LockController", "3", [], "alexa-lockcontroller.html"],
|
|
["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"],
|
|
["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"],
|
|
["Alexa.Media.Search", "1", [], "alexa-media-search.html"],
|
|
["Alexa.ModeController", "3", ["mode"], "alexa-modecontroller.html"],
|
|
["Alexa.MotionSensor", "3", [], "alexa-motionsensor.html"],
|
|
["Alexa.PercentageController", "3", [], "alexa-percentagecontroller.html"],
|
|
["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"],
|
|
["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"],
|
|
["Alexa.PowerLevelController", "3", [], "alexa-powerlevelcontroller.html"],
|
|
["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"],
|
|
["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"],
|
|
["Alexa.RangeController", "3", [], "alexa-rangecontroller.html"],
|
|
["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"],
|
|
["Alexa.RemoteVideoPlayer", "1", [], "alexa-remotevideoplayer.html"],
|
|
["Alexa.SceneController", "3", [], "alexa-scenecontroller.html"],
|
|
["Alexa.SecurityPanelController", "1", [], "alexa-securitypanelcontroller.html"],
|
|
["Alexa.SecurityPanelController.Alert", "1", [], "alexa-securitypanelcontroller-alert.html"],
|
|
["Alexa.SeekController", "3", [], "alexa-seekcontroller.html"],
|
|
["Alexa.SimpleEventSource", "1", [], "alexa-simpleeventsource.html"],
|
|
["Alexa.SmartVision.ObjectDetectionSensor", "1", [], "alexa-smartvision-objectdetectionsensor.html"],
|
|
["Alexa.SmartVision.SnapshotProvider", "1", [], "alexa-smartvision-snapshotprovider.html"],
|
|
["Alexa.Speaker", "1", [], "alexa-speaker.html"],
|
|
["Alexa.StepSpeaker", "1", [], "alexa-stepspeaker.html"],
|
|
["Alexa.ThermostatController", "3.2", ["targetSetpoint", "lowerSetpoint", "upperSetpoint", "thermostatMode"], "alexa-thermostatcontroller.html"],
|
|
["Alexa.ThermostatController.Configuration", "1", [], "alexa-thermostatcontroller-configuration.html"],
|
|
["Alexa.ThermostatController.HVAC.Components", "1", [], "alexa-thermostatcontroller-hvac-components.html"],
|
|
["Alexa.ThermostatController.Schedule", "1", [], "alexa-thermostatcontroller-schedule.html"],
|
|
// "UNKNOWN" in 1.5.2 as well; the page is titled "Interface 3"
|
|
["Alexa.TimeHoldController", "3", [], "alexa-timeholdcontroller.html"],
|
|
["Alexa.ToggleController", "3", ["toggleState"], "alexa-togglecontroller.html"],
|
|
["Alexa.UIController", "1", [], "alexa-uicontroller.html"],
|
|
["Alexa.UserPreference", "1", [], "alexa-userpreference.html"],
|
|
["Alexa.VideoRecorder", "1", [], "alexa-videorecorder.html"],
|
|
["Alexa.WakeOnLANController", "1", [], "alexa-wakeonlancontroller.html"],
|
|
];
|
|
// What 1.5.2 added to the capability object of three of them
|
|
const EXTRAS = {
|
|
// No properties object; supportsDeactivation and proactivelyReported on the capability itself
|
|
"Alexa.SceneController": ({ proactivelyReported }) => ({
|
|
properties: false,
|
|
topLevel: { supportsDeactivation: true, proactivelyReported },
|
|
}),
|
|
"Alexa.ThermostatController": () => ({
|
|
configuration: { supportedModes: ["HEAT", "COOL", "AUTO", "OFF"], supportsScheduling: false },
|
|
}),
|
|
"Alexa.ModeController": ({ options }) => (options.supportedModes?.length > 0
|
|
? { configuration: { ordered: true, supportedModes: options.supportedModes } }
|
|
: {}),
|
|
};
|
|
function kindOf(namespace) {
|
|
if (namespace.endsWith("Sensor"))
|
|
return "sensor";
|
|
if (namespace.endsWith("EventSource"))
|
|
return "eventSource";
|
|
return "controller";
|
|
}
|
|
function stub([namespace, version, properties, page]) {
|
|
return {
|
|
namespace,
|
|
version,
|
|
doc: page.startsWith("https://") ? page : `${DEVICE_APIS}/${page}`,
|
|
kind: kindOf(namespace),
|
|
tier: 3,
|
|
instanced: false,
|
|
properties: Object.fromEntries(properties.map((name) => [name, { name, value: schema_js_1.s.unknown() }])),
|
|
directives: {},
|
|
discovery: EXTRAS[namespace],
|
|
};
|
|
}
|
|
exports.STUBS = TABLE.map(stub);
|