@portpowered/reference-data 0.4.1 → 0.4.2

package/generated/public/docs/references/capability-interfaces/rtc-session.yaml

@@ -2,9 +2,8 @@ name: rtc-session
 namespace: port1/systems/zero/capability-interfaces/rtc-session
 version: '1.0'
 description: >-
-  RTC sessions initiate a connection using an offer and return an answer for the
-  session. Follow disconnection events and close the session when the connection
-  is no longer needed.
+  RTC sessions initiate a connection using an offer and return an answer for the session. Follow
+  disconnection events and close the session when the connection is no longer needed.
 messages:
   - name: answer-generated-for-session
     description: null
@@ -21,7 +20,7 @@ messages:
             format:
               type: string
               enum:
-                - sdp
+                - SDP
             value:
               type: object
               properties:
@@ -58,17 +57,16 @@ messages:
       additionalProperties: false
   - name: initiate-session-with-offer
     description: >-
-      The initiate session with offer message is used to initiate an RTC session
-      between the client and an endpoint.  The offer is expected to be a
-      standard RTC SDP (standard description protocol) offer. The offer must
-      contain all ICE candidates for the session to be established.
+      The initiate session with offer message is used to initiate an RTC session between the client
+      and an endpoint.  The offer is expected to be a standard RTC SDP (standard description
+      protocol) offer. The offer must contain all ICE candidates for the session to be established.
     directionality: in
     schema:
       description: >-
-        The initiate session with offer message is used to initiate an RTC
-        session between the client and an endpoint.  The offer is expected to be
-        a standard RTC SDP (standard description protocol) offer. The offer must
-        contain all ICE candidates for the session to be established.
+        The initiate session with offer message is used to initiate an RTC session between the
+        client and an endpoint.  The offer is expected to be a standard RTC SDP (standard
+        description protocol) offer. The offer must contain all ICE candidates for the session to be
+        established.
       type: object
       required:
         - sessionId
@@ -87,22 +85,20 @@ messages:
             format:
               type: string
               enum:
-                - sdp
+                - SDP
             value:
               type: string
               description: The SDP offer session contents
           title: RtcOffer
         authorization:
           type: array
-          description: >-
-            Message-specific session authorization entries required by the
-            target endpoint.
+          description: Message-specific session authorization entries required by the target endpoint.
           items:
             oneOf:
               - type: object
                 description: >-
-                  A Roborock session authorization entry carrying the PIN
-                  required to initiate a camera stream.
+                  A Roborock session authorization entry carrying the PIN required to initiate a
+                  camera stream.
                 additionalProperties: false
                 required:
                   - type
@@ -124,10 +120,9 @@ messages:
         sessionDuration:
           type: integer
           description: >-
-            The duration of the session in seconds. If not provided, the default
-            is 60 seconds. If provided, the session will be terminated after the
-            duration has elapsed. To reestablish the session, the client must
-            initiate a new session with a new offer.
+            The duration of the session in seconds. If not provided, the default is 60 seconds. If
+            provided, the session will be terminated after the duration has elapsed. To reestablish
+            the session, the client must initiate a new session with a new offer.
           minimum: 1
           maximum: 3600
           default: 60
@@ -151,16 +146,14 @@ configuration:
       type: array
       maxItems: 8
       description: >-
-        Optional public STUN configuration passed to the browser's standard
-        RTCIceServer interface. Omitted or empty means no ICE servers. Gathering
-        starts only when a caller deliberately initiates a session. TURN and
-        credentials are excluded.
+        Optional public STUN configuration passed to the browser's standard RTCIceServer interface.
+        Omitted or empty means no ICE servers. Gathering starts only when a caller deliberately
+        initiates a session. TURN and credentials are excluded.
       items:
         type: object
         description: >-
-          The credential-free public STUN subset of the standard WebRTC
-          RTCIceServer dictionary. URLs are discoverable configuration, never
-          session credentials.
+          The credential-free public STUN subset of the standard WebRTC RTCIceServer dictionary.
+          URLs are discoverable configuration, never session credentials.
         required:
           - urls
         properties:
@@ -168,10 +161,9 @@ configuration:
             oneOf:
               - type: string
                 description: >-
