homebridge-denon-tv 4.2.6 → 4.3.0-beta.2

package/CHANGELOG.md

@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## The properties *inputs.displayType* and *surrounds.displayType* are removed.
 ## Note - after update to 3.15.x need remove the accessory frome Home app and add it again.
 
+## [4.3.0] - (29.03.2023)
+## Note - after update to 4.1.x buttons need to be configure again using config UI.
+## Changes
+- added RESTFul server
+- code refactor and cleanup
+- config.schema updated
+- fixed some minor issues
+
 ## [4.1.0] - (02.03.2023)
 ## Note - after update to 4.1.x buttons need to be configure again using config UI.
 ## Changes

package/README.md

@@ -35,8 +35,15 @@ Tested with Denon AVR-X6300H, Denon AVR-X2700H, Denon AVR-3311CI, Marantz SR8012
 * Digital Input Modes can be controlled by creating separate tile in the buttons section.
 * Siri can be used for all functions, some times need create legacy buttons/switches/sensors.
 * Automations can be used for all functions, some times need create legacy buttons/switches/sensors.
-* MQTT publisch topic *Info*, *State* *Picture* and *Surround* as payload JSON data.
 * This plugin is based upon the official documentation: [Denon Control Protocol 2020](https://github.com/grzegorz914/homebridge-denon-tv/blob/main/src/Denon%20Control%20Protocol.xlsx)
+* RESTful server:
+  * Request: `http//homebridge_ip_address:port/path`.
+  * Path: `info`, `state`, `picture`, `surround`.
+  * Respone as JSON data.
+* MQTT client:
+  * Topic: `Info`, `State`, `Picture`, `Surround`.
+  * Publish as JSON data.
+
 
 <p align="left">
   <a href="https://github.com/grzegorz914/homebridge-denon-tv"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-denon-tv/main/graphics/homekit.png" width="382"></a> 
@@ -90,6 +97,9 @@ Tested with Denon AVR-X6300H, Denon AVR-X2700H, Denon AVR-3311CI, Marantz SR8012
 | `volumeControl` | Here choice what a additional volume control mode You want to use (`-1 - None/Disabled`, `0 - Lightbulb`, `1 - Fan`). |
 | `infoButtonCommand` | Here select the function of `I` button in RC app. |
 | `refreshInterval` | Here set the data refresh interval. |
+| `enableRestFul` | If enabled, RESTful server will start automatically and respond to any path request. |
+| `restFulPort` | Here set the listening `Port` for RESTful server, every zone need other port. |
+| `restFulDebug` | If enabled, deep log will be present in homebridge console for RESTFul server. |
 | `enableMqtt` | If enabled, MQTT Broker will start automatically and publish all awailable PV installation data. |
 | `mqttDebug` | If enabled, deep log will be present in homebridge console for MQTT. |
 | `mqttHost` | Here set the *IP Address* or *Hostname* for MQTT Broker. |

package/config.schema.json

@@ -4604,6 +4604,33 @@
               "description": "Here set the background data refresh interval.",
               "required": true
             },
+            "enableRestFul": {
+              "title": "Enable",
+              "type": "boolean",
+              "default": false,
+              "required": false,
+              "description": "This enable RESTful server."
+            },
+            "restFulDebug": {
+              "title": "Debug",
+              "type": "boolean",
+              "default": false,
+              "required": false,
+              "description": "This enable debug mode for RESTFul.",
+              "condition": {
+                "functionBody": "return model.devices[arrayIndices].enableRestFul === true;"
+              }
+            },
+            "restFulPort": {
+              "title": "Port",
+              "type": "integer",
+              "placeholder": 3000,
+              "required": true,
+              "description": "Here set the listening Port for RESTful server.",
+              "condition": {
+                "functionBody": "return model.devices[arrayIndices].enableRestFul === true;"
+              }
+            },
             "enableMqtt": {
               "title": "Enable",
               "type": "boolean",
@@ -4814,6 +4841,18 @@
             "devices[].refreshInterval"
           ]
         },
