...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
These are the device setup parameters:
...
[string] token: The device registration token[string] scope: The scope of the device registration token (for example, "cert")[string] validFrom: The beginning of the token validity window[string] validTo: The end of the token validity window
...
[int] timeBetweenNetConnects: How often the autorun checks for content
...
[int] timeBetweenHeartbeats: How often the player reports health to BSN
...
[string] sfnWebFolderUrl: The URL address for the web-accessible folder that contains the simple file networking presentation
...
[string] sfnUserName: The user name for the simple file networking setup
...
[string] sfnPassword: The password for the simple file networking setup
...
[bool] sfnEnableBasicAuthentication: If true, basic authentication is enabled for simple file networking
...
[bool] playbackLoggingEnabled: If true, playback logging is enabled
...
[bool] eventLoggingEnabled: If true, event logging is enabled
...
[bool] diagnosticLoggingEnabled: If true, diagnostic logging is enabled
...
[bool] stateLoggingEnabled: If true, state logging is enabled
...
[bool] variableLoggingEnabled: If true, variable logging is enabled
...
[bool] uploadLogFilesAtBoot: If true, log files will be uploaded at boot
...
[bool] uploadLogFilesAtSpecificTime: If true, log files will be uploaded at a specific time
...
[int] uploadLogFilesTime: The time that log files will be uploaded, if any
...
[string] logHandlerUrl:
...
[bool] enableRemoteSnapshot: If true, remote snapshot is enabled
...
[int] remoteSnapshotInterval: The number of seconds to wait between capturing each snapshot
...
[int] remoteSnapshotMaxImages: The maximum number of images to capture
...
[int] remoteSnapshotJpegQualityLevel: The JPEG quality level for the remote snapshot, on a scale from 0 to 100
...
[string] remoteSnapshotScreenOrientation: The screen orientation ("Landscape" or "Portrait")
...
[string] remoteSnapshotHandlerUrl: The Url for the remote snapshot handler
...
[bool] contentDataTypeEnabledWired: If true, the "content data type" is enabled over the ethernet interface
...
[bool] textFeedsDataTypeEnabledWired: If true, the "text feeds data type" is enabled over the ethernet interface
...
[bool] healthDataTypeEnabledWired: If true, health is enabled over the ethernet interface
...
[bool] mediaFeedsDataTypeEnabledWired: If true, the "media feeds data type" is enabled over the ethernet interface
...
[bool] logUploadsXfersEnabledWired: If true, log uploads are enabled over the ethernet interface.
...
[bool] contentDataTypeEnabledWireless: If true, the "content data type" is enabled over the WiFi interface
...
[bool] textFeedsDataTypeEnabledWireless: If true, the "text feeds data type" is enabled over the WiFi interface
...
[bool] healthDataTypeEnabledWireless: If true, health is enabled over the WiFi interface
...
[bool] mediaFeedsDataTypeEnabledWireless: If true, the "media feeds data type" is enabled over the WiFi interface
...
[bool] logUploadsXfersEnabledWireless: If true, log uploads are enabled over the WiFi interface
...
[string] rateLimitModeOutsideWindow: The rate limit mode if you are not in the content downloads window for ethernet or WiFi
...
[int] rateLimitRateOutsideWindow: The actual rate limit numerical values for ethernet or WiFi if you are outside of the content downloads window.
...
[string] rateLimitModeInWindow: The rate limit mode during the content downloads window for ethernet or WiFi
...
[int] rateLimitRateInWindow: The actual rate limit numerical values for ethernet or WiFi if you are in the content downloads window.
...
[string] rateLimitModeInitialDownloads: The rate limit mode during initial downloads for ethernet or WiFi
...
[int] rateLimitRateInitialDownloads: The actual rate limit numerical values for ethernet or WiFi
...
[string] networkConnectionPriority: The network priority for ethernet or WiFi
...
[bool] networkDiagnosticsEnabled: If true, network diagnostics are enabled
...
[bool] testEthernetEnabled: If true, ethernet testing during setup is enabled
...
[bool] testWirelessEnabled: If true, wireless testing during setup is enabled
...
[bool] testInternetEnabled: If true, internet testing during setup is enabled
...
[bool] useCustomSplashScreen: If true, a custom splash screen will be used
...
[string] BrightWallName: The name of the BrightWall settings
...
[string] BrightWallScreenNumber: The BrightWall display number
...
[bool] specifyHostname: If true, the hostname is specified
...
[string] hostname: The hostname of the interface
...
[bool] useProxy: If true, the network configuration uses a proxy
...
[string] proxyAddress:
...
[int] proxyPort: The number of the proxy port
...
[networkHosts{ }] networkHosts: An array of network hostnames
...
[bool] contentDownloadsRestricted: If true, content downloads are restricted
...
[int] contentDownloadRangeStart: The start time for the content download
...
[int] contentDownloadRangeEnd: The end time for the content download
...
[bool] heartbeatsRestricted: If true, player health reporting is restricted
...
[int] heartbeatsRangeStart: DEPRECATED The default value is 0
...
[int] heartbeatsRangeEnd: DEPRECATED The default value is 0
...
[string] staticIPAddress: The static IP address for either the ethernet or WiFi interface
...
[string] subnetMask: The subnet mask for static configuration for either the ethernet or WiFi interface
...
[string] gateway: The gateway value for static configuration of the ethernet or WiFi interface
...
[string] dns1: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[string] dns2: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[string] dns3: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[bool] useDHCP_2: If true, DHCP_2 is used
...
[string] staticIPAddress_2: The static IP address for either the ethernet or WiFi interface (static IP address 2 denotes the interface with the lower priority)
...
[string] subnetMask_2: The subnet mask for static configuration for ethernet or WiFi interface (subnet mask2 is the lower priority interface).
...
[string] gateway_2: The gateway value for static configuration of the ethernet or WiFi interface. Gateway 2 is lower priority.
...
[string] dns1_2: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[string] dns2_2: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[string] dns3_2: DNS values for static configuration of ethernet or WiFi interface. Whether it is ethernet or WiFi depends on the priority order.
...
[string] rateLimitModeOutsideWindow_2: The rate limit mode if you are not in the content downloads window for ethernet or WiFi (2 is for the interface with lower priority)
...
[int] rateLimitRateOutsideWindow: The actual rate limit numerical values for ethernet or WiFi if you are outside of the content downloads window (2 is for the interface with lower priority)_2
...
[string] rateLimitModeInWindow_2: The rate limit mode during the content downloads window for ethernet or WiFi (2 is for the interface with lower priority)
...
[int] rateLimitRateInWindow_2: The actual rate limit numerical values for ethernet or WiFi if you are in the content downloads window (2 is for the interface with lower priority)
...
[string] rateLimitModeInitialDownloads_2: The rate limit mode during initial downloads for ethernet or WiFi (2 is for the interface with lower priority)
...
[int] rateLimitRateInitialDownloads: The actual rate limit numerical values for ethernet or WiFi (2 is for the interface with lower priority)_2
...
[string] usbUpdatePassword: The password for the USB update feature
...
[bool] inheritNetworkProperties: If true, the setup will use the existing network configuration settings of the player
...
The device setup entity contains the following properties:
version This value should be "3.0.0"string required:
_id The id of the device setup objectstring required:
bDeploy A B-Deploy Entity (v3)object required
firmwareUpdatesByFamilyobject required:
firmwareUpdateType The firmware update type which is one of "different", "newer", "save", and "standard". See string required: firmwareUpdateDifferentTargetFileName, firmwareUpdateNewerTargetFileName, firmwareUpdateSaveTargetFileName, and firmwareUpdateStandardTargetFileName in FirmwareUpdatebyFamily Entity (v3) for more information about these types.
setupType string requiredThe device setup type which is one of "legacyLfn", "localToBsn", "lfn", "sfn", "partnerApplication", "standalone", or "bsn"):
bsnDeviceRegistrationTokenEntity objectA Token Entity (DOCS-1116) required:
enableSerialDebugging : False is the default. If true, serial debugging is enabled. bool required
enableSystemLogDebugging boolrequired
remoteDwsEnabled bool required
dwsEnabled : False is the default. If true, the DWS is enabled. bool required
dwsPassword stringrequired
dwsPasswordPreviousSavedTimeStamp number required
lwsEnabled boolrequired
lwsConfig stringrequired
lwsUserName stringrequired
lwsPassword string required
lwsEnableUpdateNotifications boolrequired: False is the default. If true, update notifications are enabled on the LWS.
bsnCloudEnabled False is the default. If true, bsn.cloud is enabled. boolrequired:
deviceName The user-defined device name for devices that are provisioned with the Device Setup package. This can be an empty string.string required
deviceDescription stringrequired
unitNamingMethod Either "appendUnitIDToUnitName" or "unitNameOnly", which determines whether or not to append the serial number to the device name.stringrequired
timeZone : The time zone (for example, "PST")string required
bsnGroupName : The name of the BSN.cloud group to which provisioned devices will be assigned. This value defaults to the "Default" group if undefined.string required
timeBetweenNetConnects intrequired
timeBetweenHeartbeats int required
sfnWebFolderUrl : The URL address for the web-accessible folder that contains the simple file networking presentation. This can be an empty string.string required
sfnUserName : The user name for the simple file networking setup. This string can be empty.string required
sfnPassword : The password for the simple file networking setup. This string can be empty.string required
sfnEnableBasicAuthentication boolrequired
playbackLoggingEnabled bool required
eventLoggingEnabled : False is the default. If true, event logging is enabled. bool required
diagnosticLoggingEnabled : False is the default. If true, diagnostic logging is enabled. bool required
stateLoggingEnabled bool required
variableLoggingEnabled boolrequired
uploadLogFilesAtBoot : False is the default. If true, log files will be uploaded at startup. bool required
uploadLogFilesAtSpecificTime : False is the default. If true, log files will be uploaded at a specific time. bool required
uploadLogFilesTime : The time that log files will be uploaded, if any, in minutesint required
logHandlerUrl : 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).string optional
enableRemoteSnapshot : False is the default. If true, remote snapshot is enabled. bool optional
remoteSnapshotInterval int : The number of milliseconds to wait between capturing each snapshot. Zero is the default, but this value should be set if requiredenableRemoteSnapshot is true.
remoteSnapshotMaxImages : The maximum number of snapshot images to save. Possible values are 1 to 100.int required
remoteSnapshotJpegQualityLevel intrequired
remoteSnapshotScreenOrientation : The screen orientation ("Landscape", "PortraitBottomRight", or "PortraitBottomLeft")string required
remoteSnapshotHandlerUrl The URL for the remote snapshot handlerstring optional
idleScreenColor : An object with RGBA propertiesobject required
networkDiagnosticsEnabled bool requiredtestEthernetEnabled, testWirelessEnabled, or testInternetEnabled.
testEthernetEnabled : False is the default. If true, ethernet testing during setup is enabled.bool required
testWirelessEnabled : False is the default. If true, wireless testing during setup is enabled. bool required
testInternetEnabled : False is the default. If true, internet testing during setup is enabled. bool required
useCustomSplashScreen : False is the default. If true, a custom splash screen will be used. bool required
BrightWallName string required
BrightWallScreenNumber : The BrightWall display numberstring required
contentDownloadsRestricted boolrequired
contentDownloadRangeStart time : The start time when content can be downloaded, from 00:00 to 23:59required
contentDownloadRangeEnd time : The end time when content can be downloaded, from 00:00 to 23:59required
usbUpdatePassword : The password for the USB update featurestring required
inheritNetworkProperties : 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.bool required
internalCaArtifacts internalCaArtifacts[] required: A list of certificate objects. Each object has a name and an asset (the certificate file object). This can be an empty object.
network object The Network Entity (DOCS-1116). This will contain default values unless the user specifies parameters.required