@portpowered/reference-data 0.4.1 → 0.4.2

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

@@ -2,8 +2,8 @@ name: notification
 namespace: port1/systems/zero/capability-interfaces/notification
 version: '1.0'
 description: >-
-  Notifications can be triggered immediately or scheduled. Follow notification
-  events to connect the delivery flow to the rest of an integration.
+  Notifications can be triggered immediately or scheduled. Follow notification events to connect the
+  delivery flow to the rest of an integration.
 messages:
   - name: notification
     description: null
@@ -29,20 +29,20 @@ messages:
           type: string
           description: Notification priority level
           enum:
-            - low
-            - normal
-            - high
-            - urgent
+            - LOW
+            - NORMAL
+            - HIGH
+            - URGENT
         channels:
           type: array
           items:
             type: string
             enum:
-              - push
-              - email
-              - sms
-              - in-app
-              - webhook
+              - PUSH
+              - EMAIL
+              - SMS
+              - IN_APP
+              - WEBHOOK
           description: Channels to send the notification through
         targetUsers:
           type: array
@@ -85,20 +85,20 @@ messages:
               type: string
               description: Notification priority level
               enum:
-                - low
-                - normal
-                - high
-                - urgent
+                - LOW
+                - NORMAL
+                - HIGH
+                - URGENT
             channels:
               type: array
               items:
                 type: string
                 enum:
-                  - push
-                  - email
-                  - sms
-                  - in-app
-                  - webhook
+                  - PUSH
+                  - EMAIL
+                  - SMS
+                  - IN_APP
+                  - WEBHOOK
               description: Channels to send the notification through
             targetUsers:
               type: array
@@ -148,12 +148,12 @@ messages:
                   type: string
                   description: Interval unit
                   enum:
-                    - seconds
-                    - minutes
-                    - hours
-                    - days
-                    - weeks
-                    - months
+                    - SECONDS
+                    - MINUTES
+                    - HOURS
+                    - DAYS
+                    - WEEKS
+                    - MONTHS
               required:
                 - value
                 - unit
@@ -186,10 +186,10 @@ messages:
           type: string
           description: Type of trigger
           enum:
-            - immediate
-            - scheduled
-            - event-based
-            - condition-based
+            - IMMEDIATE
+            - SCHEDULED
+            - EVENT_BASED
+            - CONDITION_BASED
         notification:
           type: object
           description: Notification payload information
@@ -208,20 +208,20 @@ messages:
               type: string
               description: Notification priority level
               enum:
-                - low
-                - normal
-                - high
-                - urgent
+                - LOW
+                - NORMAL
+                - HIGH
+                - URGENT
             channels:
               type: array
               items:
                 type: string
                 enum:
-                  - push
-                  - email
-                  - sms
-                  - in-app
-                  - webhook
+                  - PUSH
+                  - EMAIL
+                  - SMS
+                  - IN_APP
+                  - WEBHOOK
               description: Channels to send the notification through
             targetUsers:
               type: array
@@ -295,12 +295,12 @@ messages:
                   type: string
                   description: Interval unit
                   enum:
-                    - seconds
-                    - minutes
-                    - hours
-                    - days
-                    - weeks
-                    - months
+                    - SECONDS
+                    - MINUTES
+                    - HOURS
+                    - DAYS
+                    - WEEKS
+                    - MONTHS
               required:
                 - value
                 - unit

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

@@ -2,8 +2,8 @@ name: oven
 namespace: port1/systems/zero/capability-interfaces/oven
 version: '1.0'
 description: >-
-  Ovens report their temperature. Use the reading to show the temperature
-  supplied by a connected appliance.
+  Ovens report their temperature. Use the reading to show the temperature supplied by a connected
+  appliance.
 messages: []
 attributes:
   - name: temperature

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

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

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

@@ -2,8 +2,8 @@ name: percentage
 namespace: port1/systems/zero/capability-interfaces/percentage
 version: '1.0'
 description: >-
-  Percentage controls set or adjust a percentage and report the current value.
-  Use them for connected controls expressed as a proportional level.
+  Percentage controls set or adjust a percentage and report the current value. Use them for
+  connected controls expressed as a proportional level.
 messages:
   - name: adjust-percentage
     description: null

package/generated/public/docs/references/capability-interfaces/pet-feeder/1.0/messages/trigger-feed.yaml

@@ -9,9 +9,9 @@ properties:
     type: string
     description: Unit of food to feed the pet
     enum:
-      - cups
-      - grams
-      - pounds
-      - ounces
-    default: cups
+      - CUPS
+      - GRAMS
+      - POUNDS
+      - OUNCES
+    default: CUPS
 additionalProperties: false

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

@@ -20,11 +20,11 @@ messages:
           type: string
           description: Unit of food to feed the pet
           enum:
-            - cups
-            - grams
-            - pounds
-            - ounces
-          default: cups
+            - CUPS
+            - GRAMS
+            - POUNDS
+            - OUNCES
+          default: CUPS
       additionalProperties: false
 attributes: []
 configuration: null

