User Tools

Site Tools


oas:api

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.

Replace the IP address with the IP address of your OnAirScreen. This will be shown in the first footer line of OnAirScreen after start.

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"
HTTP API

You can also pass commands to OAS via HTTP. Strings need to be urlencoded.

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
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: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:TimerAIRMinWidth=PIXELS
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

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)

oas/api.txt · Last modified: 28.01.2022 17:59 by admin