homebridge-xbox-tv 2.12.34 → 2.13.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### NOTE!!!
 ## After update to 2.x.x the plugin settings (xboxLiveId) need to be updated.
 
+## [2.13.0] - (05.03.2024)
+## Changes
+- added support to subscribe MQTT and control device
+- config schema updated
+- cleanup
+
 ## [2.12.0] - (02.01.2024)
 ## Changes
 - added possibility to disable prefix name for buttons and sensors

package/README.md

@@ -36,13 +36,7 @@ Homebridge plugin for Microsoft game Consoles. Tested with Xbox One X/S and Xbox
 * Apps, Inputs, Games can be switched if `webApiControl` is enabled and console is authorized.
 * Siri can be used for all functions, some times need to be created legacy buttons/switches/sensors.
 * Automations can be used for all functions, some times need to be created legacy buttons/switches/sensors.
-* RESTful server:
-  * Request: `http//homebridge_ip_address:port/path`.
-  * Path: `info`, `state`, `consoleslist`, `profile`, `apps`, `storages`, `status`.
-  * Respone as JSON data.
-* MQTT client:
-  * Topic: `Info`, `State`, `Consoles List`, `Profile`, `Apps`, `Storages`, `Status`.
-  * Publish as JSON data.
+* Support external integrations, [RESTFul](https://github.com/grzegorz914/homebridge-xbox-tv?tab=readme-ov-file#restful-integration), [MQTT](https://github.com/grzegorz914/homebridge-xbox-tv?tab=readme-ov-file#mqtt-integration).
 
 <p align="center">
  <a href="https://github.com/grzegorz914/homebridge-xbox-tv"><img alt="Accessory tile in the HomeKit app" src="https://raw.githubusercontent.com/grzegorz914/homebridge-xbox-tv/master/graphics/homekit.png" width="382" /></a>
@@ -139,3 +133,25 @@ Homebridge plugin for Microsoft game Consoles. Tested with Xbox One X/S and Xbox
   * Enter custom redirect URI *<http://localhost:8888/auth/callback>*
 * From the overview of your app page, copy *Application (client) ID* to `webApiClientId`
 * Save restart plugin and authorize console again and have fun.
+
+### RESTFul Integration
+
+* Request: `http//homebridge_ip_address:port/path`.
+  * Path: `info`, `state`, `consoleslist`, `profile`, `apps`, `storages`, `status`.
+  * Respone as JSON data.
+
+### MQTT Integration
+
+| Direction | Topic | Message | Payload Data |
+| --- | --- | --- | --- |
+|  Publish   | `Info`, `State`, `Consoles List`, `Profile`, `Apps`, `Storages`, `Status` | `{power: true, app: Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application}` | JSON object. |
+|  Subscribe   | `Set` | `{Power: true}` | JSON object. |
+
+| Subscribe | Key | Value | Type | Description |
+| --- | --- | --- | --- | --- |
+| Xbox |     |     |     |      |
+|     | `Power` | `true`, `false` | boolean | Power state. |
+|     | `App` | `Xbox.Dashboard_8wekyb3d8bbwe!Xbox.Dashboard.Application` | string | Set app. |
+|     | `RcControl` | `fastForward` | string | Send RC command. |
+|     | `Volume` | `up`, `down` | string | Set volume. |
+|     | `Mute` | `true`, `false` | boolean | Set mute. |

package/index.js

@@ -2,7 +2,7 @@
 const path = require('path');
 const fs = require('fs');
 const XboxDevice = require('./src/xboxdevice.js');
-const CONSTANTS = require('./src/constans.json');
+const CONSTANTS = require('./src/constants.json');
 
 class XboxPlatform {
 	constructor(log, config, api) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Xbox TV",
   "name": "homebridge-xbox-tv",
-  "version": "2.12.34",
+  "version": "2.13.0",
   "description": "Homebridge plugin to control Xbox game consoles.",
   "license": "MIT",
   "author": "grzegorz914",

package/src/localApi/message.js

@@ -2,7 +2,7 @@
 const HexToBin = require('hex-to-binary');
 const Packets = require('./packets.js');
 const Structure = require('./structure');
-const CONSTANTS = require('../constans.json');
+const CONSTANTS = require('../constants.json');
 
 class MESSAGE {
     constructor(type) {

package/src/localApi/packets.js

@@ -1,5 +1,5 @@
 "use strict";
-const CONSTANTS = require('../constans.json');
+const CONSTANTS = require('../constants.json');
 
 class PACKETS {
     constructor(structure) {

package/src/localApi/xboxlocalapi.js

@@ -9,7 +9,7 @@ const Ping = require('ping');
 const SimplePacket = require('./simple.js');
 const MessagePacket = require('./message.js');
 const SGCrypto = require('./sgcrypto.js');
-const CONSTANTS = require('../constans.json');
+const CONSTANTS = require('../constants.json');
 
 class XBOXLOCALAPI extends EventEmitter {
     constructor(config) {

package/src/mqtt.js

@@ -1,5 +1,5 @@
 "use strict";
-const MQTT = require("async-mqtt");
+const AsyncMqtt = require("async-mqtt");
 const EventEmitter = require('events');
 
 class MQTTCLIENT extends EventEmitter {
@@ -25,7 +25,7 @@ class MQTTCLIENT extends EventEmitter {
                 password: this.mqttPasswd
             }
             const url = `mqtt://${this.mqttHost}:${this.mqttPort}`;
-            this.mqttClient = await MQTT.connectAsync(url, options);
+            this.mqttClient = await AsyncMqtt.connectAsync(url, options);
             this.emit('connected', 'MQTT Connected.');
             this.isConnected = true;
 

package/src/webApi/authentication.js

@@ -3,7 +3,7 @@ const QueryString = require('querystring');
 const fs = require('fs');
 const fsPromises = fs.promises;
 const axios = require('axios');
-const CONSTANTS = require('../constans.json');
+const CONSTANTS = require('../constants.json');
 
 class AUTHENTICATION {
     constructor(config) {

package/src/webApi/xboxwebapi.js

@@ -17,7 +17,7 @@ const Social = require('./providers/social.js');
 const Titlehub = require('./providers/titlehub.js');
 const UserPresence = require('./providers/userpresence.js');
 const UserStats = require('./providers/userstats.js');
-const CONSTANTS = require('../constans.json');
+const CONSTANTS = require('../constants.json');
 
 class XBOXWEBAPI extends EventEmitter {
     constructor(config) {

package/src/xboxdevice.js

@@ -6,7 +6,7 @@ const RestFul = require('./restful.js');
 const Mqtt = require('./mqtt.js');
 const XboxWebApi = require('./webApi/xboxwebapi.js');
 const XboxLocalApi = require('./localApi/xboxlocalapi.js');
-const CONSTANTS = require('./constans.json');
+const CONSTANTS = require('./constants.json');
 
 let Accessory, Characteristic, Service, Categories, Encode, AccessoryUUID;
 
@@ -113,68 +113,6 @@ class XboxDevice extends EventEmitter {
             this.emit('error', `prepare files error: ${error}`);
         }
 
-        //RESTFul server
-        const restFulEnabled = device.enableRestFul || false;
-        if (restFulEnabled) {
-            this.restFul = new RestFul({
-                port: device.restFulPort || 3000,
-                debug: device.restFulDebug || false
-            });
-
-            this.restFul.on('connected', (message) => {
-                log(`Device: ${host} ${deviceName}, ${message}`);
-                this.restFulConnected = true;
-            })
-                .on('error', (error) => {
-                    this.emit('error', error);
-                })
-                .on('debug', (debug) => {
-                    this.emit('debug', debug);
-                });
-        }
-
-        //mqtt client
-        const mqttEnabled = device.enableMqtt || false;
-        if (mqttEnabled) {
-            this.mqtt = new Mqtt({
-                host: device.mqttHost,
-                port: device.mqttPort || 1883,
-                clientId: device.mqttClientId || `xbox_${Math.random().toString(16).slice(3)}`,
-                prefix: `${device.mqttPrefix}/${device.name}`,
-                user: device.mqttUser,
-                passwd: device.mqttPasswd,
-                debug: device.mqttDebug || false
-            });
-
-            this.mqtt.on('connected', (message) => {
-                this.emit('message', message);
-                this.mqttConnected = true;
-            })
-                .on('changeState', (data) => {
-                    const key = Object.keys(data)[0];
-                    const value = Object.values(data)[0];
-                    switch (key) {
-                        case 'Power':
-                            break;
-                        case 'App':
-                            break;
-                        case 'Volume':
-                            break;
-                        case 'Mute':
-                            break;
-                        default:
-                            this.emit('message', `MQTT Received unknown key: ${key}, value: ${value}`);
-                            break;
-                    };
-                })
-                .on('debug', (debug) => {
-                    this.emit('debug', debug);
-                })
-                .on('error', (error) => {
-                    this.emit('error', error);
-                });
-        };
-
         //web api client
         if (this.webApiControl) {
             this.xboxWebApi = new XboxWebApi({
@@ -333,6 +271,114 @@ class XboxDevice extends EventEmitter {
                 };
             })
             .on('prepareAccessory', async () => {
+                //RESTFul server
+                const restFulEnabled = device.enableRestFul || false;
+                if (restFulEnabled) {
+                    this.restFul = new RestFul({
+                        port: device.restFulPort || 3000,
+                        debug: device.restFulDebug || false
+                    });
+
+                    this.restFul.on('connected', (message) => {
+                        log(`Device: ${host} ${deviceName}, ${message}`);
+                        this.restFulConnected = true;
+                    })
+                        .on('error', (error) => {
+                            this.emit('error', error);
+                        })
+                        .on('debug', (debug) => {
+                            this.emit('debug', debug);
+                        });
+                }
+
+                //mqtt client
+                const mqttEnabled = device.enableMqtt || false;
+                if (mqttEnabled) {
+                    this.mqtt = new Mqtt({
+                        host: device.mqttHost,
+                        port: device.mqttPort || 1883,
+                        clientId: device.mqttClientId || `xbox_${Math.random().toString(16).slice(3)}`,
+                        prefix: `${device.mqttPrefix}/${device.name}`,
+                        user: device.mqttUser,
+                        passwd: device.mqttPasswd,
+                        debug: device.mqttDebug || false
+                    });
+
+                    this.mqtt.on('connected', (message) => {
+                        this.emit('message', message);
+                        this.mqttConnected = true;
+                    })
+                        .on('changeState', async (data) => {
+                            const key = Object.keys(data)[0];
+                            const value = Object.values(data)[0];
+                            try {
+                                switch (key) {
+                                    case 'Power':
+                                        switch (this.webApiPowerOnOff) {
+                                            case true:
+                                                switch (value) {
+                                                    case true: //off
+                                                        await this.xboxWebApi.send('Power', 'WakeUp');
+                                                        break;
+                                                    case false: //on
+                                                        await this.xboxWebApi.send('Power', 'TurnOff');
+                                                        break;
+                                                }
+                                                break;
+                                            case false:
+                                                switch (value) {
+                                                    case true: //off
+                                                        await this.xboxLocalApi.powerOff();
+                                                        break;
+                                                    case false: //on
+                                                        await this.xboxLocalApi.powerOn();
+                                                        break;
+                                                }
+                                        }
+                                        break;
+                                    case 'App':
+                                        const payload = [{ 'oneStoreProductId': value }];
+                                        await this.xboxWebApi.send('Shell', 'ActivateApplicationWithOneStoreProductId', payload);
+                                        break;
+                                    case 'Volume':
+                                        switch (value) {
+                                            case 'up': //Up
+                                                await this.xboxWebApi.send('Volume', 'Up');
+                                                break;
+                                            case 'down': //Down
+                                                await this.xboxWebApi.send('Volume', 'Down');
+                                                break;
+                                        }
+                                        break;
+                                    case 'Mute':
+                                        switch (value) {
+                                            case true: //Mute
+                                                await this.xboxWebApi.send('Audio', 'Mute');
+                                                break;
+                                            case false: //Unmute;
+                                                await this.xboxWebApi.send('Audio', 'Unmute');
+                                                break;
+                                        }
+                                        break;
+                                    case 'RcControl':
+                                        await this.xboxWebApi.send('Shell', 'InjectKey', [{ 'keyType': value }]);
+                                        break;
+                                    default:
+                                        this.emit('message', `MQTT Received unknown key: ${key}, value: ${value}`);
+                                        break;
+                                };
+                            } catch (error) {
+                                this.emit('error', `set: ${key}, over MQTT, error: ${error}`);
+                            };
+                        })
+                        .on('debug', (debug) => {
+                            this.emit('debug', debug);
+                        })
+                        .on('error', (error) => {
+                            this.emit('error', error);
+                        });
+                };
+
                 try {
                     //read dev info from file
                     const savedInfo = await this.readData(this.devInfoFile);