discovery: generate capability JSON from the registry
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>
This commit is contained in:
parent
aa0ffd64ea
commit
c492ef74d1
90 changed files with 5539 additions and 1760 deletions
163
dist/cjs/compat/enums.js
vendored
Normal file
163
dist/cjs/compat/enums.js
vendored
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.EndpointHealth = exports.PowerController = exports.PowerState = exports.AlexaActions = exports.DisplayCategory = exports.AlexaInterfaceType = void 0;
|
||||
// The enums of 1.x, under their 1.x names.
|
||||
const EndpointHealth_js_1 = require("../registry/interfaces/EndpointHealth.js");
|
||||
const PowerController_js_1 = require("../registry/interfaces/PowerController.js");
|
||||
/** Every interface name of 1.x. registry.get() takes a member as it takes the namespace, which is its value. */
|
||||
var AlexaInterfaceType;
|
||||
(function (AlexaInterfaceType) {
|
||||
AlexaInterfaceType["APPLICATION_STATE_REPORTER"] = "Alexa.ApplicationStateReporter";
|
||||
AlexaInterfaceType["AUDIO_PLAY_QUEUE"] = "Alexa.Audio.PlayQueue";
|
||||
AlexaInterfaceType["AUTHORIZATION_CONTROLLER"] = "Alexa.AuthorizationController";
|
||||
AlexaInterfaceType["AUTOMATION_MANAGEMENT"] = "Alexa.AutomationManagement";
|
||||
AlexaInterfaceType["AUTOMOTIVE_VEHICLE_DATA"] = "Alexa.Automotive.VehicleData";
|
||||
AlexaInterfaceType["BRIGHTNESS_CONTROLLER"] = "Alexa.BrightnessController";
|
||||
AlexaInterfaceType["CAMERA_LIVE_VIEW_CONTROLLER"] = "Alexa.Camera.LiveViewController";
|
||||
AlexaInterfaceType["CAMERA_STREAM_CONTROLLER"] = "Alexa.CameraStreamController";
|
||||
AlexaInterfaceType["CHANNEL_CONTROLLER"] = "Alexa.ChannelController";
|
||||
AlexaInterfaceType["COLOR_CONTROLLER"] = "Alexa.ColorController";
|
||||
AlexaInterfaceType["COLOR_TEMPERATURE_CONTROLLER"] = "Alexa.ColorTemperatureController";
|
||||
AlexaInterfaceType["COMMISSIONABLE"] = "Alexa.Commissionable";
|
||||
AlexaInterfaceType["CONSENT_MANAGEMENT_CONSENT_REQUIRED_REPORTER"] = "Alexa.ConsentManagement.ConsentRequiredReporter";
|
||||
AlexaInterfaceType["CONTACT_SENSOR"] = "Alexa.ContactSensor";
|
||||
AlexaInterfaceType["COOKING"] = "Alexa.Cooking";
|
||||
AlexaInterfaceType["COOKING_FOOD_TEMPERATURE_CONTROLLER"] = "Alexa.Cooking.FoodTemperatureController";
|
||||
AlexaInterfaceType["COOKING_FOOD_TEMPERATURE_SENSOR"] = "Alexa.Cooking.FoodTemperatureSensor";
|
||||
AlexaInterfaceType["COOKING_PRESET_CONTROLLER"] = "Alexa.Cooking.PresetController";
|
||||
AlexaInterfaceType["COOKING_TEMPERATURE_CONTROLLER"] = "Alexa.Cooking.TemperatureController";
|
||||
AlexaInterfaceType["COOKING_TEMPERATURE_SENSOR"] = "Alexa.Cooking.TemperatureSensor";
|
||||
AlexaInterfaceType["COOKING_TIME_CONTROLLER"] = "Alexa.Cooking.TimeController";
|
||||
AlexaInterfaceType["DATA_CONTROLLER"] = "Alexa.DataController";
|
||||
AlexaInterfaceType["DEVICE_USAGE_ESTIMATION"] = "Alexa.DeviceUsage.Estimation";
|
||||
AlexaInterfaceType["DEVICE_USAGE_METER"] = "Alexa.DeviceUsage.Meter";
|
||||
AlexaInterfaceType["DOORBELL_EVENT_SOURCE"] = "Alexa.DoorbellEventSource";
|
||||
AlexaInterfaceType["ENDPOINT_HEALTH"] = "Alexa.EndpointHealth";
|
||||
AlexaInterfaceType["EQUALIZER_CONTROLLER"] = "Alexa.EqualizerController";
|
||||
AlexaInterfaceType["INPUT_CONTROLLER"] = "Alexa.InputController";
|
||||
AlexaInterfaceType["INVENTORY_LEVEL_SENSOR"] = "Alexa.InventoryLevelSensor";
|
||||
AlexaInterfaceType["INVENTORY_LEVEL_USAGE_SENSOR"] = "Alexa.InventoryLevelUsageSensor";
|
||||
AlexaInterfaceType["INVENTORY_USAGE_SENSOR"] = "Alexa.InventoryUsageSensor";
|
||||
AlexaInterfaceType["KEYPAD_CONTROLLER"] = "Alexa.KeypadController";
|
||||
AlexaInterfaceType["LAUNCHER"] = "Alexa.Launcher";
|
||||
AlexaInterfaceType["LOCK_CONTROLLER"] = "Alexa.LockController";
|
||||
AlexaInterfaceType["MEDIA_PLAYBACK"] = "Alexa.Media.Playback";
|
||||
AlexaInterfaceType["MEDIA_PLAY_QUEUE"] = "Alexa.Media.PlayQueue";
|
||||
AlexaInterfaceType["MEDIA_SEARCH"] = "Alexa.Media.Search";
|
||||
AlexaInterfaceType["MODE_CONTROLLER"] = "Alexa.ModeController";
|
||||
AlexaInterfaceType["MOTION_SENSOR"] = "Alexa.MotionSensor";
|
||||
AlexaInterfaceType["PERCENTAGE_CONTROLLER"] = "Alexa.PercentageController";
|
||||
AlexaInterfaceType["PLAYBACK_CONTROLLER"] = "Alexa.PlaybackController";
|
||||
AlexaInterfaceType["PLAYBACK_STATE_REPORTER"] = "Alexa.PlaybackStateReporter";
|
||||
AlexaInterfaceType["POWER_CONTROLLER"] = "Alexa.PowerController";
|
||||
AlexaInterfaceType["POWER_LEVEL_CONTROLLER"] = "Alexa.PowerLevelController";
|
||||
AlexaInterfaceType["PROACTIVE_NOTIFICATION_SOURCE"] = "Alexa.ProactiveNotificationSource";
|
||||
AlexaInterfaceType["RANGE_CONTROLLER"] = "Alexa.RangeController";
|
||||
AlexaInterfaceType["RECORD_CONTROLLER"] = "Alexa.RecordController";
|
||||
AlexaInterfaceType["REMOTE_VIDEO_PLAYER"] = "Alexa.RemoteVideoPlayer";
|
||||
AlexaInterfaceType["RTC_SESSION_CONTROLLER"] = "Alexa.RTCSessionController";
|
||||
AlexaInterfaceType["SCENE_CONTROLLER"] = "Alexa.SceneController";
|
||||
AlexaInterfaceType["SECURITY_PANEL_CONTROLLER"] = "Alexa.SecurityPanelController";
|
||||
AlexaInterfaceType["SECURITY_PANEL_CONTROLLER_ALERT"] = "Alexa.SecurityPanelController.Alert";
|
||||
AlexaInterfaceType["SEEK_CONTROLLER"] = "Alexa.SeekController";
|
||||
AlexaInterfaceType["SIMPLE_EVENT_SOURCE"] = "Alexa.SimpleEventSource";
|
||||
AlexaInterfaceType["SMART_VISION_OBJECT_DETECTION_SENSOR"] = "Alexa.SmartVision.ObjectDetectionSensor";
|
||||
AlexaInterfaceType["SMART_VISION_SNAPSHOT_PROVIDER"] = "Alexa.SmartVision.SnapshotProvider";
|
||||
AlexaInterfaceType["SPEAKER"] = "Alexa.Speaker";
|
||||
AlexaInterfaceType["STEP_SPEAKER"] = "Alexa.StepSpeaker";
|
||||
AlexaInterfaceType["TEMPERATURE_SENSOR"] = "Alexa.TemperatureSensor";
|
||||
AlexaInterfaceType["THERMOSTAT_CONTROLLER"] = "Alexa.ThermostatController";
|
||||
AlexaInterfaceType["THERMOSTAT_CONTROLLER_CONFIGURATION"] = "Alexa.ThermostatController.Configuration";
|
||||
AlexaInterfaceType["THERMOSTAT_CONTROLLER_HVAC_COMPONENTS"] = "Alexa.ThermostatController.HVAC.Components";
|
||||
AlexaInterfaceType["THERMOSTAT_CONTROLLER_SCHEDULE"] = "Alexa.ThermostatController.Schedule";
|
||||
AlexaInterfaceType["TIME_HOLD_CONTROLLER"] = "Alexa.TimeHoldController";
|
||||
AlexaInterfaceType["TOGGLE_CONTROLLER"] = "Alexa.ToggleController";
|
||||
AlexaInterfaceType["UI_CONTROLLER"] = "Alexa.UIController";
|
||||
AlexaInterfaceType["USER_PREFERENCE"] = "Alexa.UserPreference";
|
||||
AlexaInterfaceType["VIDEO_RECORDER"] = "Alexa.VideoRecorder";
|
||||
AlexaInterfaceType["WAKE_ON_LAN_CONTROLLER"] = "Alexa.WakeOnLANController";
|
||||
/** Not an interface: declaring it throws a DeclarationError. Kept because 1.x had it. */
|
||||
AlexaInterfaceType["UNKNOWN"] = "UNKNOWN";
|
||||
})(AlexaInterfaceType || (exports.AlexaInterfaceType = AlexaInterfaceType = {}));
|
||||
var DisplayCategory;
|
||||
(function (DisplayCategory) {
|
||||
DisplayCategory["ACTIVITY_TRIGGER"] = "ACTIVITY_TRIGGER";
|
||||
DisplayCategory["AIR_CONDITIONER"] = "AIR_CONDITIONER";
|
||||
DisplayCategory["AIR_FRESHENER"] = "AIR_FRESHENER";
|
||||
DisplayCategory["AIR_PURIFIER"] = "AIR_PURIFIER";
|
||||
DisplayCategory["AIR_QUALITY_MONITOR"] = "AIR_QUALITY_MONITOR";
|
||||
DisplayCategory["ALEXA_VOICE_ENABLED"] = "ALEXA_VOICE_ENABLED";
|
||||
DisplayCategory["AUTO_ACCESSORY"] = "AUTO_ACCESSORY";
|
||||
DisplayCategory["BLUETOOTH_SPEAKER"] = "BLUETOOTH_SPEAKER";
|
||||
DisplayCategory["CAMERA"] = "CAMERA";
|
||||
DisplayCategory["CHRISTMAS_TREE"] = "CHRISTMAS_TREE";
|
||||
DisplayCategory["COFFEE_MAKER"] = "COFFEE_MAKER";
|
||||
DisplayCategory["COMPUTER"] = "COMPUTER";
|
||||
DisplayCategory["CONTACT_SENSOR"] = "CONTACT_SENSOR";
|
||||
DisplayCategory["DISHWASHER"] = "DISHWASHER";
|
||||
DisplayCategory["DOOR"] = "DOOR";
|
||||
DisplayCategory["DOORBELL"] = "DOORBELL";
|
||||
DisplayCategory["DRYER"] = "DRYER";
|
||||
DisplayCategory["EXTERIOR_BLIND"] = "EXTERIOR_BLIND";
|
||||
DisplayCategory["FAN"] = "FAN";
|
||||
DisplayCategory["GAME_CONSOLE"] = "GAME_CONSOLE";
|
||||
DisplayCategory["GARAGE_DOOR"] = "GARAGE_DOOR";
|
||||
DisplayCategory["HEADPHONES"] = "HEADPHONES";
|
||||
DisplayCategory["HUB"] = "HUB";
|
||||
DisplayCategory["INTERIOR_BLIND"] = "INTERIOR_BLIND";
|
||||
DisplayCategory["LAPTOP"] = "LAPTOP";
|
||||
DisplayCategory["LIGHT"] = "LIGHT";
|
||||
DisplayCategory["MICROWAVE"] = "MICROWAVE";
|
||||
DisplayCategory["MOBILE_PHONE"] = "MOBILE_PHONE";
|
||||
DisplayCategory["MOTION_SENSOR"] = "MOTION_SENSOR";
|
||||
DisplayCategory["MUSIC_SYSTEM"] = "MUSIC_SYSTEM";
|
||||
DisplayCategory["NETWORK_HARDWARE"] = "NETWORK_HARDWARE";
|
||||
DisplayCategory["OTHER"] = "OTHER";
|
||||
DisplayCategory["OVEN"] = "OVEN";
|
||||
DisplayCategory["PHONE"] = "PHONE";
|
||||
DisplayCategory["PRINTER"] = "PRINTER";
|
||||
DisplayCategory["REMOTE"] = "REMOTE";
|
||||
DisplayCategory["ROUTER"] = "ROUTER";
|
||||
DisplayCategory["SCENE_TRIGGER"] = "SCENE_TRIGGER";
|
||||
DisplayCategory["SCREEN"] = "SCREEN";
|
||||
DisplayCategory["SECURITY_PANEL"] = "SECURITY_PANEL";
|
||||
DisplayCategory["SECURITY_SYSTEM"] = "SECURITY_SYSTEM";
|
||||
DisplayCategory["SLOW_COOKER"] = "SLOW_COOKER";
|
||||
DisplayCategory["SMARTLOCK"] = "SMARTLOCK";
|
||||
DisplayCategory["SMARTPLUG"] = "SMARTPLUG";
|
||||
DisplayCategory["SPEAKER"] = "SPEAKER";
|
||||
DisplayCategory["STREAMING_DEVICE"] = "STREAMING_DEVICE";
|
||||
DisplayCategory["SWITCH"] = "SWITCH";
|
||||
DisplayCategory["TABLET"] = "TABLET";
|
||||
DisplayCategory["TEMPERATURE_SENSOR"] = "TEMPERATURE_SENSOR";
|
||||
DisplayCategory["THERMOSTAT"] = "THERMOSTAT";
|
||||
DisplayCategory["TV"] = "TV";
|
||||
DisplayCategory["VACUUM_CLEANER"] = "VACUUM_CLEANER";
|
||||
DisplayCategory["VACUUM"] = "VACUUM";
|
||||
/** Not on the list of display categories any more; kept for 1.x callers. */
|
||||
DisplayCategory["VEHICLE"] = "VEHICLE";
|
||||
DisplayCategory["WASHER"] = "WASHER";
|
||||
DisplayCategory["WATER_HEATER"] = "WATER_HEATER";
|
||||
DisplayCategory["WEARABLE"] = "WEARABLE";
|
||||
})(DisplayCategory || (exports.DisplayCategory = DisplayCategory = {}));
|
||||
var AlexaActions;
|
||||
(function (AlexaActions) {
|
||||
AlexaActions["Open"] = "Alexa.Actions.Open";
|
||||
AlexaActions["Close"] = "Alexa.Actions.Close";
|
||||
AlexaActions["Raise"] = "Alexa.Actions.Raise";
|
||||
AlexaActions["Lower"] = "Alexa.Actions.Lower";
|
||||
AlexaActions["SetEcoOn"] = "Alexa.Actions.SetEcoOn";
|
||||
AlexaActions["SetEcoOff"] = "Alexa.Actions.SetEcoOff";
|
||||
})(AlexaActions || (exports.AlexaActions = AlexaActions = {}));
|
||||
/** The values of powerState and toggleState. */
|
||||
exports.PowerState = { ON: "ON", OFF: "OFF" };
|
||||
const Connectivity = { OK: "OK", UNREACHABLE: "UNREACHABLE" };
|
||||
// PowerController and EndpointHealth were enums in 1.x and are the names of two interfaces. One export serves both:
|
||||
// the descriptor, which also has the members of the enum, and a type of the same name for the values.
|
||||
/**
|
||||
* The Alexa.PowerController interface, for device.add(). PowerController.ON and PowerController.OFF are the 1.x enum
|
||||
* of power states and stay until 3.0: PowerState has the same two members.
|
||||
*/
|
||||
exports.PowerController = Object.assign(PowerController_js_1.PowerController, exports.PowerState);
|
||||
/** The Alexa.EndpointHealth interface, for device.add(). EndpointHealth.OK and EndpointHealth.UNREACHABLE are the 1.x enum of connectivity values. */
|
||||
exports.EndpointHealth = Object.assign(EndpointHealth_js_1.EndpointHealth, Connectivity);
|
||||
Loading…
Add table
Add a link
Reference in a new issue