Page Comparison

The device setup entity contains the following properties:

version string required: This value should be "3.0.0"

_id string optionalstring required: The id of the device setup object, if any

bDeploy bDeploy[] object required: A B-Deploy Entity (v3) Reviewed with Samina

firmwareUpdatesByFamilyfirmwareUpdatesByFamily {}  object required: The Package Name Entity (v3) Reviewed with Samina

firmwareUpdateType string required: The firmware update type (for example, which is one of "different", "newer", "save", and "standard". See Package Name Entity (v3) Reviewed with Samina for more information.

setupType string required: The device setup type (either device setup type which is one of "legacyLfn", "localToBsn", "lfn", "sfn", "partnerpartnerApplication", "standalone", or "bsn")

bsnDeviceRegistrationTokenEntitytokenEntity[]  object required: A Token Entity (DOCS-1116)

enableSerialDebugging boolbool required: If true, serial debugging is enabled (false is the default)

enableSystemLogDebugging  bool required: If true, system log debugging is enabled (false is the default)

remoteDwsEnabled bool  bool required:  If true, the remote DWS is enabled (false is the default)

dwsEnabled boolbool required: If true, the DWS is enabled (false is the default)

dwsPassword string required: The DWS password
dwsPasswordPreviousSavedTimeStamp stringDWS password (this can be an empty string)

dwsPasswordPreviousSavedTimeStamp  number required: The DWS password time stamp

lwsEnabled bool required: If true, the LWS is enabled (false is the default)

lwsConfig string required: The local web server user type (, either "status" or "scontent" for status/no publish or "c" for content/LFN publishingnone" (this can be an empty string)

lwsUserName string optional required: The user name of the LWS server (this can be an empty string)

lwsPassword string optional string required: The password for the LWS server (this can be an empty string)

lwsEnableUpdateNotifications bool required:  If true, update notifications are enabled on the LWS (this is false by default)

bsnCloudEnabled bool required: If true, bsn.cloud is enabled (this is false by default)

____REVIEWED WITH SAMINA UP TO THIS POINT

deviceName string required: The name given to devices that are provisioned with the Device Setup package

deviceDescription string required: The description give to devices that are provisioned with the Device Setup package

unitNamingMethod string required: Whether or not to append the serial number to the name ("appendUnitIDToUnitName" or " ")

timeZone stringstring required: The time zone (for example, "PST")

bsnGroupName stringstring required: The name of the BSN.cloud group to which provisioned devices will be assigned. This value defaults to the "Default" group if undefined.

timeBetweenNetConnects int required: How often the autorun checks for content

timeBetweenHeartbeats int required: How often the player reports health to BSN

sfnWebFolderUrl stringstring required: The URL address for the web-accessible folder that contains the simple file networking presentation

sfnUserName stringstring required: The user name for the simple file networking setup

sfnPassword stringstring required: The password for the simple file networking setup

sfnEnableBasicAuthentication  bool required: If true, basic authentication is enabled for simple file networking

playbackLoggingEnabled bool  bool required: If true, playback logging is enabled

eventLoggingEnabled boolbool required: If true, event logging is enabled

diagnosticLoggingEnabled boolbool required: If true, diagnostic logging is enabled

stateLoggingEnabled bool bool required: If true, state logging is enabled

variableLoggingEnabled bool required: If true, variable logging is enabled

uploadLogFilesAtBoot boolbool required: If true, log files will be uploaded at boot

uploadLogFilesAtSpecificTime boolbool required: If true, log files will be uploaded at a specific time

uploadLogFilesTime int int required: The time that log files will be uploaded, if any

logHandlerUrl string optional: The custom log handler URL to which the logs are uploaded

enableRemoteSnapshot boolbool required: If true, remote snapshot is enabled

remoteSnapshotInterval int int required: The number of seconds to wait between capturing each snapshot

remoteSnapshotMaxImages intint required: The maximum number of images to capture

remoteSnapshotJpegQualityLevel int required: The JPEG quality level for the remote snapshot, on a scale from 0 to 100

remoteSnapshotScreenOrientation stringstring required: The screen orientation ("Landscape" or "Portrait")

remoteSnapshotHandlerUrl string required: The Url for the remote snapshot handler

idleScreenColor idleScreenColor[] required: An array of RGBA values

networkDiagnosticsEnabled bool  bool required: If true, network diagnostics are enabled

testEthernetEnabled boolbool required: If true, ethernet testing during setup is enabled

testWirelessEnabled boolbool required: If true, wireless testing during setup is enabled

testInternetEnabled boolbool required: If true, internet testing during setup is enabled

useCustomSplashScreen bool required: If true, a custom splash screen will be used

BrightWallName  string required: The name of the BrightWall settings

BrightWallScreenNumber stringstring required: The BrightWall display number

contentDownloadsRestricted bool required: If true, content downloads are restricted

contentDownloadRangeStart int int required: The start time for the content download

contentDownloadRangeEnd int required: The end time for the content download

usbUpdatePassword stringstring required: The password for the USB update feature

inheritNetworkProperties boolbool required: If true, the setup will use the existing network configuration settings of the player

internalCaArtifacts internalCaArtifacts[] required

networknetwork[]  object required: The Network Entity (DOCS-1116)