changed control values to upper case (openhab#1904)

* changed control values to upper case lower case did not work for me > 2017-02-16 22:21:50.978 [WARN ] [.classic.internal.servlet.CmdServlet] - Received unknown command 'pause' for item 'HTPC_control' * changed FFWARD to FASTFORWARD according to source code * little cleanup to highlight item values * added examples for items and sitemap configuration * add empty lines before and after headlines and code Signed-off-by: Christoph Wempe <[email protected]> (github: CWempe)
hermann1514 · Feb 19, 2017 · 5dee9f9 · 5dee9f9
1 parent 49345d4
commit 5dee9f9
Showing 1 changed file with 48 additions and 2 deletions.
diff --git a/addons/binding/org.openhab.binding.kodi/README.md b/addons/binding/org.openhab.binding.kodi/README.md
@@ -61,7 +61,7 @@ The Kodi thing supports the following channels:
 |-------------------------|--------------|--------------|
 | mute                    | Switch       | Mute/unmute your playback |
 | volume                  | Dimmer       | Read or control the volume of your playback |
-| control                 | Player       | Control the Kodi player, e.g.  play/pause/next/previous/ffward/rewind |
+| control                 | Player       | Control the Kodi player, e.g.  `PLAY`, `PAUSE`, `NEXT`, `PREVIOUS`, `FASTFORWARD`, `REWIND` |
 | stop                    | Switch       | Stops the Kodi player |
 | title                   | String       | Title of the currently played song/movie/tv episode |
 | showtitle               | String       | Title of the currently played tv-show; empty for other types |
@@ -71,9 +71,55 @@ The Kodi thing supports the following channels:
 | shownotification        | String       | Shows the provided notification message on the screen |
 | input                   | String       | Allows to control Kodi. Valid values are: `Up`, `Down`, `Left`, `Right`, `Select`, `Back`, `Home`, `ContextMenu`, `Info`, `ShowCodec`, `ShowOSD` |
 | inputtext               | String       | This channel emulates a keyboard input |
-| systemcommand           | String       | This channel allows to send commands to shutdown/suspend/hibernate/reboot kodi |
+| systemcommand           | String       | This channel allows to send commands to `shutdown`, `suspend`, `hibernate`, `reboot` kodi |
 | mediatype               | String       | The media type of the current file. e.g. song or movie | 
 
+## Item Configuration
+
+demo.items
+
+```
+Switch myKodi_mute          "Stumm"                 { channel="kodi:kodi:myKodi:mute" }
+Dimmer myKodi_volume        "Lautstärke [%d]"       { channel="kodi:kodi:myKodi:volume" }
+Player myKodi_control       "Kontrolle [%s]"        { channel="kodi:kodi:myKodi:control" }
+Switch myKodi_stop          "Stop"                  { channel="kodi:kodi:myKodi:stop" }
+String myKodi_title         "Titel [%s]"            { channel="kodi:kodi:myKodi:title" }
+String myKodi_showtitle     "Showtitel [%s]"        { channel="kodi:kodi:myKodi:showtitle" }
+String myKodi_album         "Album [%s]"            { channel="kodi:kodi:myKodi:album" }
+String myKodi_artist        "Artist [%s]"           { channel="kodi:kodi:myKodi:artist" }
+String myKodi_playuri       "PlayerURI [%s]"        { channel="kodi:kodi:myKodi:playuri" }
+String myKodi_notification  "Benachrichtigung [%s]" { channel="kodi:kodi:myKodi:shownotification" }
+String myKodi_input         "Input [%s]"            { channel="kodi:kodi:myKodi:input" }
+String myKodi_inputtext     "Inputtext [%s]"        { channel="kodi:kodi:myKodi:inputtext" }
+String myKodi_systemcommand "Systemcommand [%s]"    { channel="kodi:kodi:myKodi:systemcommand" }
+String myKodi_mediatype     "Mediatyp [%s]"         { channel="kodi:kodi:myKodi:mediatype" }
+```
+
+## Sitemap Configuration
+
+demo.sitemap
+
+```
+sitemap demo label="myKodi"
+{
+    Frame label="myKodi" {
+        Switch    item=HTPC_mute
+        Slider    item=HTPC_volume
+        Selection item=HTPC_control mappings=[PLAY='Play', PAUSE='Pause', NEXT='Next', PREVIOUSE'Previous', FFWARD='Fastforward', REWIND='Rewind']
+        Switch    item=HTPC_stop
+        Text      item=HTPC_title
+        Text      item=HTPC_showtitle
+        Text      item=HTPC_album
+        Text      item=HTPC_artist
+        Text      item=HTPC_playuri
+        Text      item=HTPC_notification
+        Text      item=HTPC_input
+        Text      item=HTPC_inputtext
+        Text      item=HTPC_systemcommand
+        Text      item=HTPC_mediatype
+    }
+}
+```
 
 ## Audio Support