Added remote entity in addition of media player entity

README.md

@@ -18,8 +18,8 @@ development.
 
 - [Requirements and setting](docs/settings.md).
 - Multiple Android TV devices are supported with version 0.5.0 and newer.
-- A [media player entity](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_media_player.md)
-  is exposed per Android TV device to the Remote.
+- A [media player entity](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_media_player.md) and a [remote entity](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_remote.md)
+  are exposed per Android TV device to the Remote.
 - Device profiles allow device-specific support and custom key bindings, for example, double-click or long-press actions.  
   See [command mappings](docs/command_mapping.md) for more information.
 
@@ -30,6 +30,78 @@ Preview features:
 
 The preview features are not enabled by default. They can be enabled in the device configuration of the setup flow.
 
+## Configuration
+
+After running the setup flow and configuring your device, 2 new entities will be available :
+- Media Player entity : should cover most needs with predefined commands
+- Remote entity : should be used to run custom commands or command sequences
+
+The available commands depend on the device capabilities :
+
+| Command           | Description         |
+|-------------------|---------------------|
+| on                | Turn on             |
+| off               | Turn off            |
+| toggle            | Power toggle        |
+| play_pause        | Play/pause          |
+| stop              | Stop                |
+| previous          | Previous chapter    |
+| next              | Next chapter        |
+| fast_forward      | Fast forward        |
+| rewind            | Rewind              |
+| volume_up         | Volume up           |
+| volume_down       | Volume down         |
+| mute_toggle       | Mute toggle         |
+| mute              | Mute                |
+| unmute            | Unmute              |
+| repeat            | Repeat              |
+| shuffle           | Shuffle             |
+| channel_up        | Channel up          |
+| channel_down      | Channel down        |
+| cursor_up         | Cursor up           |
+| cursor_down       | Cursor down         |
+| cursor_left       | Cursor left         |
+| cursor_right      | Cursor right        |
+| cursor_enter      | Cursor enter        |
+| digit_0           | 0                   |
+| digit_1           | 1                   |
+| digit_2           | 2                   |
+| digit_3           | 3                   |
+| digit_4           | 4                   |
+| digit_5           | 5                   |
+| digit_6           | 6                   |
+| digit_7           | 7                   |
+| digit_8           | 8                   |
+| digit_9           | 9                   |
+| function_red      | Red                 |
+| function_green    | Green               |
+| function_yellow   | Yellow              |
+| function_blue     | Blue                |
+| home              | Home                |
+| menu              | Menu                |
+| context_menu      | Context menu        |
+| guide             | Guide               |
+| info              | Info                |
+| back              | Back                |
+| record            | Record              |
+| my_recordings     | My recordings       |
+| live              | Live                |
+| audio_track       | Next audio track    |
+| subtitle          | Next subtitle track |
+| settings          | Settings            |
+
+In addition these specific commands are also available depending on the device capabilities :
+
+**Any device :**
+`CURSOR_ENTER_LONG, HOME_LONG, MENU_LONG, KEYCODE_STAR, KEYCODE_POUND, KEYCODE_A to KEYCODE_Z, KEYCODE_COMMA, KEYCODE_PERIOD, KEYCODE_SPACE, KEYCODE_DEL, KEYCODE_MINUS, KEYCODE_EQUALS, KEYCODE_LEFT_BRACKET, KEYCODE_RIGHT_BRACKET, KEYCODE_BACKSLASH, KEYCODE_SEMICOLON, KEYCODE_APOSTROPHE, KEYCODE_SLASH, KEYCODE_AT, KEYCODE_PLUS, KEYCODE_PAGE_UP, KEYCODE_PAGE_DOWN, KEYCODE_F1 to KEYCODE_F12`
+
+**Dune HD :** `YOUTUBE, NETFLIX, PRIMEVIDEO, FACTORYTEST, DISNEY`
+
+**Shield TV :** `SCREENSAVER`
+
+**Philips Android TV:** `TELETEXT`
+
+
 ## Standalone Usage
 ### Setup
 

driver.json

@@ -41,5 +41,5 @@
 			}
 		]
 	},
-	"release_date": "2025-09-18"
+	"release_date": "2025-09-06"
 }

src/config.py

@@ -13,11 +13,30 @@
 from dataclasses import dataclass
 from typing import Iterator
 
+from ucapi import EntityTypes
+
 _LOG = logging.getLogger(__name__)
 
 _CFG_FILENAME = "config.json"
 
 
+def create_entity_id(device_id: str, entity_type: EntityTypes) -> str:
+    """Create a unique entity identifier for the given receiver and entity type."""
+    return f"{entity_type.value}.{device_id}"
+
+
+def device_from_entity_id(entity_id: str) -> str | None:
+    """
+    Return the device id prefix of an entity_id.
+
+    The prefix is the part before the first dot in the name and refers to the device identifier.
+
+    :param entity_id: the entity identifier
+    :return: the device prefix, or None if entity_id doesn't contain a dot
+    """
+    return entity_id.split(".", 1)[1]
+
+
 @dataclass
 class AtvDevice:
     """Android TV device configuration."""

