@portpowered/reference-data 0.0.0-stage → 0.4.0

package/generated/public/docs/references/capability-interfaces/color-temperature/1.0/messages/set-color-temperature.yaml

@@ -0,0 +1,15 @@
+type: object
+required:
+  - colorTemperatureInKelvin
+properties:
+  colorTemperatureInKelvin:
+    type: integer
+    description: >-
+      The colorTemperatureInKelvin property represents the color temperature in
+      degrees Kelvin of an endpoint, and is used by endpoints that support
+      tunable white light. Valid values range from 1,000 to 10,000 absolute
+      Kelvin.
+
+      The color values roughly map to:  - warm white: 2000 - soft white: 2500 -
+      white: 4000 - daylight white: 5500 - cool white: 7000
+additionalProperties: false

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

@@ -0,0 +1,54 @@
+name: color-temperature
+namespace: port1/systems/zero/capability-interfaces/color-temperature
+version: '1.0'
+description: >-
+  Color temperature adjusts a light between warmer and cooler tones. Set a temperature directly or
+  increase and decrease it, then read the reported value in kelvin.
+messages:
+  - name: decrease-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      additionalProperties: false
+  - name: increase-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      additionalProperties: false
+  - name: set-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      required:
+        - colorTemperatureInKelvin
+      properties:
+        colorTemperatureInKelvin:
+          type: integer
+          description: >-
+            The colorTemperatureInKelvin property represents the color temperature in degrees Kelvin
+            of an endpoint, and is used by endpoints that support tunable white light. Valid values
+            range from 1,000 to 10,000 absolute Kelvin.
+
+            The color values roughly map to:  - warm white: 2000 - soft white: 2500 - white: 4000 -
+            daylight white: 5500 - cool white: 7000
+      additionalProperties: false
+attributes:
+  - name: color-temperature-in-kelvin
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: integer
+      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/color-temperature.yaml

@@ -0,0 +1,56 @@
+name: color-temperature
+namespace: port1/systems/zero/capability-interfaces/color-temperature
+version: '1.0'
+description: >-
+  Color temperature adjusts a light between warmer and cooler tones. Set a
+  temperature directly or increase and decrease it, then read the reported value
+  in kelvin.
+messages:
+  - name: decrease-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      additionalProperties: false
+  - name: increase-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      additionalProperties: false
+  - name: set-color-temperature
+    description: null
+    directionality: in
+    schema:
+      type: object
+      required:
+        - colorTemperatureInKelvin
+      properties:
+        colorTemperatureInKelvin:
+          type: integer
+          description: >-
+            The colorTemperatureInKelvin property represents the color
+            temperature in degrees Kelvin of an endpoint, and is used by
+            endpoints that support tunable white light. Valid values range from
+            1,000 to 10,000 absolute Kelvin.
+
+            The color values roughly map to:  - warm white: 2000 - soft white:
+            2500 - white: 4000 - daylight white: 5500 - cool white: 7000
+      additionalProperties: false
+attributes:
+  - name: color-temperature-in-kelvin
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: integer
+      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/color.yaml

@@ -0,0 +1,61 @@
+name: color
+namespace: port1/systems/zero/capability-interfaces/color
+version: '1.0'
+description: >-
+  Color sets and reports the color of a connected device. Use it to coordinate
+  lighting for a scene or let an assistant choose a new color.
+messages:
+  - name: set-color
+    description: null
+    directionality: in
+    schema:
+      type: object
+      required:
+        - color
+      properties:
+        color:
+          type: object
+          description: A color in HSB (Hue, Saturation, Brightness) color space
+          properties:
+            hue:
+              type: number
+            saturation:
+              type: number
+            brightness:
+              type: number
+          required:
+            - hue
+            - saturation
+            - brightness
+          title: HsbColor
+      additionalProperties: false
+attributes:
+  - name: color
+    description: null
+    schema:
+      type: object
+      properties:
+        color:
+          type: object
+          description: A color in HSB (Hue, Saturation, Brightness) color space
+          properties:
+            hue:
+              type: number
+            saturation:
+              type: number
+            brightness:
+              type: number
+          required:
+            - hue
+            - saturation
+            - brightness
+          title: HsbColor
+      required:
+        - color
+      additionalProperties: false
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

