This script was created to allow an Hyperion Ambilight configuration to be altered in reaction to external factors, such as a change in AVR power or input. This was something I desired to be able to do myself, but was also spurred on by requests for such features in the Hyperion Issues forum, specifically issues #177 and #186.
My own AVR is a network connected Pioneer VSX-1028-K. Upon investigation I found the AVR could be controlled using basic ASCII commands issued over a telnet connection. Not only that, but if a socket was left open, the AVR could be monitored through ASCII 'event' codes it writes for each behaviour.
After learning this about my own AVR, I researched further and found almost-identical systems also employed by Denon and Onkyo, just with different event codes. If your AVR is network connected, you can easily tell if it is compatible using some basic steps.
Example codes for testing are listed below for known manufacturer specifications. Note however the specification files are old so just because your AVR is not listed does not mean it is not supported. Some specs have also changed over time so just because a manuf code doesn't work, doesn't mean it's not possible, you just need to find the correct codes.
- Replace
EVENTin each of the following commands with a compatible 'event' for your AVR manufacturer - Replace
avr.ipa.ddr.essandportwith values for your AVR. In most cases the default port of 23 will work. On my Pioneer port 8102 is also open.
printf "EVENT\r" | nc avr.ipa.ddr.ess port -w 1 returns EVENT
or
{ echo "EVENT"; sleep 1; } | telnet avr.ipa.ddr.ess port
Which will return a lot more, but in amongst it should be the same result
Trying xxx.xxx.xxx.xxx...
Connected to xxxxxxxxxxxx.local.
Escape character is '^]'.
EVENT
Connection closed by foreign host.
Using the latter telnet command, if you don't get anything the first time just try a couple more times. The telnet responses are inconsistent for some reason.
Tested and working with Pioneer VSX-1028, but should work with all compatible series such as 82X, 102X, 112X and others compatible with IP commands as listed in Pioneer Home Custom Install documentation. The included example configuration for Pioneer is based on this specification.
Compatibility test event: ?P.
Event response: PWR1 or PWR0, where 1 means is the AVR is powered off and 0 is on (backward I know).
Testers wanted
The included example configuration for Denon is based on this specification. http://openrb.com/wp-content/uploads/2012/02/AVR3312CI_AVR3312_PROTOCOL_V7.6.0.pdf
Compatibility test event: ?PW.
Event response: PWSTANDBY or PWON.
Testers wanted
The included example configuration for Onkyo is based on this specification. http://www.epanorama.net/sff/Audio/Products/Receivers/Onkyo%20-%20TXDS989-rs232-codes%5B1%5D.pdf
Compatibility test event: ?PWR.
Event response: PWR00 or PW01, where 1 is on and 0 is off.
If you have one of the three listed manufs and the codes didn't work, or if you are looking to use the script with an AVR from a different manufacturer, you can likely map the event codes yourself pretty easily.
In a terminal, type one of the following followed by the ENTER key:
nc avr.ipa.ddr.ess port or telnet avr.ipa.ddr.ess port
Power on your AVR, if not already, and change volume, switch inputs, etc. Hopefully you will see a stream of event codes appearing in the terminal window. By monitoring the output you should be able to see commonalities with repeat behaviours and manage to map what you are doing on the AVR (input, power, volume) to the corresponding codes which you can then use in a config file with this script.
Move your existing config file and creating a symbolic link as the file Hyperion will look for. This makes it easier to switch scripts without anything getting overwritten.
SSH to your Pi, then complete the following steps:
cd
git clone https://github.com/Hwulex/hyperion-config-switch.git
cd hyperion-config-switch/
chmod a+x hyperion-config-switch.daemon.sh
cd /opt/hyperion/config/
sudo mv hyperion.config.json hyperion.config.default.json
ln -s hyperion.config.default.json hyperion.config.json
initctl restart hyperion
The final command may need to be run as sudo /etc/init.d/hyperion restart
At this point you will want to
- edit the
hyperion-config-switch.confand make sure all paths are configured correctly for your platform, and - edit the
hyperion.avr.conffile and put in your AVR IP address and port
Then
cd ~/hyperion-config-switch
ln -s avr.YOUR_AVR_MANUFACTURER.conf hyperion.avr.conf
sudo nohup ./hyperion-config-switch.daemon.sh &
SSH as root to your installation using ssh root@box.ip.add.ress. The default passwords are openelec and rasplex for the respective installs. Now complete the following steps
cd /storage/.config/
mv hyperion.config.json /storage/hyperion/config/
ln -s /storage/hyperion/config/hyperion.config.json hyperion.config.json
cd /storage/hyperion/config/
mv hyperion.config.json hyperion.config.default.json
ln -s hyperion.config.default.json hyperion.config.json
cd /storage
mkdir hyperion-config-switch
cd hyperion-config-switch
killall hyperiond
/storage/hyperion/bin/hyperiond.sh /storage/hyperion/config/hyperion.config.json </dev/null >/dev/null 2>&1 &
curl -L --output hyperion-config-switch.daemon.sh --get https://raw.githubusercontent.com/Hwulex/hyperion-config-switch/master/hyperion-config-switch.daemon.sh
curl -L --output hyperion-config-switch.conf --get https://raw.githubusercontent.com/Hwulex/hyperion-config-switch/master/hyperion-config-switch.conf
curl -L --output avr.YOUR_AVR_MANUFACTURER.conf --get https://raw.githubusercontent.com/Hwulex/hyperion-config-switch/master/avr.YOUR_AVR_MANUFACTURER.conf
chmod a+x hyperion-config-switch.daemon.sh
ln -s avr.YOUR_AVR_MANUFACTURER.conf hyperion.avr.conf
At this point you will want to open hyperion.avr.conf in your favourite editor and put in your AVR IP address, port, etc.
Next, edit hyperion-config-switch.conf and make sure the paths are configured correctly for your system. Then:
nohup ./hyperion-config-switch.daemon.sh &
If you wish (or need) to run different Hyperion configurations for different AVR inputs (different black crops, colour casting, etc) then that is very easy. Simply copy the default hyperion.config.json file to another with the name of the corresponding AVR input code inserted, within your Hyperion conf directory (see instructions above). Next, ensure it is also listed in the avr.MANUF.conf file under src_custom and you're reading to go.
Example:
cp hyperion.config.json hyperion.config.FN20.json
Where FN20 is the HDMI2 input on my Pioneer AVR. Find the code for your input using the linked documents for your manufacturer and substitute in to these commands.
There is no need to restart the hyperion-config-switch.sh process. As long as the corresponding code was present in the avr.MANUF.conf src_custom section before loading, it will start using the file immediately.
If you need to kill the switch script, run
Raspbian:
sudo killall -9 hyperion-config-switch.daemon.sh
OpenELEC:
killall -9 hyperion-config-switch.daemon.sh
- Create a system-dependant install script for all this crap
- Document how to make script start at boot / with Hyperion
- Add notes about how to kill/restart process