@portpowered/reference-data 0.0.0-stage → 0.4.1

package/generated/public/docs/for-ai/capability-interfaces/reminders-provider/1.0.md

@@ -0,0 +1,17 @@
+# reminders-provider 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/reminders-provider`
+
+Reminder providers list reminders from a connected account. Use the returned items to give an assistant task context or display an existing reminder list.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/reminders-provider/1.0.yaml)
+
+## Messages
+
+- [list-reminders](/docs/references/capability-interfaces/reminders-provider/1.0/messages/list-reminders.yaml) (in): Request to list reminders from a reminders provider
+- [list-reminders-response](/docs/references/capability-interfaces/reminders-provider/1.0/messages/list-reminders-response.yaml) (out): Response containing a list of reminder lists from a reminders provider
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/remote-control/1.0.md

@@ -0,0 +1,20 @@
+# remote-control 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/remote-control`
+
+Remote control starts and ends control sessions and sends movement instructions. Use velocity, turning, and duration fields to request movement from a connected device.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/remote-control/1.0.yaml)
+
+## Messages
+
+- [end-session](/docs/references/capability-interfaces/remote-control/1.0/messages/end-session.yaml) (in): Use this exact payload schema.
+- [move](/docs/references/capability-interfaces/remote-control/1.0/messages/move.yaml) (in): Use this exact payload schema.
+- [start-session](/docs/references/capability-interfaces/remote-control/1.0/messages/start-session.yaml) (in): Use this exact payload schema.
+- [stop-session](/docs/references/capability-interfaces/remote-control/1.0/messages/stop-session.yaml) (in): Use this exact payload schema.
+- [unary-move](/docs/references/capability-interfaces/remote-control/1.0/messages/unary-move.yaml) (in): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/robotic-vacuum-cleaner/1.0.md

@@ -0,0 +1,23 @@
+# robotic-vacuum-cleaner 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/robotic-vacuum-cleaner`
+
+Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a cleaning mode and read the reported mode and operational state to follow a cleaning session.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0.yaml)
+
+## Messages
+
+- [clean-room](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/clean-room.yaml) (in): Clean one or more rooms, in the requested order. Each entry is a canonical endpoint group the robot can control through a CAN_CONTROL relationship. More than one room requires the configuration to declare supportsMultiRoomCleaning; otherwise the request is rejected with MULTI_ROOM_UNSUPPORTED.
+- [pause](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/pause.yaml) (in): Use this exact payload schema.
+- [return-to-dock](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/return-to-dock.yaml) (in): Use this exact payload schema.
+- [set-cleaning-mode](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/set-cleaning-mode.yaml) (in): Use this exact payload schema.
+- [start](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/start.yaml) (in): Use this exact payload schema.
+- [stop](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/messages/stop.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [cleaning-mode](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/attributes/cleaning-mode.yaml)
+- [operational-state](/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0/attributes/operational-state.yaml)

package/generated/public/docs/for-ai/capability-interfaces/route-discovery/1.0.md

@@ -0,0 +1,20 @@
+# route-discovery 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/route-discovery`
+
+Route discovery reports the control routes available to an integration. Use its group commands to name a group or update the routes that belong to it.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/route-discovery/1.0.yaml)
+
+## Messages
+
+- [add-group-route-members](/docs/references/capability-interfaces/route-discovery/1.0/messages/add-group-route-members.yaml) (in): Request to add members to a group route
+- [discover-routes](/docs/references/capability-interfaces/route-discovery/1.0/messages/discover-routes.yaml) (out): Request to discover routes
+- [remove-group-route-members](/docs/references/capability-interfaces/route-discovery/1.0/messages/remove-group-route-members.yaml) (in): Request to remove members from a group route
+- [route-discovery-report](/docs/references/capability-interfaces/route-discovery/1.0/messages/route-discovery-report.yaml) (out): Report of discovered routes, group routes and their relationships. Decodes to the same model as SynchronizationRequest.
+- [set-group-route-name](/docs/references/capability-interfaces/route-discovery/1.0/messages/set-group-route-name.yaml) (in): Request to set the name of a group route
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/rtc-session/1.0.md

@@ -0,0 +1,19 @@
+# rtc-session 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/rtc-session`
+
+RTC sessions initiate a connection using an offer and return an answer for the session. Follow disconnection events and close the session when the connection is no longer needed.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/rtc-session/1.0.yaml)
+
+## Messages
+
+- [answer-generated-for-session](/docs/references/capability-interfaces/rtc-session/1.0/messages/answer-generated-for-session.yaml) (out): Use this exact payload schema.
+- [disconnect-session](/docs/references/capability-interfaces/rtc-session/1.0/messages/disconnect-session.yaml) (in): Use this exact payload schema.
+- [initiate-session-with-offer](/docs/references/capability-interfaces/rtc-session/1.0/messages/initiate-session-with-offer.yaml) (in): The initiate session with offer message is used to initiate an RTC session between the client and an endpoint.  The offer is expected to be a standard RTC SDP (standard description protocol) offer. The offer must contain all ICE candidates for the session to be established.
+- [session-disconnected](/docs/references/capability-interfaces/rtc-session/1.0/messages/session-disconnected.yaml) (out): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/rtsp-session/1.0.md

