oas:api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
oas:api [19.04.2015 15:47] – admin | oas:api [30.01.2023 17:41] (current) – admin | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | < |
+ | # 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. | ||
+ | </ | ||
- | 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 OnAirScreen. This will be shown in the first footer line of OnAirScreen after start. | ||
+ | </ | ||
- | In diesem Beispiel wird angenommen das der default Port 3310 benutzt wird und der OnAirScreen auf localhost (127.0.0.1) läuft:\\ | + | < |
- | '' | + | |
- | '' | + | |
- | dies setzt den Text der 1. LED auf " | + | |
- | ==== Allgemeine Kommandos ==== | + | Set LED1 Text to " |
+ | ``` | ||
+ | echo " | ||
+ | echo " | ||
+ | ``` | ||
- | * **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 | + | |
- | * **AIR3:[ON|OFF|RESET|TOGGLE]** \\ startet/stoppt/resettet/toggelt den Radio Timer | + | |
- | * **AIR3TIME:< | + | ``` |
- | * **AIR4:[ON|OFF|RESET]** \\ startet/stoppt/resettet den Stream Timer | + | curl http:// |
- | * **CMD:REBOOT** \\ startet das Betriebssystem neu | + | curl http:// |
- | * **CMD: | + | ``` |
- | * **CMD:QUIT** \\ beendet den OnAirScreen | + | |
+ | ##### API Commands | ||
+ | </ | ||
+ | |||
+ | | UDP Command | ||
+ | | `LED1:[ON/OFF]` | switch | ||
+ | | `LED2:[ON/OFF]` | switch | ||
+ | | `LED3:[ON/OFF]` | switch | ||
+ | | `LED4:[ON/OFF]` | switch | ||
+ | | `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 | ||
+ | | `AIR3TIME:seconds` | ||
+ | | `AIR4:[ON/OFF/RESET]` | start/stop/reset Stream Timer | | ||
+ | | `CMD:REBOOT` | OS restart | | ||
+ | | `CMD: | ||
+ | | `CMD:QUIT` | quit OnAirScreen | ||
+ | |||
+ | < | ||
+ | ##### Remote Configuration Commands | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | `CONF: | ||
+ | </ | ||
+ | |||
+ | COLOR: can be in the form of Webcolors (#00FF00) or in hex notation (0x00FF00) or one of the SVG named colors (https:// | ||
- | ==== Konfiguration ==== | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: | ||
- | * **CONF: |
oas/api.1429458470.txt.gz · Last modified: 19.04.2015 15:47 by admin