AccessKitCommunicate with a BrightSign via UDP
Learn how to send commands to a BrightSign using UDP over a local network.
AccessKit BrightSigns come pre-configured with many UDP commands. You can use these commands to control the BrightSign in realtime via a Controller application such as QLab, Medialon, Max/MSP or any other application can that can generate and send UDP packets.
Network Config & MultiCasting
The Controller application must be on the same network as (or at least have a network path to) the BrightSign.
Any BrightSign registered with AccessKit will automatically register itself to a few different administratively scoped multicast IP addresses. These will allow you to send a message to a BrightSign by its AccessKit ID number, or even to send a message to many BrightSigns at once (e.g. all BrightSigns in the same sync group).
You can send the messages to a BrightSign directly using its actual IP address, or by addressing it using an IP address alias from the table below.
| IP Rule | Description | Example | Example description |
|---|---|---|---|
239.192.0.0 | Every AccessKit BrightSign on the network | N/A | N/A |
239.192.4.x | The AccessKit BrightSign with ID x in the AccessKit Dashboard | 239.192.4.17 | AccessKit BrightSign with ID=17 |
239.192.0.x | Every AccessKit BrightSign in sync group x (when a BrightSign is assigned to a Work in AccessKit, it joins the sync group with the same number as that Work's ID) | 239.192.0.5 | All Brightsign's in sync group 5 (typically all BrightSigns assigned to AccessKit Work ID=5) |
239.192.1.0 | Every AccessKit BrightSign which is set to Leader mode | N/A | N/A |
239.192.2.0 | Every AccessKit BrightSign which is set to Follower mode | N/A | N/A |
239.192.1.x | The AccessKit BrightSign which is the Leader for sync group x | 239.192.1.13 | The AccessKit BrightSign which is the leader for sync group 13 (typically corresponds to AccessKit Work ID=13) |
239.192.2.x | Every AccessKit BrightSign which is a Follower in sync group x | 239.192.2.13 | Every AccessKit BrightSign which is a follower in sync group 13 (typically corresponds to AccessKit Work ID=13) |
Available commands
The BrightSigns will respond to the following commands. Other messages will simply be ignored.
Missing a command?
If there is functionality which you would like to control via UDP which you do
not see in the table below, please contact the AccessKit
Team with the subject UDP Commands.
| Command | Description |
|---|---|
start | If the film has finished, starts the film again and syncs captions with the web application. For mediaplayers in GPIO triggered mode, also starts playback from idle (same as the GPIO start edge). |
stop | Stops playback, seeks to the beginning, and returns to idle. In GPIO triggered mode this matches the GPIO stop edge and is useful for testing without wired inputs. |
pause | Pauses the video (breaks sync lock with the web application) |
playResync | If paused, unpause the video and restore sync lock with the web application. |
play | Unpause video; does not restore sync lock with the web application. |
playReset | Regardless of where the film is, start the video over and restore sync lock with the web application. |
resync | Regardless of where the film is (even if it is playing currently), restore sync with the web application. |
lockResync | Regardless of where the film is (even if it is playing currently), restore sync lock with the web application. |
ff | Scrub forward (breaks sync lock with the web application) |
fff | Scrub forward at high speed (breaks sync lock with the web application) |
rr | Scrub backward (breaks sync lock with the web application) |
rrr | Scrub backward at high speed (breaks sync lock with the web application) |
defaultspeed | Go back to default playback speed |
saveWindow | Save any changes to the picture location and scaling so that they persist through power cycles. |
stretchX | Stretch the picture horizontally (does not persist settings unless saved) |
compressX | Compress the picture horizontally (does not persist settings unless saved) |
stretchY | Stretch the picture vertically (does not persist settings unless saved) |
compressY | Compress the picture vertically (does not persist settings unless saved) |
enlarge | Stretch the picture along both axes (does not persist settings unless saved) |
shrink | Compress the picture along both axes (does not persist settings unless saved) |
nudgeUp | Move the picture up vertically (does not persist settings unless saved) |
nudgeDown | Move the picture down vertically (does not persist settings unless saved) |
nudgeLeft | Move the picture to the left horizontally (does not persist settings unless saved) |
nudgeRight | Move the picture to the right horizontally (does not persist settings unless saved) |
restoreWindow | Reset any changes made to the picture location and scaling to the last saved settings. |
disableOutputs | Turn the picture and audio off. |
enableOutputs | Turn the picture and audio back on. |
enterPowerSave | Turn the picture and audio off and enter power save mode (note this may cause blue screens/no signal on projectors) |
exitPowerSave | Leave power save mode and turn screens back on (note that some projectors may not pick the signal up again) |
volumeUp | Turn the volume up (does persist through power cycling) |
volumeDown | Turn the volume down (does persist through power cycling) |
activate subtitles | Enable and show on screen captions (does not persist through power cycling, though this will change in the near future) (inquire for custom on-screen styling) |
deactivate subtitles | Disable and hide on screen captions (inquire for custom on-screen styling) |
updateContent | Fetch new content for the mediaplayer's registered video URL (see media player configuration documentation) |
reload | Restart the AccessKit application. |
reboot | Reboot the mediaplayer. |
OpenSoundControl (OSC) commands
Need OSC?
We currently have limited support for OSC commands, but can add any or all of the above on an as-needed basis, or new commands. Simply let us know if you need OSC and we will be happy to add the required commands.