-                  Public, credential-free STUN URI using the RFC 7064
-                  stun:host[:port] form. This version supports DNS names and
-                  IPv4 hosts, with ports 1 through 65535. IPv6 literals, secure
-                  STUN, TURN, paths, queries and fragments are not supported by
+                  Public, credential-free STUN URI using the RFC 7064 stun:host[:port] form. This
+                  version supports DNS names and IPv4 hosts, with ports 1 through 65535. IPv6
+                  literals, secure STUN, TURN, paths, queries and fragments are not supported by
                   this configuration subset.
                 minLength: 6
                 maxLength: 256
@@ -189,9 +181,8 @@ configuration:
     supportedStreams:
       type: array
       description: >-
-        Discoverable media streams in SDP offer order. Directions describe the
-        endpoint; the browser reverses SENDONLY and RECVONLY. Omitted means a
-        legacy video SENDONLY stream.
+        Discoverable media streams in SDP offer order. Directions describe the endpoint; the browser
+        reverses SENDONLY and RECVONLY. Omitted means a legacy video SENDONLY stream.
       items:
         type: object
         description: A discoverable RTC media stream supported by an endpoint.
@@ -211,9 +202,7 @@ configuration:
               - VIDEO
           direction:
             type: string
-            description: >-
-              Direction from the endpoint perspective; browser SENDONLY and
-              RECVONLY are reversed.
+            description: Direction from the endpoint perspective; browser SENDONLY and RECVONLY are reversed.
             enum:
               - SENDRECV
               - SENDONLY
@@ -225,8 +214,8 @@ configuration:
             maxItems: 16
             uniqueItems: true
             description: >-
-              Ordered permitted RTP codec MIME types, such as audio/opus or
-              video/H264. Omitted uses browser defaults.
+              Ordered permitted RTP codec MIME types, such as audio/opus or video/H264. Omitted uses
+              browser defaults.
             items:
               type: string
               pattern: ^(audio|video)/[A-Za-z0-9.+-]+$
@@ -236,13 +225,13 @@ configuration:
       type: array
       maxItems: 8
       description: >-
-        Data channels the browser creates after media transceivers, using the
-        standard RTCDataChannelInit options. Omitted means no data channels.
+        Data channels the browser creates after media transceivers, using the standard
+        RTCDataChannelInit options. Omitted means no data channels.
       items:
         type: object
         description: >-
-          Standard WebRTC RTCDataChannelInit options plus the required label
-          passed to createDataChannel. Channels are bidirectional.
+          Standard WebRTC RTCDataChannelInit options plus the required label passed to
+          createDataChannel. Channels are bidirectional.
         additionalProperties: false
         required:
           - label
@@ -286,9 +275,7 @@ configuration:
         title: RtcDataChannel
     iceMode:
       type: string
-      description: >-
-        Whether the endpoint expects a full offer up front or supports trickle
-        ICE.
+      description: Whether the endpoint expects a full offer up front or supports trickle ICE.
       enum:
         - FULL_OFFER
         - TRICKLE
@@ -323,9 +310,8 @@ configuration:
         title: RtcSessionMessageAuthorizationRequirement
   additionalProperties: false
   description: >-
-    RTC sessions initiate a connection using an offer and return an answer for
-    the session. Follow disconnection events and close the session when the
-    connection is no longer needed.
+    RTC sessions initiate a connection using an offer and return an answer for the session. Follow
+    disconnection events and close the session when the connection is no longer needed.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/rtsp-session.yaml

@@ -2,8 +2,8 @@ name: rtsp-session
 namespace: port1/systems/zero/capability-interfaces/rtsp-session
 version: '1.0'
 description: >-
-  RTSP sessions open a camera connection and return its RTSP URI and optional
-  SDP description. Close the session when the connection is no longer needed.
+  RTSP sessions open a camera connection and return its RTSP URI and optional SDP description. Close
+  the session when the connection is no longer needed.
 messages:
   - name: start-session
     description: Start session.

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

@@ -2,8 +2,8 @@ name: scene
 namespace: port1/systems/zero/capability-interfaces/scene
 version: '1.0'
 description: >-
