@portpowered/reference-data 0.4.1 → 0.4.3

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

@@ -0,0 +1,89 @@
+description: >-
+  Media players select media by its Port OS media ID, play supplied audio or a URI, and control
+  playback. Read playback state and use only the commands supported by the connected player.
+type: object
+properties:
+  supportedPlaybackStates:
+    type: array
+    items:
+      type: string
+      description: The current playback state
+      enum:
+        - PLAYING
+        - PAUSED
+        - STOPPED
+        - LOADING
+        - ERROR
+    description: Supported playback states
+  supportedPlaybackSpeeds:
+    type: array
+    items:
+      type: number
+    description: Supported playback speeds (e.g., 0.5, 1.0, 1.5, 2.0)
+  seekRange:
+    description: Seek range in seconds
+    type: object
+    properties:
+      min:
+        type: number
+        description: Minimum measured value
+      max:
+        type: number
+        description: Maximum measured value
+    required:
+      - min
+      - max
+    additionalProperties: false
+    title: MeasurementRange
+  supportedMediaTypes:
+    type: array
+    items:
+      type: string
+      enum:
+        - AUDIO
+        - VIDEO
+        - IMAGE
+        - PLAYLIST
+    description: List of supported media types
+  supportedFormats:
+    type: array
+    items:
+      type: string
+      enum:
+        - MP3
+        - WAV
+        - FLAC
+        - AAC
+        - OGG
+        - MP4
+        - AVI
+        - MKV
+        - JPG
+        - PNG
+        - GIF
+    description: List of supported media formats
+  maxPlaylistSize:
+    type: integer
+    description: Maximum number of items in a playlist
+    minimum: 1
+    maximum: 10000
+  defaultQuality:
+    type: string
+    description: Default quality setting for media playback
+    enum:
+      - LOW
+      - MEDIUM
+      - HIGH
+      - LOSSLESS
+  supportsPlayURI:
+    type: boolean
+    description: Whether the endpoint can play an audio URI.
+  supportedAudioMimeTypes:
+    type: array
+    description: >-
+      Audio MIME types accepted by play-audio. Advertise play-audio only when audio output is
+      supported.
+    items:
+      type: string
+additionalProperties: false
+title: MediaPlayerInterfaceConfiguration

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

@@ -263,11 +263,11 @@ attributes:
           type: string
           description: The current playback state
           enum:
-            - playing
-            - paused
-            - stopped
-            - loading
-            - error
+            - PLAYING
+            - PAUSED
+            - STOPPED
+            - LOADING
+            - ERROR
       required:
         - value
       additionalProperties: false
@@ -283,11 +283,11 @@ configuration:
         type: string
         description: The current playback state
         enum:
-          - playing
-          - paused
-          - stopped
-          - loading
-          - error
+          - PLAYING
+          - PAUSED
+          - STOPPED
+          - LOADING
+          - ERROR
       description: Supported playback states
     supportedPlaybackSpeeds:
       type: array
@@ -314,27 +314,27 @@ configuration:
       items:
         type: string
         enum:
-          - audio
-          - video
-          - image
-          - playlist
+          - AUDIO
+          - VIDEO
+          - IMAGE
+          - PLAYLIST
       description: List of supported media types
     supportedFormats:
       type: array
       items:
         type: string
         enum:
-          - mp3
-          - wav
-          - flac
-          - aac
-          - ogg
-          - mp4
-          - avi
-          - mkv
-          - jpg
-          - png
-          - gif
+          - MP3
+          - WAV
+          - FLAC
+          - AAC
+          - OGG
+          - MP4
+          - AVI
+          - MKV
+          - JPG
+          - PNG
+          - GIF
       description: List of supported media formats
     maxPlaylistSize:
       type: integer
@@ -345,10 +345,10 @@ configuration:
       type: string
       description: Default quality setting for media playback
       enum:
-        - low
-        - medium
-        - high
-        - lossless
+        - LOW
+        - MEDIUM
+        - HIGH
+        - LOSSLESS
     supportsPlayURI:
       type: boolean
       description: Whether the endpoint can play an audio URI.

package/generated/public/docs/references/capability-interfaces/media-player.yaml

@@ -2,9 +2,8 @@ name: media-player
 namespace: port1/systems/zero/capability-interfaces/media-player
 version: '1.0'
 description: >-
-  Media players select media by its Port OS media ID, play supplied audio or a
-  URI, and control playback. Read playback state and use only the commands
-  supported by the connected player.
+  Media players select media by its Port OS media ID, play supplied audio or a URI, and control
+  playback. Read playback state and use only the commands supported by the connected player.
 messages:
   - name: audio
     description: null
@@ -89,13 +88,13 @@ messages:
       additionalProperties: false
   - name: play-audio
     description: >-
-      Play a base64 encoded audio object on the endpoint. Requires audio output
-      support; RTSP or SDP alone does not establish playback support.
+      Play a base64 encoded audio object on the endpoint. Requires audio output support; RTSP or SDP
+      alone does not establish playback support.
     directionality: in
     schema:
       description: >-
-        Play a base64 encoded audio object on the endpoint. Requires audio
-        output support; RTSP or SDP alone does not establish playback support.
+        Play a base64 encoded audio object on the endpoint. Requires audio output support; RTSP or
+        SDP alone does not establish playback support.
       type: object
       properties:
         audio:
@@ -135,10 +134,9 @@ 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.
       required:
         - mediaId
       additionalProperties: false
@@ -265,19 +263,18 @@ attributes:
           type: string
           description: The current playback state
           enum:
-            - playing
-            - paused
-            - stopped
-            - loading
-            - error
+            - PLAYING
+            - PAUSED
+            - STOPPED
+            - LOADING
+            - ERROR
       required:
         - value
       additionalProperties: false
 configuration:
   description: >-
