DMBlakeley/homebridge-awair2

Rewording Omni advanced options config-ui-x

deanlyoung opened this issue · 5 comments

The title for the field with the 2 in it (screenshot below) isn't very descriptive / kind of confusing. It's not clear what it is meant for.

Screen Shot 2021-01-31 at 08 44 09

This is explained a bit better in the Wiki, Section 3.

Basically, as Omni sound level samples are collected, a minimum baseline is determined. Say this is 50.2dBA. The 2db is added to 50.2 (52.2dBA) to establish the upper limit for not-occupied. An additional 0.5dB (52.7dBA) is added to establish the lower limit for occupied. This results in a 0.5dB dead-band. I have found to work well in my home environment. May take a bit of adjustment based on other environments.

Will see if I can improve description in config-ui-x text.

I have updated the wording on the config-ui-x settings and also referred to Wiki Chapter 3 for details. Do these changes address your request?

What do you think?

#55

I like your updates. Only item I see is occupanceRestart should be Reset rather than Resume. I currently have not figured out how to write to the config.json file to clear the setting and removed the word next. Propose the following:

  "occupancyRestart": {
    "title": "Omni Reset Occupancy Status - reinitialize Occupancy detection measurement on Homebridge reboot.",
    "type": "boolean",
    "default": false,
    "description": "Omni only - reinitialize Occupancy detection measurement to determine unoccupied sound level on Homebridge reboot.",
    "condition": {
      "functionBody": "return model.occupancyDetection === true;"
    }

I think best to merge from my end as I can then bump the revision to v5.7.2, update CHANGELOG.md and I also want to make some tweaks to the README.md file.

I have scrubbed config.schema.json and README.md files and pushed v5.7.2 with these changes. Appreciate if you take a look and see if you have any comments or concerns.