package/generated/public/docs/references/capability-interfaces/pet-feeder.yaml

@@ -2,8 +2,8 @@ name: pet-feeder
 namespace: port1/systems/zero/capability-interfaces/pet-feeder
 version: '1.0'
 description: >-
-  Pet feeders accept a command to trigger a feed. Use the command to start a
-  feeding action from an interface or automation.
+  Pet feeders accept a command to trigger a feed. Use the command to start a feeding action from an
+  interface or automation.
 messages:
   - name: trigger-feed
     description: null
@@ -20,11 +20,11 @@ messages:
           type: string
           description: Unit of food to feed the pet
           enum:
-            - cups
-            - grams
-            - pounds
-            - ounces
-          default: cups
+            - CUPS
+            - GRAMS
+            - POUNDS
+            - OUNCES
+          default: CUPS
       additionalProperties: false
 attributes: []
 configuration: null

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

@@ -2,8 +2,8 @@ name: ph-sensor
 namespace: port1/systems/zero/capability-interfaces/ph-sensor
 version: '1.0'
 description: >-
-  pH measurements report the reading supplied by a connected sensor. Use it when
-  monitoring the conditions of a liquid or growing system.
+  pH measurements report the reading supplied by a connected sensor. Use it when monitoring the
+  conditions of a liquid or growing system.
 messages: []
 attributes:
   - name: measured-value

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

@@ -2,8 +2,8 @@ name: pm10-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/pm10-concentration-sensor
 version: '1.0'
 description: >-
-  PM10 measurements report the concentration observed by a particulate sensor.
-  Use the reported value and unit when displaying air measurements.
+  PM10 measurements report the concentration observed by a particulate sensor. Use the reported
+  value and unit when displaying air measurements.
 messages: []
 attributes:
   - name: measured-value

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

@@ -2,8 +2,8 @@ name: pm2-5-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/pm2-5-concentration-sensor
 version: '1.0'
 description: >-
-  PM2.5 measurements report the concentration observed by a particulate sensor.
-  Use the reading to follow changes in measured air conditions.
+  PM2.5 measurements report the concentration observed by a particulate sensor. Use the reading to
+  follow changes in measured air conditions.
 messages: []
 attributes:
   - name: measured-value

package/generated/public/docs/references/capability-interfaces/power-level.yaml

@@ -2,8 +2,8 @@ name: power-level
 namespace: port1/systems/zero/capability-interfaces/power-level
 version: '1.0'
 description: >-
-  Power level sets or adjusts a device's output level and reports the current
-  setting. Use it when a device supports more than a simple on/off control.
+  Power level sets or adjusts a device's output level and reports the current setting. Use it when a
+  device supports more than a simple on/off control.
 messages:
   - name: adjust-power-level
     description: null

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

@@ -2,18 +2,18 @@ name: power
 namespace: port1/systems/zero/capability-interfaces/power
 version: '1.0'
 description: >-
-  Power turns a device on or off, reports its power state, and restarts devices
-  that support rebooting.
+  Power turns a device on or off, reports its power state, and restarts devices that support
+  rebooting.
 messages:
   - name: reboot
     description: >-
-      Restart the endpoint. Advertise this message only when the provider
-      supports rebooting the device.
+      Restart the endpoint. Advertise this message only when the provider supports rebooting the
+      device.
     directionality: in
     schema:
       description: >-
-        Restart the endpoint. Advertise this message only when the provider
-        supports rebooting the device.
+        Restart the endpoint. Advertise this message only when the provider supports rebooting the
+        device.
       type: object
       additionalProperties: false
       title: PowerInterfaceRebootMessage

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

@@ -2,8 +2,8 @@ name: pressure-sensor
 namespace: port1/systems/zero/capability-interfaces/pressure-sensor
 version: '1.0'
 description: >-
-  Pressure measurements report the value supplied by a connected sensor. Use the
-  value and its declared unit when monitoring pressure.
+  Pressure measurements report the value supplied by a connected sensor. Use the value and its
+  declared unit when monitoring pressure.
 messages: []
 attributes:
   - name: measured-value

package/generated/public/docs/references/capability-interfaces/pump-configuration-and-control/1.0/attributes/pump-status.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/pump-configuration-and-control/1.0/configuration.yaml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  supportedPumpModes:
+    type: array
+    items:
+      type: string
+      enum:
+        - STANDARD
+        - CONSTANT_SPEED
+        - CONSTANT_PRESSURE
+        - PROPORTIONAL_PRESSURE
+        - CONSTANT_FLOW
+        - PROPORTIONAL_FLOW
+        - CONSTANT_TEMPERATURE
+        - AUTOMATIC
+    description: Supported pump modes
+additionalProperties: false
+description: >-
+  Pump controls set a pump mode and speed. Read its capacity, mode, and status to keep a control
+  interface in step with the pump.

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

