@portpowered/reference-data 0.4.0 → 0.4.2

package/generated/public/docs/references/authorization.json

@@ -972,8 +972,8 @@
       "resourcePermissionRequired": false
     },
     {
-      "path": "/auth/device_authorization",
-      "runtimePath": "/auth/device_authorization",
+      "path": "/auth/device-authorization",
+      "runtimePath": "/auth/device-authorization",
       "method": "POST",
       "operationId": "deviceAuthorize",
       "security": [

package/generated/public/docs/references/authorization.yaml

@@ -599,8 +599,8 @@ operations:
     security: []
     delegated: false
     resourcePermissionRequired: false
-  - path: /auth/device_authorization
-    runtimePath: /auth/device_authorization
+  - path: /auth/device-authorization
+    runtimePath: /auth/device-authorization
     method: POST
     operationId: deviceAuthorize
     security:

package/generated/public/docs/references/capability-interfaces/air-quality-sensor/1.0/attributes/air-quality-index.yaml

@@ -8,9 +8,9 @@ properties:
     type: string
     description: Air quality standard
     enum:
-      - AirQualityIndex
-      - PartsPerMillion2_5
-      - PartsPerMillion10
+      - AIR_QUALITY_INDEX
+      - PARTS_PER_MILLION_2_5
+      - PARTS_PER_MILLION_10
 required:
   - value
   - standard

package/generated/public/docs/references/capability-interfaces/air-quality-sensor/1.0/configuration.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  supportedStandards:
+    type: array
+    items:
+      type: string
+      description: Air quality standard
+      enum:
+        - AIR_QUALITY_INDEX
+        - PARTS_PER_MILLION_2_5
+        - PARTS_PER_MILLION_10
+    description: Supported air quality standards
+additionalProperties: false
+description: >-
+  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.

package/generated/public/docs/references/capability-interfaces/air-quality-sensor/1.0.yaml

@@ -25,9 +25,9 @@ attributes:
           type: string
           description: Air quality standard
           enum:
-            - AirQualityIndex
-            - PartsPerMillion2_5
-            - PartsPerMillion10
+            - AIR_QUALITY_INDEX
+            - PARTS_PER_MILLION_2_5
+            - PARTS_PER_MILLION_10
       required:
         - value
         - standard
@@ -41,9 +41,9 @@ configuration:
         type: string
         description: Air quality standard
         enum:
-          - AirQualityIndex
-          - PartsPerMillion2_5
-          - PartsPerMillion10
+          - AIR_QUALITY_INDEX
+          - PARTS_PER_MILLION_2_5
+          - PARTS_PER_MILLION_10
       description: Supported air quality standards
   additionalProperties: false
   description: >-

package/generated/public/docs/references/capability-interfaces/air-quality-sensor.yaml

@@ -2,9 +2,8 @@ name: air-quality-sensor
 namespace: port1/systems/zero/capability-interfaces/air-quality-sensor
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: get-air-quality
     description: null
@@ -26,9 +25,9 @@ attributes:
           type: string
           description: Air quality standard
           enum:
-            - AirQualityIndex
-            - PartsPerMillion2_5
-            - PartsPerMillion10
+            - AIR_QUALITY_INDEX
+            - PARTS_PER_MILLION_2_5
+            - PARTS_PER_MILLION_10
       required:
         - value
         - standard
@@ -42,15 +41,14 @@ configuration:
         type: string
         description: Air quality standard
         enum:
-          - AirQualityIndex
-          - PartsPerMillion2_5
-          - PartsPerMillion10
+          - AIR_QUALITY_INDEX
+          - PARTS_PER_MILLION_2_5
+          - PARTS_PER_MILLION_10
       description: Supported air quality standards
   additionalProperties: false
   description: >-
-    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.
+    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.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/alarm.yaml

@@ -2,8 +2,8 @@ name: alarm
 namespace: port1/systems/zero/capability-interfaces/alarm
 version: '1.0'
 description: >-
-  Alarms ring, silence, or test a device's siren when supported. Read the alarm
-  state to see whether the siren is active.
+  Alarms ring, silence, or test a device's siren when supported. Read the alarm state to see whether
+  the siren is active.
 messages:
   - name: ring-alarm
     description: Sound the endpoint alarm. Requires an endpoint with an alarm actuator.

package/generated/public/docs/references/capability-interfaces/application-launcher/1.0/configuration.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  catalogVendorId:
+    type: integer
+    description: Catalog vendor ID
+    minimum: 0
+additionalProperties: false
+description: >-
+  Application launchers start and stop applications on a connected device. Check the available
+  applications and the current selection before choosing what to launch.

package/generated/public/docs/references/capability-interfaces/application-launcher.yaml

@@ -2,9 +2,8 @@ name: application-launcher
 namespace: port1/systems/zero/capability-interfaces/application-launcher
 version: '1.0'
 description: >-
-  Application launchers start and stop applications on a connected device. Check
-  the available applications and the current selection before choosing what to
-  launch.
+  Application launchers start and stop applications on a connected device. Check the available
+  applications and the current selection before choosing what to launch.
 messages:
   - name: launch-application
     description: null
@@ -90,9 +89,8 @@ configuration:
       minimum: 0
   additionalProperties: false
   description: >-
-    Application launchers start and stop applications on a connected device.
-    Check the available applications and the current selection before choosing
-    what to launch.
+    Application launchers start and stop applications on a connected device. Check the available
+    applications and the current selection before choosing what to launch.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/authorization.yaml

@@ -2,19 +2,18 @@ name: authorization
 namespace: port1/systems/zero/capability-interfaces/authorization
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: authorization-established
     description: >-
-      The authorization established message is sent to a plugin to indicate that
-      the plugin has been installed and authorized for a principal
+      The authorization established message is sent to a plugin to indicate that the plugin has been
+      installed and authorized for a principal
     directionality: out
     schema:
       description: >-
-        The authorization established message is sent to a plugin to indicate
-        that the plugin has been installed and authorized for a principal
+        The authorization established message is sent to a plugin to indicate that the plugin has
+        been installed and authorized for a principal
       type: object
       additionalProperties: false
       properties:
@@ -24,13 +23,13 @@ messages:
         portosAccessToken:
           type: string
           description: >-
-            The access token of the authorization link representing the
-            principala as understood by port OS
+            The access token of the authorization link representing the principala as understood by
+            port OS
         pluginAccessToken:
           type: string
           description: >-
-            The access token of the authorization link representing the
-            principal as understood by the plugin
+            The access token of the authorization link representing the principal as understood by
+            the plugin
       required:
         - portosAccessToken
         - authlinkId

package/generated/public/docs/references/capability-interfaces/barrier-control.yaml

@@ -2,9 +2,8 @@ name: barrier-control
 namespace: port1/systems/zero/capability-interfaces/barrier-control
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: close
     description: null

package/generated/public/docs/references/capability-interfaces/battery.yaml

@@ -2,8 +2,8 @@ name: battery
 namespace: port1/systems/zero/capability-interfaces/battery
 version: '1.0'
 description: >-
-  Battery reports a connected device's charge level and battery health. Use it
-  to show when a device needs charging or a replacement battery.
+  Battery reports a connected device's charge level and battery health. Use it to show when a device
+  needs charging or a replacement battery.
 messages: []
 attributes:
   - name: battery

package/generated/public/docs/references/capability-interfaces/brightness.yaml

@@ -2,9 +2,8 @@ name: brightness
 namespace: port1/systems/zero/capability-interfaces/brightness
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: set-brightness
     description: null

package/generated/public/docs/references/capability-interfaces/calendar-provider.yaml

@@ -2,9 +2,8 @@ name: calendar-provider
 namespace: port1/systems/zero/capability-interfaces/calendar-provider
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: list-events
     description: Request to list events from a calendar provider

package/generated/public/docs/references/capability-interfaces/camera/1.0/configuration.yaml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  supportedStreamingProtocols:
+    type: array
+    items:
+      type: string
+      enum:
+        - RTSP
+        - HLS
+        - DASH
+        - WEBRTC
+        - OTHER
+    description: Supported streaming protocols
+  supportsPTZ:
+    type: boolean
+    description: Whether the camera supports pan-tilt-zoom controls
+    default: false
+  supportsMotionDetection:
+    type: boolean
+    description: Whether the camera supports motion detection
+    default: false
+additionalProperties: false
+description: >-
+  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.

package/generated/public/docs/references/capability-interfaces/camera.yaml

@@ -2,9 +2,8 @@ name: camera
 namespace: port1/systems/zero/capability-interfaces/camera
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: get-event-image
     description: null
@@ -120,9 +119,8 @@ configuration:
       default: false
   additionalProperties: false
   description: >-
-    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.
+    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.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/carbon-dioxide-concentration-sensor.yaml

@@ -2,9 +2,8 @@ name: carbon-dioxide-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/carbon-dioxide-concentration-sensor
 version: '1.0'
 description: >-
-  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 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.
 messages: []
 attributes:
   - name: max-measured-value

package/generated/public/docs/references/capability-interfaces/carbon-monoxide-concentration-sensor.yaml

@@ -2,9 +2,8 @@ name: carbon-monoxide-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/carbon-monoxide-concentration-sensor
 version: '1.0'
 description: >-
-  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.
+  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.
 messages: []
 attributes:
   - name: max-measured-value

package/generated/public/docs/references/capability-interfaces/channel.yaml

@@ -2,9 +2,8 @@ name: channel
 namespace: port1/systems/zero/capability-interfaces/channel
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: change-channel
     description: null

package/generated/public/docs/references/capability-interfaces/cleaning-mode/1.0/attributes/cleaning-mode.yaml

@@ -1,5 +1,5 @@
 description: >-
-  Current cleaning type. Omitted when the robot is in a native mode with no
+  Current cleaning type. CUSTOM when the robot uses a native mode with no
   equivalent value.
 type: object
 properties:
@@ -7,11 +7,13 @@ properties:
     type: string
     description: >-
       What a cleaning robot does: vacuum only, mop only, or vacuum and mop
-      together
+      together. CUSTOM is a vendor-specific setting with no Port OS name (for
+      example per-room settings); devices report it but do not accept it.
     enum:
       - VACUUM
       - MOP
       - VACUUM_AND_MOP
+      - CUSTOM
 required:
   - value
 additionalProperties: false

package/generated/public/docs/references/capability-interfaces/cleaning-mode/1.0/attributes/suction-level.yaml

@@ -1,11 +1,14 @@
 description: >-
-  Current suction level. Omitted when the robot is in a native mode with no
+  Current suction level. CUSTOM when the robot uses a native mode with no
   equivalent value.
 type: object
 properties:
   value:
     type: string
-    description: Vacuum suction level, ordered from off to strongest
+    description: >-
+      Vacuum suction level, ordered from off to strongest. CUSTOM is a
+      vendor-specific setting with no Port OS name (for example per-room
+      settings); devices report it but do not accept it.
     enum:
       - 'OFF'
       - QUIET
@@ -13,6 +16,7 @@ properties:
       - TURBO
       - MAX
       - MAX_PLUS
+      - CUSTOM
 required:
   - value
 additionalProperties: false

package/generated/public/docs/references/capability-interfaces/cleaning-mode/1.0/attributes/water-flow.yaml

@@ -1,17 +1,21 @@
 description: >-
-  Current water flow. Omitted when the robot is in a native mode with no
+  Current water flow. CUSTOM when the robot uses a native mode with no
   equivalent value.
 type: object
 properties:
   value:
     type: string
-    description: Mop water flow level, ordered from off to highest
+    description: >-
+      Mop water flow level, ordered from off to highest. CUSTOM is a
+      vendor-specific setting with no Port OS name (for example per-room
+      settings); devices report it but do not accept it.
     enum:
       - 'OFF'
       - LOW
       - MEDIUM
       - HIGH
       - EXTREME
+      - CUSTOM
 required:
   - value
 additionalProperties: false

package/generated/public/docs/references/capability-interfaces/cleaning-mode/1.0/configuration.yaml

@@ -0,0 +1,58 @@
+description: >-
+  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.
+type: object
+required:
+  - supportedModes
+properties:
+  supportedModes:
+    type: array
+    minItems: 1
+    uniqueItems: true
+    items:
+      type: string
+      description: >-
+        What a cleaning robot does: vacuum only, mop only, or vacuum and mop together. CUSTOM is a
+        vendor-specific setting with no Port OS name (for example per-room settings); devices report
+        it but do not accept it.
+      enum:
+        - VACUUM
+        - MOP
+        - VACUUM_AND_MOP
+        - CUSTOM
+    description: Supported cleaning types
+  supportedSuctionLevels:
+    type: array
+    uniqueItems: true
+    items:
+      type: string
+      description: >-
+        Vacuum suction level, ordered from off to strongest. CUSTOM is a vendor-specific setting
+        with no Port OS name (for example per-room settings); devices report it but do not accept
+        it.
+      enum:
+        - 'OFF'
+        - QUIET
+        - BALANCED
+        - TURBO
+        - MAX
+        - MAX_PLUS
+        - CUSTOM
+    description: Supported suction levels
+  supportedWaterFlows:
+    type: array
+    uniqueItems: true
+    items:
+      type: string
+      description: >-
+        Mop water flow level, ordered from off to highest. CUSTOM is a vendor-specific setting with
+        no Port OS name (for example per-room settings); devices report it but do not accept it.
+      enum:
+        - 'OFF'
+        - LOW
+        - MEDIUM
+        - HIGH
+        - EXTREME
+        - CUSTOM
+    description: Supported water flows
+additionalProperties: false

package/generated/public/docs/references/capability-interfaces/cleaning-mode/1.0/messages/set-cleaning-mode.yaml

@@ -8,14 +8,19 @@ properties:
     type: string
     description: >-
       What a cleaning robot does: vacuum only, mop only, or vacuum and mop
-      together
+      together. CUSTOM is a vendor-specific setting with no Port OS name (for
+      example per-room settings); devices report it but do not accept it.
     enum:
       - VACUUM
       - MOP
       - VACUUM_AND_MOP
+      - CUSTOM
   suctionLevel:
     type: string
-    description: Vacuum suction level, ordered from off to strongest
+    description: >-
+      Vacuum suction level, ordered from off to strongest. CUSTOM is a
+      vendor-specific setting with no Port OS name (for example per-room
+      settings); devices report it but do not accept it.
     enum:
       - 'OFF'
       - QUIET
@@ -23,15 +28,20 @@ properties:
       - TURBO
       - MAX
       - MAX_PLUS
+      - CUSTOM
   waterFlow:
     type: string
-    description: Mop water flow level, ordered from off to highest
+    description: >-
+      Mop water flow level, ordered from off to highest. CUSTOM is a
+      vendor-specific setting with no Port OS name (for example per-room
+      settings); devices report it but do not accept it.
     enum:
       - 'OFF'
       - LOW
       - MEDIUM
       - HIGH
       - EXTREME
+      - CUSTOM
 required:
   - mode
 additionalProperties: false