Hardpoint

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

CapabilityKindLowest risk allowedDevices
identity.firmwareFirmware version or layout identifier the device reports.readingstringreadAirPods 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 upread aggregateMoonlander Mark I, Voyager
keys.layerThe active keymap layer, reported when it changes.eventlayer numberreadMoonlander Mark I
keys.layer_setSwitch the active keymap layer from the host.controllayer numberguardedMoonlander Mark I
light.per_keySet the colour of an individual key.controlrgb per keyreversibleMoonlander Mark I
light.globalSet every light on the device to one colour, or hand lighting back to the firmware.controlrgbreversibleMoonlander Mark I, Voyager
light.statusSwitch the device's separate indicator lights.controlon or off per indicatorreversibleMoonlander Mark I
firmware.flashReplace the device's firmware.actionfirmware imagegatedMoonlander Mark I, Voyager
battery.levelCharge remaining.readingpercentreadAirPods Pro, MacBook Pro (14-inch, 2024), Noise Cancelling Headphones 700, MX Master 3
battery.chargingWhether the battery is charging.readingbooleanreadMacBook Pro (14-inch, 2024)
battery.cyclesCharge cycles so far.readingcountreadMacBook Pro (14-inch, 2024)
battery.healthCapacity now, relative to when the battery was new.readingpercentreadMacBook Pro (14-inch, 2024)
storage.healthThe drive's own health verdict.readingstatusreadMacBook Pro (14-inch, 2024), Expansion external drive
thermal.pressureWhether the system is limiting performance because of heat.readinglevelreadMacBook Pro (14-inch, 2024)
audio.output_volumeOutput volume.controlpercentreversibleMacBook Pro (14-inch, 2024), Chromecast
pointer.dpiPointer sensitivity.controldots per inchguardedMX Master 3
pointer.buttonsSend a button's presses to software instead of its built-in action.controlbutton to softwareguardedMX Master 3
pointer.hostMove the device to another paired computer.controlhost numbergatedMX Master 3
scroll.modeHow the scroll wheel behaves.controlratchet or free-spinreversibleMX Master 3
display.inputWhich video input the display shows.controlinput sourceguardedUltraWide display
display.brightnessDisplay brightness.controlpercentreversibleUltraWide display
media.playingWhether something is playing.readingplaying or idleread presenceChromecast
climate.temperatureThe temperature the device measures.readingdegreesreadWindow air conditioner
climate.targetThe temperature the device aims for.controldegreesreversibleWindow air conditioner
power.switchSwitch the device itself on or off.controlon or offreversibleWindow air conditioner, Light
power.outletSwitch power to whatever is plugged into the device.controlon or offgatedOutlet / smart plug
light.brightnessHow bright a light is.controlpercentreversibleLight
access.unlockUnlock a door.actionnonegatedLock