-  Scenes activate or deactivate a predefined device scene. Use them to request a
-  saved combination of settings from a connected integration.
+  Scenes activate or deactivate a predefined device scene. Use them to request a saved combination
+  of settings from a connected integration.
 messages:
   - name: activate
     description: null

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

@@ -0,0 +1,71 @@
+type: object
+properties:
+  supportedAuthorizationTypes:
+    type: array
+    items:
+      type: object
+      description: A supported security authorization type
+      properties:
+        type:
+          type: string
+          enum:
+            - FOUR_DIGIT_PIN
+      title: SecurityAuthorizationType
+  supportedArmStates:
+    type: array
+    items:
+      type: object
+      description: A supported security arm state
+      properties:
+        value:
+          type: string
+          enum:
+            - ARMED_AWAY
+            - ARMED_STAY
+            - ARMED_NIGHT
+            - DISARMED
+      title: SecurityArmState
+  alerts:
+    type: array
+    items:
+      type: object
+      description: A security alert type
+      properties:
+        type:
+          type: string
+          enum:
+            - CHIME
+            - SIREN
+            - ENTRY_DELAY
+            - EXIT_DELAY
+      title: SecurityAlert
+  assets:
+    type: array
+    items:
+      type: object
+  playlists:
+    type: array
+    items:
+      type: object
+      description: A security panel audio playlist
+      properties:
+        id:
+          type: string
+        playOrder:
+          type: array
+          items:
+            type: object
+            description: A play order item for security panel audio playback
+            properties:
+              assetId:
+                type: string
+              loopCount:
+                type: integer
+              loopPauseInMilliseconds:
+                type: integer
+            title: SecurityPlayOrderItem
+      title: SecurityPlaylist
+additionalProperties: false
+description: >-
+  Security panels accept arm and disarm commands and report alarm and arming states. Use those
+  reports to show the status supplied by a connected panel.

package/generated/public/docs/references/capability-interfaces/security-panel.yaml

@@ -2,8 +2,8 @@ name: security-panel
 namespace: port1/systems/zero/capability-interfaces/security-panel
 version: '1.0'
 description: >-
-  Security panels accept arm and disarm commands and report alarm and arming
-  states. Use those reports to show the status supplied by a connected panel.
+  Security panels accept arm and disarm commands and report alarm and arming states. Use those
+  reports to show the status supplied by a connected panel.
 messages:
   - name: arm
     description: null
@@ -210,8 +210,8 @@ configuration:
         title: SecurityPlaylist
   additionalProperties: false
   description: >-
-    Security panels accept arm and disarm commands and report alarm and arming
-    states. Use those reports to show the status supplied by a connected panel.
+    Security panels accept arm and disarm commands and report alarm and arming states. Use those
+    reports to show the status supplied by a connected panel.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

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

@@ -0,0 +1,23 @@
+description: >-
+  Security PINs create, update, query, and delete PIN records. Follow operation results and PIN
+  reports when managing the records supported by a device.
+type: object
+properties:
+  supportedKinds:
+    type: array
+    uniqueItems: true
+    items:
+      type: string
+      enum:
+        - PERMANENT
+        - TEMPORARY
+  minLength:
+    type: integer
+    minimum: 0
+  maxLength:
+    type: integer
+    minimum: 0
+  pattern:
+    type: string
+    description: Explicit device PIN regular expression; absent means no character restriction.
+additionalProperties: false

package/generated/public/docs/references/capability-interfaces/security-pin.yaml

@@ -2,20 +2,19 @@ name: security-pin
 namespace: port1/systems/zero/capability-interfaces/security-pin
 version: '1.0'
 description: >-
-  Security PINs create, update, query, and delete PIN records. Follow operation
-  results and PIN reports when managing the records supported by a device.
+  Security PINs create, update, query, and delete PIN records. Follow operation results and PIN
+  reports when managing the records supported by a device.
 messages:
   - name: create-pin
     description: >-
