@portpowered/reference-data 0.4.1 → 0.4.2

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

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

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

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

@@ -2,9 +2,8 @@ name: connectivity
 namespace: port1/systems/zero/capability-interfaces/connectivity
 version: '1.0'
 description: >-
-  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.
+  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.
 messages: []
 attributes:
   - name: network-throughput

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

@@ -2,9 +2,8 @@ name: contact-sensor
 namespace: port1/systems/zero/capability-interfaces/contact-sensor
 version: '1.0'
 description: >-
-  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.
+  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.
 messages: []
 attributes:
   - name: detection-state

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

@@ -2,9 +2,8 @@ name: contacts-provider
 namespace: port1/systems/zero/capability-interfaces/contacts-provider
 version: '1.0'
 description: >-
-  Contacts providers list contacts from a connected account. Use the returned
-  records to give an assistant the contact information available to your
-  integration.
+  Contacts providers list contacts from a connected account. Use the returned records to give an
+  assistant the contact information available to your integration.
 messages:
   - name: list-contacts
     description: Request to list contacts from a contacts provider

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

@@ -0,0 +1,19 @@
+type: object
+properties:
+  acceptHeader:
+    type: string
+    description: Accept header for content requests
+  supportedStreamingProtocols:
+    type: array
+    items:
+      type: string
+      enum:
+        - DASH
+        - HLS
+        - SMOOTH_STREAMING
+        - OTHER
+    description: Supported streaming protocols
+additionalProperties: false
+description: >-
+  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.

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

@@ -2,8 +2,8 @@ name: content-launcher
 namespace: port1/systems/zero/capability-interfaces/content-launcher
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: launch-content
     description: null
@@ -94,8 +94,8 @@ configuration:
       description: Supported streaming protocols
   additionalProperties: false
   description: >-
-    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.
+    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.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/control-route-groups-provider.yaml

@@ -2,8 +2,8 @@ name: control-route-groups-provider
 namespace: port1/systems/zero/capability-interfaces/control-route-groups-provider
 version: '1.0'
 description: >-
-  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 route groups organize several routes into a group. Create a group with its member routes
+  or delete a group your integration no longer needs.
 messages:
   - name: create-group
     description: 'Request to delete a group based on its group ID. '