For builders / Vocabulary
Vocabulary
A capability id means the same thing on every device, so a rule or an AI can ask for battery.level without knowing the hardware.
Kinds
- reading
- A value you can read.
- event
- A stream of things that happen.
- control
- A value you can set.
- action
- Something you can trigger once.
Privacy
- open
- The value can be passed on as it is.
- aggregate
- Only counts and coarse states may leave the adapter, never the raw stream.
- presence
- Only whether it is in use or present may leave the adapter, never the content.
Capabilities
| Capability | Kind | Lowest risk allowed | Devices |
|---|---|---|---|
| identity.firmwareFirmware version or layout identifier the device reports. | readingstring | read | AirPods Pro, Noise Cancelling Headphones 700, TS3 Plus, MX Master 3, TU690T Crystal UHD 4K TV, Moonlander Mark I, Voyager |
| keys.position_eventsEvery key press and release, by physical position. | eventkey position, down or up | read aggregate | Moonlander Mark I, Voyager |
| keys.layerThe active keymap layer, reported when it changes. | eventlayer number | read | Moonlander Mark I |
| keys.layer_setSwitch the active keymap layer from the host. | controllayer number | guarded | Moonlander Mark I |
| light.per_keySet the colour of an individual key. | controlrgb per key | reversible | Moonlander Mark I |
| light.globalSet every light on the device to one colour, or hand lighting back to the firmware. | controlrgb | reversible | Moonlander Mark I, Voyager |
| light.statusSwitch the device's separate indicator lights. | controlon or off per indicator | reversible | Moonlander Mark I |
| firmware.flashReplace the device's firmware. | actionfirmware image | gated | Moonlander Mark I, Voyager |
| battery.levelCharge remaining. | readingpercent | read | AirPods Pro, MacBook Pro (14-inch, 2024), Noise Cancelling Headphones 700, MX Master 3 |
| battery.chargingWhether the battery is charging. | readingboolean | read | MacBook Pro (14-inch, 2024) |
| battery.cyclesCharge cycles so far. | readingcount | read | MacBook Pro (14-inch, 2024) |
| battery.healthCapacity now, relative to when the battery was new. | readingpercent | read | MacBook Pro (14-inch, 2024) |
| storage.healthThe drive's own health verdict. | readingstatus | read | MacBook Pro (14-inch, 2024), Expansion external drive |
| thermal.pressureWhether the system is limiting performance because of heat. | readinglevel | read | MacBook Pro (14-inch, 2024) |
| audio.output_volumeOutput volume. | controlpercent | reversible | MacBook Pro (14-inch, 2024), Chromecast |
| pointer.dpiPointer sensitivity. | controldots per inch | guarded | MX Master 3 |
| pointer.buttonsSend a button's presses to software instead of its built-in action. | controlbutton to software | guarded | MX Master 3 |
| pointer.hostMove the device to another paired computer. | controlhost number | gated | MX Master 3 |
| scroll.modeHow the scroll wheel behaves. | controlratchet or free-spin | reversible | MX Master 3 |
| display.inputWhich video input the display shows. | controlinput source | guarded | UltraWide display |
| display.brightnessDisplay brightness. | controlpercent | reversible | UltraWide display |
| media.playingWhether something is playing. | readingplaying or idle | read presence | Chromecast |
| climate.temperatureThe temperature the device measures. | readingdegrees | read | Window air conditioner |
| climate.targetThe temperature the device aims for. | controldegrees | reversible | Window air conditioner |
| power.switchSwitch the device itself on or off. | controlon or off | reversible | Window air conditioner, Light |
| power.outletSwitch power to whatever is plugged into the device. | controlon or off | gated | Outlet / smart plug |
| light.brightnessHow bright a light is. | controlpercent | reversible | Light |
| access.unlockUnlock a door. | actionnone | gated | Lock |