Added docs

master
Lukas Macura 2017-01-30 14:23:22 +01:00
parent 0a36456b56
commit c32c2bcca4
3 changed files with 64 additions and 3 deletions

View File

@ -7,6 +7,7 @@ This is usefull for scripting and alerting.
## How to use ## How to use
**Note:** If you need more info about installing zaf: https://github.com/limosek/zaf **Note:** If you need more info about installing zaf: https://github.com/limosek/zaf
**Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf) **Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf)
First, create account in Booked with required access to system and enable API. Next, simply install First, create account in Booked with required access to system and enable API. Next, simply install

View File

@ -17,6 +17,7 @@ Defined items: csv.discovery.fields[] csv.discovery.rows[]
## How to use ## How to use
**Note:** If you need more info about installing zaf: https://github.com/limosek/zaf **Note:** If you need more info about installing zaf: https://github.com/limosek/zaf
**Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf) **Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf)
Simply instal zaf and after, install csv plugin Simply instal zaf and after, install csv plugin
@ -78,20 +79,24 @@ Parameters:
delimiter ',' '' delimiter ',' ''
``` ```
To discovery columns from CSV (first line of it). To discovery columns from CSV (first line of it).
Csv:
Name|Surname|Birth
Jon|Doe|2030
``` ```
{ {
"data" : [ "data" : [
{ {
"{#NAME}" : "root", "{#NAME}" : "Name",
"{#COLUMN}" : "0" "{#COLUMN}" : "0"
}, },
{ {
"{#NAME}" : "x", "{#NAME}" : "Surname",
"{#COLUMN}" : "1" "{#COLUMN}" : "1"
}, },
{ {
"{#NAME}" : "Birth"
"{#COLUMN}" : "2", "{#COLUMN}" : "2",
"{#NAME}" : "0"
} }
] ]
} }

55
iwx/README.md Normal file
View File

@ -0,0 +1,55 @@
# Wireless device support for Zaf
This plugin can be used for autodicsovery and query of wireless devices and neighbours.
```
Plugin 'iwx' version 0.5:
Plugin for wifi mac80211 informations and discovery
Url: https://raw.githubusercontent.com/limosek/zaf-plugins/master/iwx
Defined items: iwx.if_discovery iwx.phy_discovery iwx.channels_discovery[] iwx.clients_discovery[] iwx.neigh_discovery[] iwx.client_signal[] iwx.client_rxrate[] iwx.client_txrate[] iwx.neigh_ssid[] iwx.neigh_signal[] iwx.neigh_channel[] iwx.channel_noise[] iwx.channel_activetime[] iwx.channel_busytime[] iwx.channel_txtime[] iwx.channel_rxtime[]
Test items: iwx.channels_discovery[wlan0] iwx.clients_discovery[wlan0] iwx.neigh_discovery[wlan0]
```
## How to use
**Note:** If you need more info about installing zaf: https://github.com/limosek/zaf
**Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf)
Simply instal zaf and after, install csv plugin
```
zaf install iwx
```
### Items ###
```
Item iwx.if_discovery
Return: json
```
```
Item iwx.phy_discovery
Return: json
```
```
Item iwx.channels_discovery
Cache: 600
Parameters:
dev wlan0 ''
Return: json
Testparameters: wlan0
```