src/const.py

@@ -0,0 +1,104 @@
+"""
+Android TV constants.
+
+:copyright: (c) 2023-2025 by Unfolded Circle ApS.
+:license: MPL-2.0, see LICENSE for more details.
+"""
+
+from ucapi.media_player import Commands
+
+# pylint: disable=C0301
+from ucapi.ui import Buttons, DeviceButtonMapping, EntityCommand, UiPage
+
+REMOTE_BUTTONS_MAPPING: list[DeviceButtonMapping] = [
+    DeviceButtonMapping(button=Buttons.BACK, short_press=EntityCommand(**{"cmd_id": Commands.BACK})),
+    DeviceButtonMapping(button=Buttons.HOME, short_press=EntityCommand(**{"cmd_id": Commands.HOME})),
+    DeviceButtonMapping(button=Buttons.CHANNEL_DOWN, short_press=EntityCommand(**{"cmd_id": Commands.CHANNEL_DOWN})),
+    DeviceButtonMapping(button=Buttons.CHANNEL_UP, short_press=EntityCommand(**{"cmd_id": Commands.CHANNEL_UP})),
+    DeviceButtonMapping(button=Buttons.DPAD_UP, short_press=EntityCommand(**{"cmd_id": Commands.CURSOR_UP})),
+    DeviceButtonMapping(button=Buttons.DPAD_DOWN, short_press=EntityCommand(**{"cmd_id": Commands.CURSOR_DOWN})),
+    DeviceButtonMapping(button=Buttons.DPAD_LEFT, short_press=EntityCommand(**{"cmd_id": Commands.CURSOR_LEFT})),
+    DeviceButtonMapping(button=Buttons.DPAD_RIGHT, short_press=EntityCommand(**{"cmd_id": Commands.CURSOR_RIGHT})),
+    DeviceButtonMapping(button=Buttons.DPAD_MIDDLE, short_press=EntityCommand(**{"cmd_id": Commands.CURSOR_ENTER})),
+    DeviceButtonMapping(button=Buttons.PLAY, short_press=EntityCommand(**{"cmd_id": Commands.PLAY_PAUSE})),
+    DeviceButtonMapping(button=Buttons.PREV, short_press=EntityCommand(**{"cmd_id": Commands.PREVIOUS})),
+    DeviceButtonMapping(button=Buttons.NEXT, short_press=EntityCommand(**{"cmd_id": Commands.NEXT})),
+    DeviceButtonMapping(button=Buttons.VOLUME_UP, short_press=EntityCommand(**{"cmd_id": Commands.VOLUME_UP})),
+    DeviceButtonMapping(button=Buttons.VOLUME_DOWN, short_press=EntityCommand(**{"cmd_id": Commands.VOLUME_DOWN})),
+    DeviceButtonMapping(button=Buttons.MUTE, short_press=EntityCommand(**{"cmd_id": Commands.MUTE_TOGGLE})),
+    DeviceButtonMapping(button=Buttons.STOP, short_press=EntityCommand(**{"cmd_id": Commands.STOP})),
+    DeviceButtonMapping(button=Buttons.MENU, short_press=EntityCommand(**{"cmd_id": Commands.CONTEXT_MENU})),
+]
+
+
+REMOTE_UI_PAGES: list[UiPage] = [
+    UiPage(
+        **{
+            "page_id": "Android TV numbers",
+            "name": "Android TV numbers",
+            "grid": {"height": 4, "width": 3},
+            "items": [
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_1}},
+                    "location": {"x": 0, "y": 0},
+                    "text": "1",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_2}},
+                    "location": {"x": 1, "y": 0},
+                    "text": "2",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_3}},
+                    "location": {"x": 2, "y": 0},
+                    "text": "3",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_4}},
+                    "location": {"x": 0, "y": 1},
+                    "text": "4",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_5}},
+                    "location": {"x": 1, "y": 1},
+                    "text": "5",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_6}},
+                    "location": {"x": 2, "y": 1},
+                    "text": "6",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_7}},
+                    "location": {"x": 0, "y": 2},
+                    "text": "7",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_8}},
+                    "location": {"x": 1, "y": 2},
+                    "text": "8",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_9}},
+                    "location": {"x": 2, "y": 2},
+                    "text": "9",
+                    "type": "text",
+                },
+                {
+                    "command": {"cmd_id": "remote.send", "params": {"command": Commands.DIGIT_0}},
+                    "location": {"x": 1, "y": 3},
+                    "text": "0",
+                    "type": "text",
+                },
+            ],
+        }
+    ),
+]