Benutzer-Werkzeuge

Webseiten-Werkzeuge


oas:api

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Letzte Überarbeitung Beide Seiten der Revision
oas:api [19.04.2015 15:48]
admin
oas:api [11.02.2019 12:50]
admin
Zeile 1: Zeile 1:
-====== ​OnAirScreen API / Kommandos ======+#### OnAirScreen API / UDP Commands 
 +OnAirScreen can receive API commands via UDP port 3310\\ 
 +Here is an easy example on how to control a local OnAirScreen instance on a linux system.
  
-Die API des OnAirScreens wird per UDP angesprochen.Der default Port ist 3310.+Set LED1 Text to "​FOO"​ and switch LED1 on: 
 +``` 
 +echo "​CONF:​LED1:​text=FOO"​ > /​dev/​udp/​127.0.0.1/3310 
 +echo "​LED1:​ON"​ > /​dev/​udp/​127.0.0.1/​3310 
 +```
  
-In diesem Beispiel wird angenommen das der default Port 3310 benutzt wird und der OnAirScreen auf localhost (127.0.0.1) läuft:\\ +##### API Commands 
-''​echo "CONF:LED1:text=FOO" ​nc -w 1 -u 127.0.0.1 3310''​\\ +| UDP Command ​        | Function | 
-''​echo "LED1:ON" ​nc -w 1 -u 127.0.0.1 3310''​\\ +| `LED1:[ON/​OFF]` ​    | switch ​LED1 on/off | 
-dies setzt den Text der 1. LED auf "​FOO"​ und schaltet sie danach ein+| `LED2:[ON/​OFF]` ​    | switch LED2 on/​off ​
 +| `LED3:[ON/​OFF]` ​    | switch LED3 on/​off ​
 +| `LED4:​[ON/​OFF]` ​    | switch LED4 on/off | 
 +| `NOW:​TEXT` ​              | set TEXT in first footer line | 
 +| `NEXT:​TEXT` ​             | set TEXT in second footer line | 
 +| `WARN:​TEXT` ​             | set TEXT and switch on red warning mode | 
 +| `AIR1:​[ON/​OFF]` ​         | start/stop Mic Timer | 
 +| `AIR2:​[ON/​OFF]` ​         | start/stop Phone Timer | 
 +| `AIR3:​[ON/​OFF/​RESET/​TOGGLE]` | start/​stop/​reset/​toggle Radio Timer | 
 +| `AIR3TIME:​seconds` ​           | set Radio Timer to given value in seconds | 
 +| `AIR4:​[ON/​OFF/​RESET]` ​       | start/​stop/​reset Stream Timer | 
 +| `CMD:​REBOOT` ​                 | OS restart | 
 +| `CMD:​SHUTDOWN` ​               | OS shutdown | 
 +| `CMD:​QUIT` ​                   | quit OnAirScreen instance |
  
-==== Allgemeine Kommandos ==== +##### Remote Configuration Commands 
- +`CONF:​General:​stationname=TEXT`\\ 
-  * **LED1:​[ON|OFF]** \\ schaltet die LED1 ein/aus +`CONF:​General:​slogan=TEXT`\\ 
-  * **LED2:​[ON|OFF]** \\ schaltet die LED2 ein/aus +`CONF:​General:​stationcolor=COLOR`\\ 
-  * **LED3:​[ON|OFF]** \\ schaltet die LED3 ein/aus +`CONF:​General:​slogancolor=COLOR`\\ 
-  * **LED4:​[ON|OFF]** \\ schaltet die LED4 ein/aus +`CONF:​LED[1-4]:​used=[False|True]`\\ 
-  * **NOW:​**TEXT ​     \\ setzt den TEXT in der ersten Fusszeile +`CONF:​LED[1-4]:​text=TEXT`\\ 
-  * **NEXT:​**TEXT ​    \\ setzt den TEXT in der zweiten Fusszeile +`CONF:​LED[1-4]:​activebgcolor=COLOR`\\ 
-  * **WARN:​**TEXT ​    \\ setzt den TEXT und schaltet die Warnungszeile ein (blendet NOW/NEXT aus) +`CONF:​LED[1-4]:​activetextcolor=COLOR`\\ 
-  * **AIR1:​[ON|OFF]** \\ startet/​stoppt den Mic Timer +`CONF:​LED[1-4]:​autoflash=[False|True]`\\ 
-  * **AIR2:​[ON|OFF]** \\ startet/​stoppt den Phone Timer +`CONF:​LED[1-4]:​timedflash=[False|True]`\\ 
-  * **AIR3:​[ON|OFF|RESET|TOGGLE]** \\ startet/​stoppt/​resettet/​toggelt den Radio Timer +`CONF:​Clock:​digital=[True|False]`\\ 
-  * **AIR3TIME:​Sekunden** \\ setzt den Radio Timer auf die angegebenen Sekunden +`CONF:​Clock:​showseconds=[True|False]`\\ 
-  * **AIR4:​[ON|OFF|RESET]** \\ startet/​stoppt/​resettet den Stream Timer +`CONF:​Clock:​digitalhourcolor=COLOR`\\ 
-  * **CMD:​REBOOT** ​   \\ startet das Betriebssystem neu +`CONF:​Clock:​digitalsecondcolor=COLOR`\\ 
-  * **CMD:​SHUTDOWN** ​ \\ fährt das Betriebssystem herunter +`CONF:​Clock:​digitaldigitcolor=COLOR`\\ 
-  * **CMD:​QUIT** ​     \\ beendet den OnAirScreen +`CONF:​Clock:​logopath=PathToLogo`\\ 
- +`CONF:​Network:​udpport=PORT`\\ 
-==== Konfiguration ==== +`CONF:​Network:​tcpport=PORT`\\ 
- +`CONF:​CONF:​APPLY=TRUE`\\
-  * **CONF:​General:​stationname=**TEXT +
-  * **CONF:​General:​slogan=**TEXT +
-  * **CONF:​General:​stationcolor=**COLOR +
-  * **CONF:​General:​slogancolor=**COLOR +
-  * **CONF:​LED[1-4]:​used=[False|True]** +
-  * **CONF:​LED[1-4]:​text=**TEXT +
-  * **CONF:​LED[1-4]:​activebgcolor=**COLOR +
-  * **CONF:​LED[1-4]:​activetextcolor=**COLOR +
-  * **CONF:​LED[1-4]:​autoflash=[False|True]** +
-  * **CONF:​LED[1-4]:​timedflash=[False|True]** +
-  * **CONF:​Clock:​digital=[True|False]** +
-  * **CONF:​Clock:​digitalhourcolor=**COLOR +
-  * **CONF:​Clock:​digitalsecondcolor=**COLOR +
-  * **CONF:​Clock:​digitaldigitcolor=**COLOR +
-  * **CONF:​Clock:​logopath=**PathToLogo +
-  * **CONF:​Network:​udpport=**PORT +
-  * **CONF:​Network:​tcpport=**PORT +
-  * **CONF:​CONF:​APPLY=TRUE**+
oas/api.txt · Zuletzt geändert: 11.02.2019 12:54 von admin