-      Create an endpoint-scoped PIN. TEMPORARY requires both validity
-      timestamps; PERMANENT forbids them. Validate increasing, nonexpired
-      instants and declared restrictions before dispatch.
+      Create an endpoint-scoped PIN. TEMPORARY requires both validity timestamps; PERMANENT forbids
+      them. Validate increasing, nonexpired instants and declared restrictions before dispatch.
     directionality: in
     schema:
       description: >-
-        Create an endpoint-scoped PIN. TEMPORARY requires both validity
-        timestamps; PERMANENT forbids them. Validate increasing, nonexpired
-        instants and declared restrictions before dispatch.
+        Create an endpoint-scoped PIN. TEMPORARY requires both validity timestamps; PERMANENT
+        forbids them. Validate increasing, nonexpired instants and declared restrictions before
+        dispatch.
       type: object
       properties:
         name:
@@ -23,9 +22,7 @@ messages:
         pin:
           type: string
           writeOnly: true
-          description: >-
-            Credential preserved as a string. Redact from diagnostics and
-            persisted history.
+          description: Credential preserved as a string. Redact from diagnostics and persisted history.
         kind:
           type: string
           enum:
@@ -44,13 +41,13 @@ messages:
       additionalProperties: false
   - name: delete-pin
     description: >-
-      Delete a record within the authorized endpoint. Emit a correlated terminal
-      result even when enumeration no longer includes the record.
+      Delete a record within the authorized endpoint. Emit a correlated terminal result even when
+      enumeration no longer includes the record.
     directionality: in
     schema:
       description: >-
-        Delete a record within the authorized endpoint. Emit a correlated
-        terminal result even when enumeration no longer includes the record.
+        Delete a record within the authorized endpoint. Emit a correlated terminal result even when
+        enumeration no longer includes the record.
       type: object
       properties:
         id:
@@ -62,18 +59,16 @@ messages:
       additionalProperties: false
   - name: pin-operation-result
     description: >-
-      Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed
-      completion, not dispatch acceptance. CREATE supplies recordId once
-      assigned; UPDATE and DELETE retain the requested ID. FAILED requires a
-      safe code; other statuses forbid code. Never include credentials or raw
-      vendor errors.
+      Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed completion, not
+      dispatch acceptance. CREATE supplies recordId once assigned; UPDATE and DELETE retain the
+      requested ID. FAILED requires a safe code; other statuses forbid code. Never include
+      credentials or raw vendor errors.
     directionality: out
     schema:
       description: >-
-        Correlated safe PIN provisioning result. APPLIED requires
-        vendor-confirmed completion, not dispatch acceptance. CREATE supplies
-        recordId once assigned; UPDATE and DELETE retain the requested ID.
-        FAILED requires a safe code; other statuses forbid code. Never include
+        Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed completion, not
+        dispatch acceptance. CREATE supplies recordId once assigned; UPDATE and DELETE retain the
+        requested ID. FAILED requires a safe code; other statuses forbid code. Never include
         credentials or raw vendor errors.
       type: object
       properties:
@@ -99,8 +94,8 @@ messages:
           type: string
           minLength: 1
           description: >-
-            Stable safe structured failure code. Never raw vendor text,
-            credentials or response bodies.
+            Stable safe structured failure code. Never raw vendor text, credentials or response
+            bodies.
       required:
         - correlationToken
         - operation
@@ -108,13 +103,13 @@ messages:
       additionalProperties: false
   - name: pin-records-report
     description: >-
-      Bounded credential-free record page aligned with the pin-records
-      attribute. Echo the query correlation token in the message header.
+      Bounded credential-free record page aligned with the pin-records attribute. Echo the query
+      correlation token in the message header.
     directionality: out
     schema:
       description: >-
-        Bounded credential-free record page aligned with the pin-records
-        attribute. Echo the query correlation token in the message header.
+        Bounded credential-free record page aligned with the pin-records attribute. Echo the query
+        correlation token in the message header.
       type: object
       properties:
         items:
@@ -122,9 +117,9 @@ messages:
           maxItems: 100
           items:
             description: >-
