@portpowered/reference-data 0.4.1 → 0.4.2

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

@@ -2,23 +2,20 @@ name: control-routes-provider
 namespace: port1/systems/zero/capability-interfaces/control-routes-provider
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: acknowledged
     description: >-
-      Response to acknowledge a message was dispatched, it confirms that a
-      message was dispatched, but not necessarily that it did anything. 
-      Consider this to happen on any infrared based device (TV remotes), where
-      no ack is feasible.
+      Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+      but not necessarily that it did anything.  Consider this to happen on any infrared based
+      device (TV remotes), where no ack is feasible.
     directionality: in
     schema:
       description: >-
-        Response to acknowledge a message was dispatched, it confirms that a
-        message was dispatched, but not necessarily that it did anything. 
-        Consider this to happen on any infrared based device (TV remotes), where
-        no ack is feasible.
+        Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+        but not necessarily that it did anything.  Consider this to happen on any infrared based
+        device (TV remotes), where no ack is feasible.
       type: object
       additionalProperties: false
   - name: attribute-report
@@ -57,8 +54,8 @@ messages:
                       type: string
                       format: date-time
                       description: >-
-                        Actual observation time in UTC; omit when unknown.
-                        Request time is not a sample time.
+                        Actual observation time in UTC; omit when unknown. Request time is not a
+                        sample time.
                   required:
                     - namespace
                     - name
@@ -74,13 +71,13 @@ messages:
       additionalProperties: false
   - name: batch-message-dispatch
     description: >-
-      Request to dispatch a batch of messages to a control route sent from port
-      OS to the control routes provider
+      Request to dispatch a batch of messages to a control route sent from port OS to the control
+      routes provider
     directionality: in
     schema:
       description: >-
-        Request to dispatch a batch of messages to a control route sent from
-        port OS to the control routes provider
+        Request to dispatch a batch of messages to a control route sent from port OS to the control
+        routes provider
       type: object
       properties:
         items:
@@ -88,9 +85,7 @@ messages:
           description: A batch message dispatch item
           properties:
             message:
-              description: >-
-                The payload of the message to dispatch to the control route
-                provider.
+              description: The payload of the message to dispatch to the control route provider.
               type: object
           required:
             - message
@@ -100,31 +95,28 @@ messages:
       additionalProperties: false
   - name: deferred-response
     description: >-
-      Response to acknowledge a message was dispatched, it confirms that a
-      message was dispatched, and that a confirmation of the result will be sent
-      later on.  We generate this message when the device is expected to respond
-      some time later on, and we need to wait for the result.  For the default
-      behavior, we expect to wait up to a minute to handle low powered devices.
+      Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+      and that a confirmation of the result will be sent later on.  We generate this message when
+      the device is expected to respond some time later on, and we need to wait for the result.  For
+      the default behavior, we expect to wait up to a minute to handle low powered devices.
     directionality: in
     schema:
       description: >-
-        Response to acknowledge a message was dispatched, it confirms that a
-        message was dispatched, and that a confirmation of the result will be
-        sent later on.  We generate this message when the device is expected to
-        respond some time later on, and we need to wait for the result.  For the
-        default behavior, we expect to wait up to a minute to handle low powered
-        devices.
+        Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+        and that a confirmation of the result will be sent later on.  We generate this message when
+        the device is expected to respond some time later on, and we need to wait for the result. 
+        For the default behavior, we expect to wait up to a minute to handle low powered devices.
       type: object
       additionalProperties: false
   - name: error-dispatch
     description: >-
-      Response to acknowledge a message was dispatched, it confirms that a
-      message was dispatched, and that the result was not successful.
+      Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+      and that the result was not successful.
     directionality: in
     schema:
       description: >-
-        Response to acknowledge a message was dispatched, it confirms that a
-        message was dispatched, and that the result was not successful.
+        Response to acknowledge a message was dispatched, it confirms that a message was dispatched,
+        and that the result was not successful.
       type: object
       properties:
         error:
@@ -134,35 +126,32 @@ messages:
             type:
               type: string
               description: >-
