[docs] add Examples to each trigger/action
This commit is contained in:
@@ -87,6 +87,21 @@ func (p EthernetDisconnect) GetDescription() string {
|
||||
return "Triggers if Ethernetcable is disconnected."
|
||||
}
|
||||
|
||||
func (p EthernetDisconnect) GetExample() string {
|
||||
return `
|
||||
{
|
||||
"type": "EthernetDisconnect",
|
||||
"name": "Example Trigger",
|
||||
"options": {
|
||||
"interfaceName": "eth0",
|
||||
"waitTillConnected": true
|
||||
}
|
||||
"actions": [
|
||||
]
|
||||
}
|
||||
`
|
||||
}
|
||||
|
||||
func (p EthernetDisconnect) GetOptions() []internal.ConfigOption {
|
||||
return []internal.ConfigOption{
|
||||
{"waitTillConnected", "bool", "Only trigger when device was connected before", "true"},
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
package triggers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
@@ -45,7 +44,21 @@ func (p TimeOut) GetName() string {
|
||||
}
|
||||
|
||||
func (p TimeOut) GetDescription() string {
|
||||
return "Triggers after given duration."
|
||||
return "Triggers after given duration. Mostly used for debugging."
|
||||
}
|
||||
|
||||
func (p TimeOut) GetExample() string {
|
||||
return `
|
||||
{
|
||||
"type": "Timeout",
|
||||
"name": "Example Trigger",
|
||||
"options": {
|
||||
"duration": 5
|
||||
}
|
||||
"actions": [
|
||||
]
|
||||
}
|
||||
`
|
||||
}
|
||||
|
||||
func (p TimeOut) GetOptions() []internal.ConfigOption {
|
||||
|
||||
@@ -88,6 +88,22 @@ func (p UsbDisconnect) GetDescription() string {
|
||||
return "Triggers when given usb drive is disconnected"
|
||||
}
|
||||
|
||||
func (p UsbDisconnect) GetExample() string {
|
||||
return `
|
||||
{
|
||||
"type": "UsbDisconnect",
|
||||
"name": "Example Trigger",
|
||||
"options": {
|
||||
"deviceId": "ata-Samsung_SSD_860_EVO_1TB_S4AALKWJDI102",
|
||||
"waitTillConnected": true
|
||||
}
|
||||
"actions": [
|
||||
]
|
||||
}
|
||||
`
|
||||
}
|
||||
|
||||
|
||||
func (p UsbDisconnect) GetOptions() []internal.ConfigOption {
|
||||
return []internal.ConfigOption{
|
||||
{"waitTillConnected", "bool", "Only trigger when device was connected before", "true"},
|
||||
|
||||
Reference in New Issue
Block a user