iobroker.airzone 2.0.2 → 3.0.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +1,32 @@
----
-name: Bug report
-about: Something is not working as it should
-title: ''
-labels: ''
-assignees: ''
----
-
-**Describe the bug**  
-A clear and concise description of what the bug is.
-
-**To Reproduce**  
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '...'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**  
-A clear and concise description of what you expected to happen.
-
-**Screenshots & Logfiles**  
-If applicable, add screenshots and logfiles to help explain your problem.
-
-**Versions:**  
- - Adapter version: <adapter-version>
- - JS-Controller version: <js-controller-version> <!-- determine this with `iobroker -v` on the console -->
- - Node version: <node-version> <!-- determine this with `node -v` on the console -->
- - Operating system: <os-name>
-
-**Additional context**  
-Add any other context about the problem here.
+---
+name: Bug report
+about: Something is not working as it should
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**  
+A clear and concise description of what the bug is.
+
+**To Reproduce**  
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**  
+A clear and concise description of what you expected to happen.
+
+**Screenshots & Logfiles**  
+If applicable, add screenshots and logfiles to help explain your problem.
+
+**Versions:**  
+ - Adapter version: <adapter-version>
+ - JS-Controller version: <js-controller-version> <!-- determine this with `iobroker -v` on the console -->
+ - Node version: <node-version> <!-- determine this with `node -v` on the console -->
+ - Operating system: <os-name>
+
+**Additional context**  
+Add any other context about the problem here.

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog for Windows-Installer-NPX
+<!-- **WORK IN PROGRESS** -->
+## 4.0.3 (2022-05-22)
+* Corrected fixer
+
+## 4.0.2 (2022-05-22)
+* Activate windows as npx installer again

package/LocalApi/AirzoneLocalApi.js

@@ -1,7 +1,8 @@
 'use strict';
 
 const AsyncRequest = require('../Utils/asyncRequest');
-const System = require('./System')
+const System = require('./System');
+const Constants = require('./Constants');
 
 // Allow to connect to Airzone local API
 