-                The type of the error, an enum which denotes a specific type of
-                error that belongs to a family of errors.
+                The type of the error, an enum which denotes a specific type of error that belongs
+                to a family of errors.
             family:
               type: string
               description: >-
-                The family of the error, an enum which denotes a general set of
-                issues similar to the http error set. Some examples are
-                BAD_REQUEST, SYSTEM_ERROR, etc.
+                The family of the error, an enum which denotes a general set of issues similar to
+                the http error set. Some examples are BAD_REQUEST, SYSTEM_ERROR, etc.
             code:
               type: string
               description: >-
-                The code of the error, an opaque error code that can be given
-                for debugging purposes.
+                The code of the error, an opaque error code that can be given for debugging
+                purposes.
             message:
               type: string
-              description: >-
-                The message of the error, a human readable message that
-                describes the error.
+              description: The message of the error, a human readable message that describes the error.
           title: DispatchError
       additionalProperties: false
   - name: report-attributes
     description: >-
-      Request to report attributes of a control route sent from port OS to the
-      control routes provider
+      Request to report attributes of a control route sent from port OS to the control routes
+      provider
     directionality: in
     schema:
       description: >-
-        Request to report attributes of a control route sent from port OS to the
-        control routes provider
+        Request to report attributes of a control route sent from port OS to the control routes
+        provider
       type: object
       properties:
         items:
@@ -197,8 +186,8 @@ messages:
                       type: string
                       format: date-time
                       description: >-
-                        Actual observation time in UTC; omit when unknown.
-                        Request time is not a sample time.
+                        Actual observation time in UTC; omit when unknown. Request time is not a
+                        sample time.
                   required:
                     - namespace
                     - name
@@ -214,14 +203,13 @@ messages:
       additionalProperties: false
   - name: successful-dispatch
     description: >-
-      Response to acknowledge a message was successfully dispatched, it confirms
-      that a message was dispatched, and that the result was successful.
+      Response to acknowledge a message was successfully dispatched, it confirms that a message was
+      dispatched, and that the result was successful.
     directionality: in
     schema:
       description: >-
-        Response to acknowledge a message was successfully dispatched, it
-        confirms that a message was dispatched, and that the result was
-        successful.
+        Response to acknowledge a message was successfully dispatched, it confirms that a message
+        was dispatched, and that the result was successful.
       type: object
       additionalProperties: false
 attributes: []

package/generated/public/docs/references/capability-interfaces/cooktop/1.0/attributes/operational-state.yaml

@@ -4,7 +4,10 @@ properties:
     type: string
     description: >-
       Operational state of a device. RETURNING_TO_DOCK means a robot is driving
-      back to its dock; DOCKED means it is on the dock and not charging.
+      back to its dock; DOCKED means it is on the dock and not charging;
+      DOCK_MAINTENANCE means it is on the dock while the dock services it
+      (emptying the dust bin, washing or drying the mop), and it does not start
+      cleaning until that finishes.
     enum:
       - STOPPED
       - RUNNING
@@ -13,6 +16,7 @@ properties:
       - CHARGING
       - DOCKED
       - RETURNING_TO_DOCK
+      - DOCK_MAINTENANCE
 required:
   - value
 additionalProperties: false

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

@@ -15,7 +15,9 @@ attributes:
           type: string
           description: >-
             Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its
-            dock; DOCKED means it is on the dock and not charging.
+            dock; DOCKED means it is on the dock and not charging; DOCK_MAINTENANCE means it is on
+            the dock while the dock services it (emptying the dust bin, washing or drying the mop),
+            and it does not start cleaning until that finishes.
           enum:
             - STOPPED
             - RUNNING
@@ -24,6 +26,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false

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

@@ -2,8 +2,8 @@ name: cooktop
 namespace: port1/systems/zero/capability-interfaces/cooktop
 version: '1.0'
 description: >-
-  Cooktops report their operational state. Use that state to show what the
-  appliance is doing or supply context to an automation.
+  Cooktops report their operational state. Use that state to show what the appliance is doing or
+  supply context to an automation.
 messages: []
 attributes:
   - name: operational-state