-              Endpoint-scoped PIN metadata without credentials. TEMPORARY
-              requires both validity timestamps; PERMANENT forbids them.
-              Provisioning status is distinct from observation freshness.
+              Endpoint-scoped PIN metadata without credentials. TEMPORARY requires both validity
+              timestamps; PERMANENT forbids them. Provisioning status is distinct from observation
+              freshness.
             type: object
             properties:
               id:
@@ -159,26 +154,22 @@ messages:
         nextToken:
           type: string
           minLength: 1
-          description: >-
-            Opaque continuation bound to endpoint, caller and query; omitted on
-            the final page.
+          description: Opaque continuation bound to endpoint, caller and query; omitted on the final page.
       required:
         - items
       additionalProperties: false
   - name: query-operation
     description: >-
-      Retrieve an endpoint-scoped PIN operation result by its original
-      correlation token. Enforce caller and endpoint ownership. Return
-      pin-operation-result, preserving the original operation correlation token
-      in its payload and using this query's correlation token in the response
+      Retrieve an endpoint-scoped PIN operation result by its original correlation token. Enforce
+      caller and endpoint ownership. Return pin-operation-result, preserving the original operation
+      correlation token in its payload and using this query's correlation token in the response
       header.
     directionality: in
     schema:
       description: >-
-        Retrieve an endpoint-scoped PIN operation result by its original
-        correlation token. Enforce caller and endpoint ownership. Return
-        pin-operation-result, preserving the original operation correlation
-        token in its payload and using this query's correlation token in the
+        Retrieve an endpoint-scoped PIN operation result by its original correlation token. Enforce
+        caller and endpoint ownership. Return pin-operation-result, preserving the original
+        operation correlation token in its payload and using this query's correlation token in the
         response header.
       type: object
       properties:
@@ -190,15 +181,15 @@ messages:
       additionalProperties: false
   - name: query-pins
     description: >-
-      Query a bounded endpoint-scoped PIN record page. Requires message-send
-      permission. Continuations bind caller, endpoint and page size; return
-      pin-records-report with the request correlation token in its header.
+      Query a bounded endpoint-scoped PIN record page. Requires message-send permission.
+      Continuations bind caller, endpoint and page size; return pin-records-report with the request
+      correlation token in its header.
     directionality: in
     schema:
       description: >-
-        Query a bounded endpoint-scoped PIN record page. Requires message-send
-        permission. Continuations bind caller, endpoint and page size; return
-        pin-records-report with the request correlation token in its header.
+        Query a bounded endpoint-scoped PIN record page. Requires message-send permission.
+        Continuations bind caller, endpoint and page size; return pin-records-report with the
+        request correlation token in its header.
       type: object
       properties:
         maxResults:
@@ -212,15 +203,13 @@ messages:
       additionalProperties: false
   - name: update-pin
     description: >-
-      Update an endpoint-scoped record. Require at least one change. Kind is
-      immutable; validity changes require both timestamps and an authoritative
-      TEMPORARY record.
+      Update an endpoint-scoped record. Require at least one change. Kind is immutable; validity
+      changes require both timestamps and an authoritative TEMPORARY record.
     directionality: in
     schema:
       description: >-
-        Update an endpoint-scoped record. Require at least one change. Kind is
-        immutable; validity changes require both timestamps and an authoritative
-        TEMPORARY record.
+        Update an endpoint-scoped record. Require at least one change. Kind is immutable; validity
+        changes require both timestamps and an authoritative TEMPORARY record.
       type: object
       properties:
         id:
@@ -232,9 +221,7 @@ messages:
         pin:
           type: string
           writeOnly: true
-          description: >-
-            Credential preserved as a string. Redact from diagnostics and
-            persisted history.
+          description: Credential preserved as a string. Redact from diagnostics and persisted history.
         validFrom:
           type: string
           format: date-time
@@ -247,14 +234,14 @@ messages:
 attributes:
   - name: pin-records
     description: >-
-      Bounded endpoint-scoped PIN record page containing no credentials.
-      Permanent records omit validity bounds; temporary records include both.
-      Provisioning status is separate from observation freshness.
+      Bounded endpoint-scoped PIN record page containing no credentials. Permanent records omit
+      validity bounds; temporary records include both. Provisioning status is separate from
+      observation freshness.
     schema:
       description: >-
