├── sample-config.json ├── package.json ├── .gitignore ├── README.md ├── index.js └── LICENSE /sample-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "bridge": { 3 | "name": "HomebridgePI", 4 | "username": "CD:22:3D:E3:CE:30", 5 | "port": 51826, 6 | "pin": "031-45-156" 7 | }, 8 | 9 | "description": "The Onion!", 10 | 11 | "platforms": [], 12 | 13 | "accessories": [ 14 | { 15 | "accessory": "HttpTemphum", 16 | "name": "Living Room Weather", 17 | "url": "http://192.168.1.210/weather", 18 | "httpMethod": "GET", 19 | "humidity": true, 20 | "cacheExpiration": 60 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "homebridge-httptemperaturehumidity", 3 | "version": "0.0.17", 4 | "description": "https plugin for homebridge", 5 | "license": "ISC", 6 | "keywords": [ 7 | "homebridge-plugin" 8 | ], 9 | "engines": { 10 | "node": ">=0.12.0", 11 | "homebridge": ">=0.2.0" 12 | }, 13 | "author": { 14 | "name": "Luca Critelli" 15 | }, 16 | "repository": { 17 | "type": "git", 18 | "url": "git://github.com/lucacri/homebridge-http-temperature-humidity.git" 19 | }, 20 | "dependencies": { 21 | "cache-service-cache-module": "^1.2.4", 22 | "superagent": "^3.3.1", 23 | "superagent-cache-plugin": "^1.0.0" 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | *.pid.lock 11 | 12 | # Directory for instrumented libs generated by jscoverage/JSCover 13 | lib-cov 14 | 15 | # Coverage directory used by tools like istanbul 16 | coverage 17 | 18 | # nyc test coverage 19 | .nyc_output 20 | 21 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 22 | .grunt 23 | 24 | # node-waf configuration 25 | .lock-wscript 26 | 27 | # Compiled binary addons (http://nodejs.org/api/addons.html) 28 | build/Release 29 | 30 | # Dependency directories 31 | node_modules 32 | jspm_packages 33 | 34 | # Optional npm cache directory 35 | .npm 36 | 37 | # Optional eslint cache 38 | .eslintcache 39 | 40 | # Optional REPL history 41 | .node_repl_history 42 | 43 | # Output of 'npm pack' 44 | *.tgz 45 | 46 | # Yarn Integrity file 47 | .yarn-integrity 48 | 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # homebridge-http-temperature-humidity 2 | 3 | A HTTP(S) temperature and humidity accessory for [Homebridge](https://github.com/nfarina/homebridge). 4 | 5 | # Installation 6 | 7 | 1. Install homebridge using: `npm install -g homebridge` 8 | 2. Install this plugin using: `npm install -g homebridge-httptemperaturehumidity` 9 | 3. Update your configuration file. See `sample-config.json` in this repository for a sample. 10 | 11 | # Configuration 12 | 13 | Sample configuration: 14 | 15 | ``` 16 | "accessories": [ 17 | { 18 | "accessory": "HttpTemphum", 19 | "name": "Living Room Weather", 20 | "url": "http://192.168.1.210/weather", 21 | "httpMethod": "GET", 22 | "humidity": true, 23 | "cacheExpiration": 60 24 | } 25 | ] 26 | ``` 27 | 28 | Set `humidity` to false if your HTTP endpoint doesn't include a humidity reading. 29 | 30 | The `cacheExpiration` option specifies, in seconds, how long HTTP responses will be stored in the in-memory cache. 31 | 32 | --- 33 | 34 | Your HTTP(S) endpoint should produce JSON that looks like this: 35 | 36 | ``` 37 | { 38 | "temperature": 25.8, 39 | "humidity": 38 40 | } 41 | ``` 42 | 43 | --- 44 | 45 | **This plugin only acts as an interface between a web endpoint and Homebridge.** You will still need some dedicated hardware to expose the web endpoints with the temperature and humidity information. In my case, I used a simple NodeMCU board and a DHT11 (or DHT22). [Check my other repo for the NodeMCU code](https://github.com/lucacri/nodemcu-temperature-humidity-station). 46 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var Service, Characteristic; 2 | var request = require("superagent"); 3 | 4 | // Require and instantiate a cache module 5 | var cacheModule = require("cache-service-cache-module"); 6 | var cache = new cacheModule({storage: "session", defaultExpiration: 60}); 7 | 8 | // Require superagent-cache-plugin and pass your cache module 9 | var superagentCache = require("superagent-cache-plugin")(cache); 10 | 11 | module.exports = function (homebridge) { 12 | Service = homebridge.hap.Service; 13 | Characteristic = homebridge.hap.Characteristic; 14 | homebridge.registerAccessory("homebridge-httptemperaturehumidity", "HttpTemphum", HttpTemphum); 15 | } 16 | 17 | function HttpTemphum(log, config) { 18 | this.log = log; 19 | 20 | // Configuration 21 | this.url = config["url"]; 22 | this.httpMethod = config["httpMethod"] || "GET"; 23 | this.name = config["name"]; 24 | this.manufacturer = config["manufacturer"] || "Generic"; 25 | this.model = config["model"] || "HTTP(S)"; 26 | this.serial = config["serial"] || ""; 27 | this.humidity = config["humidity"]; 28 | this.lastUpdateAt = config["lastUpdateAt"] || null; 29 | this.cacheExpiration = config["cacheExpiration"] || 60; 30 | } 31 | 32 | HttpTemphum.prototype = { 33 | 34 | getRemoteState: function(service, callback) { 35 | request(this.httpMethod, this.url) 36 | .set("Accept", "application/json") 37 | .use(superagentCache) 38 | .expiration(this.cacheExpiration) 39 | .end(function(err, res, key) { 40 | if (err) { 41 | this.log(`HTTP failure (${this.url})`); 42 | callback(err); 43 | } else { 44 | this.log(`HTTP success (${key})`); 45 | 46 | this.temperatureService.setCharacteristic( 47 | Characteristic.CurrentTemperature, 48 | res.body.temperature 49 | ); 50 | this.temperature = res.body.temperature; 51 | 52 | if (this.humidity !== false) { 53 | this.humidityService.setCharacteristic( 54 | Characteristic.CurrentRelativeHumidity, 55 | res.body.humidity 56 | ); 57 | this.humidity = res.body.humidity; 58 | } 59 | 60 | this.lastUpdateAt = +Date.now(); 61 | 62 | switch (service) { 63 | case "temperature": 64 | callback(null, this.temperature); 65 | break; 66 | case "humidity": 67 | callback(null, this.humidity); 68 | break; 69 | default: 70 | var error = new Error("Unknown service: " + service); 71 | callback(error); 72 | } 73 | } 74 | }.bind(this)); 75 | }, 76 | 77 | getTemperatureState: function(callback) { 78 | this.getRemoteState("temperature", callback); 79 | }, 80 | 81 | getHumidityState: function(callback) { 82 | this.getRemoteState("humidity", callback); 83 | }, 84 | 85 | getServices: function () { 86 | var services = [], 87 | informationService = new Service.AccessoryInformation(); 88 | 89 | informationService 90 | .setCharacteristic(Characteristic.Manufacturer, this.manufacturer) 91 | .setCharacteristic(Characteristic.Model, this.model) 92 | .setCharacteristic(Characteristic.SerialNumber, this.serial); 93 | services.push(informationService); 94 | 95 | this.temperatureService = new Service.TemperatureSensor(this.name); 96 | this.temperatureService 97 | .getCharacteristic(Characteristic.CurrentTemperature) 98 | .setProps({ minValue: -273, maxValue: 200 }) 99 | .on("get", this.getTemperatureState.bind(this)); 100 | services.push(this.temperatureService); 101 | 102 | if (this.humidity !== false) { 103 | this.humidityService = new Service.HumiditySensor(this.name); 104 | this.humidityService 105 | .getCharacteristic(Characteristic.CurrentRelativeHumidity) 106 | .setProps({ minValue: 0, maxValue: 100 }) 107 | .on("get", this.getHumidityState.bind(this)); 108 | services.push(this.humidityService); 109 | } 110 | 111 | return services; 112 | } 113 | }; 114 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------