@@ -14,9 +14,10 @@ attributes:
         value:
           type: string
           description: >-
-            Operational state of a device. RETURNING_TO_DOCK means a robot is
-            driving back to its dock; DOCKED means it is on the dock and not
-            charging.
+            Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its
+            dock; DOCKED means it is on the dock and not charging; DOCK_MAINTENANCE means it is on
+            the dock while the dock services it (emptying the dust bin, washing or drying the mop),
+            and it does not start cleaning until that finishes.
           enum:
             - STOPPED
             - RUNNING
@@ -25,6 +26,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false

package/generated/public/docs/references/capability-interfaces/dishwasher/1.0/attributes/operational-state.yaml

@@ -4,7 +4,10 @@ properties:
     type: string
     description: >-
       Operational state of a device. RETURNING_TO_DOCK means a robot is driving
-      back to its dock; DOCKED means it is on the dock and not charging.
+      back to its dock; DOCKED means it is on the dock and not charging;
+      DOCK_MAINTENANCE means it is on the dock while the dock services it
+      (emptying the dust bin, washing or drying the mop), and it does not start
+      cleaning until that finishes.
     enum:
       - STOPPED
       - RUNNING
@@ -13,6 +16,7 @@ properties:
       - CHARGING
       - DOCKED
       - RETURNING_TO_DOCK
+      - DOCK_MAINTENANCE
 required:
   - value
 additionalProperties: false

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

@@ -15,7 +15,9 @@ attributes:
           type: string
           description: >-
             Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its
-            dock; DOCKED means it is on the dock and not charging.
+            dock; DOCKED means it is on the dock and not charging; DOCK_MAINTENANCE means it is on
+            the dock while the dock services it (emptying the dust bin, washing or drying the mop),
+            and it does not start cleaning until that finishes.
           enum:
             - STOPPED
             - RUNNING
@@ -24,6 +26,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false

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

@@ -2,8 +2,8 @@ name: dishwasher
 namespace: port1/systems/zero/capability-interfaces/dishwasher
 version: '1.0'
 description: >-
-  Dishwashers report their operational state. Use it to keep an appliance
-  dashboard up to date or react when a reported state changes.
+  Dishwashers report their operational state. Use it to keep an appliance dashboard up to date or
+  react when a reported state changes.
 messages: []
 attributes:
   - name: operational-state
@@ -14,9 +14,10 @@ attributes:
         value:
           type: string
           description: >-
-            Operational state of a device. RETURNING_TO_DOCK means a robot is
-            driving back to its dock; DOCKED means it is on the dock and not
-            charging.
+            Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its
+            dock; DOCKED means it is on the dock and not charging; DOCK_MAINTENANCE means it is on
+            the dock while the dock services it (emptying the dust bin, washing or drying the mop),
+            and it does not start cleaning until that finishes.
           enum:
             - STOPPED
             - RUNNING
@@ -25,6 +26,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false

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

@@ -2,8 +2,8 @@ name: doorbell
 namespace: port1/systems/zero/capability-interfaces/doorbell
 version: '1.0'
 description: >-
-  Doorbells emit a chime event. Use that event to start a notification or
-  another flow when someone rings the bell.
+  Doorbells emit a chime event. Use that event to start a notification or another flow when someone
+  rings the bell.
 messages:
   - name: chime
     description: A distinct doorbell press. A chime does not imply a door was opened.

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

@@ -2,8 +2,8 @@ name: electrical-conductivity-sensor
 namespace: port1/systems/zero/capability-interfaces/electrical-conductivity-sensor
 version: '1.0'
 description: >-
-  Electrical conductivity measurements report a sensor reading. Use the value
-  and its declared units when displaying or comparing measurements.
+  Electrical conductivity measurements report a sensor reading. Use the value and its declared units
+  when displaying or comparing measurements.
 messages: []
 attributes:
   - name: measured-value

package/generated/public/docs/references/capability-interfaces/embedding-generation.yaml

@@ -2,8 +2,8 @@ name: embedding-generation
 namespace: port1/systems/zero/capability-interfaces/embedding-generation
 version: '1.0'
 description: >-
-  Embedding generation turns an input into an embedding and returns its URI. Use
-  the result in integrations that work with vector representations of content.
+  Embedding generation turns an input into an embedding and returns its URI. Use the result in
+  integrations that work with vector representations of content.
 messages:
   - name: embedding-uri
     description: null

package/generated/public/docs/references/capability-interfaces/endpoint-registry.yaml

@@ -4,14 +4,10 @@ version: '1.0'
 description: Configuration for Port OS endpoint registry lifecycle notifications
 messages:
   - name: endpoint-updated
-    description: >-
-      Port OS emitted a durable endpoint metadata or enablement change. Delivery
-      is best effort.
+    description: Port OS emitted a durable endpoint metadata or enablement change. Delivery is best effort.
     directionality: out
     schema:
-      description: >-
-        Port OS emitted a durable endpoint metadata or enablement change.
-        Delivery is best effort.
+      description: Port OS emitted a durable endpoint metadata or enablement change. Delivery is best effort.
       type: object
       properties:
         endpointId:

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

@@ -0,0 +1,18 @@
+type: object
+properties:
+  supportedBands:
+    type: array
+    items:
+      type: string
+      enum:
+        - BASS
+        - MIDRANGE
+        - TREBLE
+  supportedModes:
+    type: array
+    items:
+      type: string
+additionalProperties: false
+description: >-
+  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.

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

@@ -2,8 +2,8 @@ name: equalizer
 namespace: port1/systems/zero/capability-interfaces/equalizer
 version: '1.0'
 description: >-
-  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.
+  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.
 messages:
   - name: adjust-bands
     description: null
@@ -124,8 +124,8 @@ configuration:
         type: string
   additionalProperties: false
   description: >-
-    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.
+    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.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/event-detection-sensor/1.0/configuration.yaml

@@ -0,0 +1,24 @@
+type: object
+properties:
+  detectionMethods:
+    type: array
+    items:
+      type: string
+      enum:
+        - AUDIO
+        - VIDEO
+  supportedEvents:
+    type: array
+    items:
+      type: object
+      description: A supported event detection category
+      properties:
+        category:
+          type: string
+        subType:
+          type: string
+      title: SupportedEvent
+additionalProperties: false
+description: >-
+  Event detection sensors report human presence and emit person-detected events. Use them to give an
+  automation context about activity in a monitored area.

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

@@ -2,18 +2,14 @@ name: event-detection-sensor
 namespace: port1/systems/zero/capability-interfaces/event-detection-sensor
 version: '1.0'
 description: >-
-  Event detection sensors report human presence and emit person-detected events.
-  Use them to give an automation context about activity in a monitored area.
+  Event detection sensors report human presence and emit person-detected events. Use them to give an
+  automation context about activity in a monitored area.
 messages:
   - name: person-detected
-    description: >-
-      A distinct person detection occurrence, independent of cached presence
-      state.
+    description: A distinct person detection occurrence, independent of cached presence state.
     directionality: out
     schema:
-      description: >-
-        A distinct person detection occurrence, independent of cached presence
-        state.
+      description: A distinct person detection occurrence, independent of cached presence state.
       type: object
       properties:
         value:
@@ -67,9 +63,8 @@ configuration:
         title: SupportedEvent
   additionalProperties: false
   description: >-
-    Event detection sensors report human presence and emit person-detected
-    events. Use them to give an automation context about activity in a monitored
-    area.
+    Event detection sensors report human presence and emit person-detected events. Use them to give
+    an automation context about activity in a monitored area.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/extractor-hood.yaml

@@ -2,8 +2,8 @@ name: extractor-hood
 namespace: port1/systems/zero/capability-interfaces/extractor-hood
 version: '1.0'
 description: >-
-  Extractor hoods report their fan speed. Use that state to show the current
-  ventilation setting alongside other kitchen appliances.
+  Extractor hoods report their fan speed. Use that state to show the current ventilation setting
+  alongside other kitchen appliances.
 messages: []
 attributes:
   - name: fan-speed

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

