oas:api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
oas:api [24.02.2013 20:48] – admin | oas:api [20.12.2022 00:30] – 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. | ||
+ | </ | ||
- | == Allgemeine Kommandos == | + | <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. | ||
+ | </ | ||
- | * **LED1:[ON|OFF]** \\ schaltet die LED1 ein/aus | + | < |
- | * **LED2:[ON|OFF]** \\ schaltet die LED2 ein/aus | + | |
- | * **LED3:[ON|OFF]** \\ schaltet die LED3 ein/aus | + | Set LED1 Text to " |
- | * **LED4:[ON|OFF]** \\ schaltet die LED4 ein/aus | + | ``` |
- | * **NOW:**TEXT \\ setzt den TEXT in der ersten Fusszeile | + | echo " |
- | * **NEXT:**TEXT \\ setzt den TEXT in der ersten Fusszeile | + | echo "LED1:ON" > / |
- | * **WARN:**TEXT \\ setzt den TEXT und schaltet die Warnungszeile ein (blendet NOW/NEXT aus) | + | ``` |
- | * **AIR1:[ON|OFF]** \\ startet/stoppt den Mic Timer | + | |
- | * **AIR2:[ON|OFF]** \\ startet/stoppt den Phone Timer | + | To remotely control an OnAirScreen from Windows, use the oas_send.exe which is part of the OAS Windows License: |
+ | |||
+ | ``` | ||
+ | oas_send.exe --ip 192.168.23.5 " | ||
+ | ``` | ||
+ | |||
+ | ##### HTTP API | ||
+ | You can also pass commands to OAS via HTTP. Strings need to be urlencoded. | ||
+ | |||
+ | |||
+ | ``` | ||
+ | curl http:// | ||
+ | curl http:// | ||
+ | ``` | ||
+ | |||
+ | ##### 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: | ||
+ | | `AIR3TIME: | ||
+ | | `AIR4: | ||
+ | | `CMD: | ||
+ | | `CMD: | ||
+ | | `CMD: | ||
+ | |||
+ | < | ||
+ | ##### 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: | ||
+ | </ | ||
+ | |||
+ | COLOR: can be in the form of Webcolors (#00FF00) or in hex notation (0x00FF00) or one of the SVG named colors (https:// | ||
- | == Konfiguration == | ||
- | * **CONF: |
oas/api.txt · Last modified: 30.01.2023 17:41 by admin