mirror of
https://github.com/hassio-addons/addon-wireguard.git
synced 2025-05-04 19:01:31 +00:00
Added a example for the Wireguard API
This still needs changes to make the sentences more fluid and better sentence structure. I personally am not good with that but the example is there. Hope this contributes and can be used.
This commit is contained in:
parent
f80450f71f
commit
fba5d3589e
1 changed files with 23 additions and 5 deletions
28
README.md
28
README.md
|
@ -467,14 +467,32 @@ With the use of the [Home Assistant RESTful][ha-rest] integration, one should
|
||||||
be able to grab some interesting data from this add-on.
|
be able to grab some interesting data from this add-on.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
Set the port in the add-on settings; for example: 6789 and your IP of your Home Assistant instance; the hassio.local didn't work for me.
|
||||||
|
Add a rest sensor:
|
||||||
```yaml
|
```yaml
|
||||||
sensor:
|
platform: rest
|
||||||
- platform: rest
|
name: wireguard_sensor
|
||||||
resource: http://a0d7b954-wireguard
|
resource: http://192.168.3.72:6789/
|
||||||
|
value_template: 'TEST'
|
||||||
|
json_attributes:
|
||||||
|
- ipad
|
||||||
|
- mac
|
||||||
|
- telefoon
|
||||||
```
|
```
|
||||||
|
The value_template: 'TEST' is for having a state; if you don't do this you will reach the 255 characters state limit.
|
||||||
|
For each peers add a json_attributes entry.
|
||||||
|
For each peer you will get a attribute such as:
|
||||||
|
```json { "endpoint": "172.30.32.1:47004", "latest_handshake": 0, "transfer_rx": 48699004, "transfer_tx": 625289972 }```
|
||||||
|
|
||||||
At this moment, we do not have template or examples on how this could be
|
Having bytes isn't so useful; that's why we can change it with filesizeformat and a template:
|
||||||
|
platform: template
|
||||||
|
sensors:
|
||||||
|
ipad_sent:
|
||||||
|
value_template: '{{ states.sensor.wireguard_sensor.attributes["ipad"]["transfer_tx"] |filesizeformat}}'
|
||||||
|
Check the end result:
|
||||||
|

|
||||||
|
|
||||||
|
At this moment, we have only a few templates or examples on how this could be
|
||||||
used effectively with Home Assistant.
|
used effectively with Home Assistant.
|
||||||
If you have, sharing would be appreciated!
|
If you have, sharing would be appreciated!
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue