@portpowered/reference-data 0.4.1 → 0.4.3

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

@@ -2,9 +2,8 @@ name: flows
 namespace: port1/systems/zero/capability-interfaces/flows
 version: '1.0'
 description: >-
-  Flows run automations that can be initiated, paused, resumed, or terminated.
-  Follow completion and acknowledgement events to understand the progress of a
-  run.
+  Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion and
+  acknowledgement events to understand the progress of a run.
 messages:
   - name: complete
     description: null
@@ -20,10 +19,10 @@ messages:
           type: string
           description: Completion status
           enum:
-            - success
-            - failure
-            - cancelled
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - CANCELLED
+            - TIMEOUT
         result:
           type: object
           description: Flow execution result
@@ -63,11 +62,11 @@ messages:
           type: string
           description: Flow execution priority
           enum:
-            - low
-            - normal
-            - high
-            - urgent
-          default: normal
+            - LOW
+            - NORMAL
+            - HIGH
+            - URGENT
+          default: NORMAL
         timeout:
           type: integer
           description: Flow timeout in milliseconds
@@ -104,9 +103,9 @@ messages:
           type: string
           description: Acknowledgment status
           enum:
-            - received
-            - processed
-            - failed
+            - RECEIVED
+            - PROCESSED
+            - FAILED
         timestamp:
           type: string
           format: date-time
@@ -144,10 +143,10 @@ messages:
           type: string
           description: Reason for unacknowledgment
           enum:
-            - timeout
-            - error
-            - rejected
-            - duplicate
+            - TIMEOUT
+            - ERROR
+            - REJECTED
+            - DUPLICATE
         timestamp:
           type: string
           format: date-time
@@ -181,10 +180,10 @@ messages:
           type: string
           description: Node completion status
           enum:
-            - success
-            - failure
-            - skipped
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - SKIPPED
+            - TIMEOUT
         result:
           type: object
           description: Node execution result
@@ -222,10 +221,10 @@ messages:
           type: string
           description: Reason for pausing
           enum:
-            - user_request
-            - resource_limit
-            - waiting
-            - maintenance
+            - USER_REQUEST
+            - RESOURCE_LIMIT
+            - WAITING
+            - MAINTENANCE
         checkpoint:
           type: boolean
           description: Whether to create a checkpoint before pausing
@@ -272,11 +271,11 @@ messages:
           type: string
           description: Reason for termination
           enum:
-            - user_request
-            - error
-            - timeout
-            - completion
-            - cancellation
+            - USER_REQUEST
+            - ERROR
+            - TIMEOUT
+            - COMPLETION
+            - CANCELLATION
         graceful:
           type: boolean
           description: Whether to perform graceful termination
@@ -314,29 +313,29 @@ configuration:
           items:
             type: string
             enum:
-              - success
-              - failure
-              - cancelled
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - CANCELLED
+              - TIMEOUT
           description: Supported flow statuses
         node:
           type: array
           items:
             type: string
             enum:
-              - success
-              - failure
-              - skipped
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - SKIPPED
+              - TIMEOUT
           description: Supported node statuses
         ack:
           type: array
           items:
             type: string
             enum:
-              - received
-              - processed
-              - failed
+              - RECEIVED
+              - PROCESSED
+              - FAILED
           description: Supported acknowledgment statuses
       required:
         - flow
@@ -353,31 +352,31 @@ configuration:
           items:
             type: string
             enum:
-              - user_request
-              - error
-              - timeout
-              - completion
-              - cancellation
+              - USER_REQUEST
+              - ERROR
+              - TIMEOUT
+              - COMPLETION
+              - CANCELLATION
           description: Supported termination reasons
         pause:
           type: array
           items:
             type: string
             enum:
-              - user_request
-              - resource_limit
-              - waiting
-              - maintenance
+              - USER_REQUEST
+              - RESOURCE_LIMIT
+              - WAITING
+              - MAINTENANCE
           description: Supported pause reasons
         unack:
           type: array
           items:
             type: string
             enum:
-              - timeout
-              - error
-              - rejected
-              - duplicate
+              - TIMEOUT
+              - ERROR
+              - REJECTED
+              - DUPLICATE
           description: Supported unacknowledgment reasons
       required:
         - termination
@@ -390,10 +389,10 @@ configuration:
       items:
         type: string
         enum:
-          - low
-          - normal
-          - high
-          - urgent
+          - LOW
+          - NORMAL
+          - HIGH
+          - URGENT
       description: Supported flow priorities
     defaultTimeout:
       type: integer
@@ -418,9 +417,8 @@ configuration:
     - checkpointEnabled
   additionalProperties: false
   description: >-
-    Flows run automations that can be initiated, paused, resumed, or terminated.
-    Follow completion and acknowledgement events to understand the progress of a
-    run.
+    Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion
+    and acknowledgement events to understand the progress of a run.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

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

@@ -2,8 +2,8 @@ name: formaldehyde-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/formaldehyde-concentration-sensor
 version: '1.0'
 description: >-
-  Formaldehyde measurements report the concentration observed by a sensor. Use
-  the reading and its declared unit when presenting environmental measurements.
+  Formaldehyde measurements report the concentration observed by a sensor. Use the reading and its
+  declared unit when presenting environmental measurements.
 messages: []
 attributes:
   - name: measured-value

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

@@ -2,8 +2,8 @@ name: humidity-sensor
 namespace: port1/systems/zero/capability-interfaces/humidity-sensor
 version: '1.0'
 description: >-
-  Humidity sensors report relative humidity. Use the reading to display room
-  conditions or provide input to a ventilation or humidifier flow.
+  Humidity sensors report relative humidity. Use the reading to display room conditions or provide
+  input to a ventilation or humidifier flow.
 messages: []
 attributes:
   - name: relative-humidity

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

@@ -0,0 +1,37 @@
+type: object
+properties:
+  supportedInputs:
+    type: array
+    items:
+      type: object
+      description: A supported input source
+      properties:
+        name:
+          type: string
+        index:
+          type: integer
+          description: Input index
+          minimum: 0
+        inputType:
+          type: string
+          description: Type of input connector
+          enum:
+            - HDMI
+            - COMPOSITE
+            - COMPONENT
+            - SVIDEO
+            - VGA
+            - DVI
+            - USB
+            - BLUETOOTH
+            - WIFI
+            - ETHERNET
+            - OTHER
+      required:
+        - name
+      additionalProperties: false
+      title: SupportedInput
+additionalProperties: false
+description: >-
+  Input controls select or navigate between the inputs on a connected device. Read the current input
+  to show which source is selected.

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

@@ -2,8 +2,8 @@ name: input
 namespace: port1/systems/zero/capability-interfaces/input
 version: '1.0'
 description: >-
-  Input controls select or navigate between the inputs on a connected device.
-  Read the current input to show which source is selected.
+  Input controls select or navigate between the inputs on a connected device. Read the current input
+  to show which source is selected.
 messages:
   - name: navigate-input
     description: null
@@ -85,8 +85,8 @@ configuration:
         title: SupportedInput
   additionalProperties: false
   description: >-
-    Input controls select or navigate between the inputs on a connected device.
-    Read the current input to show which source is selected.
+    Input controls select or navigate between the inputs on a connected device. Read the current
+    input to show which source is selected.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

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

@@ -0,0 +1,52 @@
+type: object
+properties:
+  supportedKeys:
+    type: array
+    items:
+      type: string
+      enum:
+        - '0'
+        - '1'
+        - '2'
+        - '3'
+        - '4'
+        - '5'
+        - '6'
+        - '7'
+        - '8'
+        - '9'
+        - UP
+        - DOWN
+        - LEFT
+        - RIGHT
+        - SELECT
+        - BACK
+        - EXIT
+        - MENU
+        - INFO
+        - RED
+        - GREEN
+        - YELLOW
+        - BLUE
+        - CHANNEL_UP
+        - CHANNEL_DOWN
+        - VOLUME_UP
+        - VOLUME_DOWN
+        - MUTE
+        - PLAY
+        - PAUSE
+        - STOP
+        - FAST_FORWARD
+        - REWIND
+        - SKIP_FORWARD
+        - SKIP_BACKWARD
+        - RECORD
+        - RECORD_STOP
+        - POWER
+        - SLEEP
+        - WAKE
+    description: List of supported keys
+additionalProperties: false
+description: >-
+  Keypad input sends a key to a connected device. Use it to build remote controls that send
+  individual button presses.

package/generated/public/docs/references/capability-interfaces/keypad-input.yaml

@@ -2,8 +2,8 @@ name: keypad-input
 namespace: port1/systems/zero/capability-interfaces/keypad-input
 version: '1.0'
 description: >-
-  Keypad input sends a key to a connected device. Use it to build remote
-  controls that send individual button presses.
+  Keypad input sends a key to a connected device. Use it to build remote controls that send
+  individual button presses.
 messages:
   - name: send-key
     description: null