@@ -0,0 +1,27 @@
+type: object
+properties:
+  supportedFanModes:
+    type: array
+    items:
+      type: string
+      description: Fan mode
+      enum:
+        - 'OFF'
+        - LOW
+        - MEDIUM
+        - HIGH
+        - 'ON'
+        - AUTO
+        - SMART
+    description: Supported fan modes
+  supportedFanSpeeds:
+    type: array
+    items:
+      type: integer
+      minimum: 0
+      maximum: 100
+    description: Supported fan speeds (0-100)
+additionalProperties: false
+description: >-
+  Fan control selects a fan mode and speed. Read the reported settings to check how a fan is running
+  before changing them.

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

@@ -2,8 +2,8 @@ name: fan-control
 namespace: port1/systems/zero/capability-interfaces/fan-control
 version: '1.0'
 description: >-
-  Fan control selects a fan mode and speed. Read the reported settings to check
-  how a fan is running before changing them.
+  Fan control selects a fan mode and speed. Read the reported settings to check how a fan is running
+  before changing them.
 messages:
   - name: set-mode
     description: null
@@ -98,8 +98,8 @@ configuration:
       description: Supported fan speeds (0-100)
   additionalProperties: false
   description: >-
-    Fan control selects a fan mode and speed. Read the reported settings to
-    check how a fan is running before changing them.
+    Fan control selects a fan mode and speed. Read the reported settings to check how a fan is
+    running before changing them.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

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

@@ -2,9 +2,8 @@ name: filesystem-provider
 namespace: port1/systems/zero/capability-interfaces/filesystem-provider
 version: '1.0'
 description: >-
-  Filesystem providers list folders and photo albums and expose file download,
-  upload, and deletion. Check the provider's supported commands before
-  requesting an operation.
+  Filesystem providers list folders and photo albums and expose file download, upload, and deletion.
+  Check the provider's supported commands before requesting an operation.
 messages:
   - name: delete-file
     description: Delete file.
@@ -73,9 +72,7 @@ messages:
       properties:
         cursor:
           type: string
-          description: >-
-            Opaque cursor for the next page; omitted when there are no further
-            results.
+          description: Opaque cursor for the next page; omitted when there are no further results.
         maxResults:
           type: integer
           minimum: 1
@@ -105,9 +102,7 @@ messages:
             title: PhotoAlbum
         nextCursor:
           type: string
-          description: >-
-            Opaque cursor for the next page; omitted when there are no further
-            results.
+          description: Opaque cursor for the next page; omitted when there are no further results.
       required:
         - albums
       additionalProperties: false
@@ -123,9 +118,7 @@ messages:
           description: Optional folder ID to list contents of. Defaults to root if omitted.
         cursor:
           type: string
-          description: >-
-            Opaque cursor for the next page; omitted when there are no further
-            results.
+          description: Opaque cursor for the next page; omitted when there are no further results.
         maxResults:
           type: integer
           minimum: 1
@@ -136,9 +129,7 @@ messages:
     description: Response containing a list of files and folders from a filesystem provider
     directionality: out
     schema:
-      description: >-
-        Response containing a list of files and folders from a filesystem
-        provider
+      description: Response containing a list of files and folders from a filesystem provider
       type: object
       properties:
         items:
@@ -166,9 +157,7 @@ messages:
             title: StorageItem
         nextCursor:
           type: string
-          description: >-
-            Opaque cursor for the next page; omitted when there are no further
-            results.
+          description: Opaque cursor for the next page; omitted when there are no further results.
       required:
         - items
       additionalProperties: false

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

@@ -2,8 +2,8 @@ name: flow-sensor
 namespace: port1/systems/zero/capability-interfaces/flow-sensor
 version: '1.0'
 description: >-
-  Flow measurements report the flow observed by a sensor. Use the reading and
-  its declared units to monitor changes in a connected system.
+  Flow measurements report the flow observed by a sensor. Use the reading and its declared units to
+  monitor changes in a connected system.
 messages: []
 attributes:
   - name: measured-value