homebridge-nature-remo-air-purifier 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ssasuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# homebridge-nature-remo-air-purifier
+ [Homebridge](https://github.com/homebridge/homebridge) plugin to send power on and off to an air purifier using [Nature Remo](https://nature.global/nature-remo/).
+
+## Installation
+```bash
+npm install -g homebridge-nature-remo-air-purifier
+```
+
+## Example config.json
+```json
+  "accessories": [
+    {
+      "name": "[Name display in Home app]",
+      "access_token": "[Your access_token]",
+      "signal_ID_on": "[aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa]",
+      "signal_ID_off": "[bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb]",
+      "accessory": "NatureRemoAirPurifier"
+    }
+  ]
+```
+- `name` can be set whatever you want
+- To get `access_token`, visit https://home.nature.global/
+- To get `signal_ID_on` and `signal_ID_off`, run `curl -X GET "https://api.nature.global/1/appliances" -H "Authorization: Bearer [access_token]"` and find `id` key
+- `accessory` must be `NatureRemoAirPurifier`

package/index.js

@@ -0,0 +1,61 @@
+let Service, Characteristic;
+let exec = require("child_process").exec;
+
+module.exports = function(homebridge) {
+  Service = homebridge.hap.Service;
+  Characteristic = homebridge.hap.Characteristic;
+  homebridge.registerAccessory("homebridge-nature-remo-air-purifier", "NatureRemoAirPurifier", AirPurifier);
+}
+
+function AirPurifier(log, config) {
+  this.log = log;
+
+  this.name = config["name"];
+  this.access_token = config["access_token"];
+  this.signal_ID_on = config["signal_ID_on"];
+  this.signal_ID_off = config["signal_ID_off"];
+
+  this.state = { power: false };
+
+  this.informationService = new Service.AccessoryInformation();
+  this.informationService
+    .setCharacteristic(Characteristic.Manufacturer, "Homebridge")
+    .setCharacteristic(Characteristic.Model, "NatureRemoAirPurifier")
+    .setCharacteristic(Characteristic.SerialNumber, "NRAP-" + this.name);
+
+  this.airPurifierService = new Service.AirPurifier(this.name);
+  this.airPurifierService.getCharacteristic(Characteristic.Active)
+    .on('set', this.setPower.bind(this));
+}
+
+AirPurifier.prototype.getServices = function() {
+  return [this.informationService, this.airPurifierService];
+}
+
+AirPurifier.prototype.setPower = function(value, callback) {
+  if (this.state.power != value) {
+    this.state.power = value;
+    this.log('Setting air purifier power to ' + value);
+
+    const signalID = value ? this.signal_ID_on : this.signal_ID_off;
+
+    this.cmdRequest(signalID, function(error, stdout, stderr) {
+      if (error) {
+        this.log('Failed to set power: ' + error);
+        callback(error);
+      } else {
+        callback();
+      }
+    }.bind(this));
+  } else {
+    callback();
+  }
+}
+
+AirPurifier.prototype.cmdRequest = function(signalID, callback) {
+  let cmd = 'curl -X POST ' +
+            '"https://api.nature.global/1/signals/' + signalID + '/send" ' +
+            '-H "accept":"application/json" ' +
+            '-k --header "Authorization":"Bearer ' + this.access_token + '"';
+  exec(cmd, function(error, stdout, stderr) { callback(error, stdout, stderr); });
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "homebridge-nature-remo-air-purifier",
+  "displayName": "Homebridge Nature Remo Air Purifier",
+  "version": "1.0.0",
+  "description": "Homebridge Plugin to send power on and off to an air purifier using Nature Remo",
+  "author": "Sasuki Sho",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/ssasuki/homebridge-nature-remo-air-purifier.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ssasuki/homebridge-nature-remo-air-purifier/issues"
+  },
+  "keywords": [
+    "homebridge-plugin",
+    "homebridge",
+    "apple",
+    "homekit",
+    "nature",
+    "remo",
+    "air",
+    "purifier"
+  ],
+  "engines": {
+    "node": ">=10.17.0",
+    "homebridge": ">=0.4.8"
+  },
+  "dependencies": {}
+}