@@ -0,0 +1,19 @@
+# rtsp-session 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/rtsp-session`
+
+RTSP sessions open a camera connection and return its RTSP URI and optional SDP description. Close the session when the connection is no longer needed.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/rtsp-session/1.0.yaml)
+
+## Messages
+
+- [start-session](/docs/references/capability-interfaces/rtsp-session/1.0/messages/start-session.yaml) (in): Start session.
+- [start-session-response](/docs/references/capability-interfaces/rtsp-session/1.0/messages/start-session-response.yaml) (out): Start session response.
+- [stop-session](/docs/references/capability-interfaces/rtsp-session/1.0/messages/stop-session.yaml) (in): Stop session.
+- [stop-session-response](/docs/references/capability-interfaces/rtsp-session/1.0/messages/stop-session-response.yaml) (out): Stop session response.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/scene/1.0.md

@@ -0,0 +1,17 @@
+# scene 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/scene`
+
+Scenes activate or deactivate a predefined device scene. Use them to request a saved combination of settings from a connected integration.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/scene/1.0.yaml)
+
+## Messages
+
+- [activate](/docs/references/capability-interfaces/scene/1.0/messages/activate.yaml) (in): Use this exact payload schema.
+- [deactivate](/docs/references/capability-interfaces/scene/1.0/messages/deactivate.yaml) (in): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/security-panel/1.0.md

@@ -0,0 +1,24 @@
+# security-panel 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/security-panel`
+
+Security panels accept arm and disarm commands and report alarm and arming states. Use those reports to show the status supplied by a connected panel.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/security-panel/1.0.yaml)
+
+## Messages
+
+- [arm](/docs/references/capability-interfaces/security-panel/1.0/messages/arm.yaml) (in): Use this exact payload schema.
+- [disarm](/docs/references/capability-interfaces/security-panel/1.0/messages/disarm.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [arm-state](/docs/references/capability-interfaces/security-panel/1.0/attributes/arm-state.yaml)
+- [burglary-alarm](/docs/references/capability-interfaces/security-panel/1.0/attributes/burglary-alarm.yaml)
+- [carbon-monoxide-alarm](/docs/references/capability-interfaces/security-panel/1.0/attributes/carbon-monoxide-alarm.yaml)
+- [delay-state](/docs/references/capability-interfaces/security-panel/1.0/attributes/delay-state.yaml)
+- [fire-alarm](/docs/references/capability-interfaces/security-panel/1.0/attributes/fire-alarm.yaml)
+- [siren-state](/docs/references/capability-interfaces/security-panel/1.0/attributes/siren-state.yaml)
+- [water-alarm](/docs/references/capability-interfaces/security-panel/1.0/attributes/water-alarm.yaml)

package/generated/public/docs/for-ai/capability-interfaces/security-pin/1.0.md

@@ -0,0 +1,24 @@
+# security-pin 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/security-pin`
+
+Security PINs create, update, query, and delete PIN records. Follow operation results and PIN reports when managing the records supported by a device.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/security-pin/1.0.yaml)
+
+## Messages
+
+- [create-pin](/docs/references/capability-interfaces/security-pin/1.0/messages/create-pin.yaml) (in): Create an endpoint-scoped PIN. TEMPORARY requires both validity timestamps; PERMANENT forbids them. Validate increasing, nonexpired instants and declared restrictions before dispatch.
+- [delete-pin](/docs/references/capability-interfaces/security-pin/1.0/messages/delete-pin.yaml) (in): Delete a record within the authorized endpoint. Emit a correlated terminal result even when enumeration no longer includes the record.
+- [pin-operation-result](/docs/references/capability-interfaces/security-pin/1.0/messages/pin-operation-result.yaml) (out): Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed completion, not dispatch acceptance. CREATE supplies recordId once assigned; UPDATE and DELETE retain the requested ID. FAILED requires a safe code; other statuses forbid code. Never include credentials or raw vendor errors.
+- [pin-records-report](/docs/references/capability-interfaces/security-pin/1.0/messages/pin-records-report.yaml) (out): Bounded credential-free record page aligned with the pin-records attribute. Echo the query correlation token in the message header.
+- [query-operation](/docs/references/capability-interfaces/security-pin/1.0/messages/query-operation.yaml) (in): Retrieve an endpoint-scoped PIN operation result by its original correlation token. Enforce caller and endpoint ownership. Return pin-operation-result, preserving the original operation correlation token in its payload and using this query's correlation token in the response header.
+- [query-pins](/docs/references/capability-interfaces/security-pin/1.0/messages/query-pins.yaml) (in): Query a bounded endpoint-scoped PIN record page. Requires message-send permission. Continuations bind caller, endpoint and page size; return pin-records-report with the request correlation token in its header.
+- [update-pin](/docs/references/capability-interfaces/security-pin/1.0/messages/update-pin.yaml) (in): Update an endpoint-scoped record. Require at least one change. Kind is immutable; validity changes require both timestamps and an authoritative TEMPORARY record.
+
+## State attributes
+
+- [pin-records](/docs/references/capability-interfaces/security-pin/1.0/attributes/pin-records.yaml)
+- [pin-support](/docs/references/capability-interfaces/security-pin/1.0/attributes/pin-support.yaml)

