Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 30 Next »

The device setup entity contains the following properties:


version string required: This value should be "3.0.0"


_id string required: The id of the device setup object


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


firmwareUpdatesByFamily  object required: The Package Name Entity (v3) Reviewed with Samina


firmwareUpdateType string required: The firmware update type which is one of "different", "newer", "save", and "standard". See firmwareUpdateDifferentTargetFileName, firmwareUpdateNewerTargetFileName, firmwareUpdateSaveTargetFileName, and firmwareUpdateStandardTargetFileName in Package Name Entity (v3) Reviewed with Samina for more information about these types.


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 (DOCS-1116)


enableSerialDebugging bool 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 required:  If true, the remote DWS is enabled (false is the default)


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


dwsPassword string required: The DWS 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 "content" or "none" (this can be an empty string)


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


lwsPassword 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 string required: The time zone (for example, "PST")


bsnGroupName string 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 string required: The URL address for the web-accessible folder that contains the simple file networking presentation


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


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


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


playbackLoggingEnabled  bool required: If true, playback logging is enabled


eventLoggingEnabled bool required: If true, event logging is enabled


diagnosticLoggingEnabled bool required: If true, diagnostic logging is enabled


stateLoggingEnabled bool required: If true, state logging is enabled


variableLoggingEnabled bool required: If true, variable logging is enabled


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


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


uploadLogFilesTime 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 bool required: If true, remote snapshot is enabled


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


remoteSnapshotMaxImages int 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 string 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 required: If true, network diagnostics are enabled


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


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


testInternetEnabled bool 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 string required: The BrightWall display number


contentDownloadsRestricted bool required: If true, content downloads are restricted


contentDownloadRangeStart int required: The start time for the content download


contentDownloadRangeEnd int required: The end time for the content download


usbUpdatePassword string required: The password for the USB update feature


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


internalCaArtifacts internalCaArtifacts[] required


network  object required: The Network Entity (DOCS-1116)







  • No labels