Skip to content

Commit

Permalink
Merge branch 'main' of github.com:aquette/addon-smartnut
Browse files Browse the repository at this point in the history
Signed-off-by: Arnaud Quette <[email protected]>
  • Loading branch information
aquette committed Dec 18, 2023
2 parents 73eaf55 + ef33117 commit ebea4c7
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions smartnut/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ including multiple units.

This option allows you to edit the `devices` configuration, in order to:

* add a UPS that is not automatically detected, such as remote SNMP or serial,
* fix autodetection issues, by disabling the related option (USB for example)
and adding entries to the `devices` section.
- add a UPS that is not automatically detected, such as remote SNMP or serial,
- fix autodetection issues, by disabling the related option (USB for example)
and adding entries to the `devices` section.

### Option: `devices`

Expand All @@ -134,19 +134,19 @@ specific drivers.
While the SmartNUT Add-on comes with all drivers supported by NUT, the following
are probably the most interesting:

* for USB devices: [`usbhid-ups(8)`][usbhid-ups] and [`nutdrv_qx(8)`][nutdrv_qx]
* for SNMP devices: [`snmp-ups(8)`][snmp-ups]
* for remote NUT devices: [`dummy-ups(8)`][dummy-ups]
- for USB devices: [`usbhid-ups(8)`][usbhid-ups] and [`nutdrv_qx(8)`][nutdrv_qx]
- for SNMP devices: [`snmp-ups(8)`][snmp-ups]
- for remote NUT devices: [`dummy-ups(8)`][dummy-ups]

#### Sub-option: `port`

This is the communication port used by the driver to connect to the UPS, and varies
according to devices:

* for USB devices: use `auto`, and possibly set additional config
* for SNMP devices: use `<ip_address-or_name>`, and possibly set additional config
* for remote NUT devices: use `<device>@<ip_address-or_name>`, and possibly set additional config
* for serial devices: use the port name, usually `/dev/ttyS0` for the first one
- for USB devices: use `auto`, and possibly set additional config
- for SNMP devices: use `<ip_address-or_name>`, and possibly set additional config
- for remote NUT devices: use `<device>@<ip_address-or_name>`, and possibly set additional config
- for serial devices: use the port name, usually `/dev/ttyS0` for the first one

#### Sub-option: `config`

Expand All @@ -155,7 +155,6 @@ A list of additional [options][ups-fields] to configure for this UPS. The common
using a combination of the `vendor`, `product`, `serial`, `vendorid`, and
`productid` options:


#### Example configuration:

```yaml
Expand Down Expand Up @@ -245,9 +244,9 @@ The device is named `smartnut-dummy`, and includes automatic status changes

For more information, refer to the following links:

* [`dummy-ups(8)`][dummy-ups]
* [`NUT Devices simulation`][nut-simulation]
* [`NUT Devices Dumps Library`][nut-ddl]
- [`dummy-ups(8)`][dummy-ups]
- [`NUT Devices simulation`][nut-simulation]
- [`NUT Devices Dumps Library`][nut-ddl]

### Option: `autoconf_remote_nut_devices`

Expand Down Expand Up @@ -420,7 +419,6 @@ This event allows you to create automations to do things like send a
[critical notification][critical-notif] to your phone:
-->


<!--
```yaml
automations:
Expand Down Expand Up @@ -449,7 +447,6 @@ For more information, see the NUT docs [here][nut-notif-doc-1] and

FIXME


## Changelog & Releases

This repository keeps a change log using [GitHub's releases][releases]
Expand Down

0 comments on commit ebea4c7

Please sign in to comment.