package/generated/public/docs/for-ai/capability-interfaces/smoke-co-alarm/1.0.md

@@ -0,0 +1,16 @@
+# smoke-co-alarm 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/smoke-co-alarm`
+
+Smoke and carbon monoxide detectors report detection state. Devices expose alarm controls through the alarm capability and charge level through the battery capability.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/smoke-co-alarm/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [alarm-state](/docs/references/capability-interfaces/smoke-co-alarm/1.0/attributes/alarm-state.yaml)

package/generated/public/docs/for-ai/capability-interfaces/snapshot/1.0.md

@@ -0,0 +1,17 @@
+# snapshot 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/snapshot`
+
+Snapshots request a captured view and return a snapshot response. Use them when an integration needs a single capture rather than a continuous live view.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/snapshot/1.0.yaml)
+
+## Messages
+
+- [get-snapshot](/docs/references/capability-interfaces/snapshot/1.0/messages/get-snapshot.yaml) (in): Use this exact payload schema.
+- [get-snapshot-response](/docs/references/capability-interfaces/snapshot/1.0/messages/get-snapshot-response.yaml) (out): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/soil-moisture-sensor/1.0.md

@@ -0,0 +1,16 @@
+# soil-moisture-sensor 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/soil-moisture-sensor`
+
+Soil moisture measurements report the reading supplied by a connected sensor. Use the value as input when monitoring growing conditions.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/soil-moisture-sensor/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [measured-value](/docs/references/capability-interfaces/soil-moisture-sensor/1.0/attributes/measured-value.yaml)

package/generated/public/docs/for-ai/capability-interfaces/spatial/1.0.md

@@ -0,0 +1,18 @@
+# spatial 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/spatial`
+
+Descriptive spatial declaration of a group route (home, floor/map, room or zone). The spatial interface declares no control messages; cleaning is sent to the robot endpoint.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/spatial/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [active](/docs/references/capability-interfaces/spatial/1.0/attributes/active.yaml)
+- [geometry](/docs/references/capability-interfaces/spatial/1.0/attributes/geometry.yaml)
+- [position](/docs/references/capability-interfaces/spatial/1.0/attributes/position.yaml)

package/generated/public/docs/for-ai/capability-interfaces/speaker/1.0.md

@@ -0,0 +1,20 @@
+# speaker 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/speaker`
+
+Speakers set or adjust volume and change mute state. Read the current volume and mute state to keep playback controls in step with the device.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/speaker/1.0.yaml)
+
+## Messages
+
+- [adjust-volume](/docs/references/capability-interfaces/speaker/1.0/messages/adjust-volume.yaml) (in): Use this exact payload schema.
+- [set-mute](/docs/references/capability-interfaces/speaker/1.0/messages/set-mute.yaml) (in): Use this exact payload schema.
+- [set-volume](/docs/references/capability-interfaces/speaker/1.0/messages/set-volume.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [muted](/docs/references/capability-interfaces/speaker/1.0/attributes/muted.yaml)
+- [volume](/docs/references/capability-interfaces/speaker/1.0/attributes/volume.yaml)

package/generated/public/docs/for-ai/capability-interfaces/speech-audio-generation/1.0.md

@@ -0,0 +1,17 @@
+# speech-audio-generation 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/speech-audio-generation`
+
+Speech audio generation turns an input into speech audio and returns its URI. Use the result when an integration needs an audio file it can pass to a player.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/speech-audio-generation/1.0.yaml)
+
+## Messages
+
+- [audio-uri](/docs/references/capability-interfaces/speech-audio-generation/1.0/messages/audio-uri.yaml) (out): Use this exact payload schema.
+- [generate-speech](/docs/references/capability-interfaces/speech-audio-generation/1.0/messages/generate-speech.yaml) (in): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/speech-synthesizer/1.0.md

@@ -0,0 +1,16 @@
+# speech-synthesizer 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/speech-synthesizer`
+
+Speech synthesizers accept a request to speak. Use them to send spoken output to a connected device or integration.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/speech-synthesizer/1.0.yaml)
+
+## Messages
+
+- [speak](/docs/references/capability-interfaces/speech-synthesizer/1.0/messages/speak.yaml) (in): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/temperature-sensor/1.0.md

@@ -0,0 +1,17 @@
+# temperature-sensor 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/temperature-sensor`
+
+Temperature sensors report temperature and operation mode. Use the reading to display conditions or give a heating and cooling flow a measured input.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/temperature-sensor/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [operation-mode](/docs/references/capability-interfaces/temperature-sensor/1.0/attributes/operation-mode.yaml)
+- [temperature](/docs/references/capability-interfaces/temperature-sensor/1.0/attributes/temperature.yaml)

