Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/krauskopf/node-red-contrib-avr-yamaha

Node-RED node to connect to Yamaha Audio Video Receivers (e.g. Yamaha AVR RX-677)
https://github.com/krauskopf/node-red-contrib-avr-yamaha

avr-yamaha node-red upnp-listener volume yamaha-receiver

Last synced: 3 months ago
JSON representation

Node-RED node to connect to Yamaha Audio Video Receivers (e.g. Yamaha AVR RX-677)

Awesome Lists containing this project

README 

        
[![npm version](https://badge.fury.io/js/node-red-contrib-avr-yamaha.svg)](https://badge.fury.io/js/node-red-contrib-avr-yamaha)

[![Build Status](https://travis-ci.org/krauskopf/node-red-contrib-avr-yamaha.svg?branch=master)](https://travis-ci.org/krauskopf/node-red-contrib-avr-yamaha)



[![NPM](https://nodei.co/npm/node-red-contrib-avr-yamaha.png?compact=true)](https://nodei.co/npm/node-red-contrib-avr-yamaha/)



# Node-RED nodes for Yamaha audio/video receiver (AVR)



This package contains nodes to easily integrate and control YAMAHA™ audio/video receiver from Node-RED via YNCA protocol (e.g. AVRs like the model Yamaha RX-677).



Please note, that these nodes can not be used to control YAMAHA™ MusicCast devices which no longer support the YNCA protocol. Instead YAMAHA™ introduced the "Extendend Control Protocol" (YXC) which is not supported by this library.



## Installation



Install using the managed palette from inside Node-RED.



## Usage



There are 3 new nodes which appear in the category 'devices' in your Node-Red palette.



![nodes.png](./doc/nodes.png)



#### AVR Yamaha



The node uses an UPnP-listener and emits a new message when certain events occur on the AVR. Look at `msg.topic` for the type of event and `msg.payload`

for some corresponding event information in JSON encoding.



The list of events is:



* Power On/Off: When the power state was changed. Outputs current state by reading `System.Power_Control.Power`.

* Input Changed: When the input selection changed. Outputs current state by reading `Main_Zone.Input.Input_Sel`.

* Volume Changed: When the current volume setting changed or device is muted. Outputs current state by reading `Main_Zone.Volume.Lvl` and `Main_Zone.Volume.Mute`.

* Play_Info Changed: When the current track changed. Outputs the current state by reading `.Play_Info`.

* List_Info Changed: When the current menu list changed. Outputs the current state by reading `.List_Info`.



Note: In most situations, the receiver is sending the event notification multiple times via UPnP. This is not filtered, thus the node might emit the same information multiple times.



#### AVR Yamaha Get



The GET node is used to read different status values of a YAMAHA Audio/Video Receiver. You can select different topics to read the corresponding values

which are returned in `msg.payload`. Most of the payloads are returned as JSON string.



#### AVR Yamaha Put



The PUT node is used to write commands to a YAMAHA Audio/Video Receiver. Select a `msg.topic` in the editor. If no GUI selection is done, then the `msg.topic` is used.



#### Config Node



Use the config node to set the IP address of your receiver. The `port` option allows you to specify the port where the UPnP-device description will be queried. Leave empty for default value of 8080. Other devices, like

TSR-5790 use port 49154.



### Additional Information



Hint: To power on the AVR from remote, the network standby has to be enabled in the internal settings of the AVR.



### Example 1



The following flow shows same basic control of the AVR.



![example1.png](./doc/example1.png)



    [{"id":"864a57c5.79b5a8","type":"AVR-Yamaha-put","z":"495ff459.b6a00c","device":"9202c38a.6dfd4","name":"","topic":"Main_Zone.Power_Control.Power","payload":"","x":370,"y":540,"wires":[["22e54784.dd1ab8"]]},{"id":"8e3e430.f71c1c","type":"inject","z":"495ff459.b6a00c","name":"","topic":"","payload":"On","payloadType":"str","repeat":"","crontab":"","once":false,"x":110,"y":520,"wires":[["864a57c5.79b5a8"]]},{"id":"22e54784.dd1ab8","type":"debug","z":"495ff459.b6a00c","name":"","active":true,"console":"false","complete":"false","x":610,"y":560,"wires":[]},{"id":"3c09a885.c3f658","type":"inject","z":"495ff459.b6a00c","name":"","topic":"","payload":"Standby","payloadType":"str","repeat":"","crontab":"","once":false,"x":120,"y":560,"wires":[["864a57c5.79b5a8"]]},{"id":"395b0593.c6a4fa","type":"AVR-Yamaha-get","z":"495ff459.b6a00c","device":"9202c38a.6dfd4","name":"","topic":"Main_Zone.Volume.Lvl","x":370,"y":620,"wires":[["22e54784.dd1ab8"]]},{"id":"e8c336c6.173cc8","type":"inject","z":"495ff459.b6a00c","name":"Volume Get","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"x":130,"y":620,"wires":[["395b0593.c6a4fa"]]},{"id":"12fbbe4.8614342","type":"AVR-Yamaha-put","z":"495ff459.b6a00c","device":"9202c38a.6dfd4","name":"","topic":"Main_Zone.Volume.Lvl.Val","payload":"","x":370,"y":660,"wires":[["22e54784.dd1ab8"]]},{"id":"ba8d6f4b.6565f","type":"inject","z":"495ff459.b6a00c","name":"Volume Set -40 db","topic":"","payload":"{\"Val\":\"-400\",\"Exp\":\"1\",\"Unit\":\"dB\"}","payloadType":"str","repeat":"","crontab":"","once":false,"x":150,"y":660,"wires":[["12fbbe4.8614342"]]},{"id":"c9125e07.140d2","type":"inject","z":"495ff459.b6a00c","name":"Volume Up 2 dB","topic":"","payload":"{\"Val\":\"Up 2 dB\",\"Exp\":\"\",\"Unit\":\"\"}","payloadType":"str","repeat":"","crontab":"","once":false,"x":140,"y":700,"wires":[["12fbbe4.8614342"]]},{"id":"ed87f898.0c7898","type":"inject","z":"495ff459.b6a00c","name":"Volume Down 2 dB","topic":"","payload":"{\"Val\":\"Down 2 dB\",\"Exp\":\"\",\"Unit\":\"\"}","payloadType":"str","repeat":"","crontab":"","once":false,"x":150,"y":740,"wires":[["12fbbe4.8614342"]]},{"id":"ce094334.980e1","type":"inject","z":"495ff459.b6a00c","name":"Volume Up 5 dB","topic":"","payload":"{\"Val\":\"Up 5 dB\",\"Exp\":\"\",\"Unit\":\"\"}","payloadType":"str","repeat":"","crontab":"","once":false,"x":140,"y":780,"wires":[["12fbbe4.8614342"]]},{"id":"f9ae604e.61e4c","type":"inject","z":"495ff459.b6a00c","name":"Volume Down 5 dB","topic":"","payload":"{\"Val\":\"Down 5 dB\",\"Exp\":\"\",\"Unit\":\"\"}","payloadType":"str","repeat":"","crontab":"","once":false,"x":150,"y":820,"wires":[["12fbbe4.8614342"]]},{"id":"9202c38a.6dfd4","type":"avr-yamaha","z":"495ff459.b6a00c","name":"RX-677","address":"192.168.17.151","port":"8080","debug":true}]



### Example 2



The following example shows a flow, that activates the AVR, sets it to a given volume and plays from a net radio. For example, if your AVR stands in the bedroom, you can use it as a radio alarm clock. To make sure, the

AVR doesn't play forever if you're not at home, the sleep timer is activated.



![example2.png](./doc/example2.png)



    [{"id":"e451229f.1baee","type":"AVR-Yamaha-put","z":"971b9579.68e468","device":"55fc0160.aa04","name":"Switch On","topic":"System.Power_Control.Power","payload":"On","x":590,"y":340,"wires":[["b0aa51f.f4f55b"]]},{"id":"b0aa51f.f4f55b","type":"AVR-Yamaha-put","z":"971b9579.68e468","device":"55fc0160.aa04","name":"Set Volume","topic":"Main_Zone.Volume.Lvl.Val","payload":"-500","x":590,"y":400,"wires":[["c33d23fd.3cc2e"]]},{"id":"a780c420.587f38","type":"AVR-Yamaha-put","z":"971b9579.68e468","device":"55fc0160.aa04","name":"Play NetRadio","topic":"NET_RADIO.Play_Control.Playback","payload":"Play","x":820,"y":460,"wires":[["8b4530b7.74bad"]]},{"id":"916636b1.6e99c8","type":"debug","z":"971b9579.68e468","name":"","active":true,"console":"false","complete":"false","x":810,"y":520,"wires":[]},{"id":"8b4530b7.74bad","type":"AVR-Yamaha-put","z":"971b9579.68e468","device":"55fc0160.aa04","name":"Activate Sleep","topic":"Main_Zone.Power_Control.Sleep","payload":"30 min","x":600,"y":520,"wires":[["916636b1.6e99c8"]]},{"id":"c33d23fd.3cc2e","type":"AVR-Yamaha-put","z":"971b9579.68e468","device":"55fc0160.aa04","name":"Activate NetRadio","topic":"Main_Zone.Input.Input_Sel","payload":"NET","x":610,"y":460,"wires":[["a780c420.587f38"]]},{"id":"55fc0160.aa04","type":"avr-yamaha","z":"","name":"RX-677","address":"192.168.0.30","debug":true}]



### Example 3



The node `AVR Yamaha In` node listens to any UPnP event that is send to the receiver and emits

corresponding messages. Thus, it can happen, that multiple messages with the same content are emitted.

If you want to filter out these duplicate messages, then you can use the `rbe` node

to block out all messages without value changes. The stringify function is necessary because the `rbe`

node only works for strings and numbers.



![example3.png](./doc/example3.png)



    [{"id":"9202c38a.6dfd4","type":"avr-yamaha","z":"495ff459.b6a00c","name":"RX-677","address":"192.168.0.30","port":"8080","debug":true},{"id":"6e8384fe.917c7c","type":"debug","z":"495ff459.b6a00c","name":"","active":true,"console":"false","complete":"payload","x":650,"y":140,"wires":[]},{"id":"22311353.ddceec","type":"AVR-Yamaha-in","z":"495ff459.b6a00c","device":"9202c38a.6dfd4","name":"","devdesc":true,"x":160,"y":140,"wires":[["13a07ec2.47f281"]]},{"id":"56ad3cb2.17ed24","type":"rbe","z":"495ff459.b6a00c","name":"","func":"rbe","gap":"","x":490,"y":140,"wires":[["6e8384fe.917c7c"]]},{"id":"13a07ec2.47f281","type":"function","z":"495ff459.b6a00c","name":"stringify","func":"\nif (typeof msg.payload != 'string')\n    msg.payload = JSON.stringify(msg.payload);\n\nreturn msg;","outputs":1,"noerr":0,"x":340,"y":140,"wires":[["56ad3cb2.17ed24"]]}]



### Example 4



It is also possible to inject the topic via the message instead of selecting one from the properties of node in the GUI.

This might also be usefull if your topic is not in the list of selectable topics. In the following flow, the topic and its value is injected by the inject node in front of it, instead by the `AVR Yamaha Put` node itself.



![example4.png](./doc/example4.png)



    [{"id":"b5bc50fe.9dc44","type":"debug","z":"417d8dc2.bde0e4","name":"","active":true,"console":"false","complete":"false","x":710,"y":320,"wires":[]},{"id":"4e817720.03ee08","type":"inject","z":"417d8dc2.bde0e4","name":"","topic":"Zone_2.Power_Control.Power","payload":"On","payloadType":"str","repeat":"","crontab":"","once":false,"x":230,"y":320,"wires":[["1cb2986e.5e3f68"]]},{"id":"1cb2986e.5e3f68","type":"AVR-Yamaha-put","z":"417d8dc2.bde0e4","device":"6f100f8e.4e5c9","name":"","topic":"","payload":"","x":490,"y":320,"wires":[["b5bc50fe.9dc44"]]},{"id":"6f100f8e.4e5c9","type":"avr-yamaha","z":"","name":"V667","address":"192.168.17.151","port":"","debug":false}]



## Open Topics



* The AVR Yamaha node that listens for UPnP events might not work on every system. Most of the time, this is because there is already another

  UPnP service running and blocking port 1900 for other multicast listeners. Also check, that the Topic `System.Misc.Event.Notice` is written to `On`.

* The list of topics in the GUI is from the model RX-677. Although most of the topics are equal for the different Yamaha receivers, there might be some special topics,

  which are missing for newer models.



## List of verified devices



The nodes have been successfully tested with the following devices:



* RX-V4A

* RX-V677

* RX-V775

* RX-V777

* RX-A740

* TSR-5790 (uses port 49154)

* HTR-4065

* RX-V500D (not all commands supported)

* RX-V2067

* RX-A2080



## List of potentially working devices



The following incomplete nodes have not been tested but should work according to the spec:



* RX-A700

* RX-A710

* RX-A800

* RX-A810

* RX-A1000

* RX-A1010

* RX-A2000

* RX-A2010

* RX-A3000

* RX-A3010

* RX-V671

* RX-V867

* RX-V871

* RX-V1067

* RX-V2067

* RX-V2600

* RX-V3067

* ...



## History



* 2016-feb-20: 0.1.0 - Created node to read status of the receiver.

* 2016-mar-04: 0.3.0 - GET and PUT nodes are working to read and write to the receiver.

* 2016-mar-17: 0.4.0 - Input node emits new message on volume change, power mode and input change.

* 2016-may-17: 0.5.0 - Fixed errors when writing some values like volume or tuner frequency.

* 2016-sep-11: 0.5.1 - Opening UPnP socket with reuseAddr so there can be more than one UPnP listener running.

* 2016-sep-11: 0.5.2 - Updated readme.

* 2016-sep-11: 0.6.0 - Added new option to config-node, where the port to query the UPnP device description can be specified.

* 2016-sep-25: 0.7.0 - Some fixes in the UPnP-Listener. Also added support for the Events `Play_Info` and `List_Info`.

* 2016-sep-26: 0.7.1 - Now also emitting Mute/Unmute state, when `Volume` event is received.

* 2016-sep-27: 0.7.2 - Updated readme.

* 2017-jul-15: 0.7.3 - Updated node description according to node red style guide.

* 2017-nov-05: 0.8.0 - Added some more topics to support Zone3 and Zone4 and improved readme.

* 2017-dec-02: 0.8.1 - Fixed crash of 'AVR Yamaha' node, when event with unknown xml data is received.

* 2017-dec-03: 0.8.2 - Fixed crash of 'AVR Yamaha' node for events of zones other than Main_Zone. Now works for all zones. (Thanks to kuchod)

* 2018-mar-09: 0.8.3 - Fixed "Failed to request data from AVR with error: 400" of 'AVR Yamaha In' node, when input selection is changed. (Thanks to Allyn Fratkin)

                     - Fixed Play_Info event of 'AVR Yamaha In' node, for the inputs 'NET RADIO' and 'TUNER'.

                     - Now supporting List_Info event of 'AVR Yamaha In' node.

* 2018-mar-09: 0.8.4 - Messed up version scheme.

* 2019-may-11: 0.8.5 - Fixed 'Error Message on PUT Node' about 'Received unexpected response data' (Thanks to GasTurbineMan).

* 2019-aug-06: 0.8.6 - PUT and GET nodes now trigger a catch node on error in transmission. E.g. if receiver is not reachable (Thanks to tomrey1).

* 2021-jan-02: 0.8.7 - Added some additional references for HDMI_OUT2, iPod and DAB and some notes to the readme.md.

* 2021-jan-14: 0.8.8 - Added command 'Main_Zone.Scene.Scene_Sel' (Thanks to afrixx)



## Credits



* Sebastian Krauskopf ([email protected])

* This library uses the yamaha-nodejs library by Pascal Seitz.



## Trademarks



* "YAMAHA" is a registered trademark of Yamaha Corporation.



## License



The MIT License (MIT)



Copyright (c) 2017-2021 sebakrau ([email protected])



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.