@portpowered/reference-data 0.0.0-stage → 0.4.0

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

@@ -0,0 +1,120 @@
+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.
+messages:
+  - name: set-mode
+    description: null
+    directionality: in
+    schema:
+      type: object
+      properties:
+        mode:
+          type: string
+          enum:
+            - STANDARD
+            - CONSTANT_SPEED
+            - CONSTANT_PRESSURE
+            - PROPORTIONAL_PRESSURE
+            - CONSTANT_FLOW
+            - PROPORTIONAL_FLOW
+            - CONSTANT_TEMPERATURE
+            - AUTOMATIC
+      required:
+        - mode
+      additionalProperties: false
+  - name: set-speed
+    description: null
+    directionality: in
+    schema:
+      type: object
+      properties:
+        speed:
+          type: integer
+          description: Pump speed percentage (0-100)
+          minimum: 0
+          maximum: 100
+      required:
+        - speed
+      additionalProperties: false
+attributes:
+  - name: capacity
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: number
+          description: Pump capacity
+          minimum: 0
+      required:
+        - value
+      additionalProperties: false
+  - name: pump-mode
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - STANDARD
+            - CONSTANT_SPEED
+            - CONSTANT_PRESSURE
+            - PROPORTIONAL_PRESSURE
+            - CONSTANT_FLOW
+            - PROPORTIONAL_FLOW
+            - CONSTANT_TEMPERATURE
+            - AUTOMATIC
+      required:
+        - value
+      additionalProperties: false
+  - name: pump-status
+    description: null
+    schema:
+      type: object
+      properties:
+        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.
+          enum:
+            - STOPPED
+            - RUNNING
+            - PAUSED
+            - ERROR
+            - CHARGING
+            - DOCKED
+            - RETURNING_TO_DOCK
+      required:
+        - value
+      additionalProperties: false
+configuration:
+  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.
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

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

@@ -0,0 +1,121 @@
+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.
+messages:
+  - name: set-mode
+    description: null
+    directionality: in
+    schema:
+      type: object
+      properties:
+        mode:
+          type: string
+          enum:
+            - STANDARD
+            - CONSTANT_SPEED
+            - CONSTANT_PRESSURE
+            - PROPORTIONAL_PRESSURE
+            - CONSTANT_FLOW
+            - PROPORTIONAL_FLOW
+            - CONSTANT_TEMPERATURE
+            - AUTOMATIC
+      required:
+        - mode
+      additionalProperties: false
+  - name: set-speed
+    description: null
+    directionality: in
+    schema:
+      type: object
+      properties:
+        speed:
+          type: integer
+          description: Pump speed percentage (0-100)
+          minimum: 0
+          maximum: 100
+      required:
+        - speed
+      additionalProperties: false
+attributes:
+  - name: capacity
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: number
+          description: Pump capacity
+          minimum: 0
+      required:
+        - value
+      additionalProperties: false
+  - name: pump-mode
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - STANDARD
+            - CONSTANT_SPEED
+            - CONSTANT_PRESSURE
+            - PROPORTIONAL_PRESSURE
+            - CONSTANT_FLOW
+            - PROPORTIONAL_FLOW
+            - CONSTANT_TEMPERATURE
+            - AUTOMATIC
+      required:
+        - value
+      additionalProperties: false
+  - name: pump-status
+    description: null
+    schema:
+      type: object
+      properties:
+        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.
+          enum:
+            - STOPPED
+            - RUNNING
+            - PAUSED
+            - ERROR
+            - CHARGING
+            - DOCKED
+            - RETURNING_TO_DOCK
+      required:
+        - value
+      additionalProperties: false
+configuration:
+  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.
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/delete-recording-response.yaml

@@ -0,0 +1,4 @@
+description: Delete recording response.
+type: object
+additionalProperties: false
+title: RecordingsInterfaceDeleteRecordingResponseMessage

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/delete-recording.yaml

@@ -0,0 +1,11 @@
+description: Delete recording.
+type: object
+properties:
+  recordingId:
+    type: string
+    minLength: 1
+    description: Provider recording identifier.
+required:
+  - recordingId
+additionalProperties: false
+title: RecordingsInterfaceDeleteRecordingMessage

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/download-recording-response.yaml