package/generated/public/docs/for-ai/capability-interfaces/text/1.0.md

@@ -0,0 +1,16 @@
+# text 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/text`
+
+Text sends a text message to a connected component. Use it to pass written input between integrations.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/text/1.0.yaml)
+
+## Messages
+
+- [text](/docs/references/capability-interfaces/text/1.0/messages/text.yaml) (in): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/text-stream/1.0.md

@@ -0,0 +1,16 @@
+# text-stream 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/text-stream`
+
+Text streams emit text as a stream of messages. Use the stream to consume output as it becomes available.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/text-stream/1.0.yaml)
+
+## Messages
+
+- [text-stream](/docs/references/capability-interfaces/text-stream/1.0/messages/text-stream.yaml) (out): Use this exact payload schema.
+
+## State attributes
+

package/generated/public/docs/for-ai/capability-interfaces/thermostat/1.0.md

@@ -0,0 +1,22 @@
+# thermostat 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/thermostat`
+
+Thermostats set a target temperature and select a heating or cooling mode. Read the reported setpoints and operating mode to show the current settings.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/thermostat/1.0.yaml)
+
+## Messages
+
+- [adjust-target-temperature](/docs/references/capability-interfaces/thermostat/1.0/messages/adjust-target-temperature.yaml) (in): Use this exact payload schema.
+- [set-target-temperature](/docs/references/capability-interfaces/thermostat/1.0/messages/set-target-temperature.yaml) (in): Use this exact payload schema.
+- [set-thermostat-mode](/docs/references/capability-interfaces/thermostat/1.0/messages/set-thermostat-mode.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [lower-setpoint](/docs/references/capability-interfaces/thermostat/1.0/attributes/lower-setpoint.yaml)
+- [target-setpoint](/docs/references/capability-interfaces/thermostat/1.0/attributes/target-setpoint.yaml)
+- [thermostat-mode](/docs/references/capability-interfaces/thermostat/1.0/attributes/thermostat-mode.yaml)
+- [upper-setpoint](/docs/references/capability-interfaces/thermostat/1.0/attributes/upper-setpoint.yaml)

package/generated/public/docs/for-ai/capability-interfaces/water-heater/1.0.md

@@ -0,0 +1,19 @@
+# water-heater 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/water-heater`
+
+Water heaters set a temperature and operating mode. Read the temperature setpoint and mode to show the settings supplied by a connected heater.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/water-heater/1.0.yaml)
+
+## Messages
+
+- [set-mode](/docs/references/capability-interfaces/water-heater/1.0/messages/set-mode.yaml) (in): Use this exact payload schema.
+- [set-temperature](/docs/references/capability-interfaces/water-heater/1.0/messages/set-temperature.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [mode](/docs/references/capability-interfaces/water-heater/1.0/attributes/mode.yaml)
+- [temperature-setpoint](/docs/references/capability-interfaces/water-heater/1.0/attributes/temperature-setpoint.yaml)

package/generated/public/docs/for-ai/capability-interfaces/wind-speed-sensor/1.0.md

@@ -0,0 +1,16 @@
+# wind-speed-sensor 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/wind-speed-sensor`
+
+Wind speed measurements report the reading supplied by a connected sensor. Use the value and its declared unit when displaying measured wind conditions.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/wind-speed-sensor/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [measured-value](/docs/references/capability-interfaces/wind-speed-sensor/1.0/attributes/measured-value.yaml)

package/generated/public/docs/for-ai/capability-interfaces/window/1.0.md

@@ -0,0 +1,17 @@
+# window 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/window`
+
+Windows report their window state and lock state. Use those reports to check the status supplied by a connected window.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/window/1.0.yaml)
+
+## Messages
+
+
+## State attributes
+
+- [lock-state](/docs/references/capability-interfaces/window/1.0/attributes/lock-state.yaml)
+- [window-state](/docs/references/capability-interfaces/window/1.0/attributes/window-state.yaml)

package/generated/public/docs/for-ai/capability-interfaces/window-covering/1.0.md

@@ -0,0 +1,18 @@
+# window-covering 1.0
+
+Namespace: `port1/systems/zero/capability-interfaces/window-covering`
+
+Window coverings move to a requested lift or tilt percentage. Read their reported position to keep a shade or blind control in step with the device.
+
+Read scopes: endpoint:read. Inbound control scope: message:send. Resource permission is also required.
+
+[Complete YAML](/docs/references/capability-interfaces/window-covering/1.0.yaml)
+
+## Messages
+
+- [go-to-lift-percentage](/docs/references/capability-interfaces/window-covering/1.0/messages/go-to-lift-percentage.yaml) (in): Use this exact payload schema.
+- [go-to-tilt-percentage](/docs/references/capability-interfaces/window-covering/1.0/messages/go-to-tilt-percentage.yaml) (in): Use this exact payload schema.
+
+## State attributes
+
+- [position](/docs/references/capability-interfaces/window-covering/1.0/attributes/position.yaml)

