diff --git a/README.md b/README.md index c79998975..389518da6 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,19 @@ Automatically convert your existing UI to the new Lovelace UI [:books: Lovelace Migration add-on documentation][addon-doc-lovelace-migration] +### ✓ [Network UPS Tools][addon-nut] + +![Latest Version][nut-version-shield] +![Supports armhf Architecture][nut-armhf-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] + ### ✓ [Node-RED][addon-node-red] ![Latest Version][node-red-version-shield] @@ -427,6 +440,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Jupyter][jupyter-issue] - [Open an issue for the add-on: Log Viewer][log-viewer-issue] - [Open an issue for the add-on: Lovelace Migration][lovelace-migration-issue] +- [Open an issue for the add-on: Network UPS Tools][nut-issue] - [Open an issue for the add-on: Node-RED][node-red-issue] - [Open an issue for the add-on: Octobox][octobox-issue] - [Open an issue for the add-on: Pi-hole][pi-hole-issue] @@ -623,6 +637,15 @@ SOFTWARE. [lovelace-migration-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [lovelace-migration-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [lovelace-migration-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-nut]: https://github.com/hassio-addons/addon-nut/tree/65d0b03 +[addon-doc-nut]: https://github.com/hassio-addons/addon-nut/blob/65d0b03/README.md +[nut-issue]: https://github.com/hassio-addons/addon-nut/issues +[nut-version-shield]: https://img.shields.io/badge/version-65d0b03-blue.svg +[nut-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/nut.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-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-node-red]: https://github.com/hassio-addons/addon-node-red/tree/0aec68f [addon-doc-node-red]: https://github.com/hassio-addons/addon-node-red/blob/0aec68f/README.md [node-red-issue]: https://github.com/hassio-addons/addon-node-red/issues diff --git a/nut/CHANGELOG.md b/nut/CHANGELOG.md new file mode 100644 index 000000000..2ed195528 --- /dev/null +++ b/nut/CHANGELOG.md @@ -0,0 +1,3 @@ +2018/09/14 20:59 UTC - [65d0b03](https://github.com/hassio-addons/addon-nut/commit/65d0b03fe940c4fa5b8bb70f12609b882bcbc2b5) by [@dale3h](https://github.com/dale3h) +> 🚑 Fixes shellcheck errors + diff --git a/nut/README.md b/nut/README.md new file mode 100644 index 000000000..64b572b64 --- /dev/null +++ b/nut/README.md @@ -0,0 +1,78 @@ +# Community Hass.io Add-ons: 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 Hass.io 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] + +## WARNING! THIS IS AN EDGE VERSION! + +This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds +add-ons are based upon the latest development version. + +- They may not work at all. +- 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. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[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 +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[release-shield]: https://img.shields.io/badge/version-65d0b03-blue.svg +[release]: https://github.com/hassio-addons/addon-nut/tree/65d0b03 +[docs]: https://github.com/hassio-addons/addon-nut/blob/65d0b03/README.md +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/dale3h \ No newline at end of file diff --git a/nut/config.json b/nut/config.json new file mode 100644 index 000000000..5ca7995f2 --- /dev/null +++ b/nut/config.json @@ -0,0 +1,92 @@ +{ + "name": "Network UPS Tools", + "version": "65d0b03", + "slug": "nut", + "description": "Manage battery backup (UPS) devices", + "url": "https://github.com/hassio-addons/addon-nut", + "startup": "system", + "arch": [ + "aarch64", + "amd64", + "armhf", + "i386" + ], + "boot": "auto", + "ports": { + "3493/tcp": 3493 + }, + "devices": [ + "/dev/bus/usb:/dev/bus/usb:rwm" + ], + "map": [ + "config" + ], + "options": { + "log_level": "info", + "users": [ + { + "username": "", + "password": "", + "instcmds": [ + "all" + ], + "actions": [] + } + ], + "devices": [ + { + "name": "myups", + "driver": "usbhid-ups", + "port": "auto", + "config": [] + } + ], + "upsd": [ + "LISTEN 0.0.0.0" + ], + "nut": { + "mode": "netserver" + } + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "users": [ + { + "username": "str", + "password": "str", + "instcmds": [ + "str" + ], + "actions": [ + "str" + ], + "upsmon": "match(^(master|slave)$)?" + } + ], + "devices": [ + { + "name": "str", + "driver": "str", + "port": "str", + "config": [ + "str" + ] + } + ], + "upsd": [ + "match(^(MAXAGE|STATEPATH|LISTEN|MAXCONN|CERTFILE|CERTPATH|CERTIDENT|CERTREQUEST) )" + ], + "nut": { + "mode": "match(^(none|standalone|netserver|netclient)$)", + "upsd_options": "str?", + "upsmon_options": "str?", + "poweroff_wait": "str?" + }, + "i_like_to_be_pwned": "bool?", + "leave_front_door_open": "bool?" + }, + "environment": { + "LOG_FORMAT": "{LEVEL}: {MESSAGE}" + }, + "image": "hassioaddons/nut" +} \ No newline at end of file diff --git a/nut/icon.png b/nut/icon.png new file mode 100644 index 000000000..4c36debd9 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 000000000..4c36debd9 Binary files /dev/null and b/nut/logo.png differ