package/generated/public/docs/references/capability-interfaces/connectivity/1.0/attributes/network-throughput.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  quality:
+    type: string
+  bitsPerSecond:
+    type: integer
+additionalProperties: false

package/generated/public/docs/references/capability-interfaces/connectivity/1.0/attributes/radio-diagnostics.yaml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  values:
+    type: array
+    items:
+      type: object
+      description: A radio diagnostic measurement
+      properties:
+        radioType:
+          type: string
+        rssi:
+          type: number
+        snr:
+          type: number
+      title: RadioDiagnosticValue
+required:
+  - values
+additionalProperties: false

package/generated/public/docs/references/capability-interfaces/connectivity/1.0/attributes/reachability.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  value:
+    type: string
+    enum:
+      - OK
+      - UNREACHABLE
+required:
+  - value
+additionalProperties: false

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

@@ -0,0 +1,58 @@
+name: connectivity
+namespace: port1/systems/zero/capability-interfaces/connectivity
+version: '1.0'
+description: >-
+  Connectivity tells you whether a connected device is reachable. Use its reported state to explain
+  an unavailable device or decide when to retry an action.
+messages: []
+attributes:
+  - name: network-throughput
+    description: null
+    schema:
+      type: object
+      properties:
+        quality:
+          type: string
+        bitsPerSecond:
+          type: integer
+      additionalProperties: false
+  - name: radio-diagnostics
+    description: null
+    schema:
+      type: object
+      properties:
+        values:
+          type: array
+          items:
+            type: object
+            description: A radio diagnostic measurement
+            properties:
+              radioType:
+                type: string
+              rssi:
+                type: number
+              snr:
+                type: number
+            title: RadioDiagnosticValue
+      required:
+        - values
+      additionalProperties: false
+  - name: reachability
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - OK
+            - UNREACHABLE
+      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/connectivity.yaml

@@ -0,0 +1,59 @@
+name: connectivity
+namespace: port1/systems/zero/capability-interfaces/connectivity
+version: '1.0'
+description: >-
+  Connectivity tells you whether a connected device is reachable. Use its
+  reported state to explain an unavailable device or decide when to retry an
+  action.
+messages: []
+attributes:
+  - name: network-throughput
+    description: null
+    schema:
+      type: object
+      properties:
+        quality:
+          type: string
+        bitsPerSecond:
+          type: integer
+      additionalProperties: false
+  - name: radio-diagnostics
+    description: null
+    schema:
+      type: object
+      properties:
+        values:
+          type: array
+          items:
+            type: object
+            description: A radio diagnostic measurement
+            properties:
+              radioType:
+                type: string
+              rssi:
+                type: number
+              snr:
+                type: number
+            title: RadioDiagnosticValue
+      required:
+        - values
+      additionalProperties: false
+  - name: reachability
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - OK
+            - UNREACHABLE
+      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/contact-sensor/1.0/attributes/detection-state.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  value:
+    type: string
+    enum:
+      - NOT_DETECTED
+      - DETECTED
+required:
+  - value
+additionalProperties: false

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

@@ -0,0 +1,27 @@
+name: contact-sensor
+namespace: port1/systems/zero/capability-interfaces/contact-sensor
+version: '1.0'
+description: >-
+  Contact sensors tell you whether a door, window, or gate is open or closed. Use their reported
+  state to check an entryway or trigger an automation when something is left open.
+messages: []
+attributes:
+  - name: detection-state
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - NOT_DETECTED
+            - DETECTED
+      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/contact-sensor.yaml

@@ -0,0 +1,28 @@
+name: contact-sensor
+namespace: port1/systems/zero/capability-interfaces/contact-sensor
+version: '1.0'
+description: >-
+  Contact sensors tell you whether a door, window, or gate is open or closed.
+  Use their reported state to check an entryway or trigger an automation when
+  something is left open.
+messages: []
+attributes:
+  - name: detection-state
+    description: null
+    schema:
+      type: object
+      properties:
+        value:
+          type: string
+          enum:
+            - NOT_DETECTED
+            - DETECTED
+      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/contacts-provider/1.0/messages/list-contacts-response.yaml

