release v4.1.0

CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - After update to v4.0.0 RESTFull and MQTT config settings need to be updated
 
+## [4.1.0] - (01.12.2024)
+
+## Changes
+
+- move from commonJS to esm module
+- moved constants.json to constants.js
+- cleanup
+
 ## [4.0.2] - (18.08.2024)
 
 ## Changes

index.js

@@ -1,23 +1,23 @@
 'use strict';
-const path = require('path');
-const fs = require('fs');
-const OpenWebIfDevice = require('./src/openwebifdevice.js');
-const ImpulseGenerator = require('./src/impulsegenerator.js');
-const CONSTANTS = require('./src/constants.json');
+import { join } from 'path';
+import { mkdirSync, existsSync, writeFileSync } from 'fs';
+import OpenWebIfDevice from './src/openwebifdevice.js';
+import ImpulseGenerator from './src/impulsegenerator.js';
+import { PluginName, PlatformName } from './src/constants.js';
 
 class OpenWebIfPlatform {
 	constructor(log, config, api) {
 		// only load if configured
 		if (!config || !Array.isArray(config.devices)) {
-			log.warn(`No configuration found for ${CONSTANTS.PluginName}`);
+			log.warn(`No configuration found for ${PluginName}`);
 			return;
 		}
 		this.accessories = [];
 
 		//check if prefs directory exist
-		const prefDir = path.join(api.user.storagePath(), 'openwebifTv');
+		const prefDir = join(api.user.storagePath(), 'openwebifTv');
 		try {
-			fs.mkdirSync(prefDir, { recursive: true });
+			mkdirSync(prefDir, { recursive: true });
 		} catch (error) {
 			log.error(`Prepare directory error: ${error.message ?? error}`);
 			return;
@@ -70,8 +70,8 @@ class OpenWebIfPlatform {
 					];
 
 					files.forEach((file) => {
-						if (!fs.existsSync(file)) {
-							fs.writeFileSync(file, '');
+						if (!existsSync(file)) {
+							writeFileSync(file, '');
 						}
 					});
 				} catch (error) {
@@ -83,7 +83,7 @@ class OpenWebIfPlatform {
 				try {
 					const openWebIfDevice = new OpenWebIfDevice(api, device, devInfoFile, inputsFile, channelsFile, inputsNamesFile, inputsTargetVisibilityFile, refreshInterval);
 					openWebIfDevice.on('publishAccessory', (accessory) => {
-						api.publishExternalAccessories(CONSTANTS.PluginName, [accessory]);
+						api.publishExternalAccessories(PluginName, [accessory]);
 						log.success(`Device: ${host} ${deviceName}, Published as external accessory.`);
 					})
 						.on('devInfo', (devInfo) => {
@@ -132,6 +132,6 @@ class OpenWebIfPlatform {
 	}
 };
 
-module.exports = (api) => {
-	api.registerPlatform(CONSTANTS.PluginName, CONSTANTS.PlatformName, OpenWebIfPlatform, true);
+export default (api) => {
+	api.registerPlatform(PluginName, PlatformName, OpenWebIfPlatform, true);
 };

package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "OpenWebIf TV",
   "name": "homebridge-openwebif-tv",
-  "version": "4.0.26",
+  "version": "4.1.0",
   "description": "Homebridge plugin to control Sat Receivers based on openWebIf api.",
   "license": "MIT",
   "author": "grzegorz914",
@@ -16,6 +16,7 @@
   "bugs": {
     "url": "https://github.com/grzegorz914/homebridge-openwebif-tv/issues"
   },
+  "type": "module",
   "main": "index.js",
   "files": [
     "src",

src/constants.js

@@ -0,0 +1,27 @@
+export const PlatformName = "OpenWebIfTv";
+export const PluginName = "homebridge-openwebif-tv";
+
+export const ApiUrls = {
+    "DeviceInfo": "/api/deviceinfo",
+    "DeviceStatus": "/api/statusinfo",
+    "GetAllServices": "/api/getallservices",
+    "SetPower": "/api/powerstate?newstate=",
+    "SetChannel": "/api/zap?sRef=",
+    "SetVolume": "/api/vol?set=set",
+    "ToggleMute": "/api/vol?set=mute",
+    "SetRcCommand": "/api/remotecontrol?command="
+};
+
+export const InputSourceType = [
+    "OTHER",
+    "HOME_SCREEN",
+    "TUNER",
+    "HDMI",
+    "COMPOSITE_VIDEO",
+    "S_VIDEO",
+    "COMPONENT_VIDEO",
+    "DVI",
+    "AIRPLAY",
+    "USB",
+    "APPLICATION"
+]

src/impulsegenerator.js

@@ -1,5 +1,5 @@
 "use strict";
-const EventEmitter = require('events');
+import EventEmitter from 'events';
 
 class ImpulseGenerator extends EventEmitter {
     constructor() {
@@ -15,7 +15,7 @@ class ImpulseGenerator extends EventEmitter {
         this.timers = [];
         for (const timer of timers) {
             this.emit(timer.name);
-            
+
             const newTimer = setInterval(() => {
                 this.emit(timer.name);
             }, timer.sampling);
@@ -39,12 +39,12 @@ class ImpulseGenerator extends EventEmitter {
         this.timersState = false;
         this.state();
 
-        return true;
+        return true
     }
 
     state() {
         this.emit('state', this.timersState);
         return this.timersState;
     }
 }
-module.exports = ImpulseGenerator;
+export default ImpulseGenerator;

src/mqtt.js

@@ -1,6 +1,7 @@
 "use strict";
-const AsyncMqtt = require("async-mqtt");
-const EventEmitter = require('events');
+import asyncMqtt from 'async-mqtt';
+const { connectAsync } = asyncMqtt;
+import EventEmitter from 'events';
 
 class Mqtt extends EventEmitter {
     constructor(config) {
@@ -16,7 +17,7 @@ class Mqtt extends EventEmitter {
         this.on('connect', async () => {
             try {
                 //connect
-                this.mqttClient = await AsyncMqtt.connectAsync(url, options);
+                this.mqttClient = await connectAsync(url, options);
                 this.emit('connected', 'MQTT Connected.');
 
                 //subscribe
@@ -52,4 +53,4 @@ class Mqtt extends EventEmitter {
         this.emit('connect');
     };
 };
-module.exports = Mqtt;
+export default Mqtt

src/openwebif.js

@@ -1,12 +1,12 @@
 'use strict';
-const fs = require('fs');
-const fsPromises = fs.promises;
-const axios = require('axios');
-const EventEmitter = require('events');
-const ImpulseGenerator = require('./impulsegenerator.js');
-const CONSTANTS = require('./constants.json');
-
-class OPENWEBIF extends EventEmitter {
+import { promises } from 'fs';
+const fsPromises = promises;
+import axios from 'axios';
+import EventEmitter from 'events';
+import ImpulseGenerator from './impulsegenerator.js';
+import { ApiUrls } from './constants.js';
+
+class OpenWebIf extends EventEmitter {
     constructor(config) {
         super();
         const host = config.host;
@@ -56,7 +56,7 @@ class OPENWEBIF extends EventEmitter {
 
     async connect() {
         try {
-            const deviceInfo = await this.axiosInstance(CONSTANTS.ApiUrls.DeviceInfo);
+            const deviceInfo = await this.axiosInstance(ApiUrls.DeviceInfo);
             const devInfo = deviceInfo.data;
             const debug = this.debugLog ? this.emit('debug', `Connect data: ${JSON.stringify(devInfo, null, 2)}`) : false;
             this.devInfo = devInfo;
@@ -78,7 +78,7 @@ class OPENWEBIF extends EventEmitter {
             await this.saveData(this.devInfoFile, devInfo);
 
             //get all channels
-            const channelsInfo = this.getInputsFromDevice ? await this.axiosInstance(CONSTANTS.ApiUrls.GetAllServices) : false;
+            const channelsInfo = this.getInputsFromDevice ? await this.axiosInstance(ApiUrls.GetAllServices) : false;
             const allChannels = channelsInfo ? channelsInfo.data.services : false;
             const debug1 = this.debugLog ? this.emit('debug', `Channels info: ${channelsInfo}`) : false;
 
@@ -113,7 +113,7 @@ class OPENWEBIF extends EventEmitter {
 
     async checkState() {
         try {
-            const deviceState = await this.axiosInstance(CONSTANTS.ApiUrls.DeviceStatus);
+            const deviceState = await this.axiosInstance(ApiUrls.DeviceStatus);
             const devState = deviceState.data;
             const debug = this.debugLog ? this.emit('debug', `State: ${JSON.stringify(devState, null, 2)}`) : false;
 
@@ -221,4 +221,4 @@ class OPENWEBIF extends EventEmitter {
         };
     };
 };
-module.exports = OPENWEBIF;
+export default OpenWebIf;