@@ -11,16 +12,26 @@ class AirzoneLocalApi {
     constructor(a, local_ip)
     {
         adapter = a;
-        log = a.log;        
+        log = a.log;
         this.local_ip = local_ip;
+        this.baseUrl = `http://${local_ip}:3000`;
     }
 
     async init(system_id) {
-        
         this.system = new System(adapter, this, system_id);
         await this.system.init();
+
+        // Try to get version info
+        try {
+            const version = await this.getVersion();
+            if (version) {
+                this.logInfo(`Airzone API Version: ${JSON.stringify(version)}`);
+            }
+        } catch (_e) {
+            this.logInfo('Version endpoint not available');
+        }
     }
-    
+
     async update() {
         if(this.system == undefined)
             return;
@@ -36,47 +47,105 @@ class AirzoneLocalApi {
         log.error(msg);
     }
 
+    /**
+     * Get the API version information
+     * @returns {Promise<object|undefined>} Version info or undefined on error
+     */
+    async getVersion() {
+        const url = this.baseUrl + Constants.API_ENDPOINTS.VERSION;
+        const response = await AsyncRequest.jsonGetRequest(url);
+
+        if (response['errors']) {
+            return undefined;
+        }
+
+        const body = response['body'];
+        return body ? JSON.parse(body) : undefined;
+    }
+
+    /**
+     * Get webserver information (if available)
+     * @returns {Promise<object|undefined>} Webserver info or undefined on error
+     */
+    async getWebserverInfo() {
+        const url = this.baseUrl + Constants.API_ENDPOINTS.WEBSERVER;
+        const data = {};
+        const response = await AsyncRequest.jsonPostRequest(url, data);
+
+        if (response['errors']) {
+            return undefined;
+        }
+
+        const body = response['body'];
+        return body ? JSON.parse(body) : undefined;
+    }
+
     async getZoneState() {
         if(this.system == undefined)
             return undefined;
-        
-        var url = "http://"+this.local_ip+":3000/api/v1/hvac";
-        var systemId = this.system.id;
-        var data = '{\"systemID\":'+systemId+', \"ZoneID\":0}';
-        var response = await AsyncRequest.jsonPostRequest(url, data);
 
-        var errors = response["errors"];
+        const url = this.baseUrl + Constants.API_ENDPOINTS.HVAC;
+        const systemId = this.system.id;
+        const data = { systemID: systemId, ZoneID: 0 };
+        const response = await AsyncRequest.jsonPostRequest(url, data);
+
+        const errors = response['errors'];
         if(errors)
         {
-            this.logError("Failed to get zone state: (statusCode: "+response["statusCode"]+") - "+response["errors"]);
+            this.logError('Failed to get zone state: (statusCode: '+response['statusCode']+') - '+response['errors']);
             return undefined;
         }
-        var body = response["body"];
-        var zones = JSON.parse(body)["data"];
-        
+        const body = response['body'];
+        const zones = JSON.parse(body)['data'];
+
         return zones;
     }
 
-    async sendUpdate(zoneid, key, value) 
+    /**
+     * Get IAQ sensor data (if available)
+     * @returns {Promise<Array|undefined>} IAQ data array or undefined on error
+     */
+    async getIAQData() {
+        if(this.system == undefined)
+            return undefined;
+
+        const url = this.baseUrl + Constants.API_ENDPOINTS.IAQ;
+        const systemId = this.system.id;
+        const data = { systemID: systemId };
+        const response = await AsyncRequest.jsonPostRequest(url, data);
+
+        const errors = response['errors'];
+        if (errors) {
+            // IAQ endpoint may not be available on all devices
+            return undefined;
+        }
+
+        const body = response['body'];
+        const iaqData = body ? JSON.parse(body)['data'] : undefined;
+
+        return iaqData;
+    }
+
+    async sendUpdate(zoneid, key, value)
     {
         if(this.system == undefined)
             return false;
 
         try
         {
-            var url = "http://"+this.local_ip+":3000/api/v1/hvac";
-            var systemId = this.system.id;
-            var data = '{\"systemID\":'+systemId+', \"ZoneID\":'+zoneid+', \"'+key+'\":'+value+'}';
-            var response = await AsyncRequest.jsonPutRequest(url, data);
-            var errors = response["errors"];
+            const url = this.baseUrl + Constants.API_ENDPOINTS.HVAC;
+            const systemId = this.system.id;
+            const data = { systemID: systemId, zoneID: zoneid, [key]: value };
+            const response = await AsyncRequest.jsonPutRequest(url, data);
+            const errors = response['errors'];
             if(errors)
             {
-                this.logError("Failed to update '"+key+"' with value '"+value+"': (statusCode: "+response["statusCode"]+") - "+response["errors"]);
-                return undefined;
+                this.logError("Failed to update '"+key+"' with value '"+value+"': (statusCode: "+response['statusCode']+') - '+response['errors']);
+                return false;
             }
-            var body = response["body"];
-            var responseData = JSON.parse(body)["data"];
-            return responseData.hasOwnProperty(key);
+            const body = response['body'];
+            const responseData = JSON.parse(body)['data'];
+            return responseData && responseData.hasOwnProperty(key);
         }
         catch (e) {
             this.logError('error during sendUpdate '+e+'\r\n'+e.stack);

package/LocalApi/Constants.js

@@ -1,14 +1,58 @@
+'use strict';
+
 module.exports = Object.freeze({
-    MODES_CONVERTER : {
-        "1": {"name": "Stop"},
-        "2": {"name": "Cooling"},
-        "3": {"name": "Heating"},
-        "4": {"name": "Fan"},
-        "5": {"name": "Dry"}
+    // Operating modes - Mode 7 (Auto) added for newer firmware
+    MODES_CONVERTER: {
+        '1': { 'name': 'Stop' },
+        '2': { 'name': 'Cooling' },
+        '3': { 'name': 'Heating' },
+        '4': { 'name': 'Fan' },
+        '5': { 'name': 'Dry' },
+        '7': { 'name': 'Auto' }
+    },
+
+    // Temperature units
+    UNIT_CONVERTER: {
+        '0': { 'name': 'Celsius', 'unit': '°C' },
+        '1': { 'name': 'Fahrenheit', 'unit': '°F' }
+    },
+
+    // Fan speed levels (0 = Auto, 1-7 = Manual speeds)
+    FAN_SPEED_CONVERTER: {
+        '0': { 'name': 'Auto' },
+        '1': { 'name': 'Speed 1 (Lowest)' },
+        '2': { 'name': 'Speed 2' },
+        '3': { 'name': 'Speed 3' },
+        '4': { 'name': 'Speed 4' },
+        '5': { 'name': 'Speed 5' },
+        '6': { 'name': 'Speed 6' },
+        '7': { 'name': 'Speed 7 (Highest)' }
+    },
+
+    // Indoor Air Quality score mapping
+    IAQ_SCORE_CONVERTER: {
+        '1': { 'name': 'Good', 'color': 'green' },
+        '2': { 'name': 'Medium', 'color': 'yellow' },
+        '3': { 'name': 'Bad', 'color': 'orange' },
+        '4': { 'name': 'Very Bad', 'color': 'red' }
     },
 
-    UNIT_CONVERTER : {
-        "0": {"name": "Celsius", "unit": "°C"},
-        "1": {"name": "Fahrenheit", "unit": "°F"}
+    // API Endpoints
+    API_ENDPOINTS: {
+        HVAC: '/api/v1/hvac',
+        SYSTEMS: '/api/v1/systems',
+        ZONES: '/api/v1/zones',
+        WEBSERVER: '/api/v1/webserver',
+        VERSION: '/api/v1/version',
+        IAQ: '/api/v1/iaq'
     },
+
+    // Error codes from the API
+    ERROR_CODES: {
+        '-1': 'System error',
+        '1': 'Invalid parameter',
+        '2': 'Invalid value',
+        '3': 'Out of range',
+        '4': 'Permission denied'
+    }
 });

package/LocalApi/IAQSensor.js

@@ -0,0 +1,123 @@
+'use strict';
+
+const Constants = require('./Constants');
+
+/**
+ * Indoor Air Quality (IAQ) Sensor class
+ * Handles air quality sensor data from the Airzone system
+ */
+class IAQSensor {
+    constructor(adapter, localApi) {
+        this.adapter = adapter;
+        this.localApi = localApi;
+    }
+
+    /**
+     * Initialize the IAQ sensor with data from the airzone local api
+     * @param {string} path - Base path for the sensor objects
+     * @param {object} iaqData - IAQ sensor data from the API
+     */
+    async init(path, iaqData) {
+        this.systemId = parseInt(iaqData['system_id'] || iaqData['systemID'] || 1);
+        this.zoneId = parseInt(iaqData['zone_id'] || iaqData['zoneID'] || 0);
+
+        this.path = path + '.IAQ_Zone' + this.zoneId;
+        await this.adapter.setObjectNotExistsAsync(this.path, {
+            type: 'device',
+            common: {
+                name: 'IAQ_Sensor_Zone_' + this.zoneId,
+                type: 'object',
+                read: true,
+                write: false,
+            },
+            native: {},
+        });
+
+        // IAQ Index (overall air quality score 1-4)
+        await this.adapter.createProperty(this.path, 'iaq_index', 'number', true, false, 'value');
+        await this.adapter.createProperty(this.path, 'iaq_score_name', 'string', true, false, 'text');
+
+        // CO2 level
+        await this.adapter.createUnitProperty(this.path, 'co2', 'number', 0, 5000, 'ppm', true, false, 'value.co2');
+
+        // Temperature from IAQ sensor
+        await this.adapter.createUnitProperty(this.path, 'temperature', 'number', -50, 100, '°C', true, false, 'value.temperature');
+
+        // Humidity from IAQ sensor
+        await this.adapter.createUnitProperty(this.path, 'humidity', 'number', 0, 100, '%', true, false, 'value.humidity');
+
+        // PM2.5 (Particulate Matter)
+        await this.adapter.createUnitProperty(this.path, 'pm2_5', 'number', 0, 1000, 'µg/m³', true, false, 'value');
+
+        // PM10 (Particulate Matter)
+        await this.adapter.createUnitProperty(this.path, 'pm10', 'number', 0, 1000, 'µg/m³', true, false, 'value');
+
+        // TVOC (Total Volatile Organic Compounds)
+        await this.adapter.createUnitProperty(this.path, 'tvoc', 'number', 0, 10000, 'ppb', true, false, 'value');
+
+        // Atmospheric pressure
+        await this.adapter.createUnitProperty(this.path, 'pressure', 'number', 800, 1200, 'hPa', true, false, 'value.pressure');
+
+        // Ventilation mode
+        await this.adapter.createProperty(this.path, 'ventilation_mode', 'number', true, false, 'value');
+
+        await this.updateData(iaqData);
+    }
+
+    /**
+     * Update the IAQ sensor data
+     * @param {object} iaqData - IAQ sensor data from the API
+     */
+    async updateData(iaqData) {
+        // IAQ Index
+        if (iaqData.hasOwnProperty('iaq_index')) {
+            const iaqIndex = iaqData['iaq_index'];
+            await this.adapter.updatePropertyValue(this.path, 'iaq_index', iaqIndex);
+
+            const scoreName = Constants.IAQ_SCORE_CONVERTER[iaqIndex.toString()]?.name || 'Unknown';
+            await this.adapter.updatePropertyValue(this.path, 'iaq_score_name', scoreName);
+        }
+
+        // CO2
+        if (iaqData.hasOwnProperty('co2_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'co2', iaqData['co2_value']);
+        }
+
+        // Temperature
+        if (iaqData.hasOwnProperty('iaq_temp_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'temperature', iaqData['iaq_temp_value']);
+        }
+
+        // Humidity
+        if (iaqData.hasOwnProperty('iaq_humidity_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'humidity', iaqData['iaq_humidity_value']);
+        }
+
+        // PM2.5
+        if (iaqData.hasOwnProperty('pm2_5_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'pm2_5', iaqData['pm2_5_value']);
+        }
+
+        // PM10
+        if (iaqData.hasOwnProperty('pm10_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'pm10', iaqData['pm10_value']);
+        }
+
+        // TVOC
+        if (iaqData.hasOwnProperty('tvoc_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'tvoc', iaqData['tvoc_value']);
+        }
+
+        // Pressure
+        if (iaqData.hasOwnProperty('pressure_value')) {
+            await this.adapter.updatePropertyValue(this.path, 'pressure', iaqData['pressure_value']);
+        }
+
+        // Ventilation mode
+        if (iaqData.hasOwnProperty('iaq_mode_vent')) {
+            await this.adapter.updatePropertyValue(this.path, 'ventilation_mode', iaqData['iaq_mode_vent']);
+        }
+    }
+}
+
+module.exports = IAQSensor;

package/LocalApi/System.js

@@ -1,12 +1,11 @@
-const Zone = require('./Zone')
-const AsyncRequest = require('../Utils/asyncRequest');
+const Zone = require('./Zone');
 const Constants = require('./Constants');
 
 class System {
     constructor(adapter, localApi, id)
     {
         this.adapter = adapter;
-        this.localApi = localApi;                   
+        this.localApi = localApi;
         this.id = id;
     }
 
@@ -14,7 +13,7 @@ class System {
      * Initialize the system with the data from the airzone local api
      */
     async init() {
-        this.path = "System"+this.id;
+        this.path = 'System'+this.id;
         await this.adapter.setObjectNotExistsAsync(this.path, {
             type: 'device',
             common: {
@@ -26,12 +25,12 @@ class System {
             native: {},
         });
 
-        await this.adapter.createProperty(this.path, 'mode_raw', 'string', true, true, 'state');
+        await this.adapter.createProperty(this.path, 'mode_raw', 'number', true, true, 'state');
         await this.adapter.createProperty(this.path, 'mode', 'string', true, false, 'text');
 
         this.adapter.subscribeState(this.path+'.mode_raw', this, this.reactToModeRawChange);
-        
-        var masterZone = await this.load_zones(this.path);
+
+        const masterZone = await this.load_zones(this.path);
         if(masterZone == undefined)
             return false;
 
@@ -44,24 +43,24 @@ class System {
      * Synchronized the system data from airzone into the iobroker data points
      */
     async updateData(masterZoneData)
-    {                               
+    {
         if(masterZoneData == undefined)
         {
-            this.localApi.logError("Missing master Zone");
+            this.localApi.logError('Missing master Zone');
             return;
-        }            
+        }
 
-        this.mode_raw = masterZoneData["mode"];
+        this.mode_raw = masterZoneData['mode'];
         await this.adapter.updatePropertyValue(this.path, 'mode_raw', this.mode_raw);
-        this.mode = Constants.MODES_CONVERTER[this.mode_raw]["name"];
+        this.mode = Constants.MODES_CONVERTER[this.mode_raw]['name'];
         await this.adapter.updatePropertyValue(this.path, 'mode', this.mode);
     }
-   
+
     /**
      * Synchronized the system data from airzone into the iobroker data points and call update for all sub zones
      */
-    async update() {            
-        var masterZoneData = await this.update_zones();        
+    async update() {
+        const masterZoneData = await this.update_zones();
 
         await this.updateData(masterZoneData);
     }
@@ -71,25 +70,25 @@ class System {
      */
     async load_zones(path) {
 
-        var zones_relations = await this.localApi.getZoneState();
+        const zones_relations = await this.localApi.getZoneState();
         if(zones_relations == undefined)
             return undefined;
 
-        var masterZoneData = undefined;
+        let masterZoneData = undefined;
         this.zones = [];
         for (let index = 0; index < zones_relations.length; index++) {
-            var zoneData = zones_relations[index];
-            var zone = new Zone(this.adapter, this.localApi);
-            await zone.init(path, zoneData)
-            this.zones[index] = zone;          
-            
-            if(zoneData.hasOwnProperty("mode"))
+            const zoneData = zones_relations[index];
+            const zone = new Zone(this.adapter, this.localApi);
+            await zone.init(path, zoneData);
+            this.zones[index] = zone;
+
+            if(zoneData.hasOwnProperty('mode'))
             {
                 masterZoneData = zoneData;
                 this.masterZoneId =  this.zones[index].id;
             }
         }
-        
+
         return masterZoneData;
     }
 
@@ -97,21 +96,21 @@ class System {
      * Update zones with the current zone data from airzone local api
      */
     async update_zones() {
-                       
-        var zones_relations = await this.localApi.getZoneState();
+
+        const zones_relations = await this.localApi.getZoneState();
         if(zones_relations == undefined)
             return undefined;
 
         if(this.zones == undefined)
             return undefined;
 
-        var masterZoneData = undefined;
+        let masterZoneData = undefined;
 
         for (let index = 0; index < zones_relations.length; index++) {
-            var zoneData = zones_relations[index];
-            var zId = zoneData["zoneID"];
-            
-            if(zoneData.hasOwnProperty("mode"))
+            const zoneData = zones_relations[index];
+            const zId = zoneData['zoneID'];
+
+            if(zoneData.hasOwnProperty('mode'))
                 masterZoneData = zoneData;
 
             for(let i = 0;i<this.zones.length;i++) {
@@ -119,24 +118,24 @@ class System {
                     await this.zones[i].updateData(zoneData);
                     break;
                 }
-            }                        
-        }        
+            }
+        }
 
         return masterZoneData;
     }
-    
+
     /**
      * Is called when the state of mode was changed
      */
     async reactToModeRawChange(self, id, state) {
-        
+
         if(state.val == 0)
         {
             self.zones.forEach(zone => {
                 zone.turn_off();
             });
         }
-        
+
         self.sendEvent('mode', state.val);
     }
 
@@ -144,7 +143,7 @@ class System {
      * Send event to the airzone local api
      */
     async sendEvent(option, value) {
-        await this.localApi.sendUpdate(this.masterZoneId, option, value)        
-    }    
+        await this.localApi.sendUpdate(this.masterZoneId, option, value);
+    }
 }
 module.exports = System;