New plugin [pimatic-onkyo-avr]
Finally…
I started writing a plugin for controlling Onkyo and Pioneer (2016+) AVRs
The plugin is working and I’m already able to switch the power of my Pioneer VSX-831 and read the current power state.
Next step is to provide a PowerSensor and implement functionality to send other commands than power on/off.
Please, could one of the @developer tell me, why my OnkyoSensor isn’t instantiated?
The constructor is never called and I don’t know why.
@saxnpaule I think the line 24 in onkyo.coffee should be
createCallback: (config, lastState) => new OnkyoSensor(config, lastState) instead of
createCallback: (config, lastState) -> new OnkyoSensor(config, lastState)
pimatic-google-calendar | pimatic-wmi | pimatic-snmp | pimatic-wakeonlan |
Like my work? Then consider a donation
Follow me: www.thorstenreichelt.de
Thank you, but that changed nothing 
I could create a sensor device with the actually repo version. I get only an error about the “finally” statement.
Did you change anything? Because I get no errors at all. But also no logging from the sensor device e.g. the config from the constructor.
EDIT: I’m too stupid. I thought the sensor is instatiated automatically and didn’t create one via config. Sorry.
no
clone the repo. activate the plugin in the config and create a device over the gui.
EDIT: ok 
EDIT2: one hint. you must create for all attributes getter functions. without you get later errors.
Yes, I already got them 
Sensor is working now. Plugin is ready for test. Unless my pull request isn’t accepted, you need the forked dependecy from my repo: https://github.com/saxn-paule/onkyo.js
Published a first version to npm.
The provided action is called “sendOnkyo”.
The provided sensor class is:
Possible attributes are:
Has to be used in the following syntax:
[action] "[group].[command]"
Sample:
Power the AVR on
sendOnkyo "POWER.ON"
Switch the AVR off
sendOnkyo "POWER.OFF"
handling the volume
getting the current volume
handling power status
handling the input
change the listening mode
There is only one (self explaining) configuration parameter
{
"plugin": "onkyo-avr"
}
{
"class": "OnkyoDevice",
"ip": "192.168.0.15",
"id": "vsx-831",
"name": "VSX-831"
}
{
"class": "OnkyoSensor",
"id": "avrsensor",
"name": "Display",
"attributes": [
{
"name": "volume"
},
{
"name": "sound"
},
{
"name": "source"
}
],
"xAttributeOptions": [
{
"name": "volume",
"displaySparkline": false,
"hidden": false
}
]
}
This plugin is in an early alpha stadium and you use it on your own risk.
I’m not responsible for any possible damages that occur on your health, hard- or software.
MIT
Hi! Hereby some feedback on your plugin. I don’t have an Onkyo AVR though,
You are defining the following variables in the global namespace, this way you can only support one Onkyo AVR. What if someone has more than one device?
onkyoClient = null
connected = false
power = null
currentVolume = -100
currentDisplay = "Test"
currentSource = ""
currentSoundSetting = ""
mute = false
I think these variables should be part of the OnkyoDevice class
Also I think the OnkyoDevice class should be named OnkyoAVRDevice, or maybe even more specific with a type number. What if someone else wants to write a plugin for an other Onkyo device which uses a different protocol? OnkyoDevice is to much a generic name in my opinion.
OnkyoPlugin should then be named OnkyoAVRPlugin or something in that direction.
OnkyoDevice and OnkyoSensor could be integrated in one device
I think your actions should be executed on Devices, like:
when <something> then switch OnkyoAVR on
when <something> then set OnkyoAVR volume to 5
when <something> then mute OnkyoAVR
Where OnkyoAVR is a Device
Oh, and change the German debugging messages to English
Please feel free to comment on my code
Hi, many thanks for you feedback. I know that the variables are in the global namespace. It’s already on my ToDo list. You’re totally right, they should be part of the device.
The naming of the Device: Yes you’re right. This should be more specific.
The Plugin is already named onkyo-avr. No need to change this IMHO.
Putting sensor and device in one class: Is that possible? Do you have a snippet or example? That would make the configuration much more easy.
I suggest not to touch the actions. If I go into your direction, I need to define one action per command. That makes no sense. With one action for all commands, it’s more flexible. Also for the future, only define some new commands and they should work ootb.
The debug message 
well… plugin is in alpha stadium. Of course, every german occurence is going to be translated or removed.
FYI, Pimatic supports some default actions for AVR devices:
AVPlayerPauseActionProvider
AVPlayerPauseActionHandler
AVPlayerStopActionProvider
AVPlayerStopActionHandler
AVPlayerPlayActionProvider
and more
If you implement the needed methods these actions are automatically supported by your device
So for instance, if you include a pause method in your Device class the AVPlayerPauseActionHandler will automatically support a rule like
when <something> then pause OnkyoAVR
Do all Onkyo AVR support this protocol, or only IP connected?
If it supports only the Onkyo EISCP protocol, then maybe OnkyoEISCPDevice could be a good name
I don’t know, I have a Pioneer AVR with build in Onkyo technology. I think OnkyoAVRDevice is a good name. It’s unlikely, that someone has two different plugins installed to control an Onkyo AVR.
For integrating the Device and Sensor, a Sensor is just a type of device, it extends the Device class.
You can just integrate all the functions of the Sensor class in the Device class
Oh, great. I’ll try this.
So, thinking a bit more about the rules, I think it would be nice to support all the by Pimatic provided AVR related actions, and for those other commands maybe something like:
when <something> then send "<command>" to OnkyoAVR
Well, I refactored the plugin and was able to merge sensor and device. But there is one problem now. I need the onkyoClient within the ActionHandler. The onkyoClient is created inside the device, but the ActionProvider is created by the plugin. Do you see a way to inject the onkyoClient into the ActionHandler?
I don’t think you need an OnkyoClient in the ActionProvider, you need an OnkyoDevice
Have a look overhere, where I, inspired by your use case, suggested, and included an implementation example, of an ActionProvider which would do what you want