openhab-docs/_bindings/samsungtv1/readme.md

328 lines
6.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

---
id: samsungtv
label: Samsung TV
title: Samsung TV - Bindings
type: binding
description: "This binding should be compatible with Samsung TV models which support Apple and Android remote applications."
source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.samsungtv/README.md
since: 1x
logo: images/addons/samsungtv.png
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Samsung TV Binding
This binding should be compatible with Samsung TV models which support Apple and Android remote applications.
## Limitations
* The binding can send commands from openHAB to Samsung TV, but it does not signal any state changes issued by the Samsung TV remote. So creating a rule that triggers an action when the TV is switched on or off by the TV remote is not possible.
* The KEY_POWERON command does not switch the TV on. Tested on Samsung UE40ES5700, maybe other models are working.
* New models (H-Series TV´s like e.g. UEH5570 ) use a different (encrypted) protocol; they are not yet supported by this binding.
There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/samsungtv/readme.html).
## Binding Configuration
This binding can be configured in the file `services/samsungtv.cfg`.
| Key | Default | Required | Description |
|-----|---------|:--------:|-------------|
| `<id1>`.host | | Yes | IP address of the first TV to control |
| `<id1>`.port | 55000 | No | TCP Port number of the first TV to control |
| `<id2>`.host | | Yes | IP address of the second TV to control |
| `<id2>`.port | 55000 | No | TCP Port number of the second TV to control |
where `<id1>` and `<id2>` can be freely set to whatever name you want to give for a certain TV (e.g. "Livingroom" or "Bedroom").
### Example
```
# Host and port of the first TV to control
Livingroom.host=192.168.0.12
Livingroom.port=55000
# Host and port of the second TV to control
Bedroom.host=192.168.0.13
Bedroom.port=55000
```
During first connection attempt, the TV asks you to grant permission to the openHAB application. If you have missed the dialog, you can change permission options from the TV's menu (e.g. `Menu -> Network -> AllShare options`). If you have any problems to control you TV by openHAB, you could verify connection by the official Samsung iOS or Android remote control app.
## Item Configuration
The syntax is:
```
samsungtv="<openHAB-command>:<id>:<device-command>[,<openHAB-command>:<device-id>:<device-command>][,...]"
```
where:
* parts in brackets `[ ]` is optional information.
* `<openHAB-command>` corresponds to an openHAB command.
* `<id`> corresponds to the device which is introduced in the binding configuration.
* `<device-command>` corresponds to the TV command. See the complete list below.
### Supported TV Commands
* KEY_0
* KEY_1
* KEY_2
* KEY_3
* KEY_4
* KEY_5
* KEY_6
* KEY_7
* KEY_8
* KEY_9
* KEY_11
* KEY_12
* KEY_3SPEED
* KEY_4_3
* KEY_16_9
* KEY_AD
* KEY_ADDDEL
* KEY_ALT_MHP
* KEY_ANGLE
* KEY_ANTENA
* KEY_ANYNET
* KEY_ANYVIEW
* KEY_APP_LIST
* KEY_ASPECT
* KEY_AUTO_ARC_ANTENNA_AIR
* KEY_AUTO_ARC_ANTENNA_CABLE
* KEY_AUTO_ARC_ANTENNA_SATELLITE
* KEY_AUTO_ARC_ANYNET_AUTO_START
* KEY_AUTO_ARC_ANYNET_MODE_OK
* KEY_AUTO_ARC_AUTOCOLOR_FAIL
* KEY_AUTO_ARC_AUTOCOLOR_SUCCESS
* KEY_AUTO_ARC_CAPTION_ENG
* KEY_AUTO_ARC_CAPTION_KOR
* KEY_AUTO_ARC_CAPTION_OFF
* KEY_AUTO_ARC_CAPTION_ON
* KEY_AUTO_ARC_C_FORCE_AGING
* KEY_AUTO_ARC_JACK_IDENT
* KEY_AUTO_ARC_LNA_OFF
* KEY_AUTO_ARC_LNA_ON
* KEY_AUTO_ARC_PIP_CH_CHANGE
* KEY_AUTO_ARC_PIP_DOUBLE
* KEY_AUTO_ARC_PIP_LARGE
* KEY_AUTO_ARC_PIP_LEFT_BOTTOM
* KEY_AUTO_ARC_PIP_LEFT_TOP
* KEY_AUTO_ARC_PIP_RIGHT_BOTTOM
* KEY_AUTO_ARC_PIP_RIGHT_TOP
* KEY_AUTO_ARC_PIP_SMALL
* KEY_AUTO_ARC_PIP_SOURCE_CHANGE
* KEY_AUTO_ARC_PIP_WIDE
* KEY_AUTO_ARC_RESET
* KEY_AUTO_ARC_USBJACK_INSPECT
* KEY_AUTO_FORMAT
* KEY_AUTO_PROGRAM
* KEY_AV1
* KEY_AV2
* KEY_AV3
* KEY_BACK_MHP
* KEY_BOOKMARK
* KEY_CALLER_ID
* KEY_CAPTION
* KEY_CATV_MODE
* KEY_CHDOWN
* KEY_CHUP
* KEY_CH_LIST
* KEY_CLEAR
* KEY_CLOCK_DISPLAY
* KEY_COMPONENT1
* KEY_COMPONENT2
* KEY_CONTENTS
* KEY_CONVERGENCE
* KEY_CONVERT_AUDIO_MAINSUB
* KEY_CUSTOM
* KEY_CYAN
* KEY_BLUE(KEY_CYAN)
* KEY_DEVICE_CONNECT
* KEY_DISC_MENU
* KEY_DMA
* KEY_DNET
* KEY_DNIe
* KEY_DNSe
* KEY_DOOR
* KEY_DOWN
* KEY_DSS_MODE
* KEY_DTV
* KEY_DTV_LINK
* KEY_DTV_SIGNAL
* KEY_DVD_MODE
* KEY_DVI
* KEY_DVR
* KEY_DVR_MENU
* KEY_DYNAMIC
* KEY_ENTER
* KEY_ENTERTAINMENT
* KEY_ESAVING
* KEY_EXIT
* KEY_EXT1
* KEY_EXT2
* KEY_EXT3
* KEY_EXT4
* KEY_EXT5
* KEY_EXT6
* KEY_EXT7
* KEY_EXT8
* KEY_EXT9
* KEY_EXT10
* KEY_EXT11
* KEY_EXT12
* KEY_EXT13
* KEY_EXT14
* KEY_EXT15
* KEY_EXT16
* KEY_EXT17
* KEY_EXT18
* KEY_EXT19
* KEY_EXT20
* KEY_EXT21
* KEY_EXT22
* KEY_EXT23
* KEY_EXT24
* KEY_EXT25
* KEY_EXT26
* KEY_EXT27
* KEY_EXT28
* KEY_EXT29
* KEY_EXT30
* KEY_EXT31
* KEY_EXT32
* KEY_EXT33
* KEY_EXT34
* KEY_EXT35
* KEY_EXT36
* KEY_EXT37
* KEY_EXT38
* KEY_EXT39
* KEY_EXT40
* KEY_EXT41
* KEY_FACTORY
* KEY_FAVCH
* KEY_FF
* KEY_FF_
* KEY_FM_RADIO
* KEY_GAME
* KEY_GREEN
* KEY_GUIDE
* KEY_HDMI
* KEY_HDMI1
* KEY_HDMI2
* KEY_HDMI3
* KEY_HDMI4
* KEY_HELP
* KEY_HOME
* KEY_ID_INPUT
* KEY_ID_SETUP
* KEY_INFO
* KEY_INSTANT_REPLAY
* KEY_LEFT
* KEY_LINK
* KEY_LIVE
* KEY_MAGIC_BRIGHT
* KEY_MAGIC_CHANNEL
* KEY_MDC
* KEY_MENU
* KEY_MIC
* KEY_MORE
* KEY_MOVIE1
* KEY_MS
* KEY_MTS
* KEY_MUTE
* KEY_NINE_SEPERATE
* KEY_OPEN
* KEY_PANNEL_CHDOWN
* KEY_PANNEL_CHUP
* KEY_PANNEL_ENTER
* KEY_PANNEL_MENU
* KEY_PANNEL_POWER
* KEY_PANNEL_SOURCE
* KEY_PANNEL_VOLDOW
* KEY_PANNEL_VOLUP
* KEY_PANORAMA
* KEY_PAUSE
* KEY_PCMODE
* KEY_PERPECT_FOCUS
* KEY_PICTURE_SIZE
* KEY_PIP_CHDOWN
* KEY_PIP_CHUP
* KEY_PIP_ONOFF
* KEY_PIP_SCAN
* KEY_PIP_SIZE
* KEY_PIP_SWAP
* KEY_PLAY
* KEY_PLUS100
* KEY_PMODE
* KEY_POWER
* KEY_POWEROFF
* KEY_POWERON
* KEY_PRECH
* KEY_PRINT
* KEY_PROGRAM
* KEY_QUICK_REPLAY
* KEY_REC
* KEY_RED
* KEY_REPEAT
* KEY_RESERVED1
* KEY_RETURN
* KEY_REWIND
* KEY_REWIND_
* KEY_RIGHT
* KEY_RSS
* KEY_INTERNET
* KEY_RSURF
* KEY_SCALE
* KEY_SEFFECT
* KEY_SETUP_CLOCK_TIMER
* KEY_SLEEP
* KEY_SOUND_MODE
* KEY_SOURCE
* KEY_SRS
* KEY_STANDARD
* KEY_STB_MODE
* KEY_STILL_PICTURE
* KEY_STOP
* KEY_SUB_TITLE
* KEY_SVIDEO1
* KEY_SVIDEO2
* KEY_SVIDEO3
* KEY_TOOLS
* KEY_TOPMENU
* KEY_TTX_MIX
* KEY_TTX_SUBFACE
* KEY_TURBO
* KEY_TV
* KEY_TV_MODE
* KEY_UP
* KEY_VCHIP
* KEY_VCR_MODE
* KEY_VOLDOWN
* KEY_VOLUP
* KEY_WHEEL_LEFT
* KEY_WHEEL_RIGHT
* KEY_W_LINK
* KEY_YELLOW
* KEY_ZOOM1
* KEY_ZOOM2
* KEY_ZOOM_IN
* KEY_ZOOM_MOVE
* KEY_ZOOM_OUT
## Examples
```
Number directChannel {samsungtv="1:Livingroom:KEY_1, 2:Livingroom:KEY_2, 3:Livingroom:KEY_3"}
Dimmer channel {samsungtv="INCREASE:Livingroom:KEY_CHUP, DECREASE:Livingroom:KEY_CHDOWN"}
Switch mute {samsungtv="ON:Livingroom:KEY_MUTE, OFF:Livingroom:KEY_MUTE"}
Rollershutter volume {samsungtv="UP:Livingroom:KEY_VOLUP, DOWN:Livingroom:KEY_VOLDOWN"}
```