Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolving inconsistencies in parameters #19

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Resolving inconsistencies in parameters #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2cde54
Resolving inconsistencies in parameters
chrisvanpatten Aug 29, 2022
ee0e6e3
update sample config file
chrisvanpatten Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,9 @@ See [config-sample.json](https://github.com/deanlyoung/homebridge-awair-local/bl
"accessory": "AwairLocal",
"name": "Example Room 1 Awair",
"ip": "X.X.X.X",
"model": "awair-element",
"manufacturer": "Awair",
"devType": "awair",
"devId": "123",
"serial": "example-serial_123",
"model": "Awair",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 1000,
"voc_mixture_mw": 72.66578273019740,
Expand All @@ -62,16 +60,16 @@ See [config-sample.json](https://github.com/deanlyoung/homebridge-awair-local/bl
```
`accessory` => The Homebridge Accessory (REQUIRED, must be exactly: `AwairLocal`)
`name` => The accessory name that appears by default in HomeKit (REQUIRED, can be anything)
`ip` => The IP address or mDNS .local address (without http://) of the device on your network (REQUIRED)
`ip` => The IP address or mDNS .local address (without http://) of the device on your network (REQUIRED)
`model` => Device Model (OPTIONAL, default = `devType`, options: `Awair`, `Awair Glow`, `Awair Glow C`, `Awair Element`, `Awair Mint`, `Awair Omni`, `Awair 2nd Edition`)
`manufacturer` => Manufacturer (OPTIONAL, default = `Awair`)
`devType` => Device Type (REQUIRED, options: `awair-element`, `awair-mint`, `awair-omni`, or `awair-r2`)
`serial` => Serial Number (OPTIONAL, default = `devType_devId`, options: `mac-address` or `devType_devId`)
`model` => Device Model (OPTIONAL, default = `devType`, options: `Awair`, `Awair Glow`, `Awair Glow C`, `Awair Element`, `Awair Mint`, `Awair Omni`, `Awair 2nd Edition`)

`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`, `awair-aqi`, `awair-pm25`)
`polling` => The frequency (OPTIONAL, default = `10` (10 seconds), units: seconds, that you would like to update the data in HomeKit)
`polling_interval` => The frequency (OPTIONAL, default = `10` (10 seconds), units: seconds, that you would like to update the data in HomeKit)
`url` => The Awair url to poll (OPTIONAL, default = `"http://" + this.ip + "/air-data/latest";`, EDITING NOT RECOMMENDED)
`logging` => Whether to output logs to the Homebridge logs (OPTIONAL, default = `false`)
```
Expand Down
6 changes: 2 additions & 4 deletions config-sample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@
"accessory": "AwairLocal",
"name": "Example Room 1 Awair",
"ip": "X.X.X.X",
"model": "awair-element",
"manufacturer": "Awair",
"devType": "awair-r2",
"devId": "123",
"serial": "awair-r2_123",
"model": "Awair",
"carbonDioxideThreshold": 1200,
"carbonDioxideThresholdOff": 1200,
"voc_mixture_mw": 72.66578273019740,
Expand All @@ -27,4 +25,4 @@
"logging": false
}
]
}
}