AstraStudio Wiki

User Tools

Site Tools

Trace:
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
Last revisionBoth sides next revision
oas:api [11.02.2019 12:54] – adminoas:api [02.01.2023 22:09] – admin
Line 1: Line 1:
-#### OnAirScreen API / UDP Commands +<markdown> 
-OnAirScreen can receive API commands via UDP port 3310\\ +# OnAirScreen API / UDP / HTTP Commands 
-Here is an easy example on how to control a local OnAirScreen instance on a linux system.+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> 
 + 
 +<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. 
 +</WRAP> 
 + 
 +<markdown>
  
 Set LED1 Text to "FOO" and switch LED1 on: Set LED1 Text to "FOO" and switch LED1 on:
Line 13: Line 21:
 ``` ```
 oas_send.exe --ip 192.168.23.5 "LED1:ON" 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 ##### API Commands
 +</markdown>
 +
 | UDP Command         | Function | | UDP Command         | Function |
 | `LED1:[ON/OFF]`     | switch LED1 on/off | | `LED1:[ON/OFF]`     | switch LED1 on/off |
Line 33: Line 52:
 | `CMD:QUIT`                    | quit OnAirScreen instance | | `CMD:QUIT`                    | quit OnAirScreen instance |
  
 +<markdown>
 ##### Remote Configuration Commands ##### Remote Configuration Commands
-`CONF:General:stationname=TEXT`\\ +`CONF:General:stationname=TEXT`   
-`CONF:General:slogan=TEXT`\\ +`CONF:General:slogan=TEXT`   
-`CONF:General:stationcolor=COLOR`\\ +`CONF:General:stationcolor=COLOR`   
-`CONF:General:slogancolor=COLOR`\\ +`CONF:General:slogancolor=COLOR`   
-`CONF:LED[1-4]:used=[False|True]`\\ +`CONF:General:replacenow=[False|True]`   
-`CONF:LED[1-4]:text=TEXT`\\ +`CONF:General:replacenowtext=TEXT`   
-`CONF:LED[1-4]:activebgcolor=COLOR`\\ +`CONF:LED[1-4]:used=[False|True]`   
-`CONF:LED[1-4]:activetextcolor=COLOR`\\ +`CONF:LED[1-4]:text=TEXT`   
-`CONF:LED[1-4]:autoflash=[False|True]`\\ +`CONF:LED[1-4]:activebgcolor=COLOR`   
-`CONF:LED[1-4]:timedflash=[False|True]`\\ +`CONF:LED[1-4]:activetextcolor=COLOR`   
-`CONF:Clock:digital=[True|False]`\\ +`CONF:LED[1-4]:autoflash=[False|True]`   
-`CONF:Clock:showseconds=[True|False]`\\ +`CONF:LED[1-4]:timedflash=[False|True]`   
-`CONF:Clock:digitalhourcolor=COLOR`\\ +`CONF:Timers:TimerAIR[1-4]Enabled=[False|True]`   
-`CONF:Clock:digitalsecondcolor=COLOR`\\ +`CONF:Timers:TimerAIR[1-4]Text=TEXT`   
-`CONF:Clock:digitaldigitcolor=COLOR`\\ +`CONF:Timers:AIR[1-4]activebgcolor=COLOR`   
-`CONF:Clock:logopath=PathToLogo`\\ +`CONF:Timers:AIR[1-4]activetextcolor=COLOR`   
-`CONF:Network:udpport=PORT`\\ +`CONF:Timers:TimerAIRMinWidth=PIXELS`   
-`CONF:Network:tcpport=PORT`\\ +`CONF:Clock:digital=[True|False]`   
-`CONF:CONF:APPLY=TRUE`\\+`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) 
 + 
oas/api.txt · Last modified: 30.01.2023 17:41 by admin