docs: select-entity API definitions

Author: zehnm

CHANGELOG.md

@@ -23,6 +23,7 @@ _Changes in the next release_
 - Media-player entity: new attribute `media_position_updated_at`.
 - Dock 3 external port configuration.
 - Voice Assistant support.
+- Select Entity support.
 
 ---
 

core-api/README.md

@@ -27,6 +27,7 @@ in YAML format.
 
 | UCR Firmware  | Core Simulator | REST API | WS API |
 |---------------|----------------|----------|--------|
+|               | 0.68.0         | 0.44.0   | 0.34.0 |
 | 2.8.0-beta    | 0.66.4         | 0.43.1   | 0.33.0 |
 | 2.7.2-beta    | 0.65.1         | 0.42.0   | 0.32.0 |
 | 2.6.2-beta    | 0.62.0         | 0.40.0   | 0.31.0 |

core-api/rest/CHANGELOG.md

@@ -10,6 +10,10 @@ This section contains unreleased changes which will be part of an upcoming relea
 
 ---
 
+## 0.44.0
+### Added
+- New entity type `select`.
+
 ## 0.43.1
 ### Added
 - Touch slider configuration in an activity.

core-api/rest/UCR-core-openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Remote Two/3 REST Core-API
-  version: 0.43.0
+  version: 0.44.0
   contact:
     name: API Support
     url: 'https://github.com/unfoldedcircle/core-api/issues'
@@ -13245,6 +13245,7 @@ components:
         - macro
         - remote
         - ir_emitter
+        - select
         - voice_assistant
     ExternalSystems:
       type: array
@@ -15929,6 +15930,10 @@ components:
       properties:
         entity_id:
           $ref: '#/components/schemas/EntityId'
+        available:
+          description: |
+            Flag indicating if the referenced `entity_id` is still available or is a dangling reference.
+          type: boolean
         profile_id:
           $ref: '#/components/schemas/SimpleId'
       required:

core-api/websocket/CHANGELOG.md

@@ -10,6 +10,10 @@ This section contains unreleased changes which will be part of an upcoming relea
 
 ---
 
+## 0.34.0-beta
+### Added
+- New entity type `select`.
+
 ## 0.33.0-beta
 ### Changed
 - Voice assistant configuration refactoring.

core-api/websocket/UCR-core-asyncapi.yaml

@@ -8,7 +8,7 @@ asyncapi: 2.2.0
 id: 'urn:com:unfoldedcircle:core'
 info:
   title: Remote Two/3 WebSocket Core-API
-  version: '0.33.0-beta'
+  version: '0.34.0-beta'
   contact:
     name: API Support
     url: https://github.com/unfoldedcircle/core-api/issues
@@ -6730,6 +6730,7 @@ components:
             - entity_activity
             - entity_macro
             - entity_remote
+            - entity_select
             - activity_groups
             - integrations
             - profiles
@@ -7462,6 +7463,7 @@ components:
         - macro
         - remote
         - ir_emitter
+        - select
         - voice_assistant
 
     ActivityGroup:
@@ -8261,6 +8263,7 @@ components:
       properties:
         url:
           type: string
+          format: url
         mime_type:
           type: string
       required:

integration-api/UCR-integration-asyncapi.yaml

@@ -8,7 +8,7 @@ asyncapi: 2.2.0
 id: 'urn:com:unfoldedcircle:integration'
 info:
   title: Remote Two/3 WebSocket Integration API
-  version: '0.13.0-beta'
+  version: '0.14.0-beta'
   contact:
     name: API Support
     url: https://github.com/unfoldedcircle/core-api/issues
@@ -747,6 +747,16 @@ components:
               entity_type: cover
               entity_id: blind-2_cover-only
               cmd_id: close
+        - payload:
+            kind: req
+            id: 128
+            msg: entity_command
+            msg_data:
+              entity_type: select
+              entity_id: select-1
+              cmd_id: select_option
+              params:
+                option: "Option 1"
 
     # --- events
     entity_change:
@@ -1696,8 +1706,8 @@ components:
 
     entity:
       description: |
-        Common definition of an entity. Concrete entities are: `cover`, `button`, `climate`, `ir_emitter`, `light`,
-        `media_player`, `remote`,`sensor`, `switch`, `voice_assistant`. 
+        Common definition of an entity. Concrete entities are: `button`, `switch`, `light`, `cover`, `media_player`,
+        `climate`, `sensor`, `remote`, `ir_emitter`, `select`, `voice_assistant`. 
 
         See [entity documentation](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/)
         for more information.
@@ -2174,6 +2184,25 @@ components:
                     🚧 Optional maximum value of the sensor output. This can be used in the UI for graphs or gauges.
                   type: number
 
+    select:
+      description: |
+        The select entity offers a limited set of selectable options.
+        The available options are defined by the integration driver. They can be a static list or dynamically generated
+        and changed at runtime.
+
+        See [select entity documentation](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_select.md)
+        for more information.
+      allOf:
+        - $ref: '#/components/schemas/entity'
+        - type: object
+          properties:
+            features:
+              description: The select entity has no features.
+              type: array
+            options:
+              description: The select entity has no options.
+              type: object
+
     voice_assistant:
       description: |
         A voice assistant entity can be used to receive a microphone input stream suitable to send voice commands
@@ -2429,6 +2458,7 @@ components:
             - sensor
             - remote
             - ir_emitter
+            - select
             - voice_assistant
         - {}  # extensible enum: there might be more supported entity types in a newer implementation than defined above