 |
Online-Hilfe icom Data Suite |
Ermitteln der Befehls-Syntax für CLI und REST-Schnittstelle
Die Syntax der verfügbaren Befehle lässt sich leicht über die Autovervollständigung im CLI herausfinden.
Im Folgenden ist die Vorgehensweise für das Ermitteln der Befehle zum manuellen Setzen eines digitalen Merkers beschrieben. Die unten aufgeführten Sektionen und Parameter hängen vom Router und der Version der Applikation ab und können unterschiedlich sein.
- Eine CLI-Sitzung öffnen
- Tabulator-Taste drücken
>
exit
status
datapoints
gateway
alu
messages
events
administration
help
Alle verfügbaren Sektionen der ersten Ebene werden angezeigt (vergleichbar mit den Haupt-Menü-Einträgen im Web-Interface). - "h" eingeben und Tabulator-Taste drücken
> help. - Tabulator-Taste drücken
> help.
debug
Alle verfügbaren Sektionen der zweiten Ebene werden angezeigt (hier nur einer, vergleichbar mit den Unter-Menü-Einträgen im Web-Interface). - "d" eingeben und Tabulator-Taste drücken
> help.debug. - Tabulator-Taste drücken
> help.debug.
digital
analog
timer
function
message
sms
email
mqtt
profile
ascii
reboot
m3_cli
sleep
Alle verfügbaren manuellen Aktionen werden angezeigt. - "d" eingeben und Tabulator-Taste drücken
> help.debug.digital. - Tabulator-Taste drücken
> help.debug.digital.
datapoint
change
submit
Alle verfügbaren Parameter für das manuelle Setzen eines Datenpunkts werden aufgelistet. Der Parameter "submit" ist nur für die Bedienung über das CLI relevant, da er zum Auslösen des Befehls erforderlich ist. - "d" eingeben, Tabulator-Taste drücken, ein "=" anhängen und die Tabulator-Taste zweimal drücken
> help.debug.digital.datapoint=
flag1
flag2
Alle verfügbaren digitalen Datenpunkte werden aufgelistet. - "c" eingeben, Tabulator-Taste drücken, ein "=" anhängen und die Tabulator-Taste zweimal drücken
> help.debug.digital.change=to
to_one
to_zero
toggle
Alle verfügbaren Optionen zum Ändern des digitalen Datenpunkts werden aufgelistet.
Für das Umschalten des digitalen Datenpunkts "flag1" über REST ergibt sich also folgende Syntax:
POST /operation
{
"method" : "manual_action",
"params" : {
"type" : "digital",
"options" : {
"datapoint" : "flag1",
"change" : "toggle"
}
}
}
Die CLI-Befehle zum Umschalten des digitalen Datenpunkts "flag1" haben dann folgende Syntax:
> help.debug.digital.datapoint=flag1
> help.debug.digital.change=toggle
> help.debug.digital.submit