Update frontier_silicon documentation (#21238)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Thijs W 2023-03-13 15:22:10 +01:00 committed by GitHub
parent 1556f0dac7
commit 0d0b7947a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -11,58 +11,37 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@wlcrs'
ha_ssdp: true
ha_config_flow: true
---
This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app.
This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the UNDOK app.
## Supported Models
Frontier Silicon is used by many different brands of radio manufacturers.
Supported devices include, but are not limited to:
* Hama: [IR50], [IR110], [DIR3110]
* Medion: [Medion Radios]
* Silvercrest: [SIRD 14 C2 (archived website)]
* Teufel: [Radio 3sixty (2019)]
* Roberts: [Roberts Stream 94i]
* Some models from: Auna, Technisat, Revo, Pinell, Como Audio
This integration was developed and tested with a Hama [DIR3110] and a Medion [MD 87466].
This integration was developed and tested with a [Roberts Stream 94i].
## Configuration
If your device is supported by the UNDOK app, then it is also supported by this integration.
Your Frontier Silicon based device should be automatically discovered by Home Assistant. The auto-discovery service assumes that the device uses the default PIN code: *1234*. If you have changed the PIN code, the auto-discovery will fail as Home Assistant will not be able to connect to the device. You can set the PIN code of your device (depending on manufacturer) under:
## Prerequisites
The integration supports automatic discovery of your Internet Radio. If you need to set up the device manually, please provide the device IP-address. Some models use a separate port (2244) for API access, this can be verified by visiting `http://[host]:[port]/device`.
The default PIN for Frontier Silicon-based devices is 1234. You can set the PIN code of your device (depending on manufacturer) under:
*MENU button > Main Menu > System setting > Network > NetRemote PIN setup*
If your device was not automatically discovered or you have changed the PIN you can alternatively add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
- platform: frontier_silicon
host: IP_ADDRESS
```
{% configuration %}
host:
description: The host name or the IP address of the device.
required: true
default: 192.168.1.11
type: string
port:
description: The port number of the device.
required: false
default: 80
type: integer
password:
description: PIN code of the Internet Radio.
required: false
default: 1234
type: string
name:
description: Friendly name of the Internet Radio. If present this will override the friendly name reported by the radio itself.
required: false
default: empty
type: string
{% endconfiguration %}
Some models use a separate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.
{% include integrations/config_flow.md %}
In case your device (friendly name) is called *badezimmer*, an example automation can look something like this:
@ -81,6 +60,7 @@ action:
```
## Screenshots:
Overview DAB+ (Badezimmer) and Spotify (Küche):
<p class='img'>
<img src='/images/screenshots/frontier_silicon_overview.png' />
@ -91,17 +71,13 @@ Overview of the info dialog:
<img src='/images/screenshots/frontier_silicon_info_dialog.png' />
</p>
## Development
Support is provided through the Python [fsapi] module. The Python module was developed by using the documentation provided by [flammy] and
is based on [tiwillam]'s fsapi project. Special thanks to both developers, this integration would have not been possible without their work.
## Notes and Limitations
<div class='note warning'>
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session.
*If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
Some older devices may require setting up a session to process requests. This is automatically detected by the underlying library. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated.
This renders the usage of [UNDOK] almost impossible for these older devices, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session. In that case, you have to disable the integration if you want to use UNDOK.
</div>
@ -113,7 +89,4 @@ The Frontier Silicon API does not provide a multi-user environment. There is alw
[MD 87466]: https://www.conrad.com/p/medion-p83302-md-87466-internet-kitchen-radio-dab-fm-aux-internet-radio-dlna-compatible-white-1434428
[Radio 3sixty (2019)]: https://teufel.de/radio-3sixty-2019-105437000
[SIRD 14 C2 (archived website)]: https://web.archive.org/web/20191011141311/https://www.silvercrest-multiroom.de/produkte/stereo-internet-radio/
[fsapi]: https://github.com/zhelev/python-fsapi
[UNDOK]: https://www.frontiersmart.com/product/undok/
[flammy]: https://github.com/flammy/fsapi/
[tiwillam]: https://github.com/tiwilliam/fsapi
[Roberts Stream 94i]: https://www.robertsradio.com/en-gb/stream-94i