+        {
+          "key": "devices[]",
+          "type": "section",
+          "title": "RESTful",
+          "expandable": true,
+          "expanded": false,
+          "items": [
+            "devices[].enableRestFul",
+            "devices[].restFulDebug",
+            "devices[].restFulPort"
+          ]
+        },
         {
           "key": "devices[]",
           "type": "section",

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Denon TV",
   "name": "homebridge-denon-tv",
-  "version": "4.2.6",
+  "version": "4.3.0-beta.2",
   "description": "Homebridge plugin (https://github.com/homebridge/homebridge) to control Denon/Marantz AV Receivers.",
   "license": "MIT",
   "author": "grzegorz914",
@@ -30,7 +30,8 @@
   "dependencies": {
     "async-mqtt": "^2.6.3",
     "axios": "^1.4.0",
-    "fast-xml-parser": "^4.2.6"
+    "fast-xml-parser": "^4.2.6",
+    "express": "^4.18.2"
   },
   "keywords": [
     "homebridge",

package/src/denon.js

@@ -13,6 +13,7 @@ class DENON extends EventEmitter {
         const zoneControl = config.zoneControl;
         const debugLog = config.debugLog;
         const disableLogConnectError = config.disableLogConnectError;
+        const restFulEnabled = config.restFulEnabled;
         const mqttEnabled = config.mqttEnabled;
         this.refreshInterval = config.refreshInterval;
 
@@ -157,8 +158,15 @@ class DENON extends EventEmitter {
                     return;
                 }
 
+
                 this.emit('deviceInfo', devInfo, manufacturer, modelName, serialNumber, firmwareRevision, zones, apiVersion, supportPictureMode, supportFavorites, supportShortcut, supportInputSource, supportQuickSmartSelect);
-                const mqtt = mqttEnabled ? this.emit('mqtt', 'Info', JSON.stringify(devInfo, null, 2)) : false;
+
+                //restFul
+                const restFul = restFulEnabled ? this.emit('restFul', 'info', devInfo) : false;
+
+                //mqtt
+                const mqtt = mqttEnabled ? this.emit('mqtt', 'Info', devInfo) : false;
+
                 await new Promise(resolve => setTimeout(resolve, 2000));
                 this.supportPictureMode = supportPictureMode;
                 this.supportSoundMode = supportSoundMode;
@@ -225,9 +233,16 @@ class DENON extends EventEmitter {
                     this.soundMode = soundMode;
 
                     this.emit('stateChanged', power, reference, volume, volumeDisplay, mute, pictureMode);
-                    const mqtt1 = mqttEnabled ? this.emit('mqtt', 'State', JSON.stringify(devState, null, 2)) : false;
-                    const mqtt2 = mqttEnabled && checkPictureMode ? this.emit('mqtt', 'Picture', JSON.stringify({ 'Picture Mode': CONSTANS.PictureModesDenonNumber[pictureMode] }, null, 2)) : false;
-                    const mqtt3 = mqttEnabled && checkSoundeMode ? this.emit('mqtt', 'Surround', JSON.stringify({ 'Sound Mode': CONSTANS.SoundModeConversion[soundMode] }, null, 2)) : false;
+
+                    //restFul
+                    const restFul = restFulEnabled ? this.emit('restFul', 'state', devState) : false;
+                    const restFul1 = restFulEnabled && checkPictureMode ? this.emit('restFul', 'picture', { 'Picture Mode': CONSTANS.PictureModesDenonNumber[pictureMode] }) : false;
+                    const restFul2 = restFulEnabled && checkSoundeMode ? this.emit('restFul', 'surround', { 'Sound Mode': CONSTANS.SoundModeConversion[soundMode] }) : false;
+
+                    //mqtt
+                    const mqtt1 = mqttEnabled ? this.emit('mqtt', 'State', devState) : false;
+                    const mqtt2 = mqttEnabled && checkPictureMode ? this.emit('mqtt', 'Picture', { 'Picture Mode': CONSTANS.PictureModesDenonNumber[pictureMode] }) : false;
+                    const mqtt3 = mqttEnabled && checkSoundeMode ? this.emit('mqtt', 'Surround', { 'Sound Mode': CONSTANS.SoundModeConversion[soundMode] }) : false;
                     this.checkState();
                 } catch (error) {
                     const debug = disableLogConnectError ? false : this.emit('error', `State error: ${error}, reconnect in 15s.`);

package/src/denondevice.js

@@ -2,6 +2,7 @@
 const fs = require('fs');
 const fsPromises = fs.promises;
 const EventEmitter = require('events');
+const RestFul = require('./restful.js');
 const Mqtt = require('./mqtt.js');
 const Denon = require('./denon.js');
 const CONSTANS = require('./constans.json');
@@ -44,6 +45,9 @@ class DenonDevice extends EventEmitter {
         this.infoButtonCommand = config.infoButtonCommand || 'MNINF';
         this.volumeControl = config.volumeControl >= 0 ? config.volumeControl : -1;
         this.refreshInterval = config.refreshInterval || 5;
+        this.restFulEnabled = config.enableRestFul || false;
+        this.restFulPort = config.restFulPort || 3000;
+        this.restFulDebug = config.restFulDebug || false;
         this.mqttEnabled = config.enableMqtt || false;
         this.mqttDebug = config.mqttDebug || false;
         this.mqttHost = config.mqttHost;
@@ -60,6 +64,7 @@ class DenonDevice extends EventEmitter {
 
         //setup variables
         this.startPrepareAccessory = true;
+        this.restFulConnected = false;
         this.mqttConnected = false;
         this.services = [];
         this.inputsReference = [];
@@ -89,7 +94,26 @@ class DenonDevice extends EventEmitter {
         this.inputsNamesFile = `${prefDir}/inputsNames_${this.sZoneName}${this.host.split('.').join('')}`;
         this.inputsTargetVisibilityFile = `${prefDir}/inputsTargetVisibility_${this.sZoneName}${this.host.split('.').join('')}`;
 
-        //mqtt client
+        //RESTFul server
+        if (this.restFulEnabled) {
+            this.restFul = new RestFul({
+                port: this.restFulPort,
+                debug: this.restFulDebug
+            });
+
+            this.restFul.on('connected', (message) => {
+                this.emit('message', `${message}`);
+                this.restFulConnected = true;
+            })
+                .on('error', (error) => {
+                    this.emit('error', error);
+                })
+                .on('debug', (debug) => {
+                    this.emit('debug', debug);
+                });
+        }
+
+        //MQTT client
         if (this.mqttEnabled) {
             this.mqtt = new Mqtt({
                 host: this.mqttHost,
@@ -122,6 +146,7 @@ class DenonDevice extends EventEmitter {
             disableLogConnectError: this.disableLogConnectError,
             zoneControl: this.zoneControl,
             refreshInterval: this.refreshInterval,
+            restFulEnabled: this.restFulEnabled,
             mqttEnabled: this.mqttEnabled
         });
 
@@ -383,6 +408,9 @@ class DenonDevice extends EventEmitter {
             .on('error', (error) => {
                 this.emit('error', error);
             })
+            .on('restFul', (path, data) => {
+                const restFul = this.restFulConnected ? this.restFul.update(path, data) : false;
+            })
             .on('mqtt', (topic, message) => {
                 const mqtt = this.mqttConnected ? this.mqtt.send(topic, message) : false;
             })

package/src/mqtt.js

@@ -41,7 +41,8 @@ class MQTTCLIENT extends EventEmitter {
 
         try {
             const fullTopic = `${this.mqttPrefix}/${topic}`;
-            await this.mqttClient.publish(fullTopic, message);
+            const publishMessage = JSON.stringify(message, null, 2);
+            await this.mqttClient.publish(fullTopic, publishMessage);
             const debug = this.mqttDebug ? this.emit('debug', `MQTT publish: ${fullTopic}: ${message}`) : false;
         } catch (error) {
             this.emit('error', `MQTT Publish error: ${error}`);

package/src/restful.js

@@ -0,0 +1,58 @@
+"use strict";
+const express = require('express');
+const EventEmitter = require('events');
+
+class RestFul extends EventEmitter {
+    constructor(config) {
+        super();
+        this.restFulPort = config.port;
+        this.restFulDebug = config.debug;
+
+        this.restFulData = {
+            info: 'This data is not available in this zone.',
+            state: 'This data is not available in this zone.',
+            picture: 'This data is not available in this zone.',
+            surround: 'This data is not available in this zone.'
+        };
+
+        this.connect();
+    };
+
+    connect() {
+        try {
+            const restFul = express();
+            restFul.get('/info', (req, res) => { res.json(this.restFulData.info) });
+            restFul.get('/state', (req, res) => { res.json(this.restFulData.state) });
+            restFul.get('/picture', (req, res) => { res.json(this.restFulData.picture) });
+            restFul.get('/surround', (req, res) => { res.json(this.restFulData.surround) });
+
+            restFul.listen(this.restFulPort, () => {
+                this.emit('connected', `RESTful started on port: ${this.restFulPort}`)
+            });
+
+        } catch (error) {
+            this.emit('error', `RESTful error: ${error}`)
+        }
+    };
+
+    update(path, data) {
+        switch (path) {
+            case 'info':
+                this.restFulData.info = data;
+                break;
+            case 'state':
+                this.restFulData.state = data;
+                break;
+            case 'picture':
+                this.restFulData.picture = data;
+                break;
+            case 'surround':
+                this.restFulData.surround = data;
+                break;
+            default:
+                break;
+        };
+        const emitDebug = this.restFulDebug ? this.emit('debug', `RESTFul update path: ${path}, data: ${data}`) : false;
+    };
+};
+module.exports = RestFul;