-    Media players select media by its Port OS media ID, play supplied audio or a
-    URI, and control playback. Read playback state and use only the commands
-    supported by the connected player.
+    Media players select media by its Port OS media ID, play supplied audio or a URI, and control
+    playback. Read playback state and use only the commands supported by the connected player.
   type: object
   properties:
     supportedPlaybackStates:
@@ -286,11 +283,11 @@ configuration:
         type: string
         description: The current playback state
         enum:
-          - playing
-          - paused
-          - stopped
-          - loading
-          - error
+          - PLAYING
+          - PAUSED
+          - STOPPED
+          - LOADING
+          - ERROR
       description: Supported playback states
     supportedPlaybackSpeeds:
       type: array
@@ -317,27 +314,27 @@ configuration:
       items:
         type: string
         enum:
-          - audio
-          - video
-          - image
-          - playlist
+          - AUDIO
+          - VIDEO
+          - IMAGE
+          - PLAYLIST
       description: List of supported media types
     supportedFormats:
       type: array
       items:
         type: string
         enum:
-          - mp3
-          - wav
-          - flac
-          - aac
-          - ogg
-          - mp4
-          - avi
-          - mkv
-          - jpg
-          - png
-          - gif
+          - MP3
+          - WAV
+          - FLAC
+          - AAC
+          - OGG
+          - MP4
+          - AVI
+          - MKV
+          - JPG
+          - PNG
+          - GIF
       description: List of supported media formats
     maxPlaylistSize:
       type: integer
@@ -348,18 +345,18 @@ configuration:
       type: string
       description: Default quality setting for media playback
       enum:
-        - low
-        - medium
-        - high
-        - lossless
+        - LOW
+        - MEDIUM
+        - HIGH
+        - LOSSLESS
     supportsPlayURI:
       type: boolean
       description: Whether the endpoint can play an audio URI.
     supportedAudioMimeTypes:
       type: array
       description: >-
-        Audio MIME types accepted by play-audio. Advertise play-audio only when
-        audio output is supported.
+        Audio MIME types accepted by play-audio. Advertise play-audio only when audio output is
+        supported.
       items:
         type: string
   additionalProperties: false

package/generated/public/docs/references/capability-interfaces/media-playlist.yaml

@@ -2,8 +2,8 @@ name: media-playlist
 namespace: port1/systems/zero/capability-interfaces/media-playlist
 version: '1.0'
 description: >-
-  Media playlists create and manage a collection of items to play. Add or remove
-  items, retrieve a playlist, shuffle it, or ask the device to play it.
+  Media playlists create and manage a collection of items to play. Add or remove items, retrieve a
+  playlist, shuffle it, or ask the device to play it.
 messages:
   - name: add-to-playlist
     description: null

package/generated/public/docs/references/capability-interfaces/media-search.yaml

@@ -2,8 +2,8 @@ name: media-search
 namespace: port1/systems/zero/capability-interfaces/media-search
 version: '1.0'
 description: >-
-  Media search requests content matching a search and returns audio media
-  results. Use it to find an item before asking a player to play it.
+  Media search requests content matching a search and returns audio media results. Use it to find an
+  item before asking a player to play it.
 messages:
   - name: audio-media-results
     description: null
@@ -127,19 +127,15 @@ messages:
           default: track
         album:
           type: string
-          description: >-
-            Search by album name, can only be used when searching albums, and
-            tracks
+          description: Search by album name, can only be used when searching albums, and tracks
         artist:
           type: string
-          description: >-
-            Search by artist name, can only be used when searching artists,
-            albums and tracks
+          description: Search by artist name, can only be used when searching artists, albums and tracks
         year:
           type: string
           description: >-
-            Search by year, can only be used when searching albums, years, and
-            tracks. You can pass a range like 1990-2000
+            Search by year, can only be used when searching albums, years, and tracks. You can pass
+            a range like 1990-2000
       required:
         - query
       additionalProperties: false

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

@@ -2,8 +2,8 @@ name: microwave-oven
 namespace: port1/systems/zero/capability-interfaces/microwave-oven
 version: '1.0'
 description: >-
-  Microwave ovens report their operational state. Use that state to show what
-  the appliance is currently doing.
+  Microwave ovens report their operational state. Use that state to show what the appliance is
+  currently doing.
 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/motion-sensor.yaml

@@ -2,9 +2,8 @@ name: motion-sensor
 namespace: port1/systems/zero/capability-interfaces/motion-sensor
 version: '1.0'
 description: >-
-  Motion sensors report detection state and emit motion-detected events. Use
-  them to trigger a light, a notification, or another automation when movement
-  is detected.
+  Motion sensors report detection state and emit motion-detected events. Use them to trigger a
+  light, a notification, or another automation when movement is detected.
 messages:
   - name: motion-detected
     description: A distinct motion occurrence, independent of cached detection state.

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

@@ -2,8 +2,8 @@ name: nitrogen-dioxide-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/nitrogen-dioxide-concentration-sensor
 version: '1.0'
 description: >-
-  Nitrogen dioxide measurements report the concentration observed by a sensor.
-  Use the value and its declared units in environmental monitoring.
+  Nitrogen dioxide measurements report the concentration observed by a sensor. Use the value and its
+  declared units in environmental monitoring.
 messages: []
 attributes:
   - name: measured-value

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

@@ -22,20 +22,20 @@ properties:
         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,12 +85,12 @@ properties:
             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/notification/1.0/messages/notification-trigger.yaml

@@ -8,10 +8,10 @@ properties:
     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
@@ -30,20 +30,20 @@ properties:
         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
@@ -117,12 +117,12 @@ properties:
             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/notification/1.0/messages/notification.yaml

@@ -18,20 +18,20 @@ properties:
     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