These are the The device setup parametersentity contains the following properties:
version
This value should be "3.0.0"string:
_id
The id of the device setup object, if anystring
optional:
bDeploy
A B-Deploy Entity (v3)bDeploy {}:
firmwareUpdatesByFamily
The Package Name Entity (v3)firmwareUpdatesByFamily
{}:
firmwareUpdateType
The firmware update type (for example, "standard")string:
setupType
The device setup type (either "lfn", "sfn", "partner", "standalone", or "bsn")string:
bsnDeviceRegistrationTokenEntity
tokenEntity{}:
A Token Entity (DOCS-1116)
enableSerialDebugging
: If true, serial debugging is enabledbool
enableSystemLogDebugging
: If true, system log debugging is enabledbool
remoteDwsEnabled
: If true, the remote DWS is enabledbool
dwsEnabled
: If true, the DWS is enabledbool
dwsPassword
: The DWS passwordstring
dwsPasswordPreviousSavedTimeStamp
: The DWS password time stampstring
lwsEnabled
: If true, the LWS is enabledbool
lwsConfig
: The local web server user type (either "s" for status/no publish or "c" for content/LFN publishing)string
lwsUserName
: The optional user name of the LWS serverstring
lwsPassword
:The optional password for the LWS serverstring
lwsEnableUpdateNotifications
: If true, update notifications are enabled on the LWS bool
bsnCloudEnabled
If true, bsn.cloud is enabled
:bool
deviceName
The name given to devices that are provisioned with the Device Setup package
:string
deviceDescription
: The description give to devices that are provisioned with the Device Setup packagestring
unitNamingMethod
Whether or not to append the serial number to the name ("appendUnitIDToUnitName" or " ")
:string
timeZone
: The time zone (for example, "PST")string
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
timeBetweenNetConnects
: How often the autorun checks for contentint
timeBetweenHeartbeats
: How often the player reports health to BSNint
sfnWebFolderUrl
: The URL address for the web-accessible folder that contains the simple file networking presentationstring
sfnUserName
: The user name for the simple file networking setupstring
sfnPassword
: The password for the simple file networking setupstring
sfnEnableBasicAuthentication
: If true, basic authentication is enabled for simple file networkingbool
playbackLoggingEnabled
: If true, playback logging is enabledbool
eventLoggingEnabled
: If true, event logging is enabledbool
diagnosticLoggingEnabled
: If true, diagnostic logging is enabledbool
stateLoggingEnabled
: If true, state logging is enabledbool
variableLoggingEnabled
: If true, variable logging is enabledbool
uploadLogFilesAtBoot
: If true, log files will be uploaded at bootbool
uploadLogFilesAtSpecificTime
: If true, log files will be uploaded at a specific timebool
uploadLogFilesTime
: The time that log files will be uploaded, if anyint
logHandlerUrl
:string
enableRemoteSnapshot
: If true, remote snapshot is enabledbool
remoteSnapshotInterval int
: The number of seconds to wait between capturing each snapshot
remoteSnapshotMaxImages
: The maximum number of images to captureint
remoteSnapshotJpegQualityLevel
: The JPEG quality level for the remote snapshot, on a scale from 0 to 100int
remoteSnapshotScreenOrientation
: The screen orientation ("Landscape" or "Portrait")string
remoteSnapshotHandlerUrl
The Url for the remote snapshot handler
:string
idleScreenColor
: An array of RGBA valuesidleScreenColor
{}
networkDiagnosticsEnabled
: If true, network diagnostics are enabledbool
testEthernetEnabled
: If true, ethernet testing during setup is enabledbool
testWirelessEnabled
: If true, wireless testing during setup is enabledbool
testInternetEnabled
: If true, internet testing during setup is enabledbool
useCustomSplashScreen
: If true, a custom splash screen will be usedbool
BrightWallName
: The name of the BrightWall settingsstring
BrightWallScreenNumber
: The BrightWall display numberstring
contentDownloadsRestricted
: If true, content downloads are restrictedbool
contentDownloadRangeStart int
: The start time for the content download
contentDownloadRangeEnd
int
: The end time for the content download
usbUpdatePassword
: The password for the USB update featurestring
inheritNetworkProperties
: If true, the setup will use the existing network configuration settings of the playerbool
internalCaArtifacts
internalCaArtifacts
{ }
network
network {}:
The Network Entity (DOCS-1116)