@portpowered/reference-data 0.4.1 → 0.4.3

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

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

@@ -20,14 +20,21 @@ messages:
       properties:
         mode:
           type: string
-          description: 'What a cleaning robot does: vacuum only, mop only, or vacuum and mop together'
+          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
         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
@@ -35,44 +42,56 @@ messages:
             - 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
 attributes:
   - name: cleaning-mode
-    description: Current cleaning type. Omitted when the robot is in a native mode with no equivalent value.
+    description: Current cleaning type. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: Current cleaning type. Omitted when the robot is in a native mode with no equivalent value.
+      description: Current cleaning type. CUSTOM when the robot uses a native mode with no equivalent value.
       type: object
       properties:
         value:
           type: string
-          description: 'What a cleaning robot does: vacuum only, mop only, or vacuum and mop together'
+          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
       required:
         - value
       additionalProperties: false
   - name: suction-level
-    description: Current suction level. Omitted when the robot is in a native mode with no equivalent value.
+    description: Current suction level. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: Current suction level. Omitted when the robot is in a native mode with no equivalent value.
+      description: 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
@@ -80,24 +99,29 @@ attributes:
             - TURBO
             - MAX
             - MAX_PLUS
+            - CUSTOM
       required:
         - value
       additionalProperties: false
   - name: water-flow
-    description: Current water flow. Omitted when the robot is in a native mode with no equivalent value.
+    description: Current water flow. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: Current water flow. Omitted when the robot is in a native mode with no equivalent value.
+      description: 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
@@ -115,18 +139,25 @@ configuration:
       uniqueItems: true
       items:
         type: string
-        description: 'What a cleaning robot does: vacuum only, mop only, or vacuum and mop together'
+        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
+        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
@@ -134,19 +165,24 @@ configuration:
           - 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
+        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
 authorization:

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

@@ -2,37 +2,39 @@ name: cleaning-mode
 namespace: port1/systems/zero/capability-interfaces/cleaning-mode
 version: '1.0'
 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.
+  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.
 messages:
   - name: set-cleaning-mode
     description: >-
-      Set whether the robot vacuums, mops or does both, optionally with a
-      suction level and water flow. Omitted levels keep the current non-off
-      value. Values outside the configured supported lists are rejected with 422
-      before dispatch.
+      Set whether the robot vacuums, mops or does both, optionally with a suction level and water
+      flow. Omitted levels keep the current non-off value. Values outside the configured supported
+      lists are rejected with 422 before dispatch.
     directionality: in
     schema:
       description: >-
-        Set whether the robot vacuums, mops or does both, optionally with a
-        suction level and water flow. Omitted levels keep the current non-off
-        value. Values outside the configured supported lists are rejected with
-        422 before dispatch.
+        Set whether the robot vacuums, mops or does both, optionally with a suction level and water
+        flow. Omitted levels keep the current non-off value. Values outside the configured supported
+        lists are rejected with 422 before dispatch.
       type: object
       properties:
         mode:
           type: string
           description: >-
-            What a cleaning robot does: vacuum only, mop only, or vacuum and mop
-            together
+            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
         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
@@ -40,54 +42,56 @@ messages:
             - 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
 attributes:
   - name: cleaning-mode
-    description: >-
-      Current cleaning type. Omitted when the robot is in a native mode with no
-      equivalent value.
+    description: Current cleaning type. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: >-
-        Current cleaning type. Omitted when the robot is in a native mode with
-        no equivalent value.
+      description: Current cleaning type. CUSTOM when the robot uses a native mode with no equivalent value.
       type: object
       properties:
         value:
           type: string
           description: >-
-            What a cleaning robot does: vacuum only, mop only, or vacuum and mop
-            together
+            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
       required:
         - value
       additionalProperties: false
   - name: suction-level
-    description: >-
-      Current suction level. Omitted when the robot is in a native mode with no
-      equivalent value.
+    description: Current suction level. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: >-
-        Current suction level. Omitted when the robot is in a native mode with
-        no equivalent value.
+      description: 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
@@ -95,36 +99,36 @@ attributes:
             - TURBO
             - MAX
             - MAX_PLUS
+            - CUSTOM
       required:
         - value
       additionalProperties: false
   - name: water-flow
-    description: >-
-      Current water flow. Omitted when the robot is in a native mode with no
-      equivalent value.
+    description: Current water flow. CUSTOM when the robot uses a native mode with no equivalent value.
     schema:
-      description: >-
-        Current water flow. Omitted when the robot is in a native mode with no
-        equivalent value.
+      description: 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
 configuration:
   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.
+    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
@@ -136,19 +140,24 @@ configuration:
       items:
         type: string
         description: >-
-          What a cleaning robot does: vacuum only, mop only, or vacuum and mop
-          together
+          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
+        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
@@ -156,19 +165,24 @@ configuration:
           - 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
+        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
 authorization:

package/generated/public/docs/references/capability-interfaces/color-temperature.yaml

@@ -2,9 +2,8 @@ name: color-temperature
 namespace: port1/systems/zero/capability-interfaces/color-temperature
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: decrease-color-temperature
     description: null
@@ -29,13 +28,12 @@ messages:
         colorTemperatureInKelvin:
           type: integer
           description: >-
-            The colorTemperatureInKelvin property represents the color
-            temperature in degrees Kelvin of an endpoint, and is used by
-            endpoints that support tunable white light. Valid values range from
-            1,000 to 10,000 absolute Kelvin.
+            The colorTemperatureInKelvin property represents the color temperature in degrees Kelvin
+            of an endpoint, and is used by endpoints that support tunable white light. Valid values
+            range from 1,000 to 10,000 absolute Kelvin.
 
-            The color values roughly map to:  - warm white: 2000 - soft white:
-            2500 - white: 4000 - daylight white: 5500 - cool white: 7000
+            The color values roughly map to:  - warm white: 2000 - soft white: 2500 - white: 4000 -
+            daylight white: 5500 - cool white: 7000
       additionalProperties: false
 attributes:
   - name: color-temperature-in-kelvin