Skip to content

Commit 046edba

Browse files
committed
docs: updated README with requirements, settings, known issues
1 parent 1e6e3f2 commit 046edba

File tree

2 files changed

+53
-5
lines changed

2 files changed

+53
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Source list is limited to a predefined list as retrieving a list of installed ap
88

99
This integration is included in the Remote Two firmware and no external service must be run to connect with Android TV
1010
devices. A standalone service can be used for development or connecting multiple devices.
11-
A single instance of the integration doesn't support multiple Android TV devices yet (planned: [#14](https://github.com/aitatoi/integration-androidtv/issues/14)).
1211

13-
Device profiles allow device specific support and custom key bindings, for example double-click or long-press actions.
14-
See [command mappings](docs/command_mapping.md) for more information.
12+
- [Requirements and setting](docs/settings.md).
13+
- Multiple Android TV devices are supported with version 0.5.0 and newer.
14+
- Device profiles allow device specific support and custom key bindings, for example double-click or long-press actions.
15+
See [command mappings](docs/command_mapping.md) for more information.
1516

1617
## Standalone Usage
1718
### Setup
@@ -38,8 +39,10 @@ For running a separate integration driver on your network for Remote Two, the co
3839
UC_CONFIG_HOME=./config python3 intg-androidtv/driver.py
3940
```
4041

41-
See available [environment variables](https://github.com/unfoldedcircle/integration-python-library#environment-variables)
42-
in the Python integration library to control certain runtime features like listening interface and configuration directory.
42+
- See available [environment variables](https://github.com/unfoldedcircle/integration-python-library#environment-variables)
43+
in the Python integration library to control certain runtime features like listening interface and configuration directory.
44+
- The client name used for the client certificate can be set in ENV variable `UC_CLIENT_NAME`.
45+
The hostname is used by default.
4346

4447
## Build self-contained binary
4548

docs/settings.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Requirements and Settings
2+
3+
## Requirements
4+
5+
- Only devices running the [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service)
6+
are supported.
7+
- ‼️ This service does not work on Fire TV devices.
8+
- Only devices in the same network can be discovered.
9+
- The mDNS protocol must be allowed in your network.
10+
- In most consumer networks the mDNS protocol is allowed and when the Remote and the Android TV device(s) are on the
11+
same network, the Remote should have no difficulties finding the device(s).
12+
- When using mesh networking or professional networking gear, mDNS may be disabled or only specific mDNS services may
13+
be allowed.
14+
In such cases, please check the manufacturer's documentation on how to enable mDNS or specific mDNS services.
15+
16+
## Limitations and Known Issues
17+
18+
- During the setup process, you have to enter a PIN code that is shown on your Android TV.
19+
- Please make sure that your Android TV is powered on and that no old pairing request is shown.
20+
- If pairing continuously fails, reboot your Android TV device and try again.
21+
- If sending commands doesn't work after pairing or the integration is repeatedly disconnected, try rebooting the
22+
Android TV device.
23+
- Verify with the Google TV mobile app or the Google Home mobile app to send commands to the Android TV device.
24+
- If these don't work, neither will this integration.
25+
- Not every app will work or supports all keycodes.
26+
- For example, some IP-TV apps don't support channel-up & down commands.
27+
- Some devices, like TCL, become unavailable after they are turned off, unless you activate the `Screenless service`.
28+
- Activate it under: Settings, System, Power and energy: Screenless service
29+
30+
See also the known issues of [Home Assistant's Android TV Remote Integration](https://www.home-assistant.io/integrations/androidtv_remote/#limitations-and-known-issues),
31+
since it is using the same communication library.
32+
33+
## Application Settings
34+
35+
### Kodi
36+
37+
If navigation doesn't work within the Kodi app, an additional input controller needs to be configured first with the
38+
original Android TV remote:
39+
40+
1. Start Kodi
41+
2. Go to Settings, System, Input: `Configure attached controllers`
42+
3. Select `Get more...`
43+
4. Scroll down and select `TV Remote`
44+
5. Configure buttons: select a button in the list with the original remote, then confirm it with the corresponding
45+
Remote Two button.

0 commit comments

Comments
 (0)