@@ -0,0 +1,11 @@
+description: Download recording response.
+type: object
+properties:
+  uri:
+    type: string
+    format: uri
+    description: Provider URL for downloading the recording.
+required:
+  - uri
+additionalProperties: false
+title: RecordingsInterfaceDownloadRecordingResponseMessage

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/download-recording.yaml

@@ -0,0 +1,11 @@
+description: Download recording.
+type: object
+properties:
+  recordingId:
+    type: string
+    minLength: 1
+    description: Provider recording identifier.
+required:
+  - recordingId
+additionalProperties: false
+title: RecordingsInterfaceDownloadRecordingMessage

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/list-recordings-response.yaml

@@ -0,0 +1,44 @@
+description: List recordings response.
+type: object
+properties:
+  items:
+    type: array
+    items:
+      type: object
+      description: A stored recording.
+      properties:
+        recordingId:
+          type: string
+          minLength: 1
+          description: Provider identifier of the recording.
+        mediaId:
+          title: MediaId
+          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.
+        startedAt:
+          type: string
+          format: date-time
+          description: Recording start time.
+        durationSeconds:
+          type: number
+          minimum: 0
+          description: Recording duration in seconds.
+      required:
+        - recordingId
+      additionalProperties: false
+      title: Recording
+    description: Recordings in this page.
+  nextCursor:
+    type: string
+    description: >-
+      Opaque cursor for the next page; omitted when there are no further
+      results.
+required:
+  - items
+additionalProperties: false
+title: RecordingsInterfaceListRecordingsResponseMessage

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

@@ -0,0 +1,23 @@
+description: List recordings.
+type: object
+properties:
+  cursor:
+    type: string
+    description: >-
+      Opaque cursor for the next page; omitted when there are no further
+      results.
+  maxResults:
+    type: integer
+    minimum: 1
+    maximum: 1000
+    description: Maximum number of items to return.
+  from:
+    type: string
+    format: date-time
+    description: Inclusive start time.
+  to:
+    type: string
+    format: date-time
+    description: Exclusive end time.
+additionalProperties: false
+title: RecordingsInterfaceListRecordingsMessage

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

@@ -0,0 +1,138 @@
+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.
+messages:
+  - name: delete-recording
+    description: Delete recording.
+    directionality: in
+    schema:
+      description: Delete recording.
+      type: object
+      properties:
+        recordingId:
+          type: string
+          minLength: 1
+          description: Provider recording identifier.
+      required:
+        - recordingId
+      additionalProperties: false
+      title: RecordingsInterfaceDeleteRecordingMessage
+  - name: delete-recording-response
+    description: Delete recording response.
+    directionality: out
+    schema:
+      description: Delete recording response.
+      type: object
+      additionalProperties: false
+      title: RecordingsInterfaceDeleteRecordingResponseMessage
+  - name: download-recording
+    description: Download recording.
+    directionality: in
+    schema:
+      description: Download recording.
+      type: object
+      properties:
+        recordingId:
+          type: string
+          minLength: 1
+          description: Provider recording identifier.
+      required:
+        - recordingId
+      additionalProperties: false
+      title: RecordingsInterfaceDownloadRecordingMessage
+  - name: download-recording-response
+    description: Download recording response.
+    directionality: out
+    schema:
+      description: Download recording response.
+      type: object
+      properties:
+        uri:
+          type: string
+          format: uri
+          description: Provider URL for downloading the recording.
+      required:
+        - uri
+      additionalProperties: false
+      title: RecordingsInterfaceDownloadRecordingResponseMessage
+  - name: list-recordings
+    description: List recordings.
+    directionality: in
+    schema:
+      description: List recordings.
+      type: object
+      properties:
+        cursor:
+          type: string
+          description: Opaque cursor for the next page; omitted when there are no further results.
+        maxResults:
+          type: integer
+          minimum: 1
+          maximum: 1000
+          description: Maximum number of items to return.
+        from:
+          type: string
+          format: date-time
+          description: Inclusive start time.
+        to:
+          type: string
+          format: date-time
+          description: Exclusive end time.
+      additionalProperties: false
+      title: RecordingsInterfaceListRecordingsMessage
+  - name: list-recordings-response
+    description: List recordings response.
+    directionality: out
+    schema:
+      description: List recordings response.
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            type: object
+            description: A stored recording.
+            properties:
+              recordingId:
+                type: string
+                minLength: 1
+                description: Provider identifier of the recording.
+              mediaId:
+                title: MediaId
+                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.
+              startedAt:
+                type: string
+                format: date-time
+                description: Recording start time.
+              durationSeconds:
+                type: number
+                minimum: 0
+                description: Recording duration in seconds.
+            required:
+              - recordingId
+            additionalProperties: false
+            title: Recording
+          description: Recordings in this page.
+        nextCursor:
+          type: string
+          description: Opaque cursor for the next page; omitted when there are no further results.
+      required:
+        - items
+      additionalProperties: false
+      title: RecordingsInterfaceListRecordingsResponseMessage
+attributes: []
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

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

