Pioneer AVR Control plugin

---

Hello community,

there was only one thing missing in my pimatic configuration. The possibility to control my Pioneer AVR.
After a few investigations, I found out, that the AVR talks Telnet.

Some tests later, the idea for a new plugin was born, because the Marantz/Denon AVRs talk another “language” an so, the existing plugin isn’t really usable for me.

After two evenings full of frustration and curses regarding coffeescript, I’m using pure JS now. During the day I’m Java programmer by profession, so it’s some kind of turnaround for me.

At the moment my plugin is running and the first actions could be triggered as well, but everytime I call an action, an exception is thrown. I think it has something to do with callbacks/promises and my execute action needs some improvements.
With respect to my rookie JS skills it would be great, if someone could have a look on it.

The Plugin:

var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; },
  __hasProp = {}.hasOwnProperty,
  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };

module.exports = function(env) {
  var M, Promise, PioRemotePlugin, PioRemoteActionProvider, PioRemoteActionHandler, assert, pioRemotePlugin, pioRemoteActionHandler;
  var client;
  M = env.matcher;

  Promise = env.require('bluebird');
  assert = env.require('cassert');
  var net = env.require('net');
  var util = env.require('util');
  
  /**
   * THE PLUGIN ITSELF 
  **/
  PioRemotePlugin = (function(_super) {
    __extends(PioRemotePlugin, _super);

    function PioRemotePlugin() {
      this.init = __bind(this.init, this);      
      return PioRemotePlugin.__super__.constructor.apply(this, arguments);
    }

    PioRemotePlugin.prototype.init = function(app, framework, config) {
      this.framework = framework;
      this.config = config;
      this.framework.ruleManager.addActionProvider(new PioRemoteActionProvider(this.framework));
      return env.logger.info('Initialising done');
    };


    return PioRemotePlugin;

  })(env.plugins.Plugin);

  pioRemotePlugin = new PioRemotePlugin;

  /**
   * THE ACTION PROVIDER
  **/
  PioRemoteActionProvider = (function(_super) {
    __extends(PioRemoteActionProvider, _super);

    function PioRemoteActionProvider(framework, config) {
      this.framework = framework;
      this.config = config;
      this.connectAction = __bind(this.connectAction, this);
      this.myOptionKeys = ['connect'];
      //this.configWithDefaults = _.assign(config.__proto__, config);
    }

    /**
     *This function handles action in the form of `sendAvr "some string"`
    **/

    PioRemoteActionProvider.prototype.parseAction = function(input, context) {
      var commandTokens, fullMatch, m, match, onEnd, retVal, setCommand;
      retVal = null;
      commandTokens = null;
      fullMatch = false;
      setCommand = (function(_this) {
        return function(m, tokens) {
          return commandTokens = tokens;
        };
      })(this);
      onEnd = (function(_this) {
        return function() {
          return fullMatch = true;
        };
      })(this);
      m = M(input, context).match("sendAvr ").matchStringWithVars(setCommand);
      if (m.hadMatch()) {
        match = m.getFullMatch();
        return {
          token: match,
          nextInput: input.substring(match.length),
          actionHandler: new PioRemoteActionHandler(this.framework, commandTokens)
        };
      } else {
        return null;
      }
    };

    return PioRemoteActionProvider;

  })(env.actions.ActionProvider);

  /**
   * THE ACTION HANDLER 
  **/

  PioRemoteActionHandler = (function(_super) {
    __extends(PioRemoteActionHandler, _super);

    function PioRemoteActionHandler(framework, commandTokens) {
      this.framework = framework;
      this.commandTokens = commandTokens;
      this.executeAction = __bind(this.executeAction, this);
      this.connect = __bind(this.connect, this);   
      this.disconnect = __bind(this.disconnect, this);   
    }

    PioRemoteActionHandler.prototype.connect = function(callback) {      
      if(!client) {
        env.logger.info('Client is undefined, establish new connection...');

        client = new net.Socket();

        client.on('data', function(data) {
          env.logger.info('Received: ' + data);
        });

        client.on('close', function() {
          if(client) {
            env.logger.info('Connection closed');          
            client.disconnect();
          }  
        });  

        client.connect(23, '192.168.0.15', function() {
          env.logger.info('Connected');
        });
      } else {
        env.logger.info('Client already connected, nothing to do.');
      }

      callback();
    };

    PioRemoteActionHandler.prototype.disconnect = function(callback) {
      if(client) {
        env.logger.info('Closing telnet session...');
        client.destroy();
        client = undefined;
      
        env.logger.info('done');
      } else {
        env.logger.info('Nothing to disconnect from.');
      }
      
      callback();
    };

    /*
    This function handles action in the form of `execute "some string"`
     */
    PioRemoteActionHandler.prototype.executeAction = function() {
      return this.framework.variableManager.evaluateStringExpression(this.commandTokens).then((function(_this) {
        
        return function(command) {  
          switch(command) {
              case 'connect':
                  pioRemoteActionHandler.connect(function() {
                  });
                  break;
              case 'disconnect':
                  pioRemoteActionHandler.disconnect(function() {});
                  break;
              default:
                  return __('Unknown Command');
          } 
        };


      })(this));
    };

    return PioRemoteActionHandler;

  })(env.actions.ActionHandler);

  pioRemoteActionHandler = new PioRemoteActionHandler;

  module.exports.PioRemoteActionProvider = PioRemoteActionProvider;

  return pioRemotePlugin;
};

