| Expand | ||||
|---|---|---|---|---|
| ||||
|
Overview
BrightSign players in large, distributed networks should meet certain provisioning and recovery requirements. Partners who want to set up their own provisioning and recovery systems, rather than using BSN.cloud, should make sure that those systems meet the following requirements.
...
The following player registry entries are associated with the provisioning and recovery process. These keys can be modified by accessing the registry’s “networking” section using the roRegistrySectionBrightScript object.
Registry Key | Description |
| The URL prefix that is applied to the URLs of the ru, eu, and cu key values. This prefix is not applied to a key value containing a colon. |
| The provisioning/recovery URL used by the player to download an autorun script |
| The URL to which error notifications are posted |
| The URL to which crash reports are posted |
| The |
password to the recovery handler ( |
The following registry keys are specific to BSN.cloud but can be modified by partners to affect the BSN.cloud registration. You should not store your own information in these sections because it can affect BSN.cloud operations:
Registry Key | Description |
| The name of the BSN.cloud account to which the player belongs. |
| The name of the BSN.cloud user in the account to which the player belongs |
| The BSN.cloud group within the account to which the player belongs |
The account, username, and group registry keys are used for provisioning/recovery with BSN.cloud. A request handler may use these keys, but they are not required.
...
The player connects to a network and obtains an IP address.
The player checks the storage device for an autorun. If an autorun is found, the player will execute the autorun and if none is found, it will proceed with the steps below. See Player Storage for more information about storage devices and device priority (if you have multiple storage devices).
If an IPv4 address exists, the player will attempt to provision over the network.
The player will check for a recovery URL (ru):
If a DHCP Option 43 recovery URL (ru) is found, it will override any registry value for
ruuntil the end of the DHCP lease. This URL can be set through DHCP Option 43. See Option 43 to configure a DHCP server to communicate this URL to a BrightSign player.If DHCP Option 43 ru is not found, the ru that is set in the registry will be used.
If there is no registry value for the ru, this step will be skipped.
If the recovery URL is blank, the player will attempt:
Well-known host provisioning: Also known as custom name mapping in your network's DNS server. If an IP address is mapped to brightsign-b-deploy, then the player will attempt to use the associated IP to provision itself automatically.
B-Deploy cloud provisioning: See B-Deploy/Provisioning APIs.
multicast DNS (mDNS): The player will automatically check the standard mDNS location (http://brightsign-b-deploy.local/) and if there is a server on your network with that address, the player will automatically provision itself. However, no other provisioning methods can be active if you want to provision with mDNS. See the Appendix for more information about this option.
The player will retry the provisioning process every 30 seconds until there is a successful response or interruption.
...
These parameters are used for communicating between a player and the request handler.
Player Request Parameters
The following parameters are included in the header of HTTP GET requests that a player sends to provisioning/recovery URL:
Parameter | Example Value | Description |
|
| The model designation of the BrightSign player |
|
| The family designation of the BrightSign player |
|
| The unique serial number of the player |
|
| The OS (firmware) version currently installed on the player |
|
| The amount of time (in seconds) since the player booted up |
|
| The mode of the current URL request:
|
|
| A flag indicating that the current boot was initiated by a forced reboot due to a crash (this header is only present if true). |
|
| The current autorun and file-system status of each storage device. |
Optional BSN.cloud Keys
Parameter | Example Value | Description |
|
| The |
|
| The |
|
| The |
|
| The p registry value described above |
Storage Status Parameters
The StorageStatus value contains a list of key-value pairs indicating the status of each storage device. The following storage device keys are returned:
BrightScript Key | Storage Status Key |
USB1: | usb1 |
SD: | sd |
SD2: | sd2 |
SSD: | ssd |
These status values can be returned for each storage device:
Storage Status Value | Description |
| The storage device was not detected. |
| The storage device is present, but an autorun script was not detected. |
| The storage device is present and contains an autorun.brs or autorun.zip file. |
| The storage device is present and contains an autorun.brs or autorun.zip file that failed to load. |
| The storage device is present and contains an autorun.brs or autorun.zip file that encountered a runtime error. |
| The storage device is present but failed a file-system check. This value also implies that attempts to repair the file system also failed. |
Server Response Parameters
The header of a request handler response may contain a single parameter. This parameter can accompany an HTTP 204 or 200 response (even if the response body is empty).
Parameter | Example Value | Description |
Retry-After | 7200 | The amount of time (in seconds) that the player should wait to make a periodic request to the provisioning/recovery URL. If this parameter is not provided, the default request interval will be two hours. |
Player Recovery
If no valid autorun is found, a recovery is triggered. In a recovery, the player pulls down content from the recovery URL (stored in the registry) and attempts to execute it.
...
Multicast DNS is a unique DNS protocol developed for small networks. These diagrams show the differences between a normal DNS setup and a mDNS setup. Note that multicast DNS is not on by default in all networks.
...
Setting up a Recovery/Provisioning Server
...
Different provisioning scripts depending on the DeviceId or Group (or other HTTP GET parameters)
Multiple provisioning or recovery autorun scripts for different storage
...