User Tools

Site Tools


oas:api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
oas:api [14.10.2014 11:54] – [OnAirScreen API / Kommandos] adminoas:api [30.01.2023 17:41] (current) admin
Line 1: Line 1:
-====== OnAirScreen API / Kommandos ======+<markdown> 
 +OnAirScreen API / UDP / HTTP Commands 
 +OnAirScreen can receive API commands via UDP default port 3310 or HTTP default port 8010\\ 
 +Here is an easy UDP example on how to control a local OnAirScreen instance on a linux system. 
 +</markdown>
  
-Die API des OnAirScreens wird per UDP angesprochen.Der default Port ist 3310.+<WRAP center round info 60%> 
 +Replace the IP address with the IP address of your OnAirScreenThis will be shown in the first footer line of OnAirScreen after start. 
 +</WRAP>
  
-In diesem Beispiel wird angenommen das der default Port 3310 benutzt wird und der OnAirScreen auf localhost (127.0.0.1) läuft:\\ +<markdown>
-''echo "CONF:LED1:text=FOO" | nc -w 1 -u 127.0.0.1 3310''\\ +
-''echo "LED1:ON" | nc -w 1 -u 127.0.0.1 3310''\\ +
-dies setzt den Text der 1. LED auf "FOO" und schaltet sie danach ein+
  
-==== Allgemeine Kommandos ====+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 
 +```
  
-  * **LED1:[ON|OFF]** \\ schaltet die LED1 ein/aus +To remotely control an OnAirScreen from Windows, use the oas_send.exe which is part of the OAS Windows License: 
-  * **LED2:[ON|OFF]** \\ schaltet die LED2 ein/aus + 
-  * **LED3:[ON|OFF]** \\ schaltet die LED3 ein/aus +``` 
-  * **LED4:[ON|OFF]** \\ schaltet die LED4 ein/aus +oas_send.exe --ip 192.168.23.5 "LED1:ON
-  * **NOW:**TEXT      \\ setzt den TEXT in der ersten Fusszeile +``` 
-  * **NEXT:**TEXT     \\ setzt den TEXT in der zweiten Fusszeile + 
-  * **WARN:**TEXT     \\ setzt den TEXT und schaltet die Warnungszeile ein (blendet NOW/NEXT aus) +##### HTTP API 
-  * **AIR1:[ON|OFF]** \\ startet/stoppt den Mic Timer +You can also pass commands to OAS via HTTP. Strings need to be urlencoded. 
-  * **AIR2:[ON|OFF]** \\ startet/stoppt den Phone Timer + 
-  * **CMD:REBOOT**    \\ startet das Betriebssystem neu + 
-  * **CMD:SHUTDOWN**  \\ fährt das Betriebssystem herunter +``` 
-  * **CMD:QUIT**      \\ beendet den OnAirScreen+curl http://127.0.0.1:8010/?cmd=LED1:ON 
 +curl http://127.0.0.1:8010/?cmd=NOW:You%20are%20listening%20to%20Queen%20-%20Show%20must%20go%20on 
 +``` 
 + 
 +##### API Commands 
 +</markdown> 
 + 
 +UDP Command         | Function | 
 +| `LED1:[ON/OFF]`     | switch LED1 on/off | 
 +| `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 | 
 + 
 +<markdown> 
 +##### Remote Configuration Commands 
 +`CONF:General:stationname=TEXT`   
 +`CONF:General:slogan=TEXT`   
 +`CONF:General:stationcolor=COLOR`   
 +`CONF:General:slogancolor=COLOR`   
 +`CONF:General:replacenow=[False|True]`   
 +`CONF:General:replacenowtext=TEXT`   
 +`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:Timers:TimerAIR[1-4]Enabled=[False|True]`   
 +`CONF:Timers:TimerAIR[1-4]Text=TEXT`   
 +`CONF:Timers:AIR[1-4]activebgcolor=COLOR`   
 +`CONF:Timers:AIR[1-4]activetextcolor=COLOR`   
 +`CONF:Timers:AIR[1-4]iconpath=PathToIcon`   
 +`CONF:Timers:TimerAIRMinWidth=PIXELS`   
 +`CONF:Clock:digital=[True|False]`   
 +`CONF:Clock:showseconds=[True|False]`   
 +`CONF:Clock:secondsinoneline=[True|False]`   
 +`CONF:Clock:digitalhourcolor=COLOR`   
 +`CONF:Clock:digitalsecondcolor=COLOR`   
 +`CONF:Clock:digitaldigitcolor=COLOR`   
 +`CONF:Clock:logopath=PathToLogo`   
 +`CONF:Clock:logoUpper=[True|False]`   
 +`CONF:Network:udpport=PORT`   
 +`CONF:Network:tcpport=PORT`   
 +`CONF:CONF:APPLY=TRUE`   
 +</markdown> 
 + 
 +COLOR: can be in the form of Webcolors (#00FF00) or in hex notation (0x00FF00) or one of the SVG named colors (https://www.w3.org/TR/SVG11/types.html#ColorKeywords)
  
-==== Konfiguration ==== 
  
-  * **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.1413287676.txt.gz · Last modified: 14.10.2014 11:54 by admin