@@ -0,0 +1,23 @@
+description: Response containing a list of contacts from a contacts provider
+type: object
+properties:
+  contacts:
+    type: array
+    items:
+      type: object
+      description: A contact entry
+      properties:
+        contactId:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        companyName:
+          type: string
+      required:
+        - contactId
+      title: Contact
+required:
+  - contacts
+additionalProperties: false

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

@@ -0,0 +1,3 @@
+description: Request to list contacts from a contacts provider
+type: object
+additionalProperties: false

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

@@ -0,0 +1,48 @@
+name: contacts-provider
+namespace: port1/systems/zero/capability-interfaces/contacts-provider
+version: '1.0'
+description: >-
+  Contacts providers list contacts from a connected account. Use the returned records to give an
+  assistant the contact information available to your integration.
+messages:
+  - name: list-contacts
+    description: Request to list contacts from a contacts provider
+    directionality: in
+    schema:
+      description: Request to list contacts from a contacts provider
+      type: object
+      additionalProperties: false
+  - name: list-contacts-response
+    description: Response containing a list of contacts from a contacts provider
+    directionality: out
+    schema:
+      description: Response containing a list of contacts from a contacts provider
+      type: object
+      properties:
+        contacts:
+          type: array
+          items:
+            type: object
+            description: A contact entry
+            properties:
+              contactId:
+                type: string
+              firstName:
+                type: string
+              lastName:
+                type: string
+              companyName:
+                type: string
+            required:
+              - contactId
+            title: Contact
+      required:
+        - contacts
+      additionalProperties: false
+attributes: []
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

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

@@ -0,0 +1,49 @@
+name: contacts-provider
+namespace: port1/systems/zero/capability-interfaces/contacts-provider
+version: '1.0'
+description: >-
+  Contacts providers list contacts from a connected account. Use the returned
+  records to give an assistant the contact information available to your
+  integration.
+messages:
+  - name: list-contacts
+    description: Request to list contacts from a contacts provider
+    directionality: in
+    schema:
+      description: Request to list contacts from a contacts provider
+      type: object
+      additionalProperties: false
+  - name: list-contacts-response
+    description: Response containing a list of contacts from a contacts provider
+    directionality: out
+    schema:
+      description: Response containing a list of contacts from a contacts provider
+      type: object
+      properties:
+        contacts:
+          type: array
+          items:
+            type: object
+            description: A contact entry
+            properties:
+              contactId:
+                type: string
+              firstName:
+                type: string
+              lastName:
+                type: string
+              companyName:
+                type: string
+            required:
+              - contactId
+            title: Contact
+      required:
+        - contacts
+      additionalProperties: false
+attributes: []
+configuration: null
+authorization:
+  configuration: endpoint:read
+  attributes: endpoint:read
+  inboundMessages: message:send
+  resourcePermissionRequired: true

package/generated/public/docs/references/capability-interfaces/content-launcher/1.0/messages/launch-content.yaml

@@ -0,0 +1,33 @@
+type: object
+properties:
+  search:
+    type: object
+    description: Content search criteria
+    properties:
+      parameterList:
+        type: array
+        items:
+          type: object
+          description: A content search parameter
+          properties:
+            type:
+              type: string
+              enum:
+                - VIDEO
+                - AUDIO
+                - IMAGE
+                - OTHER
+            value:
+              type: string
+          required:
+            - type
+            - value
+          additionalProperties: false
+          title: ContentSearchParameter
+    additionalProperties: false
+    title: ContentSearch
+  autoPlay:
+    type: boolean
+    description: Whether to auto-play the content
+    default: true
+additionalProperties: false

package/generated/public/docs/references/capability-interfaces/content-launcher/1.0/messages/launch-url.yaml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  contentUrl:
+    type: string
+    format: uri
+    description: URL of the content to launch
+  displayString:
+    type: string
+    description: Display string for the content
+  brandingInformation:
+    type: object
+    description: Content provider branding information
+    properties:
+      providerName:
+        type: string
+        description: Provider name
+      background:
+        type: string
+        format: uri
+        description: Background image URL
+      logo:
+        type: string
+        format: uri
+        description: Logo image URL
+    additionalProperties: false
+    title: BrandingInformation
+required:
+  - contentUrl
+additionalProperties: false