🎉 Release of add-on MQTT IO 0.1.0

2025-05-03 18:41:30 +00:00 · 2022-07-19 18:48:38 +00:00 · 2022-07-19 18:48:38 +00:00 · 382f1036aa
commit 382f1036aa
parent 5004dda860
6 changed files with 245 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -232,6 +232,19 @@ Browser-based log utility for Home Assistant

 [:books: Log Viewer add-on documentation][addon-doc-log-viewer]

+### &#10003; [MQTT IO][addon-mqtt-io]
+
+![Latest Version][mqtt-io-version-shield]
+![Supports armhf Architecture][mqtt-io-armhf-shield]
+![Supports armv7 Architecture][mqtt-io-armv7-shield]
+![Supports aarch64 Architecture][mqtt-io-aarch64-shield]
+![Supports amd64 Architecture][mqtt-io-amd64-shield]
+![Supports i386 Architecture][mqtt-io-i386-shield]
+
+Expose GPIO modules and digital sensors via MQTT for remote control and monitoring.
+
+[:books: MQTT IO add-on documentation][addon-doc-mqtt-io]
+
 ### &#10003; [Matrix][addon-matrix]

 ![Latest Version][matrix-version-shield]
@ -601,6 +614,7 @@ on the correct GitHub repository matching the add-on.
 - [Open an issue for the add-on: InfluxDB][influxdb-issue]
 - [Open an issue for the add-on: JupyterLab][jupyterlab-issue]
 - [Open an issue for the add-on: Log Viewer][log-viewer-issue]
+- [Open an issue for the add-on: MQTT IO][mqtt-io-issue]
 - [Open an issue for the add-on: Matrix][matrix-issue]
 - [Open an issue for the add-on: Network UPS Tools][nut-issue]
 - [Open an issue for the add-on: Nginx Proxy Manager][nginxproxymanager-issue]
@ -808,6 +822,15 @@ 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/v0.1.0
+[addon-doc-mqtt-io]: https://github.com/hassio-addons/addon-mqtt-io/blob/v0.1.0/README.md
+[mqtt-io-issue]: https://github.com/hassio-addons/addon-mqtt-io/issues
+[mqtt-io-version-shield]: https://img.shields.io/badge/version-v0.1.0-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
+[mqtt-io-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
+[mqtt-io-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
 [addon-matrix]: https://github.com/hassio-addons/addon-matrix/tree/v0.10.0
 [addon-doc-matrix]: https://github.com/hassio-addons/addon-matrix/blob/v0.10.0/README.md
 [matrix-issue]: https://github.com/hassio-addons/addon-matrix/issues
--- a/mqtt-io/CHANGELOG.md
+++ b/mqtt-io/CHANGELOG.md
@ -0,0 +1,3 @@
+## What’s changed
+
+🎉  Initial release 🎉 
--- a/mqtt-io/DOCS.md
+++ b/mqtt-io/DOCS.md
@ -0,0 +1,139 @@
+# Home Assistant Community Add-on: MQTT IO
+
+Exposes general purpose inputs and outputs (GPIO), hardware sensors and serial
+devices to an MQTT server. Ideal for single-board computers such as
+the Raspberry Pi.
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in
+comparison to installing any other Home Assistant add-on.
+
+1. Click the Home Assistant My button below to open the add-on on your Home
+   Assistant instance.
+
+   [![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
+
+1. Click the "Install" button to install the 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:
+   <https://mqtt-io.app/2.2.6/#/config/scenarios>
+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
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+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:
+
+<https://mqtt-io.app/2.2.7/#/config/scenarios> and <https://mqtt-io.app/2.2.7/#/config/ha_discovery>
+
+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
+be changed to be more or less verbose, which might be useful when you are
+dealing with an unknown issue. Possible values are:
+
+- `trace`: Show every detail, like all called internal functions.
+- `debug`: Shows detailed debug information.
+- `info`: Normal (usually) interesting events.
+- `warning`: Exceptional occurrences that are not errors.
+- `error`: Runtime errors that do not require immediate action.
+- `fatal`: Something went terribly wrong. Add-on becomes unusable.
+
+Please note that each level automatically includes log messages from a
+more severe level, e.g., `debug` also shows `info` messages. By default,
+the `log_level` is set to `info`, which is the recommended setting unless
+you are troubleshooting.
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality.
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
+based on the following:
+
+- `MAJOR`: Incompatible or major changes.
+- `MINOR`: Backwards-compatible new features and enhancements.
+- `PATCH`: Backwards-compatible bugfixes and package updates.
+
+## Support
+
+Got questions?
+
+You have several options to get them answered:
+
+- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
+  support and feature requests.
+- The [Home Assistant Discord chat server][discord-ha] for general Home
+  Assistant discussions and questions.
+- The Home Assistant [Community Forum][forum].
+- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
+
+You could also [open an issue here][issue] GitHub.
+
+## Authors & contributors
+
+The original setup of this repository is by [Franck Nijhof][frenck].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2022 Franck Nijhof
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
+[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_mqtt_io&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
+[alpine-packages]: https://pkgs.alpinelinux.org/packages
+[contributors]: https://github.com/hassio-addons/addon-mqtt-io/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[forum]: https://community.home-assistant.io/?u=frenck
+[frenck]: https://github.com/frenck
+[issue]: https://github.com/hassio-addons/addon-mqtt-io/issues
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-mqtt-io/releases
+[semver]: http://semver.org/spec/v2.0.0.htm
--- a/mqtt-io/README.md
+++ b/mqtt-io/README.md
@ -0,0 +1,38 @@
+# Home Assistant Community Add-on: MQTT IO
+
+[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
+
+[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
+
+Expose GPIO modules and digital sensors via MQTT for remote control and monitoring.
+
+## About
+
+Exposes general purpose inputs and outputs (GPIO), hardware sensors and serial
+devices to an MQTT server. Ideal for single-board computers such as
+the Raspberry Pi.
+
+## WARNING! THIS IS A BETA VERSION!
+
+This Home Assistant Add-ons repository contains beta releases of add-ons.
+
+- They might stop working at any time.
+- They could have a negative impact on your system.
+
+This repository was created for:
+
+- Anybody willing to test.
+- Anybody interested in trying out upcoming add-ons or add-on features.
+
+If you are more interested in stable releases of our add-ons:
+
+<https://github.com/hassio-addons/repository>
+
+[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
+[discord]: https://discord.me/hassioaddons
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
+[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-v0.1.0-blue.svg
+[release]: https://github.com/hassio-addons/addon-mqtt-io/tree/v0.1.0
--- a/mqtt-io/config.yaml
+++ b/mqtt-io/config.yaml
@ -0,0 +1,32 @@
+arch:
+- aarch64
+- amd64
+- armhf
+- armv7
+- i386
+codenotary: codenotary@frenck.dev
+description: Expose GPIO modules and digital sensors via MQTT for remote control and
+  monitoring.
+devices:
+- /dev/mem
+- /dev/gpiomem
+gpio: true
+homeassistant_api: true
+image: ghcr.io/hassio-addons/mqtt-io/{arch}
+init: false
+map:
+- config:rw
+- 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: 0.1.0
--- a/mqtt-io/translations/en.yaml
+++ b/mqtt-io/translations/en.yaml
@ -0,0 +1,10 @@
+---
+configuration:
+  configuration_file:
+    name: MQTT IO Configuration File
+    description: >-
+      Location of the MQTT IO configuration file.
+  log_level:
+    name: Log level
+    description: >-
+      Controls the level of log details the add-on provides.