User Tools

Site Tools


oas:api

This is an old revision of the document!


#### 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.

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 ```

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 "LED1:ON" ```

##### API Commands

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

##### Remote Configuration Commands `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:showseconds=[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.1549889658.txt.gz · Last modified: 11.02.2019 12:54 by admin