Here you will find a rich set of resources for developers.

Your starting point for BrightSign development. Complete SDK, working examples, and documentation that gets you to your first deployment in under 15 minutes.

BrightScript and JavaScript APIs provide direct access to players.

APIs for accessing BSN.Cloud as well as the legacy BrightSign Network (BSN).

BrightSign players feature a full Chromium installation enabling players to display HTML content. Here you will find resources to help you develop HTML apps to run on our players.

The Diagnostic Web Server (DWS) enables access to player info and settings and offers tools for troubleshooting players. These APIs provide direct access to the DWS.

An introductory guide for the integration of a partner CMS with the BrightSign ecosystem 

Guidance for partners to help them integrate with BSN.Cloud

Similar to the JavaScript console in web browsers, the BrightScript Debugger is a powerful command-line tool for troubleshooting and debugging issues with BrightScript scripts or interacting with BrightScript objects.

The BrightSign Shell is a command-line interface (CLI) that enables interaction with the BrightSignOS (BOS). It can be used to troubleshoot and debug issues with the player as well as accessing things like network settings, display details, the BrightScript Interpreter, the BrightScript Debugger, a Node.js runtime, and player logs.

Develop

This is our legacy cloud platform. Our latest cloud platform is BrightSign Cloud, aka BSN.Cloud. Development of BSN has largely ceased and will eventually be deprecated.

BrightSign_Network_BSN

BrightSign’s *legacy* app for authoring and managing players. The app's actual name is BrightAuthor but is referred to as BrightAuthor Classic to lessen confusion with BrightSign Author, our latest app.

BrightAuthor_Classic

BrightSign’s latest free, all-in-one app for player setup / management, authoring, and content management.

BrightAuthorconnected

BrightSign's record of a player and its Setup File. The Default Setup File is assigned to the player unless another Setup File has been explicitly set.

Provision_Record

The process where a player is registered with BrightSign and a Setup File is assigned to the player.

Provision

BrightDev

Language Reference

Object Reference

BrightScript

Enabling BrightScript-JavaScript Objects

BSBtManager

BSCECReceiver

BSCECTransmitter

BSControlPort

BSDatagramSocket

BSDeviceInfo

BSIRReceiver

BSIRTransmitter

BSMessagePort

BSSerialPort

BSSyncManager

BSTicker

BSVideoMode

Global BrightScript-JavaScript Functions

BrightScript-JavaScript Objects

BrightScript-JavaScript Migration Guide

JavaScript Event Handling

BrightSign Asset Pool

assetfetcher

assetpool

assetpoolfiles

assetrealizer

audio

audioconfig

audiooutput

chardisplay

compositor

configurednetworks

controlport

cookiestore

decoderconfiguration

devicecustomization

deviceinfo

devicestatus

dwsconfiguration

filesysteminfile

filesysteminfo

hostconfiguration

htmlwidget

keyboard

keystore

messageport

networkconfiguration

networkdiagnostics

networkhotplug

networkstatus

openvpn

pointer

pointercalibration

registry

resolver

screenshot

securestore

serialport

serialportlist

storage

storageinfo

syncmanager

system

systemtime

tvcontroller

usbfilesystem

usbhidemulator

usbhotplug

usbpowercontrol

videoinput

videomodeconfiguration

videooutput

JavaScript APIs

Player APIs (BrightScript & JavaScript)

Version 2.0 B-Deploy Endpoints

Version 3.0 B-Deploy Endpoints

B-Deploy/Provisioning APIs

Making Requests

Main API version 2022/06

Upload API version 2019/03

BSN.Cloud Main APIs

BSN.Cloud API Integration

Postman Collections

Cloud APIs

Displaying HTML with BrightSign Author

Displaying HTML without BrightSign Author or  BA Classic

How to Efficiently Restart Applications on a Player

HTML Authoring Resources

Animations and Add-on Libraries

BrightSign Extensions

Creating HTML Pages

Debugging Webpages

Disabling Staged ES6 Features

HTML Caching

HTML Content Restrictions

HTML Storage

Touchscreen Support

Using HTML Websites that Require Logins

HTML Best Practices

HTML Playback by Player Series

HTML Video

Debugging HTML/Node Apps

Known Issues

Node.js

Chromium, Node.js, & BOS Versions

Using iframes with Chromium 110/120

HTML Development

LDWS Advanced Endpoints

LDWS Control Endpoints

LDWS Diagnostics Endpoints

LDWS Display Control Endpoints

LDWS General Endpoints

LDWS Info Endpoints

LDWS Logs Endpoints

LDWS Registry Endpoints

LDWS Remote Snapshot Endpoint

LDWS sendCecX Endpoint

LDWS Storage Endpoints

LDWS Video Endpoints

Local DWS APIs

rDWS Advanced Endpoints

rDWS Control Endpoints

rDWS Diagnostics Endpoints

rDWS Display Control Endpoints

rDWS Information Endpoints

rDWS Logs Endpoints

rDWS Other Endpoints

rDWS Registry Endpoints

rDWS Remoteview Endpoints

rDWS Storage Endpoints

rDWS Video Endpoints

Remote DWS APIs

Diagnostic Web Server APIs

BrightSign Players

Provisioning & Recovery

Player Setup/Provisioning

Autorun Files

Content Sources

Preparations

Copy to Player

Considerations

Example (Manual Setup)

BrightSign Control Integration

App URL/CMS URL

Example (CMS URL/App URL)

Developer Tools

Developer Setup

Partner Resources

Onboarding

Integrating with BrightSign

Technical Best Practices

Operational Best Practices

BrightSign / Partner Responsibilities

Support

Staying Updated

Partner Glossary

BrightSign Partner Packet

Adding a CMS to bsn.Cloud Partner Gallery

Adding Partner CMS Players to  Networks

Applying Settings in the Properties Panel

BrightSign Cloud

Partner Setup and Recovery

BSN.Cloud for Partners

IGMP Behavior

BrightSign Registry Keys

BrightScript Debugger

BrightSign Shell