Addition of Wiki update

* Minimum Omni occupancy level changed to 48.0dBA per Omni specifications. * Addition of Wiki screenshots.
DMBlakeley · Nov 22, 2020 · e3f8543 · e3f8543
1 parent 95b408e
commit e3f8543
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/).
 
+## v5.5.6
+  * Minimum Omni occupancy level changed to 48.0dBA per Omni specifications.
+  * Addition of Wiki screenshots.
+
 ## v5.5.5
   * Omni occupancy detection improvments. Minimum sound level set to 47dBA based on dust sensor fan noise as guard for spurious low reading. Provide option to restart detection algorithm on Homebridge restart.
 

diff --git a/README.md b/README.md
@@ -73,7 +73,7 @@ Parameter | Description
 `platform` | The Homebridge Accessory (REQUIRED, must be exactly: `Awair2`)
 `token` | Developer Token (REQUIRED, see [Installation](#installation)) above.
 `userType` | The type of user account (OPTIONAL, default = `users/self`, options: `users/self` or `orgs/###`, where ### is the Awair Organization `orgId`)
-`airQualityMethod` | Air quality calculation method used to define the Air Quality Chracteristic (OPTIONAL, default = `awair-aqi`, options: `awair-score`, `awair-aqi`)
+`airQualityMethod` | Air quality calculation method used to define the Air Quality Chracteristic (OPTIONAL, default = `awair-aqi`, options: `awair-aqi` or `awair-score`)
 `endpoint` | The `/air-data/` endpoint to use (OPTIONAL, default = `15-min-avg`, options: `15-min-avg`, `5-min-avg`, `raw` or `latest`)
 `limit` | Number of consecutive data points returned per request, used for custom averaging of sensor values (OPTIONAL, default = `1` i.e. one `15-min-avg`). Defaults to 1 for  `latest`.
 `carbonDioxideThreshold` | (OPTIONAL, default = `0` [i.e. OFF], the level at which HomeKit will trigger an alert for the CO2 in ppm)
@@ -102,4 +102,5 @@ Parameter | Description
 - Reference AQ plugin: https://github.com/toto/homebridge-airrohr
 - Reference temperature plugin: https://github.com/metbosch/homebridge-http-temperature
 - AQI Calculation NPM package: https://www.npmjs.com/package/aqi-bot
+- How is the Air Quality Index (AQI) calculated: https://stimulatedemissions.wordpress.com/2013/04/10/how-is-the-air-quality-index-aqi-calculated/
 - Homebridge-philips-air plugin: https://github.com/Sunoo/homebridge-philips-air
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "private": false,
   "displayName": "Homebridge Awair2",
   "name": "homebridge-awair2",
-  "version": "5.5.5",
+  "version": "5.5.6",
   "description": "HomeKit integration of Awair air purifier as Dynamic Platform.",
   "main": "dist/index.js",
   "scripts": {

diff --git a/screenshots/Awair_Characteristics.png b/screenshots/Awair_Characteristics.png
diff --git a/screenshots/Image3.png b/screenshots/Image3.png
diff --git a/src/index.ts b/src/index.ts
@@ -802,7 +802,7 @@ class AwairPlatform implements DynamicPlatformPlugin {
 	        this.log('[' + accessory.context.serial + '] spl_a: ' + omniSpl_a);
 	      }
 
-	      if(omniSpl_a > 47.0 && omniSpl_a < accessory.context.minSoundLevel) { // 50dBA (±3) baseline set by dust sensor fan noise 
+	      if(omniSpl_a > 48.0 && omniSpl_a < accessory.context.minSoundLevel) { // Omni ambient sound level range 48 - 90dBA 
 	        accessory.context.minSoundLevel = omniSpl_a; // use 'context' to track occupancy status for each Omni device
 	        accessory.context.occDetectedLevel = accessory.context.minSoundLevel + this.occupancyOffset + 0.5; // dBA
 	        accessory.context.occDetectedNotLevel = accessory.context.minSoundLevel + this.occupancyOffset; // dBA