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.

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

Reopened- GUI Configuration: Created config.schema.json #13

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

Conversation

AppleTechy
Copy link

@AppleTechy AppleTechy commented May 7, 2020

Created config.schema.json which would allow configuration via GUI in Config-UI-X. Also fixed the license listed in the package.json currently throws an SPDX License error on install due to incorrect ID. All configuration settings can be set via the GUI except excluded_attributes and excluded_capabilities. If those were to be configured via GUI it would require a change in how users configure them in the config.json. See here for necessary changes . It would be possible put this would break backwards compatibility with previous config.json version. Another breaking change that would make GUI configuration simpler would be reworking how the boolean values in the config.json work. If GUI configuration is used boolean values will be put into config.json no matter if they are the same as the defaults the plugin uses.
I also moved the changelog from the readme to a separate file. This makes the readme a little bit more readable and this way the changelog can be read in to Homebridge UI.

This PR has no breaking changes.

These breaking changes are just being discussed for possibly another PR later to allow better configuration via GUI.

RE: Dependencies from last PR, Winston log rotate has been deprecate.Tried switching to https://github.com/winstonjs/winston-daily-rotate-file however that seemed to break some stuff. I think it would be best to remove the external log and integrate solely into Homebridge's log rather than generating an extraneous log file.

Created config.schema.json for all configuration values besides 'excluded_attributes' and `excluded_capabilities`.  A by product of the UI configuration is that it automatically inputs into the config.json the boolean values even if they are not different than the defaults the plugin sets.
Moved the changelog from the readme into its own file. This is more inline with what the expectations of Homebridge
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant