資料介紹
軟件簡介
DEPRECATION
This plugin is now deprecated/archived/read-only.
It is recommended that you switch to the second generation Homebridge Dynamic Platform plugin: homebridge-awair2
homebridge-awair
Awair plugin for homebridge: https://github.com/nfarina/homebridge
Based on the great work of @henrypoydar.
This is a very basic plugin for Nfarina's amazing Homebridge project. It will fetch current sensor conditions from an Awair device (e.g. Awair, Awair Glow, Awair Mint, Awair Omni, Awair 2nd Edition or Awair Element) and provide available sensor readings (e.g. temperature, humidity, carbon dioxide, TVOC, and dust/PM2.5/PM10) information for HomeKit.
You can look at the current Awair information via HomeKit enabled Apps on your iOS device or even ask Siri for them.
It will get new data once every 15 minutes (default), but it can be customized in config.json
.
Installation
-
Install homebridge using:
[sudo] npm install -g homebridge
-
Install this plugin using:
[sudo] npm install -g homebridge-awair
- Update your configuration file. See the sample below.
You'll need to run an HTTP request to obtain each Awair's device ID (devId
) and device type (devType
).
curl -X GET \
http://developer-apis.awair.is/v1/users/self/devices \
-H 'Authorization: Bearer {developer-token}'
You'll also need to request access to the Awair Developer Console to obtain your Developer Token (token
).
The Awair Developer API Documentation explains the inner workings of the Awair Developer API, but for the most part is not necessary to use this plugin.
Configuration
Configuration sample:
Add the following information to your config file (note: shown with (6) example devices: Awair, Awair Glow, Awair Mint, Awair Omni, Awair 2nd Edition and Awair Element).
"accessories": [
{
"accessory": "Awair",
"name": "Example Room 1 Awair",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair",
"devId": "123",
"serial": "example-serial_123",
"model": "Awair",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 1200,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
},{
"accessory": "Awair",
"name": "Example Room 2 Awair Glow",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair-glow",
"devId": "124",
"serial": "example-serial_124",
"model": "Awair Glow",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 900,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
},{
"accessory": "Awair",
"name": "Example Room 3 Awair Mint",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair-mint",
"devId": "125",
"serial": "example-serial_125",
"model": "Awair Mint",
"carbonDioxideThreshold": 0,
"carbonDioxideThresholdOff": 0,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
},{
"accessory": "Awair",
"name": "Example Room 4 Awair Omni",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair-omni",
"devId": "126",
"serial": "example-serial_126",
"model": "Awair Omni",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 800,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
},{
"accessory": "Awair",
"name": "Example Room 5 Awair 2nd Edition",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair-r2",
"devId": "127",
"serial": "example-serial_127",
"model": "Awair 2nd Edition",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 1000,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
},{
"accessory": "Awair",
"name": "Example Room 6 Awair Element",
"token": "AAA.AAA.AAA",
"manufacturer": "Awair",
"devType": "awair-element",
"devId": "127",
"serial": "example-serial_127",
"model": "Awair Element",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 1000,
"voc_mixture_mw": 72.66578273019740,
"air_quality_method": "awair-score",
"userType": "users/self",
"endpoint": "15-min-avg",
"polling_interval": 900,
"limit": 12
}
]
Descriptions
`accessory` => The Homebridge Accessory (REQUIRED, must be exactly: `Awair`)
`name` => The accessory name that appears by default in HomeKit (REQUIRED, can be anything)
`token` => Developer Token (REQUIRED, see [Installation](#installation))
`manufacturer` => Manufacturer (OPTIONAL, default = `Awair`)
`devType` => Device Type (REQUIRED, options: `awair`, `awair-glow`, `awair-mint`, `awair-omni`, `awair-r2` or 'awair-element')
`devId` => Device ID (REQUIRED, see [Installation](#installation))
`serial` => Serial Number (OPTIONAL, default = `devType_devId`, options: `mac-address` or `devType_devId`)
`model` => Device Model (OPTIONAL, default = `devType`, options: `Awair`, `Awair Glow`, `Awair Mint`, `Awair Omni`, `Awair 2nd Edition`, 'Awair Element')
`carbonDioxideThreshold` => (OPTIONAL, default = `0` [i.e. OFF], the level at which HomeKit will trigger an alert for the CO2 in ppm)
`carbonDioxideThresholdOff` => (OPTIONAL, default = `0` [i.e. `carbonDioxideThreshold`], the level at which HomeKit will turn off the trigger alert for the CO2 in ppm, to ensure that it doesn't trigger on/off too frequently choose a number lower than `carbonDioxideThreshold`)
`voc_mixture_mw` => The Molecular Weight (g/mol) of a reference gas or mixture that you use to convert from ppb to ug/m^3 (OPTIONAL, default = `72.66578273019740`)
`air_quality_method` => Air quality calculation method used to define the Air Quality Chracteristic (OPTIONAL, default = `awair-score`, options: `awair-score`, `aqi`, `nowcast-aqi`)
`endpoint` => The `/air-data` endpoint to use (OPTIONAL, default = `15-min-avg`, options: `15-min-avg`, `5-min-avg`, `raw`, or `latest`)
`polling_interval` => The frequency (OPTIONAL, default = `900` (15 minutes), units: seconds, that you would like to update the data in HomeKit)
`userType` => The type of user account (OPTIONAL, default = `users/self`, options: `users/self` or `orgs/###`, where ### is the Awair Organization `orgId`)
`limit` => Number of consecutive 10 second data points returned per request, used for custom averaging of sensor values from `/raw` endpoint (OPTIONAL, default = `12` i.e. 2 minute average)
`url` => The Awair url to poll (OPTIONAL, default = `http://developer-apis.awair.is/v1/users/self/devices/:device_type/:device_id/air-data/:endpoint?limit=:limit&desc=true`, EDITING NOT RECOMMENDED)
`logging` => Whether to output logs to the Homebridge logs (OPTIONAL, default = `false`)
`logging_level` => How verbosely to log (OPTIONAL, default = `0`, options: `0`, `1`, `2`, `3`)
API Response
See response.sample.json
Resources
- Awair API: https://docs.developer.getawair.com/
- Homebridge: https://github.com/nfarina/homebridge
- Homebridge plugin development: http://blog.theodo.fr/2017/08/make-siri-perfect-home-companion-devices-not-supported-apple-homekit/
- List of Services and conventions: https://github.com/KhaosT/HAP-NodeJS/blob/master/lib/gen/HomeKitTypes.js
- Another Awair plugin: https://github.com/henrypoydar/homebridge-awair-glow
- Reference AQ plugin: https://github.com/toto/homebridge-airrohr
- Refenerce temperature plugin: https://github.com/metbosch/homebridge-http-temperature
- AQI Calculation NPM package: https://www.npmjs.com/package/aqi-bot
- 用Rust編寫的Homebridge Spotify插件
- 用于樹莓派與PIR傳感器連接成運動傳感器的homebridge插件
- Homebridge插件集成Shinobi
- Homebridge的Loxone插件
- Homebridge Pi恒溫器插件
- 米家安防攝像頭Homebridge插件
- Homebridge插件可在Apple HomeKit中使用RuuviTags
- homebridge通過wifi檢測房間中的存在
- homebridge示例插件示例集合
- homebridge-smartthings SmartThings插件
- homebridge miio平臺插件
- 熱門的homebridge插件列表
- 將Wyze連接家庭設備支持添加到Homebridge的插件
- Homebridge-Denon-Marantz-AVR插件
- Homebridge GPIO WiringPi平臺插件
- 晶振的封裝類型選擇,貼片還是插件?到底該怎么選? 225次閱讀
- DIP插件加工注意事項 766次閱讀
- PCBA加工接插件焊接式的質量控制 404次閱讀
- 使用DevartExcel插件的好處 525次閱讀
- Rust構建QEMU插件的框架 745次閱讀
- 如何制作交互式BOM的AD插件 4355次閱讀
- 插件器件的方形引腳繪制及處理方法 1363次閱讀
- 分享幾個vscode必備精品插件 2871次閱讀
- 插件電阻的選用方法 2870次閱讀
- dfrobot面包板實驗插件LED插件包簡介 1174次閱讀
- 魏德米勒新推用于驅動系統的印刷線路板接插件 2890次閱讀
- 電子接插件電鍍技術 3361次閱讀
- vscode常用插件有哪些 2w次閱讀
- jquery插件開發實例(MSBar2D圖效果、手風琴特效插件) 1988次閱讀
- jquery插件寫法及用法(jQuery插件開發全解析) 1w次閱讀
下載排行
本周
- 1使用單片機實現七人表決器的程序和仿真資料免費下載
- 2.96 MB | 44次下載 | 免費
- 2聯想E46L DAOLL6筆記本電腦圖紙
- 1.10 MB | 2次下載 | 5 積分
- 3MATLAB繪圖合集
- 27.12 MB | 2次下載 | 5 積分
- 4PR735,使用UCC28060的600W交錯式PFC轉換器
- 540.03KB | 1次下載 | 免費
- 5UCC38C42 30W同步降壓轉換器參考設計
- 428.07KB | 1次下載 | 免費
- 6DV2004S1/ES1/HS1快速充電開發系統
- 2.08MB | 1次下載 | 免費
- 7模態分解合集matlab代碼
- 3.03 MB | 1次下載 | 2 積分
- 8美的電磁爐維修手冊大全
- 1.56 MB | 1次下載 | 5 積分
本月
- 1使用單片機實現七人表決器的程序和仿真資料免費下載
- 2.96 MB | 44次下載 | 免費
- 2UC3842/3/4/5電源管理芯片中文手冊
- 1.75 MB | 15次下載 | 免費
- 3DMT0660數字萬用表產品說明書
- 0.70 MB | 13次下載 | 免費
- 4TPS54202H降壓轉換器評估模塊用戶指南
- 1.02MB | 8次下載 | 免費
- 5STM32F101x8/STM32F101xB手冊
- 1.69 MB | 8次下載 | 1 積分
- 6HY12P65/HY12P66數字萬用表芯片規格書
- 0.69 MB | 6次下載 | 免費
- 7華瑞昇CR216芯片數字萬用表規格書附原理圖及校正流程方法
- 0.74 MB | 6次下載 | 3 積分
- 8華瑞昇CR215芯片數字萬用表原理圖
- 0.21 MB | 5次下載 | 3 積分
總榜
- 1matlab軟件下載入口
- 未知 | 935119次下載 | 10 積分
- 2開源硬件-PMP21529.1-4 開關降壓/升壓雙向直流/直流轉換器 PCB layout 設計
- 1.48MB | 420061次下載 | 10 積分
- 3Altium DXP2002下載入口
- 未知 | 233084次下載 | 10 積分
- 4電路仿真軟件multisim 10.0免費下載
- 340992 | 191367次下載 | 10 積分
- 5十天學會AVR單片機與C語言視頻教程 下載
- 158M | 183335次下載 | 10 積分
- 6labview8.5下載
- 未知 | 81581次下載 | 10 積分
- 7Keil工具MDK-Arm免費下載
- 0.02 MB | 73807次下載 | 10 積分
- 8LabVIEW 8.6下載
- 未知 | 65987次下載 | 10 積分
評論
查看更多