The device setup entity contains the following required properties:
version string required: This value should be "3.0.0"
_id string required: The id of the device setup object. This is only required for a “PUT” call (not “POST”).
bDeploy object required: A B-Deploy Entity (v3)
setupType string required: The device setup type which is one of "legacyLfn", "localToBsn", "lfn", "sfn", "partnerApplication", "standalone", or "bsn"
bsnDeviceRegistrationTokenEntity object required: A Token Entity (v3)
timeZone string required: The time zone (for example, "PST"). See roSystemTime | roSystemTime supported_time_zones for the available time zone options.
bsnGroupName string required: If the setup type is BSN, this is required. The name of the BSN.cloud group to which provisioned devices will be assigned. This value defaults to the "Default" group if the value is not provided.
network object required: The Network Entity (v3). This will contain default values unless the user specifies parameters.
These optional properties can also be used:
firmwareUpdatesByFamily object optional: The FirmwareUpdatebyFamily Entity (v3). If a firmware update is required with your setup, this field is required.
firmwareUpdateType string optional: The firmware update type which is one of "different", "newer", "save", and "standard". See firmwareUpdateDifferentTargetFileName, firmwareUpdateNewerTargetFileName, firmwareUpdateSaveTargetFileName, and firmwareUpdateStandardTargetFileName in FirmwareUpdatebyFamily Entity (v3) for more information about these types. If a firmware update is required with your setup, this field is required.
enableSerialDebugging bool optional: False is the default. If true, serial debugging is enabled.
enableSystemLogDebugging bool optional: False is the default. If true, system log debugging is enabled.
remoteDwsEnabled bool optional: False is the default. If true, the remote DWS is enabled on the player and can be accessed remotely.
dwsEnabled bool optional: False is the default. If true, the DWS is enabled on local network of the player.
dwsPassword string optional: The DWS password (this can be an empty string). Although this is not required, you should add this password for security purposes. The default password is the player serial number.
lwsEnabled bool optional: False is the default. If true, the LWS is enabled.
lwsUserName string optional: The user name of the LWS server (this can be an empty string)
lwsPassword string optional: The password for the LWS server (this can be an empty string)
lwsEnableUpdateNotifications bool optional: False is the default. If true, update notifications are enabled on the LWS.
bsnCloudEnabled bool optional: The default, true, indicates that bsn.cloud is enabled.
deviceName string optional: The user-defined device name for devices that are provisioned with the Device Setup package. This can be an empty string.
deviceDescription string optional: The user-defined description give to devices that are provisioned with the Device Setup package. This can be an empty string.
unitNamingMethod string optional: Either "appendUnitIDToUnitName" or "unitNameOnly", which determines whether or not to append the serial number to the device name.
timeBetweenNetConnects int optional: How often the autorun checks for content (in seconds). The default is 300 seconds (5 minutes).
timeBetweenHeartbeats int optional: How often the player reports health to BSN (in seconds). The default is 900 seconds (15 minutes).
sfnWebFolderUrl string optional: This is only required if the setup type is SFN. The URL address for the web-accessible folder that contains the simple file networking presentation. This can be an empty string.
sfnEnableBasicAuthentication bool optional: If this is true, the password and username are required. False is the default.
sfnUserName string: The username for the SFN file server, which is only required if the SFN server is password protected. This string can be empty.
sfnPassword string: The password for the SFN server. This string can be empty.
playbackLoggingEnabled bool optional: False is the default. If true, playback logging is enabled.
eventLoggingEnabled bool optional: False is the default. If true, event logging is enabled.
diagnosticLoggingEnabled bool optional: False is the default. If true, diagnostic logging is enabled.
stateLoggingEnabled bool optional: False is the default. If true, state logging is enabled.
variableLoggingEnabled bool optional: False is the default. If true, variable logging is enabled.
uploadLogFilesAtBoot bool optional: False is the default. If true, log files will be uploaded at player startup.
uploadLogFilesAtSpecificTime bool optional: False is the default. If true, log files will be uploaded at a specific time.
uploadLogFilesTime int: The time that log files will be uploaded, if any, in minutes. This is required if uploadLogFilesAtSpecificTime is enabled.
logHandlerUrl string optional: The custom log handler URL to which the logs are uploaded. This is only enabled for simple file networking (otherwise it will be an empty string).
enableRemoteSnapshot bool optional: False is the default. If true, remote snapshot is enabled. The following parameters are required if you enable this boolean:
remoteSnapshotInterval int: The number of minutes to wait between capturing each snapshot. Zero is the default, but this value should be set if enableRemoteSnapshot is true.
remoteSnapshotMaxImages int: The maximum number of snapshot images to save. Possible values are 1 to 100.
remoteSnapshotJpegQualityLevel int: The JPEG quality level for the remote snapshot, on a scale from 1 to 100
remoteSnapshotScreenOrientation string: The screen orientation ("Landscape", "PortraitBottomRight", or "PortraitBottomLeft")
remoteSnapshotHandlerUrl string: The URL for the remote snapshot handler
idleScreenColor object optional: An object with RGBA properties. The default color is black.
networkDiagnosticsEnabled bool optional: False is the default. If true, network diagnostics are enabled. This must be enabled in order to enable testEthernetEnabled, testWirelessEnabled, or testInternetEnabled:
testEthernetEnabled bool : False is the default. If true, ethernet testing during setup is enabled.
testWirelessEnabled bool: False is the default. If true, wireless testing during setup is enabled.
testInternetEnabled bool: False is the default. If true, internet testing during setup is enabled.
useCustomSplashScreen bool optional: False is the default. If true, a custom splash screen will be used.
BrightWallName string optional: The name of the BrightWall settings
BrightWallScreenNumber string optional: The BrightWall display number
contentDownloadsRestricted bool optional: False is the default. If true, content downloads are restricted for SFN and BSN. If the value is true, the following fields are required:
contentDownloadRangeStart int: The start time when content can be downloaded, from 00:00 to 23:59 (in minutes)
contentDownloadRangeEnd int: The end time when content can be downloaded, from 00:00 to 23:59 (in minutes)
usbUpdatePassword string optional: The password for the USB update feature
inheritNetworkProperties bool optional: False is the default (it will use the network properties from the device setup file). If true, the setup will use the current network configuration settings of the player.
internalCaArtifacts internalCaArtifacts[] optional: A list of certificate objects. Each object has a name and an asset (the certificate file object). This can be an empty object.
Example
The FirmwareUpdatebyFamily entity is removed for readability since it is only required if you need to do a firmware update.
{
"version":"3.0.0",
"_id":"",
"bDeploy":{
"username":"anon@brightsign.biz",
"networkName":"admin",
"packageName":"test2023"
},
"firmwareUpdateType":"standard",
"setupType":"standalone",
"bsnDeviceRegistrationTokenEntity":{
"token":"{{token}}",
"scope":"cert",
"validFrom":"2023-01-26T23:21:48.000Z",
"validTo":"2025-01-25T23:21:48.000Z"
},
"enableSerialDebugging":false,
"enableSystemLogDebugging":false,
"remoteDwsEnabled":true,
"dwsEnabled":false,
"dwsPassword":"",
"lwsEnabled":true,
"lwsUserName":"",
"lwsPassword":"",
"lwsEnableUpdateNotifications":true,
"bsnCloudEnabled":true,
"deviceName":"",
"deviceDescription":"",
"unitNamingMethod":"appendUnitIDToUnitName",
"timeZone":"PST",
"bsnGroupName":"Default",
"timeBetweenNetConnects":300,
"timeBetweenHeartbeats":900,
"sfnWebFolderUrl":"",
"sfnUserName":"",
"sfnPassword":"",
"sfnEnableBasicAuthentication":false,
"playbackLoggingEnabled":false,
"eventLoggingEnabled":false,
"diagnosticLoggingEnabled":false,
"stateLoggingEnabled":false,
"variableLoggingEnabled":false,
"uploadLogFilesAtBoot":false,
"uploadLogFilesAtSpecificTime":false,
"uploadLogFilesTime":0,
"logHandlerUrl":"",
"enableRemoteSnapshot":false,
"remoteSnapshotInterval":15,
"remoteSnapshotMaxImages":5,
"remoteSnapshotJpegQualityLevel":50,
"remoteSnapshotScreenOrientation":"Landscape",
"remoteSnapshotHandlerUrl":"",
"idleScreenColor":{
"r":0,
"g":0,
"b":0,
"a":1
},
"networkDiagnosticsEnabled":false,
"testEthernetEnabled":false,
"testWirelessEnabled":false,
"testInternetEnabled":false,
"useCustomSplashScreen":false,
"BrightWallName":"",
"BrightWallScreenNumber":"",
"contentDownloadsRestricted":false,
"contentDownloadRangeStart":0,
"contentDownloadRangeEnd":0,
"heartbeatsRestricted":false,
"heartbeatsRangeStart":0,
"heartbeatsRangeEnd":0,
"usbUpdatePassword":"",
"inheritNetworkProperties":false,
"internalCaArtifacts":[
],
"network":{
"timeServers":[
"http://time.brightsignnetwork.com"
],
"hostname":null,
"dns":null,
"proxyServer":null,
"proxyBypass":null,
"interfaces":[
{
"id":"wired_eth0",
"name":"eth0",
"type":"Ethernet",
"proto":"DHCPv4",
"ip":[
],
"gateway":null,
"dns":[
],
"rateLimitDuringInitialDownloads":0,
"rateLimitInsideContentDownloadWindow":0,
"rateLimitOutsideContentDownloadWindow":null,
"contentDownloadEnabled":true,
"textFeedsDownloadEnabled":true,
"mediaFeedsDownloadEnabled":true,
"healthReportingEnabled":true,
"logsUploadEnabled":true,
"wpaSettings":{
"enableWPAEnterpriseAuthentication":false,
"wpaEnterpriseVariant":"WPAEnterpriseEapTls",
"eapCertificateType":"WPAEapTlsPKCS",
"eapCertificateFile":null,
"eapCertificatePassphrase":"",
"eapPemOrDerKeyFile":null,
"peapUsername":"",
"peapPassphrase":"",
"caCertificateFile":null
}
},
{
"id":"wireless_wlan0",
"name":"wlan0",
"type":"WiFi",
"proto":"DHCPv4",
"ip":[
],
"gateway":null,
"dns":[
],
"rateLimitDuringInitialDownloads":null,
"rateLimitInsideContentDownloadWindow":null,
"rateLimitOutsideContentDownloadWindow":null,
"contentDownloadEnabled":true,
"textFeedsDownloadEnabled":true,
"mediaFeedsDownloadEnabled":true,
"healthReportingEnabled":true,
"logsUploadEnabled":true,
"ssid":"dadmom",
"passphrase":"",
"security":{
"authentication":{
"mode":"Shared",
"passphrase":"{{passphrase}}"
},
"encryption":{
"mode":"TKIP, CCMP"
}
},
"wpaSettings":{
"enableWPAEnterpriseAuthentication":false,
"wpaEnterpriseVariant":"WPAEnterpriseEapTls",
"eapCertificateType":"WPAEapTlsPKCS",
"eapCertificateFile":null,
"eapCertificatePassphrase":"",
"eapPemOrDerKeyFile":null,
"peapUsername":"",
"peapPassphrase":"",
"caCertificateFile":null
}
}
]
}
}