@@ -110,8 +110,8 @@ configuration:
       description: List of supported keys
   additionalProperties: false
   description: >-
-    Keypad input sends a key to a connected device. Use it to build remote
-    controls that send individual button presses.
+    Keypad input sends a key to a connected device. Use it to build remote controls that send
+    individual button presses.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/laundry-dryer/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/laundry-dryer/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/laundry-dryer.yaml

@@ -2,8 +2,8 @@ name: laundry-dryer
 namespace: port1/systems/zero/capability-interfaces/laundry-dryer
 version: '1.0'
 description: >-
-  Laundry dryers report their operational state. Use it to show the current
-  appliance status or react to a change in a flow.
+  Laundry dryers report their operational state. Use it to show the current appliance status or
+  react to a change in a flow.
 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/laundry-washer/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/laundry-washer/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/laundry-washer.yaml

@@ -2,8 +2,8 @@ name: laundry-washer
 namespace: port1/systems/zero/capability-interfaces/laundry-washer
 version: '1.0'
 description: >-
-  Laundry washers report their operational state. Use it to keep a laundry
-  dashboard in step with the appliance.
+  Laundry washers report their operational state. Use it to keep a laundry dashboard in step with
+  the appliance.
 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/leaf-wetness-sensor.yaml

@@ -2,8 +2,8 @@ name: leaf-wetness-sensor
 namespace: port1/systems/zero/capability-interfaces/leaf-wetness-sensor
 version: '1.0'
 description: >-
-  Leaf wetness measurements report readings from a connected sensor. Use them as
-  input when monitoring plants and growing conditions.
+  Leaf wetness measurements report readings from a connected sensor. Use them as input when
+  monitoring plants and growing conditions.
 messages: []
 attributes:
   - name: measured-value

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

@@ -2,8 +2,8 @@ name: light-sensor
 namespace: port1/systems/zero/capability-interfaces/light-sensor
 version: '1.0'
 description: >-
-  Light sensors report illuminance. Use the reading to understand ambient light
-  and provide input to a lighting automation.
+  Light sensors report illuminance. Use the reading to understand ambient light and provide input to
+  a lighting automation.
 messages: []
 attributes:
   - name: illuminance
@@ -14,9 +14,8 @@ attributes:
         value:
           type: number
           description: >-
-            The illuminance value is a number between 1 and 65533. This
-            attribute SHALL indicate the illuminance in Lux (symbol lx) as
-            follows:
+            The illuminance value is a number between 1 and 65533. This attribute SHALL indicate the
+            illuminance in Lux (symbol lx) as follows:
               • MeasuredValue = 10,000 x log10(illuminance) + 1,
                 where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
                 The MeasuredValue attribute can take the following values:

package/generated/public/docs/references/capability-interfaces/location-tracker.yaml

@@ -2,8 +2,8 @@ name: location-tracker
 namespace: port1/systems/zero/capability-interfaces/location-tracker
 version: '1.0'
 description: >-
-  Location trackers start a locator and report its signal. Use them when helping
-  a customer locate a connected item.
+  Location trackers start a locator and report its signal. Use them when helping a customer locate a
+  connected item.
 messages:
   - name: start-locator
     description: null

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

@@ -2,8 +2,8 @@ name: location
 namespace: port1/systems/zero/capability-interfaces/location
 version: '1.0'
 description: >-
-  Location reports a connected resource's geolocation. Use it to show the
-  position supplied by that resource.
+  Location reports a connected resource's geolocation. Use it to show the position supplied by that
+  resource.
 messages: []
 attributes:
   - name: geolocation

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

@@ -2,8 +2,8 @@ name: lock
 namespace: port1/systems/zero/capability-interfaces/lock
 version: '1.0'
 description: >-
-  Locks accept lock and unlock commands and report their lock state. Use the
-  reported state to check an entryway before requesting a change.
+  Locks accept lock and unlock commands and report their lock state. Use the reported state to check
+  an entryway before requesting a change.
 messages:
   - name: lock
     description: null

package/generated/public/docs/references/capability-interfaces/media-player/1.0/attributes/playback-state.yaml

@@ -4,11 +4,11 @@ properties:
     type: string
     description: The current playback state
     enum:
-      - playing
-      - paused
-      - stopped
-      - loading
-      - error
+      - PLAYING
+      - PAUSED
+      - STOPPED
+      - LOADING
+      - ERROR
 required:
   - value
 additionalProperties: false