@@ -0,0 +1,142 @@
+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.
+messages:
+  - name: delete-recording
+    description: Delete recording.
+    directionality: in
+    schema:
+      description: Delete recording.
+      type: object
+      properties:
+        recordingId:
+          type: string
+          minLength: 1
+          description: Provider recording identifier.
+      required:
+        - recordingId
+      additionalProperties: false
+      title: RecordingsInterfaceDeleteRecordingMessage
+  - name: delete-recording-response
+    description: Delete recording response.
+    directionality: out
+    schema:
+      description: Delete recording response.
+      type: object
+      additionalProperties: false
+      title: RecordingsInterfaceDeleteRecordingResponseMessage
+  - name: download-recording
+    description: Download recording.
+    directionality: in
+    schema:
+      description: Download recording.
+      type: object
+      properties:
+        recordingId:
+          type: string
+          minLength: 1
+          description: Provider recording identifier.
+      required:
+        - recordingId
+      additionalProperties: false
+      title: RecordingsInterfaceDownloadRecordingMessage
+  - name: download-recording-response
+    description: Download recording response.
+    directionality: out
+    schema:
+      description: Download recording response.
+      type: object
+      properties:
+        uri:
+          type: string
+          format: uri
+          description: Provider URL for downloading the recording.
+      required:
+        - uri
+      additionalProperties: false
+      title: RecordingsInterfaceDownloadRecordingResponseMessage
+  - name: list-recordings
+    description: List recordings.
+    directionality: in
+    schema:
+      description: List recordings.
+      type: object
+      properties:
+        cursor:
+          type: string
+          description: >-
+            Opaque cursor for the next page; omitted when there are no further
+            results.
+        maxResults:
+          type: integer
+          minimum: 1
+          maximum: 1000
+          description: Maximum number of items to return.
+        from:
+          type: string
+          format: date-time
+          description: Inclusive start time.
+        to:
+          type: string
+          format: date-time
+          description: Exclusive end time.
+      additionalProperties: false
+      title: RecordingsInterfaceListRecordingsMessage
+  - name: list-recordings-response
+    description: List recordings response.
+    directionality: out
+    schema:
+      description: List recordings response.
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            type: object
+            description: A stored recording.
+            properties:
+              recordingId:
+                type: string
+                minLength: 1
+                description: Provider identifier of the recording.
+              mediaId:
+                title: MediaId
+                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.
+              startedAt:
+                type: string
+                format: date-time
+                description: Recording start time.
+              durationSeconds:
+                type: number
+                minimum: 0
+                description: Recording duration in seconds.
+            required:
+              - recordingId
+            additionalProperties: false
+            title: Recording
+          description: Recordings in this page.
+        nextCursor:
+          type: string
+          description: >-
+            Opaque cursor for the next page; omitted when there are no further
+            results.
+      required:
+        - items
+      additionalProperties: false
+      title: RecordingsInterfaceListRecordingsResponseMessage
+attributes: []
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

package/generated/public/docs/references/capability-interfaces/refrigerator/1.0/attributes/temperature.yaml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  value:
+    type: number
+    description: Temperature in degrees Celsius
+required:
+  - value
+additionalProperties: false

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

@@ -0,0 +1,25 @@
+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.
+messages: []
+attributes:
+  - name: temperature
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: number
+          description: Temperature in degrees Celsius
+      required:
+        - value
+      additionalProperties: false
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

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

@@ -0,0 +1,25 @@
+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.
+messages: []
+attributes:
+  - name: temperature
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: number
+          description: Temperature in degrees Celsius
+      required:
+        - value
+      additionalProperties: false
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true