@@ -80,7 +80,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
@@ -89,6 +91,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false

package/generated/public/docs/references/capability-interfaces/pump-configuration-and-control.yaml

@@ -2,8 +2,8 @@ name: pump-configuration-and-control
 namespace: port1/systems/zero/capability-interfaces/pump-configuration-and-control
 version: '1.0'
 description: >-
-  Pump controls set a pump mode and speed. Read its capacity, mode, and status
-  to keep a control interface in step with the pump.
+  Pump controls set a pump mode and speed. Read its capacity, mode, and status to keep a control
+  interface in step with the pump.
 messages:
   - name: set-mode
     description: null
@@ -79,9 +79,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
@@ -90,6 +91,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false
@@ -112,8 +114,8 @@ configuration:
       description: Supported pump modes
   additionalProperties: false
   description: >-
-    Pump controls set a pump mode and speed. Read its capacity, mode, and status
-    to keep a control interface in step with the pump.
+    Pump controls set a pump mode and speed. Read its capacity, mode, and status to keep a control
+    interface in step with the pump.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

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

@@ -2,8 +2,8 @@ name: recordings
 namespace: port1/systems/zero/capability-interfaces/recordings
 version: '1.0'
 description: >-
-  Recordings list saved captures and expose recording download and deletion. Use
-  pagination to browse the recordings supplied by a connected provider.
+  Recordings list saved captures and expose recording download and deletion. Use pagination to
+  browse the recordings supplied by a connected provider.
 messages:
   - name: delete-recording
     description: Delete recording.
@@ -67,9 +67,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
@@ -107,10 +105,10 @@ messages:
                 type: string
                 minLength: 1
                 description: >-
-                  Media IDs are a standardized identifier that Port OS uses to
-                  represent media across YouTube, Spotify, and other media
-                  providers. See https://portpowered.com/docs/media for the
-                  current media identifiers documentation.
+                  Media IDs are a standardized identifier that Port OS uses to represent media
+                  across YouTube, Spotify, and other media providers. See
+                  https://portpowered.com/docs/media for the current media identifiers
+                  documentation.
               startedAt:
                 type: string
                 format: date-time
@@ -126,9 +124,7 @@ messages:
           description: Recordings in this page.
         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/refrigerator.yaml

@@ -2,8 +2,8 @@ name: refrigerator
 namespace: port1/systems/zero/capability-interfaces/refrigerator
 version: '1.0'
 description: >-
-  Refrigerators report their temperature. Use the reading to show the conditions
-  supplied by the appliance.
+  Refrigerators report their temperature. Use the reading to show the conditions supplied by the
+  appliance.
 messages: []
 attributes:
   - name: temperature

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

@@ -2,8 +2,8 @@ name: reminders-provider
 namespace: port1/systems/zero/capability-interfaces/reminders-provider
 version: '1.0'
 description: >-
-  Reminder providers list reminders from a connected account. Use the returned
-  items to give an assistant task context or display an existing reminder list.
+  Reminder providers list reminders from a connected account. Use the returned items to give an
+  assistant task context or display an existing reminder list.
 messages:
   - name: list-reminders
     description: Request to list reminders from a reminders provider

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

@@ -2,9 +2,8 @@ name: remote-control
 namespace: port1/systems/zero/capability-interfaces/remote-control
 version: '1.0'
 description: >-
-  Remote control starts and ends control sessions and sends movement
-  instructions. Use velocity, turning, and duration fields to request movement
-  from a connected device.
+  Remote control starts and ends control sessions and sends movement instructions. Use velocity,
+  turning, and duration fields to request movement from a connected device.
 messages:
   - name: end-session
     description: null

package/generated/public/docs/references/capability-interfaces/robotic-vacuum-cleaner/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/robotic-vacuum-cleaner/1.0/configuration.yaml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  supportedCleaningModes:
+    type: array
+    items:
+      type: string
+      description: Robot vacuum cleaning mode
+      enum:
+        - AUTO
+        - SPOT
+        - EDGE
+        - SINGLE_ROOM
+        - CUSTOM
+    description: Supported cleaning modes
+  supportsScheduling:
+    type: boolean
+    description: Whether the vacuum supports scheduling
+    default: false
+  supportsRoomCleaning:
+    type: boolean
+    description: >-
+      Whether the vacuum accepts clean-room for rooms it declares CAN_CONTROL on. Vacuums that omit
+      it do not advertise clean-room.
+    default: false
+  supportsMultiRoomCleaning:
+    type: boolean
+    description: >-
+      Whether clean-room accepts more than one room in one request. When false, more than one
+      groupId is rejected with MULTI_ROOM_UNSUPPORTED before dispatch.
+    default: false
+additionalProperties: false
+description: >-
+  Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a cleaning mode and read
+  the reported mode and operational state to follow a cleaning session.

package/generated/public/docs/references/capability-interfaces/robotic-vacuum-cleaner/1.0.yaml

@@ -106,7 +106,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
@@ -115,6 +117,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false