OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
openhab-docs/_bindings/pioneeravr1
History
John Cocula aa2ab2cac1 [Add-ons] Generate as Jekyll Collections instead of Jekyll Pages (#355) 
* Generate addon docs as Jekyll Collections instead of Jekyll Pages

Simplifies a lot of Jekyll, makes custom addon layout possible.

Signed-off-by: John Cocula <john@cocula.com>

* Adds-on (all but bindings) in user menu

Signed-off-by: John Cocula <john@cocula.com>

* Added openhab-distro submodule

Signed-off-by: John Cocula <john@cocula.com>
 		2017-03-02 01:08:44 +01:00
..
readme.md [Add-ons] Generate as Jekyll Collections instead of Jekyll Pages (#355) 2017-03-02 01:08:44 +01:00

readme.md

id label title type description source since logo install
pioneeravr Pioneer AV Receiver (1.x) Pioneer AV Receiver (1.x) - Bindings binding This binding allows openHAB to remotely control a Pioneer AV receiver equipped with an Ethernet interface. It enables openHAB to switch ON/OFF the receiver, adjust the volume, set the input source and configure most other parameters. https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.pioneeravr/README.md 1x images/addons/pioneeravr.png manual

{% include base.html %}

Pioneer AV Receiver Binding (1.x)

This binding allows openHAB to remotely control a Pioneer AV receiver equipped with an Ethernet interface. It enables openHAB to switch ON/OFF the receiver, adjust the volume, set the input source and configure most other parameters.

Most common commands are supported directly, special commands can be added manually using the "advanced command" mechanism described below.

There is also a binding specifically for openHAB 2 here.

Binding configuration

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

Property Default Required Description
<device-id>.host Yes IP address of the first Pioneer AV receiver to control
<device-id>.port 23 No TCP port of the Pioneer device to control
<device-id>.checkconn 1 No controls whether the binding will check the TCP connection once every minute by polling the receivers power status. Set to 0 in order to disable the connection check. When the receiver is connected via a serial-to-ethernet converter, this polling was reported to wake up the receiver from standby mode. In most cases this option can be left away.

where <device-id> is a name you choose, like livingroom, to identify one Pioneer AV receiver to control. The configuration properties can be repeated with different instance names to control multiple receivers.

Example

livingroom.host=192.168.2.140
bedroom.host=192.168.2.141
bedroom.port=2300

Item Configuration

The syntax accepted is:

pioneeravr="<openHAB-command>:<device-id>:<device-command>[,<openHAB-command>:<device-id>:<device-command>][,...]"

where:

  • parts in brackets [ ] signify an optional information.
  • <openHAB-command> corresponds the openHAB command to respond to.
  • <device-id> corresponds the <device-id> that was introduced in the binding configuration.
  • <device-command> corresponds to the Pioneer AV receiver command. See complete list below.

Pioneer AV Receiver Commands

These command are supported out of the box by the binding.

  • Power

    • POWER_OFF
    • POWER_ON
    • POWER_QUERY (for reading the current power state)

  • Mute

    • UNMUTE
    • MUTE
    • MUTE_QUERY (for reading the mute state)

  • Volume

    • VOLUME_UP
    • VOLUME_DOWN
    • VOLUME_QUERY (for reading the volume)
    • VOLUME_SET _(Volume range is from 0=mute, 1=-80.0 dB to 185=+12.0 dB in steps of 0.5 dB. _ When using a dimmer item, 0% is mapped to 0 and 100% is mapped to 185)

  • Source

    • SOURCE_DVD
    • SOURCE_BD
    • SOURCE_TV_SAT
    • SOURCE_DVR_BDR
    • SOURCE_VIDEO1
    • SOURCE_VIDEO2
    • SOURCE_HDMI1
    • SOURCE_HDMI2
    • SOURCE_HDMI3
    • SOURCE_HDMI4
    • SOURCE_HDMI5
    • SOURCE_HMG
    • SOURCE_IPOD
    • SOURCE_XMRADIO
    • SOURCE_CD
    • SOURCE_CDR_TAPE
    • SOURCE_TUNER
    • SOURCE_PHONO
    • SOURCE_MULTI_CH_IN
    • SOURCE_ADAPTER_PORT
    • SOURCE_SIRIUS
    • SOURCE_UP
    • SOURCE_DOWN
    • SOURCE_QUERY (for reading the current source)
    • SOURCE_SET (for list of supported enum values see "Additional protocol info" below)
    • SOURCE_HDMI_CYCLIC

  • Listening mode

    • LISTENING_MODE
    • LISTENING_MODE_QUERY

  • Home Media Gallery

    • HMG_NUMKEY (accepts a number 0 - 9)
    • HMG_NUMKEY_0
    • HMG_NUMKEY_1
    • HMG_NUMKEY_2
    • HMG_NUMKEY_3
    • HMG_NUMKEY_4
    • HMG_NUMKEY_5
    • HMG_NUMKEY_6
    • HMG_NUMKEY_7
    • HMG_NUMKEY_8
    • HMG_NUMKEY_9
    • HMG_PLAY
    • HMG_PAUSE
    • HMG_PREVIOUS
    • HMG_NEXT
    • HMG_DISPLAY
    • HMG_STOP
    • HMG_UP
    • HMG_DOWN
    • HMG_RIGHT
    • HMG_LEFT
    • HMG_ENTER
    • HMG_RETURN
    • HMG_PROGRAM
    • HMG_CLEAR
    • HMG_REPEAT
    • HMG_RANDOM
    • HMG_MENU
    • HMG_EDIT
    • HMG_CLASS

  • Tone control

    • TONE_ON
    • TONE_BYPASS
    • TONE_QUERY
    • BASS_INCREMENT
    • BASS_DECREMENT
    • BASS_QUERY
    • TREBLE_INCREMENT
    • TREBLE_DECREMENT
    • TREBLE_QUERY

  • Speaker control

    • SPEAKERS (0=Speakers off, 1=A on, 2=B on, 3=A+B on, 9=change cyclic)
    • SPEAKERS_OFF
    • SPEAKERS_A
    • SPEAKERS_B
    • SPEAKERS_A_B

  • HDMI Output selection

    • HDMI_OUTPUT
    • HDMI_OUT_ALL
    • HDMI_OUT_1
    • HDMI_OUT_2

  • HDMI Audio control

    • HDMI_AUDIO_AMP
    • HDMI_AUDIO_THROUGH

  • PQLS setting

    • PQLS_OFF
    • PQLS_AUTO

  • Zone 2 control

    • ZONE2_POWER_ON
    • ZONE2_POWER_OFF
    • ZONE2_POWER_QUERY
    • ZONE2_INPUT
    • ZONE2_INPUT_DVD
    • ZONE2_INPUT_TV_SAT
    • ZONE2_INPUT_DVR_BDR
    • ZONE2_INPUT_VIDEO1
    • ZONE2_INPUT_VIDEO2
    • ZONE2_INPUT_HMG
    • ZONE2_INPUT_IPOD
    • ZONE2_INPUT_XMRADIO
    • ZONE2_INPUT_CD
    • ZONE2_INPUT_CDR_TAPE
    • ZONE2_INPUT_TUNER
    • ZONE2_INPUT_ADAPTER
    • ZONE2_INPUT_SIRIUS
    • ZONE2_INPUT_QUERY
    • ZONE2_VOLUME_UP
    • ZONE2_VOLUME_DOWN
    • ZONE2_VOLUME
    • ZONE2_VOLUME_QUERY
    • ZONE2_MUTE
    • ZONE2_UNMUTE
    • ZONE2_MUTE_QUERY

  • Zone 3 control

    • ZONE3_POWER_ON
    • ZONE3_POWER_OFF
    • ZONE3_POWER_QUERY
    • ZONE3_INPUT
    • ZONE3_INPUT_DVD
    • ZONE3_INPUT_TV_SAT
    • ZONE3_INPUT_DVR_BDR
    • ZONE3_INPUT_VIDEO1
    • ZONE3_INPUT_VIDEO2
    • ZONE3_INPUT_HMG
    • ZONE3_INPUT_IPOD
    • ZONE3_INPUT_XMRADIO
    • ZONE3_INPUT_CD
    • ZONE3_INPUT_CDR_TAPE
    • ZONE3_INPUT_TUNER
    • ZONE3_INPUT_ADAPTER
    • ZONE3_INPUT_SIRIUS
    • ZONE3_INPUT_QUERY
    • ZONE3_VOLUME_UP
    • ZONE3_VOLUME_DOWN
    • ZONE3_VOLUME
    • ZONE3_VOLUME_QUERY
    • ZONE3_MUTE
    • ZONE3_UNMUTE
    • ZONE3_MUTE_QUERY

  • Tuner settings

    • TUNER_FREQ_INCREMENT
    • TUNER_FREQ_DECREMENT
    • TUNER_FREQ_QUERY_AM
    • TUNER_FREQ_QUERY_FM
    • TUNER_BAND
    • TUNER_PRESET
    • TUNER_CLASS
    • TUNER_PRESET_INCREMENT
    • TUNER_PRESET_DECREMENT
    • TUNER_PRESET_QUERY

  • iPod Control

    • IPOD_PLAY
    • IPOD_PAUSE
    • IPOD_STOP
    • IPOD_PREVIOS
    • IPOD_NEXT
    • IPOD_REV
    • IPOD_FWD
    • IPOD_REPEAT
    • IPOD_SHUFFLE
    • IPOD_DISPLAY
    • IPOD_CONTROL
    • IPOD_CURSOR_UP
    • IPOD_CURSOR_DOWN
    • IPOD_CURSOR_LEFT
    • IPOD_CURSOR_RIGHT
    • IPOD_ENTER
    • IPOD_RETURN
    • IPOD_TOP_MENU
    • IPOD_KEY_OFF

  • Adapter port

    • ADAPTER_PLAY_PAUSE
    • ADAPTER_PLAY
    • ADAPTER_PAUSE
    • ADAPTER_STOP
    • ADAPTER_PREVIOUS
    • ADAPTER_NEXT
    • ADAPTER_REV
    • ADAPTER_FWD

  • LCD status information text

    • DISPLAY_INFO_QUERY (needs to be mapped to a string item)

Advanced commands

If you want to use commands that are not predefined by the binding you can add them manually using a shape # as a prefix.

Example:

 Switch  AV_AdvCmd { pioneeravr="INIT:livingroom:POWER_QUERY, ON:livingroom:#PO, OFF:livingroom:#PF" }

This will act as a power switch. Parameter may be added using the java format syntax, e.g.:

 Dimmer  AV_Volume { pioneeravr="*:livingroom:#%03dVL" }

This will set the volume like the predefined VOLUME_SET command does.

A list of all commands that are supported by the pioneer receiver can be found here: http://www.pioneerelectronics.com/PUSA/Support/Home-Entertainment-Custom-Install/RS-232+&+IP+Codes

Examples

Items

items/av.items

Switch  AV_Pwr { pioneeravr="INIT:livingroom:POWER_QUERY, OFF:livingroom:POWER_OFF, ON:livingroom:POWER_ON"}
Switch  AV_Mute  { pioneeravr="INIT:livingroom:MUTE_QUERY, ON:livingroom:MUTE, OFF:livingroom:UNMUTE" }
Dimmer  AV_Volume { pioneeravr="INIT:livingroom:VOLUME_QUERY, INCREASE:livingroom:VOLUME_UP, DECREASE:livingroom:VOLUME_DOWN, *:livingroom:VOLUME_SET" }

Note: The "INIT" action will be called once upon initialization of the binding. Its purpose is to query the current state of the receiver, so the item state represents the receiver state when the binding is running. Without that command, the initial values will be uninitialized until a corresponding command is performed to change the setting, or the receiver sends an update on his own.

Basic Demo

items/av.items

Switch  AV_Pwr     "Power" { pioneeravr="INIT:livingroom:POWER_QUERY, OFF:livingroom:POWER_OFF, ON:livingroom:POWER_ON" }
Switch  AV_Mute    "Mute" { pioneeravr="INIT:livingroom:MUTE_QUERY, ON:livingroom:MUTE, OFF:livingroom:UNMUTE" }
Number  AV_Source  "Source [%.1f]" { pioneeravr="INCREASE:livingroom:SOURCE_UP, DECREASE:livingroom:SOURCE_DOWN, *:livingroom:SOURCE_SET" }
String  AV_Status  "Status [%s]" { pioneeravr="INIT:livingroom:DISPLAY_INFO_QUERY" }
Number  AV_Volume "Volume abs.[%.1f]" { pioneeravr="INIT:livingroom:VOLUME_QUERY, *:livingroom:VOLUME_SET" }
Dimmer  AV_Volume_perc "Volume perc. [%.1f]%" (gAV_Receiver) { pioneeravr="INIT:livingroom:VOLUME_QUERY,  INCREASE:livingroom:VOLUME_UP, DECREASE:livingroom:VOLUME_DOWN, *:livingroom:VOLUME_SET" }
Switch  AV_HMG_Class "HMG class" { pioneeravr="ON:livingroom:HMG_CLASS" }
Number  AV_HMG_Num "HMG Num" { pioneeravr="*:livingroom:HMG_NUMKEY" }
Switch  AV_AdvCmd_Test "Adv Cmd test" { pioneeravr="INIT:livingroom:POWER_QUERY, ON:livingroom:#PO, OFF:livingroom:#PF" }

sitemaps/av.sitemap

sitemap av label="Main Menu"     
Frame {
     		Text label="AV Receiver" icon="video" {
     			Text item=AV_Status label="Status: [%s]"
     			Switch item=AV_Pwr
     			Switch item=AV_Mute mappings=[ON="Mute", OFF="Un-Mute"]
     			Switch item=AV_Source  mappings=[5=TV, 4=DVD, 26=HMG, 15=DVR, 2=FM ] 
     			Setpoint item=AV_Volume_perc
     			Switch item=AV_HMG_Num  mappings=[1="WDR2", 2="1Live", 3="DLF" ]
     			Switch item=AV_Tuner_Preset  mappings=[1="WDR2", 2="1Live", 3="DLF" ]
     		}
     	}

Additional protocol information:

The mapping of the source channels (AV_Source) to enumation numbers is as follows:

  • 04: DVD
  • 25: BD
  • 05: TV/SAT
  • 06: SAT/CBL
  • 15: DVR/BDR
  • 10: VIDEO 1(VIDEO)
  • 14: VIDEO 2
  • 19: HDMI 1
  • 20: HDMI 2
  • 21: HDMI 3
  • 22: HDMI 4
  • 23: HDMI 5
  • 26: HOME MEDIA GALLERY(Internet Radio)
  • 17: iPod/USB
  • 18: XM RADIO
  • 01: CD
  • 03: CD-R/TAPE
  • 02: TUNER
  • 00: PHONO
  • 12: MULTI CH IN
  • 33: ADAPTER PORT
  • 27: SIRIUS
  • 31: HDMI (cyclic)

Further information for specific receivers can be found here: http://www.pioneerelectronics.com/PUSA/Support/Home-Entertainment-Custom-Install/RS-232+&+IP+Codes

Troubleshooting

It has been observed that from time to time, the ip-interface of the receiver hangs up and won't accept connections any more or it stops returning results and updates. This leads to items not being updated any more. This behaviour seems to be related to use of other network features of the receiver, e.g. music streaming via Airplay. Currently there is no solution known to get rid of this other then to power cycle the receiver by temporary plugging out its power cord (going to standby is not sufficient).

Note: The Telnet-Connection must be exclusively usable by this binding. Means dont use telnet in terminal beforehand. This would block this binding (please confirm,20150128)