diff --git a/README.md b/README.md index 5b9075240..60dd4db1e 100644 --- a/README.md +++ b/README.md @@ -845,10 +845,10 @@ SOFTWARE. [log-viewer-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [log-viewer-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [log-viewer-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-mqtt-io]: https://github.com/hassio-addons/addon-mqtt-io/tree/726f097 -[addon-doc-mqtt-io]: https://github.com/hassio-addons/addon-mqtt-io/blob/726f097/README.md +[addon-mqtt-io]: https://github.com/hassio-addons/addon-mqtt-io/tree/d6e237a +[addon-doc-mqtt-io]: https://github.com/hassio-addons/addon-mqtt-io/blob/d6e237a/README.md [mqtt-io-issue]: https://github.com/hassio-addons/addon-mqtt-io/issues -[mqtt-io-version-shield]: https://img.shields.io/badge/version-726f097-blue.svg +[mqtt-io-version-shield]: https://img.shields.io/badge/version-d6e237a-blue.svg [mqtt-io-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [mqtt-io-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [mqtt-io-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/mqtt-io/CHANGELOG.md b/mqtt-io/CHANGELOG.md index ad2d7c0a7..5e3221e69 100644 --- a/mqtt-io/CHANGELOG.md +++ b/mqtt-io/CHANGELOG.md @@ -1 +1,9 @@ -- ⬆️ Upgrades add-on base image to 12.0.0 (#4) +- Improvements after first iteration (#1) + +* Add option to specify configuration file location + +* Add configuration_file schema + +* Update documentation + +* Fix add-on options vs config diff --git a/mqtt-io/DOCS.md b/mqtt-io/DOCS.md index cc73b3f06..bcabc1b91 100644 --- a/mqtt-io/DOCS.md +++ b/mqtt-io/DOCS.md @@ -11,7 +11,12 @@ comparison to installing any other Home Assistant add-on. 1. Search for the "MQTT IO" add-on in the Supervisor add-on store and install it. -1. Start the "MQTT IO" add-on +1. Set the location of the MQTT IO configuration file in the add-on options. + By default, this will be `/config/mqtt-io/config.yml`. +1. Create the MQTT IO configuration file. For information about the format + and configuration option, please consult the MQTT IO documentation: + +1. Start the "MQTT IO" add-on when the configuration is created. 1. Check the logs of the "MQTT IO" add-on to see if everything went well. ## Configuration @@ -21,11 +26,24 @@ comparison to installing any other Home Assistant add-on. Example add-on configuration: ```yaml +configuration_file: /config/mqtt-io.yml log_level: info ``` **Note**: _This is just an example, don't copy and past it! Create your own!_ +### Option: `configuration_file` + +The `configuration_file` option allows you to configure the configuration +file MQTT IO will use to run. The default is `/config/mqtt-io/config.yml`, +but you change it to something else if you want. + +For more information about the MQTT IO configuration file format, see: + + + +Please note that this configuration file is not created automatically. + ### Option: `log_level` The `log_level` option controls the level of log output by the addon and can diff --git a/mqtt-io/README.md b/mqtt-io/README.md index 70b69ebb1..3ed2212ad 100644 --- a/mqtt-io/README.md +++ b/mqtt-io/README.md @@ -37,5 +37,5 @@ If you are more interested in stable releases of our add-ons: [forum]: https://community.home-assistant.io/?u=frenck [maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-726f097-blue.svg -[release]: https://github.com/hassio-addons/addon-mqtt-io/tree/726f097 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-d6e237a-blue.svg +[release]: https://github.com/hassio-addons/addon-mqtt-io/tree/d6e237a \ No newline at end of file diff --git a/mqtt-io/config.yaml b/mqtt-io/config.yaml index d53cbe439..93de7eec8 100644 --- a/mqtt-io/config.yaml +++ b/mqtt-io/config.yaml @@ -17,11 +17,14 @@ map: - share:rw - ssl name: MQTT IO +options: + configuration_file: /config/mqtt-io/config.yml privileged: - SYS_RAWIO schema: + configuration_file: str log_level: list(trace|debug|info|notice|warning|error|fatal)? slug: mqtt-io uart: true url: https://github.com/hassio-addons/addon-mqtt-io -version: 726f097 +version: d6e237a diff --git a/mqtt-io/translations/en.yaml b/mqtt-io/translations/en.yaml index e5d9caa4b..8a82d7896 100644 --- a/mqtt-io/translations/en.yaml +++ b/mqtt-io/translations/en.yaml @@ -1,5 +1,9 @@ --- configuration: + configuration_file: + name: MQTT IO Configuration File + description: >- + Location of the MQTT IO configuration file. log_level: name: Log level description: >-