diff --git a/README.md b/README.md index fccda306..5b5fd844 100644 --- a/README.md +++ b/README.md @@ -332,6 +332,20 @@ A secure and decentralized communication platform. [:books: Matrix add-on documentation][addon-doc-matrix] +### ✓ [Network UPS Tools][addon-nut] + +![Latest Version][nut-version-shield] +![Supports armhf Architecture][nut-armhf-shield] +![Supports armv7 Architecture][nut-armv7-shield] +![Supports aarch64 Architecture][nut-aarch64-shield] +![Supports amd64 Architecture][nut-amd64-shield] +![Supports i386 Architecture][nut-i386-shield] +![Docker Pulls][nut-pulls-shield] + +Manage battery backup (UPS) devices + +[:books: Network UPS Tools add-on documentation][addon-doc-nut] + ### ✓ [Nginx Proxy Manager][addon-nginxproxymanager] ![Latest Version][nginxproxymanager-version-shield] @@ -672,6 +686,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Lutron Certificate][lutron-cert-issue] - [Open an issue for the add-on: MQTT Server & Web client][mqtt-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] - [Open an issue for the add-on: Node-RED][node-red-issue] - [Open an issue for the add-on: Pi-hole][pi-hole-issue] @@ -950,6 +965,16 @@ SOFTWARE. [matrix-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [matrix-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [matrix-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-nut]: https://github.com/hassio-addons/addon-nut/tree/v0.1.0 +[addon-doc-nut]: https://github.com/hassio-addons/addon-nut/blob/v0.1.0/README.md +[nut-issue]: https://github.com/hassio-addons/addon-nut/issues +[nut-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg +[nut-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/nut-armhf.svg +[nut-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[nut-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[nut-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[nut-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[nut-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/tree/v0.5.0 [addon-doc-nginxproxymanager]: https://github.com/hassio-addons/addon-nginx-proxy-manager/blob/v0.5.0/README.md [nginxproxymanager-issue]: https://github.com/hassio-addons/addon-nginx-proxy-manager/issues diff --git a/nut/CHANGELOG.md b/nut/CHANGELOG.md new file mode 100644 index 00000000..7f8a8356 --- /dev/null +++ b/nut/CHANGELOG.md @@ -0,0 +1,3 @@ +🎉 Initial add-on release 🎉 + +Questions? Join our Discord server! https://discord.me/hassioaddons \ No newline at end of file diff --git a/nut/README.md b/nut/README.md new file mode 100644 index 00000000..3928032d --- /dev/null +++ b/nut/README.md @@ -0,0 +1,64 @@ +# Home Assistant Community Add-on: Network UPS Tools + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +A Network UPS Tools daemon to allow you to easily manage battery backup (UPS) +devices connected to your Home Assistant machine. + +## About + +The primary goal of the Network UPS Tools (NUT) project is to provide support +for Power Devices, such as Uninterruptible Power Supplies, Power Distribution +Units, Automatic Transfer Switch, Power Supply Units and Solar Controllers. + +NUT provides many control and monitoring [features][nut-features], with a +uniform control and management interface. + +More than 140 different manufacturers, and several thousands models +are [compatible][nut-compatible]. + +The Network UPS Tools (NUT) project is the combined effort of +many [individuals and companies][nut-acknowledgements]. + +Be sure to add a NUT Sensor to your `configuration.yaml` after starting the +add-on: + +```yaml +sensor: + - platform: nut + name: "CyberPower 1500" + host: a0d7b954-nut + username: nutty + password: changeme + resources: + - battery.charge + - battery.runtime + - ups.load + - ups.status +``` + +For more information on how to configure the NUT Sensor in Home Assistant +see the [NUT Sensor documentation][nut-sensor-docs]. + +[Click here for the full documentation][docs] + + +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/dale3h +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[docs]: https://github.com/hassio-addons/addon-nut/blob/v0.1.0/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-network-ups-tools/68516 +[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg +[nut-acknowledgements]: https://networkupstools.org/acknowledgements.html +[nut-compatible]: https://networkupstools.org/stable-hcl.html +[nut-features]: https://networkupstools.org/features.html +[nut-sensor-docs]: https://www.home-assistant.io/components/sensor.nut/ +[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-nut/tree/v0.1.0 \ No newline at end of file diff --git a/nut/config.json b/nut/config.json new file mode 100644 index 00000000..c7f13e65 --- /dev/null +++ b/nut/config.json @@ -0,0 +1,89 @@ +{ + "name": "Network UPS Tools", + "version": "0.1.0", + "slug": "nut", + "description": "Manage battery backup (UPS) devices", + "url": "https://github.com/hassio-addons/addon-nut", + "startup": "system", + "arch": [ + "aarch64", + "amd64", + "armhf", + "armv7", + "i386" + ], + "auto_uart": "true", + "boot": "auto", + "hassio_api": true, + "hassio_role": "manager", + "homeassistant_api": true, + "ports": { + "3493/tcp": null + }, + "ports_description": { + "3493/tcp": "Network UPS Tools" + }, + "devices": [ + "/dev/bus/usb:/dev/bus/usb:rwm" + ], + "options": { + "users": [ + { + "username": "", + "password": "", + "instcmds": [ + "all" + ], + "actions": [] + } + ], + "devices": [ + { + "name": "myups", + "driver": "usbhid-ups", + "port": "auto", + "config": [] + } + ], + "mode": "netserver", + "shutdown_host": "false" + }, + "schema": { + "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", + "users": [ + { + "username": "str", + "password": "password", + "instcmds": [ + "str" + ], + "actions": [ + "str" + ], + "upsmon": "list(master|slave)?" + } + ], + "devices": [ + { + "name": "str", + "driver": "str", + "port": "str", + "config": [ + "str" + ] + } + ], + "mode": "list(netserver|netclient)", + "shutdown_host": "bool", + "list_usb_devices": "bool?", + "remote_ups_name": "str?", + "remote_ups_host": "str?", + "remote_ups_password": "password?", + "remote_ups_user": "str?", + "upsd_maxage": "int?", + "fake_usb_devices": "bool?", + "i_like_to_be_pwned": "bool?", + "leave_front_door_open": "bool?" + }, + "image": "hassioaddons/nut-{arch}" +} \ No newline at end of file diff --git a/nut/icon.png b/nut/icon.png new file mode 100644 index 00000000..4c36debd Binary files /dev/null and b/nut/icon.png differ diff --git a/nut/logo.png b/nut/logo.png new file mode 100644 index 00000000..4c36debd Binary files /dev/null and b/nut/logo.png differ