The exception:

20:23:17.715 [pimatic] Listening for HTTP-request on port 80...
20:23:25.059 [pimatic-my-plugin] Client is undefined, establish new connection...
20:23:25.095 [pimatic] rule connect error executing an action: Array.isArray result
20:23:25.096 [pimatic] AssertionError: Array.isArray result
20:23:25.096 [pimatic]>    at /home/psc/pimatic-dev/node_modules/pimatic/lib/rules.coffee:897:15
20:23:25.096 [pimatic]>    at tryCatcher (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/util.js:26:23)
20:23:25.096 [pimatic]>    at Promise._settlePromiseFromHandler (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/promise.js:507:31)
20:23:25.096 [pimatic]>    at Promise._settlePromiseAt (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/promise.js:581:18)
20:23:25.096 [pimatic]>    at Async._drainQueue (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:128:12)
20:23:25.096 [pimatic]>    at Async._drainQueues (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:133:10)
20:23:25.096 [pimatic]>    at Async.drainQueues (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:15:14)
20:23:25.096 [pimatic]>    at process._tickDomainCallback (node.js:459:13)
20:23:25.113 [pimatic-my-plugin] Connected
20:23:44.070 [pimatic-my-plugin] Closing telnet session...
20:23:44.071 [pimatic-my-plugin] done
20:23:44.075 [pimatic] rule disconnect error executing an action: Array.isArray result
20:23:44.077 [pimatic] AssertionError: Array.isArray result
20:23:44.077 [pimatic]>    at /home/psc/pimatic-dev/node_modules/pimatic/lib/rules.coffee:897:15
20:23:44.077 [pimatic]>    at tryCatcher (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/util.js:26:23)
20:23:44.077 [pimatic]>    at Promise._settlePromiseFromHandler (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/promise.js:507:31)
20:23:44.077 [pimatic]>    at Promise._settlePromiseAt (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/promise.js:581:18)
20:23:44.077 [pimatic]>    at Async._drainQueue (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:128:12)
20:23:44.077 [pimatic]>    at Async._drainQueues (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:133:10)
20:23:44.077 [pimatic]>    at Async.drainQueues (/home/psc/pimatic-dev/node_modules/pimatic/node_modules/bluebird/js/main/async.js:15:14)
20:23:44.077 [pimatic]>    at process._tickDomainCallback (node.js:459:13)
^C20:23:46.447 [pimatic] Flushing database to disk, please wait...
20:23:46.557 [pimatic] Flushing database to disk, please wait... Done.
20:23:46.558 [pimatic] exiting...

Best regards,
Paul

I added the sources to https://github.com/saxn-paule/pimatic-pio-remote/tree/develop

Current state is untested!

I added a documentation to the develop branch. Still the configuration section does not work atm. The parameters need to be changed directly in the sourcecode.

