openhab-docs/_addons_bindings/frontiersiliconradio1
Thomas Dietrich 826ef4abb4 Distinguish collections, improve update process (#514)
* Rename collection folders

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Change all occurences of addons and repos

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Add further corrections

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Remove temporary directories after processing

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Reduce addons menus, show current uncond.

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Fix typo

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Remove redundant addons from permalinks

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Sort UI menu entries correctly

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Split maven command

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-09-22 21:05:09 +02:00
..
readme.md Distinguish collections, improve update process (#514) 2017-09-22 21:05:09 +02:00

readme.md

id label title type description source since logo install
frontiersiliconradio Frontier Silicon Radio Frontier Silicon Radio - Bindings binding This binding is for internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/digital-radio-solutions). https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.frontiersiliconradio/README.md 1x images/addons/frontiersiliconradio.png manual

{% include base.html %}

Frontier Silicon Radio Binding

This binding is for internet radios based on the Frontier Silicon chipset.

This binding has been developed and tested with the Hama IR110 and Medion MD87180 internet radios.

The MEDION® P85040 (MD 86988), MEDION® P85035 (MD 87090), Pinell Supersound II, Silvercrest SIRD 14 C1, [Revo Superconnect] (http://revo.co.uk/shop/superconnect/), [Ruark R2] (http://www.ruarkaudio.com/products/r2-overview), [Technisat DigiRadio 450] (https://www.technisat.com/en_XX/DigitRadio-450/352-10996-9589/) and the Hama DIR3110 are also supported.

MEDION LIFE P85044 (MD 87180) Hama Internetradio IR110 MEDION LIFE P85040 (MD 86988) Pinell Supersound II Silvercrest SIRD 14 C1 Technisat DigitRadio 450 Revo Superconnect

Ruark R2

You can easily check if your IP radio is supported:

  1. Figure out the IP of your radio (e.g. by looking it up in your router)
  2. Figure out the PIN that is configured for the radio (somewhere hidden in the radio's on-screen menu); or try the default pin 1234
  3. Go to your web browser and enter: http://<IP>/fsapi/CREATE_SESSION?pin=<PIN>
  4. If the response is similar to FS_OK 6836164442, your radio is most likely compatible with this binding
  5. If you radio works with this binding, please add it to the list above by Editing this page!

There is also a binding specifically for openHAB 2 here.

Binding Configuration

This binding can be configured in the services/frontiersiliconradio.cfg file.

Property Default Required Description
radio.host Yes Hostname/IP of the radio to control
radio.pin 1234 No PIN access code of the radio
radio.port 80 No Port number of the radio to control
refreshInterval 60000 No The number of milliseconds between checks of the radio
cachePeriod 0 No Cache the state for cachePeriod minutes so only changes are posted (0 = disabled, 60 = recommended)

Notes

  • radio is an identifier that can be replaced with your custom identifier, e.g. bedroom or radio-kitchen. This allows to use the binding also for multiple radios.
  • The pin may vary from radio to radio, you can typically look it up in the radio settings.
  • refreshInterval and cachePeriod are global settings that apply to all radios.

Item Configuration

There are different types of item bindings, all of them are qualified with the device's identifier used in the binding configuration:

frontiersiliconradio="<identifier>:<property>"

Example for the power state of a device with identifier radio:

Switch RadioPower "Radio Power" { frontiersiliconradio="radio:POWER" }

A list of all properties and their possible item types is given below:

item item type purpose changeable
POWER Switch power state yes
MODE Number radio mode (details about mapping below) yes
VOLUME Number volume yes
MUTE Swtich mute yes
PLAYINFONAME String title of current playback, e.g. radio station no
PLAYINFOTEXT String additional information, e.g. current song no
PRESET Number select preset, e.g. configured radio stations yes

The radio mode property is just a number that specifies the radio mode which may differ for each radio. This is why there is no fixed mapping implemented. For radios listed above, the mapping is as follows (please add your radio mapping, if it differs!):

radio mode Hama IR110 Medion MD 87180/87090 Medion MD 86988 Pinell Supersound II Silvercrest SIRD 14 C1 Revo Superconnect Hama DIR3110
0 Internet Radio Internet Radio Internet Radio Internet Radio Internet Radio Internet Radio Internet Radio
1 Spotify Music Player (USB, LAN) Music Player Spotify Spotify Spotify Spotify
2 Player DAB Radio FM Radio Player --- --- Player
3 AUX in FM Radio AUX in DAB Radio Music Player Music Player DAB Radio
4 - AUX in - FM Radio DAB Radio DAB Radio FM Radio
5 - - - AUX in FM Radio FM Radio AUX in
6 - - - - AUX in AUX in -
7 - - - - - Bluetooth -

Example

Items

Switch RadioPower         "Radio Power" (gRadio) { frontiersiliconradio="radio:POWER" }
Number RadioMode          "Radio Mode [%d]" (gRadio) { frontiersiliconradio="radio:MODE" }
Switch RadioMute          "Radio Mute" (gRadio) { frontiersiliconradio="radio:MUTE" } 
Number RadioVolDimmer     "Radio Volume [%d %%]" (gRadio) { frontiersiliconradio="radio:VOLUME" } 
String RadioPlayInfoName  "Play Info Name [%s]" (gRadio) { frontiersiliconradio="radio:PLAYINFONAME" }
String RadioPlayInfoText  "Play Info Text [%s]" (gRadio) { frontiersiliconradio="radio:PLAYINFOTEXT" }
Number RadioPreset        "Preset" (gRadio) { frontiersiliconradio="radio:PRESET" }

Sitemap

Presets and mode are radio-specific, this is why their mapping is specified here.

Frame label="Radio Control" {
    Switch     item=RadioPower
    Selection  visibility=[RadioPower==ON] item=RadioPreset mappings=[0="1Live", 1="WDR2", 2="SWR3"]
    Selection  visibility=[RadioPower==ON] item=RadioMode   mappings=[0="Internet Radio", 1="Spotify", 2="Player", 3="AUX IN"]
    Slider     visibility=[RadioPower==ON] item=RadioVolDimmer
    Switch     visibility=[RadioPower==ON] item=RadioMute
    Text       visibility=[RadioPower==ON] item=RadioPlayInfoName
    Text       visibility=[RadioPower==ON] item=RadioPlayInfoText
}

Developer Info

If you would like to extend this binding and contribute further functionality, here is some technical information about it. The communication with the radio is realized via simple HTTP requests. Unfortunately, there is no official documentation of the API for the frontier silicon chipset, but there are some sources around the internet (flammy/fsapi on github, for example). Until now, only the following requests are implemented:

  • netRemote.sys.power
  • netRemote.sys.mode
  • netRemote.sys.audio.volume
  • netRemote.sys.audio.mute
  • netRemote.nav.action.selectPreset
  • netRemote.play.info.text
  • netRemote.play.info.name

If you like to add further actions, have a look at FrontierSiliconRadio.java.