-        Bounded endpoint-scoped PIN record page containing no credentials.
-        Permanent records omit validity bounds; temporary records include both.
-        Provisioning status is separate from observation freshness.
+        Bounded endpoint-scoped PIN record page containing no credentials. Permanent records omit
+        validity bounds; temporary records include both. Provisioning status is separate from
+        observation freshness.
       type: object
       properties:
         items:
@@ -262,9 +249,9 @@ attributes:
           maxItems: 100
           items:
             description: >-
-              Endpoint-scoped PIN metadata without credentials. TEMPORARY
-              requires both validity timestamps; PERMANENT forbids them.
-              Provisioning status is distinct from observation freshness.
+              Endpoint-scoped PIN metadata without credentials. TEMPORARY requires both validity
+              timestamps; PERMANENT forbids them. Provisioning status is distinct from observation
+              freshness.
             type: object
             properties:
               id:
@@ -299,20 +286,18 @@ attributes:
         nextToken:
           type: string
           minLength: 1
-          description: >-
-            Opaque continuation bound to endpoint, caller and query; omitted on
-            the final page.
+          description: Opaque continuation bound to endpoint, caller and query; omitted on the final page.
       required:
         - items
       additionalProperties: false
   - name: pin-support
     description: >-
-      Verified optional restrictions from endpoint configuration. Omit unknown
-      restrictions; absence does not guarantee vendor acceptance.
+      Verified optional restrictions from endpoint configuration. Omit unknown restrictions; absence
+      does not guarantee vendor acceptance.
     schema:
       description: >-
-        Verified optional restrictions from endpoint configuration. Omit unknown
-        restrictions; absence does not guarantee vendor acceptance.
+        Verified optional restrictions from endpoint configuration. Omit unknown restrictions;
+        absence does not guarantee vendor acceptance.
       type: object
       properties:
         supportedKinds:
@@ -334,9 +319,8 @@ attributes:
       additionalProperties: false
 configuration:
   description: >-
-    Security PINs create, update, query, and delete PIN records. Follow
-    operation results and PIN reports when managing the records supported by a
-    device.
+    Security PINs create, update, query, and delete PIN records. Follow operation results and PIN
+    reports when managing the records supported by a device.
   type: object
   properties:
     supportedKinds:
@@ -355,9 +339,7 @@ configuration:
       minimum: 0
     pattern:
       type: string
-      description: >-
-        Explicit device PIN regular expression; absent means no character
-        restriction.
+      description: Explicit device PIN regular expression; absent means no character restriction.
   additionalProperties: false
 authorization:
   configuration: endpoint:read

package/generated/public/docs/references/capability-interfaces/smoke-co-alarm.yaml

@@ -2,9 +2,8 @@ name: smoke-co-alarm
 namespace: port1/systems/zero/capability-interfaces/smoke-co-alarm
 version: '1.0'
 description: >-
-  Smoke and carbon monoxide detectors report detection state. Devices expose
-  alarm controls through the alarm capability and charge level through the
-  battery capability.
+  Smoke and carbon monoxide detectors report detection state. Devices expose alarm controls through
+  the alarm capability and charge level through the battery capability.
 messages: []
 attributes:
   - name: alarm-state

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

@@ -2,8 +2,8 @@ name: snapshot
 namespace: port1/systems/zero/capability-interfaces/snapshot
 version: '1.0'
 description: >-
-  Snapshots request a captured view and return a snapshot response. Use them
-  when an integration needs a single capture rather than a continuous live view.
+  Snapshots request a captured view and return a snapshot response. Use them when an integration
+  needs a single capture rather than a continuous live view.
 messages:
   - name: get-snapshot
     description: null

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

@@ -2,8 +2,8 @@ name: soil-moisture-sensor
 namespace: port1/systems/zero/capability-interfaces/soil-moisture-sensor
 version: '1.0'
 description: >-
-  Soil moisture measurements report the reading supplied by a connected sensor.
-  Use the value as input when monitoring growing conditions.
+  Soil moisture measurements report the reading supplied by a connected sensor. Use the value as
+  input when monitoring growing conditions.
 messages: []
 attributes:
   - name: measured-value