package/generated/public/docs/for-ai/capability-interfaces.md

@@ -0,0 +1,93 @@
+# Capability interfaces
+
+Match the endpoint’s full namespace and version. Message payloads are the body inside the REST message envelope; they are not the entire POST /messages request.
+
+- [air-quality-sensor 1.0](/docs/for-ai/capability-interfaces/air-quality-sensor/1.0.md): Air quality reports the air-quality index measured by a device. Use the reading to understand conditions in a room and decide when to run ventilation or another automation.
+- [alarm 1.0](/docs/for-ai/capability-interfaces/alarm/1.0.md): Alarms ring, silence, or test a device's siren when supported. Read the alarm state to see whether the siren is active.
+- [application-launcher 1.0](/docs/for-ai/capability-interfaces/application-launcher/1.0.md): Application launchers start and stop applications on a connected device. Check the available applications and the current selection before choosing what to launch.
+- [authorization 1.0](/docs/for-ai/capability-interfaces/authorization/1.0.md): Authorization connects an integration to an account and keeps its credentials up to date. Use token refresh and authorization reports to follow the connection as it changes.
+- [barrier-control 1.0](/docs/for-ai/capability-interfaces/barrier-control/1.0.md): Barrier control opens, closes, or positions a connected barrier. Read its position and state to check a garage door or gate before sending the next command.
+- [battery 1.0](/docs/for-ai/capability-interfaces/battery/1.0.md): Battery reports a connected device's charge level and battery health. Use it to show when a device needs charging or a replacement battery.
+- [brightness 1.0](/docs/for-ai/capability-interfaces/brightness/1.0.md): Brightness sets how bright a connected device should be and reports its current level. Use it to dim a light for the evening or restore a brighter setting for work.
+- [calendar-provider 1.0](/docs/for-ai/capability-interfaces/calendar-provider/1.0.md): Calendar providers list events from a connected calendar. Use the returned events to give an assistant schedule context or build an automation around an upcoming appointment.
+- [camera 1.0](/docs/for-ai/capability-interfaces/camera/1.0.md): Cameras provide streaming, event images, and camera controls. Start a stream, adjust pan and tilt when supported, or configure motion detection for the view you need.
+- [carbon-dioxide-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/carbon-dioxide-concentration-sensor/1.0.md): Carbon dioxide measurements report the concentration observed by a sensor, including its minimum and maximum readings. Use them to track changes in indoor conditions over time.
+- [carbon-monoxide-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/carbon-monoxide-concentration-sensor/1.0.md): Carbon monoxide measurements report the concentration observed by a sensor, including its minimum and maximum readings. Use the reported values as input to monitoring and notification flows.
+- [channel 1.0](/docs/for-ai/capability-interfaces/channel/1.0.md): Channel controls select a channel or skip between channels on a connected device. Read the current channel to keep the interface in step with what is playing.
+- [cleaning-mode 1.0](/docs/for-ai/capability-interfaces/cleaning-mode/1.0.md): Cleaning types, suction levels and water flows the robot supports, refreshed on every discovery. set-cleaning-mode values outside these lists are rejected before dispatch.
+- [color 1.0](/docs/for-ai/capability-interfaces/color/1.0.md): Color sets and reports the color of a connected device. Use it to coordinate lighting for a scene or let an assistant choose a new color.
+- [color-temperature 1.0](/docs/for-ai/capability-interfaces/color-temperature/1.0.md): Color temperature adjusts a light between warmer and cooler tones. Set a temperature directly or increase and decrease it, then read the reported value in kelvin.
+- [connectivity 1.0](/docs/for-ai/capability-interfaces/connectivity/1.0.md): Connectivity tells you whether a connected device is reachable. Use its reported state to explain an unavailable device or decide when to retry an action.
+- [contact-sensor 1.0](/docs/for-ai/capability-interfaces/contact-sensor/1.0.md): Contact sensors tell you whether a door, window, or gate is open or closed. Use their reported state to check an entryway or trigger an automation when something is left open.
+- [contacts-provider 1.0](/docs/for-ai/capability-interfaces/contacts-provider/1.0.md): Contacts providers list contacts from a connected account. Use the returned records to give an assistant the contact information available to your integration.
+- [content-launcher 1.0](/docs/for-ai/capability-interfaces/content-launcher/1.0.md): Content launchers open content or a URL on a connected device. Use them to send a selected item to a screen or start the content a customer asked for.
+- [control-route-groups-provider 1.0](/docs/for-ai/capability-interfaces/control-route-groups-provider/1.0.md): Control route groups organize several routes into a group. Create a group with its member routes or delete a group your integration no longer needs.
+- [control-routes-provider 1.0](/docs/for-ai/capability-interfaces/control-routes-provider/1.0.md): Control route providers carry dispatch results and attribute reports between an integration and Port OS. Use them to report acknowledgements, errors, deferred responses, and batches of messages.
+- [cooktop 1.0](/docs/for-ai/capability-interfaces/cooktop/1.0.md): Cooktops report their operational state. Use that state to show what the appliance is doing or supply context to an automation.
+- [dishwasher 1.0](/docs/for-ai/capability-interfaces/dishwasher/1.0.md): Dishwashers report their operational state. Use it to keep an appliance dashboard up to date or react when a reported state changes.
+- [doorbell 1.0](/docs/for-ai/capability-interfaces/doorbell/1.0.md): Doorbells emit a chime event. Use that event to start a notification or another flow when someone rings the bell.
+- [electrical-conductivity-sensor 1.0](/docs/for-ai/capability-interfaces/electrical-conductivity-sensor/1.0.md): Electrical conductivity measurements report a sensor reading. Use the value and its declared units when displaying or comparing measurements.
+- [embedding-generation 1.0](/docs/for-ai/capability-interfaces/embedding-generation/1.0.md): Embedding generation turns an input into an embedding and returns its URI. Use the result in integrations that work with vector representations of content.
+- [endpoint-registry 1.0](/docs/for-ai/capability-interfaces/endpoint-registry/1.0.md): Configuration for Port OS endpoint registry lifecycle notifications
+- [equalizer 1.0](/docs/for-ai/capability-interfaces/equalizer/1.0.md): Equalizers adjust audio bands and select an equalizer mode. Read the current bands and mode to keep an audio control in step with the device.
+- [event-detection-sensor 1.0](/docs/for-ai/capability-interfaces/event-detection-sensor/1.0.md): Event detection sensors report human presence and emit person-detected events. Use them to give an automation context about activity in a monitored area.
+- [extractor-hood 1.0](/docs/for-ai/capability-interfaces/extractor-hood/1.0.md): Extractor hoods report their fan speed. Use that state to show the current ventilation setting alongside other kitchen appliances.
+- [fan-control 1.0](/docs/for-ai/capability-interfaces/fan-control/1.0.md): Fan control selects a fan mode and speed. Read the reported settings to check how a fan is running before changing them.
+- [filesystem-provider 1.0](/docs/for-ai/capability-interfaces/filesystem-provider/1.0.md): Filesystem providers list folders and photo albums and expose file download, upload, and deletion. Check the provider's supported commands before requesting an operation.
+- [flow-sensor 1.0](/docs/for-ai/capability-interfaces/flow-sensor/1.0.md): Flow measurements report the flow observed by a sensor. Use the reading and its declared units to monitor changes in a connected system.
+- [flows 1.0](/docs/for-ai/capability-interfaces/flows/1.0.md): Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion and acknowledgement events to understand the progress of a run.
+- [formaldehyde-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/formaldehyde-concentration-sensor/1.0.md): Formaldehyde measurements report the concentration observed by a sensor. Use the reading and its declared unit when presenting environmental measurements.
+- [humidity-sensor 1.0](/docs/for-ai/capability-interfaces/humidity-sensor/1.0.md): Humidity sensors report relative humidity. Use the reading to display room conditions or provide input to a ventilation or humidifier flow.
+- [input 1.0](/docs/for-ai/capability-interfaces/input/1.0.md): Input controls select or navigate between the inputs on a connected device. Read the current input to show which source is selected.
+- [keypad-input 1.0](/docs/for-ai/capability-interfaces/keypad-input/1.0.md): Keypad input sends a key to a connected device. Use it to build remote controls that send individual button presses.
+- [laundry-dryer 1.0](/docs/for-ai/capability-interfaces/laundry-dryer/1.0.md): Laundry dryers report their operational state. Use it to show the current appliance status or react to a change in a flow.
+- [laundry-washer 1.0](/docs/for-ai/capability-interfaces/laundry-washer/1.0.md): Laundry washers report their operational state. Use it to keep a laundry dashboard in step with the appliance.
+- [leaf-wetness-sensor 1.0](/docs/for-ai/capability-interfaces/leaf-wetness-sensor/1.0.md): Leaf wetness measurements report readings from a connected sensor. Use them as input when monitoring plants and growing conditions.
+- [light-sensor 1.0](/docs/for-ai/capability-interfaces/light-sensor/1.0.md): Light sensors report illuminance. Use the reading to understand ambient light and provide input to a lighting automation.
+- [location 1.0](/docs/for-ai/capability-interfaces/location/1.0.md): Location reports a connected resource's geolocation. Use it to show the position supplied by that resource.
+- [location-tracker 1.0](/docs/for-ai/capability-interfaces/location-tracker/1.0.md): Location trackers start a locator and report its signal. Use them when helping a customer locate a connected item.
+- [lock 1.0](/docs/for-ai/capability-interfaces/lock/1.0.md): Locks accept lock and unlock commands and report their lock state. Use the reported state to check an entryway before requesting a change.
+- [media-player 1.0](/docs/for-ai/capability-interfaces/media-player/1.0.md): Media players select media by its Port OS media ID, play supplied audio or a URI, and control playback. Read playback state and use only the commands supported by the connected player.
+- [media-playlist 1.0](/docs/for-ai/capability-interfaces/media-playlist/1.0.md): Media playlists create and manage a collection of items to play. Add or remove items, retrieve a playlist, shuffle it, or ask the device to play it.
+- [media-search 1.0](/docs/for-ai/capability-interfaces/media-search/1.0.md): Media search requests content matching a search and returns audio media results. Use it to find an item before asking a player to play it.
+- [microwave-oven 1.0](/docs/for-ai/capability-interfaces/microwave-oven/1.0.md): Microwave ovens report their operational state. Use that state to show what the appliance is currently doing.
+- [motion-sensor 1.0](/docs/for-ai/capability-interfaces/motion-sensor/1.0.md): Motion sensors report detection state and emit motion-detected events. Use them to trigger a light, a notification, or another automation when movement is detected.
+- [nitrogen-dioxide-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/nitrogen-dioxide-concentration-sensor/1.0.md): Nitrogen dioxide measurements report the concentration observed by a sensor. Use the value and its declared units in environmental monitoring.
+- [notification 1.0](/docs/for-ai/capability-interfaces/notification/1.0.md): Notifications can be triggered immediately or scheduled. Follow notification events to connect the delivery flow to the rest of an integration.
+- [oven 1.0](/docs/for-ai/capability-interfaces/oven/1.0.md): Ovens report their temperature. Use the reading to show the temperature supplied by a connected appliance.
+- [ozone-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/ozone-concentration-sensor/1.0.md): Ozone measurements report the concentration observed by a sensor. Use the reading and its declared unit when displaying environmental conditions.
+- [percentage 1.0](/docs/for-ai/capability-interfaces/percentage/1.0.md): Percentage controls set or adjust a percentage and report the current value. Use them for connected controls expressed as a proportional level.
+- [pet-feeder 1.0](/docs/for-ai/capability-interfaces/pet-feeder/1.0.md): Pet feeders accept a command to trigger a feed. Use the command to start a feeding action from an interface or automation.
+- [ph-sensor 1.0](/docs/for-ai/capability-interfaces/ph-sensor/1.0.md): pH measurements report the reading supplied by a connected sensor. Use it when monitoring the conditions of a liquid or growing system.
+- [pm10-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/pm10-concentration-sensor/1.0.md): PM10 measurements report the concentration observed by a particulate sensor. Use the reported value and unit when displaying air measurements.
+- [pm2-5-concentration-sensor 1.0](/docs/for-ai/capability-interfaces/pm2-5-concentration-sensor/1.0.md): PM2.5 measurements report the concentration observed by a particulate sensor. Use the reading to follow changes in measured air conditions.
+- [power 1.0](/docs/for-ai/capability-interfaces/power/1.0.md): Power turns a device on or off, reports its power state, and restarts devices that support rebooting.
+- [power-level 1.0](/docs/for-ai/capability-interfaces/power-level/1.0.md): Power level sets or adjusts a device's output level and reports the current setting. Use it when a device supports more than a simple on/off control.
+- [pressure-sensor 1.0](/docs/for-ai/capability-interfaces/pressure-sensor/1.0.md): Pressure measurements report the value supplied by a connected sensor. Use the value and its declared unit when monitoring pressure.
+- [pump-configuration-and-control 1.0](/docs/for-ai/capability-interfaces/pump-configuration-and-control/1.0.md): Pump controls set a pump mode and speed. Read its capacity, mode, and status to keep a control interface in step with the pump.
+- [recordings 1.0](/docs/for-ai/capability-interfaces/recordings/1.0.md): Recordings list saved captures and expose recording download and deletion. Use pagination to browse the recordings supplied by a connected provider.
+- [refrigerator 1.0](/docs/for-ai/capability-interfaces/refrigerator/1.0.md): Refrigerators report their temperature. Use the reading to show the conditions supplied by the appliance.
+- [reminders-provider 1.0](/docs/for-ai/capability-interfaces/reminders-provider/1.0.md): Reminder providers list reminders from a connected account. Use the returned items to give an assistant task context or display an existing reminder list.
+- [remote-control 1.0](/docs/for-ai/capability-interfaces/remote-control/1.0.md): Remote control starts and ends control sessions and sends movement instructions. Use velocity, turning, and duration fields to request movement from a connected device.
+- [robotic-vacuum-cleaner 1.0](/docs/for-ai/capability-interfaces/robotic-vacuum-cleaner/1.0.md): Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a cleaning mode and read the reported mode and operational state to follow a cleaning session.
+- [route-discovery 1.0](/docs/for-ai/capability-interfaces/route-discovery/1.0.md): Route discovery reports the control routes available to an integration. Use its group commands to name a group or update the routes that belong to it.
+- [rtc-session 1.0](/docs/for-ai/capability-interfaces/rtc-session/1.0.md): RTC sessions initiate a connection using an offer and return an answer for the session. Follow disconnection events and close the session when the connection is no longer needed.
+- [rtsp-session 1.0](/docs/for-ai/capability-interfaces/rtsp-session/1.0.md): RTSP sessions open a camera connection and return its RTSP URI and optional SDP description. Close the session when the connection is no longer needed.
+- [scene 1.0](/docs/for-ai/capability-interfaces/scene/1.0.md): Scenes activate or deactivate a predefined device scene. Use them to request a saved combination of settings from a connected integration.
+- [security-panel 1.0](/docs/for-ai/capability-interfaces/security-panel/1.0.md): Security panels accept arm and disarm commands and report alarm and arming states. Use those reports to show the status supplied by a connected panel.
+- [security-pin 1.0](/docs/for-ai/capability-interfaces/security-pin/1.0.md): Security PINs create, update, query, and delete PIN records. Follow operation results and PIN reports when managing the records supported by a device.
+- [smoke-co-alarm 1.0](/docs/for-ai/capability-interfaces/smoke-co-alarm/1.0.md): Smoke and carbon monoxide detectors report detection state. Devices expose alarm controls through the alarm capability and charge level through the battery capability.
+- [snapshot 1.0](/docs/for-ai/capability-interfaces/snapshot/1.0.md): Snapshots request a captured view and return a snapshot response. Use them when an integration needs a single capture rather than a continuous live view.
+- [soil-moisture-sensor 1.0](/docs/for-ai/capability-interfaces/soil-moisture-sensor/1.0.md): Soil moisture measurements report the reading supplied by a connected sensor. Use the value as input when monitoring growing conditions.
+- [spatial 1.0](/docs/for-ai/capability-interfaces/spatial/1.0.md): Descriptive spatial declaration of a group route (home, floor/map, room or zone). The spatial interface declares no control messages; cleaning is sent to the robot endpoint.
+- [speaker 1.0](/docs/for-ai/capability-interfaces/speaker/1.0.md): Speakers set or adjust volume and change mute state. Read the current volume and mute state to keep playback controls in step with the device.
+- [speech-audio-generation 1.0](/docs/for-ai/capability-interfaces/speech-audio-generation/1.0.md): Speech audio generation turns an input into speech audio and returns its URI. Use the result when an integration needs an audio file it can pass to a player.
+- [speech-synthesizer 1.0](/docs/for-ai/capability-interfaces/speech-synthesizer/1.0.md): Speech synthesizers accept a request to speak. Use them to send spoken output to a connected device or integration.
+- [temperature-sensor 1.0](/docs/for-ai/capability-interfaces/temperature-sensor/1.0.md): Temperature sensors report temperature and operation mode. Use the reading to display conditions or give a heating and cooling flow a measured input.
+- [text 1.0](/docs/for-ai/capability-interfaces/text/1.0.md): Text sends a text message to a connected component. Use it to pass written input between integrations.
+- [text-stream 1.0](/docs/for-ai/capability-interfaces/text-stream/1.0.md): Text streams emit text as a stream of messages. Use the stream to consume output as it becomes available.
+- [thermostat 1.0](/docs/for-ai/capability-interfaces/thermostat/1.0.md): Thermostats set a target temperature and select a heating or cooling mode. Read the reported setpoints and operating mode to show the current settings.
+- [water-heater 1.0](/docs/for-ai/capability-interfaces/water-heater/1.0.md): Water heaters set a temperature and operating mode. Read the temperature setpoint and mode to show the settings supplied by a connected heater.
+- [wind-speed-sensor 1.0](/docs/for-ai/capability-interfaces/wind-speed-sensor/1.0.md): Wind speed measurements report the reading supplied by a connected sensor. Use the value and its declared unit when displaying measured wind conditions.
+- [window 1.0](/docs/for-ai/capability-interfaces/window/1.0.md): Windows report their window state and lock state. Use those reports to check the status supplied by a connected window.
+- [window-covering 1.0](/docs/for-ai/capability-interfaces/window-covering/1.0.md): Window coverings move to a requested lift or tilt percentage. Read their reported position to keep a shade or blind control in step with the device.

package/generated/public/docs/for-ai/guides/adding-devices.md

@@ -0,0 +1,7 @@
+# Add devices through provider linking
+
+Read the public [integration catalog](https://app.portoperatingsystem.lol/integrations/) and [Connect device](https://app.portoperatingsystem.lol/connect-device/) pages. Match the provider by its exact name, then inspect supported capabilities, prerequisites, limitations and current availability before asking the user to sign in.
+
+Devices enter Port OS through a plugin/provider account link. The user performs sign-in/consent on the provider and Port OS pages; an agent must not ask for their password. After linking, enumerate authorized endpoints and inspect actual capabilities. Catalog availability does not guarantee every vendor device implements every action.
+
+Use [first setup](/docs/for-ai/guides/first-setup.md) to verify one safe device and [troubleshooting](/docs/for-ai/guides/troubleshooting.md) for expired provider links.