@SaxnPaule I’ll have a look at it.

@SaxnPaule You should write the plugin using coffeescript.

As I wrote in the opening post, I tried it two evenings and there was nothing but frustration. I wrote it in pure JS and its working. Only the annoying exceptions still exist.

I once did a conversion of a simple javascript to coffeescript using js2coffee. That worked nicely.
Your script is way more advanced, but you could give it a try.
npm install -g js2coffee

I think the way to use coffeescript could have a lot of advantages, but it scares a lot of developers from starting the development of their own plugins as well.

Meanwhile I solved the first two errors. When I solve the last one too, I’ll have a good plain JS template for further plugins.

It’s also a pitty that all comments regarding plain JS plugins I found in other threads were “use coffeescript”.
In my opinion is much easier for beginners to write JS, but thats only my point of view.

@Harry-van-der-Wolf maybe it would help to translate the code to CS, but the answer would be corrected CS too. So why not correcting the JS code? Is JS harder to understand than CS, I think not.

Nevertheless, thx for your help.

I’m not in favor of coffeescript. I have quite some experience with javascript and php on one side and python on the other. I already wrote some things for pimatic but I always use python.
As mentioned I converted a simple javascript but was not able to write something decent in coffeescript.
Maybe the conversion would have worked.

Finally, I solved the problems. Now I’m going to make it nice

Changed the name to a real one and created new repository: https://github.com/saxn-paule/pimatic-pio-remote

nice! thx a lot for your efforts!
could you please publish your plugin on npm to, so we can add it to the official plugin list.
thx!

Awesome work, I’ll be using it as an example and make other simple socket based plugins, god job!

@leader21 said:

could you please publish your plugin on npm to, so we can add it to the official plugin list.

Done: https://www.npmjs.com/package/pimatic-pio-remote

The plugin is still written in Javascript

@mwittig said:

The plugin is still written in Javascript

Slightly off topic: but does this mean that a plugin does not necessarily has to be written in coffeescript?
You might not like that but for me it is good news.

@Harry-van-der-Wolf said:

You might not like that but for me it is good news.

Well, I think it is on @sweetpi to decide which plugins will be added to the “official” list of plugins. i.e, the list of plugins on the website and integrated with the update mechanism of the mobile frontend.

Apart from this, users are free to add whatever they want to their private base, and, of course, they are free to share their contributions via github, npmjs, and the forum with other users. However, I believe, some rules must be followed for “official” plugins:

• Plugins must be written in Coffescript. If required, plugins may use supplemental Javascript libraries, which shall be published as separate npm packages.
• Plugins must have a Readme file written in Markdown with reasonable level of detail
• Plugin packages and sources must include a LICENSE
• Plugins must have a well written package.json descriptor
• Plugin authors shall be responsive to user requests. As this is difficult to achieve at all times, authors should seek for co-maintainers (github & npmjs) who can do fixture when the author has no time.

I could use a coffescript generator to build CS from my JS file, but I think, that helps nobody. I don’t care If my plugin is official or not. I share it with the community and give help to developers who won’t get in touch with CS but want to develop their own plugins too.

@SaxnPaule said:

give help to developers who won’t get in touch with CS

Well, that’s fair enough. Looking at your Javascript, parts of it look like being generated by the Coffeescript compliler. It should be noted, that the corresponding Coffeescript code would be less than 50% of the source lines and more fun to read.

Please consider learning Coffeescript as all the other Plugin contributors did. It is not rocket science and it may also help you on other projects. I am not saying Coffeescript is the best language, but I think it should be agreed the language for plugins - like we’re writing forum posts in English language most of the time. Thanks!

Added a sensor to view the volume and display today. Currently polled every second.
Sensor class is called AVRSensor.
Sample config:

{
      "class": "AVRSensor",
      "id": "avrsensor",
      "name": "AVR",
      "attributes": [
        {
          "name": "display"
        },
        {
          "name": "vol"
        }
      ],
      "xAttributeOptions": [
        {
          "name": "vol",
          "displaySparkline": false,
          "hidden": false
        }
      ]
    }