...
...
...
...
...
...
...
...
The device setup
...
entity contains the following properties:
...
version string
...
required:
...
_id string 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")
...
[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
bsnDeviceRegistrationTokenEntity objectA Token Entity (DOCS-1116) required:
enableSerialDebugging : False is the default. If true, serial debugging is enabled. bool required
...
enableSystemLogDebugging bool
...
required
...
remoteDwsEnabled bool required
...
.
dwsEnabled : False is the default. If true, the DWS is enabled. bool required
...
dwsPassword string
...
required
...
(this can be an empty string)
dwsPasswordPreviousSavedTimeStamp number required
...
lwsEnabled bool
...
required
...
lwsConfig string
...
required
lwsUserName stringrequired
lwsPassword string required
lwsEnableUpdateNotifications boolrequired: False is the default. If true, update notifications are enabled on the LWS.
...
bsnCloudEnabled bool
...
False is the default. If true, bsn.cloud is enabled. required:
...
deviceName string
...
required
...
user-defined device name for devices that are provisioned with the Device Setup package
...
. This can be an empty string.
deviceDescription stringrequired
...
. This can be an empty string.
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 int
...
[int] timeBetweenHeartbeats:
...
required
timeBetweenHeartbeats int required
sfnWebFolderUrl : The URL address for the web-accessible folder that contains the simple file networking presentationstring required
...
. This can be an empty string.
sfnUserName : The user name for the simple file networking setupstring required
...
. This string can be empty.
sfnPassword : The password for the simple file networking setupstring required
...
. This string can be empty.
sfnEnableBasicAuthentication boolrequired
...
playbackLoggingEnabled bool required
...
.
eventLoggingEnabled : False is the default. If true, event logging is enabledbool required
...
.
diagnosticLoggingEnabled : False is the default. If true, diagnostic logging is enabled. bool required
...
stateLoggingEnabled bool required
...
variableLoggingEnabled bool
...
required
...
.
uploadLogFilesAtBoot : False is the default. If true, log files will be uploaded at bool required
...
startup.
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 string
...
optional
enableRemoteSnapshot : False is the default. If true, remote snapshot is enabled. bool optional
...
remoteSnapshotInterval int : The number of required
...
milliseconds to wait between capturing each snapshot
...
. Zero is the default, but this value should be set if enableRemoteSnapshot is true.
remoteSnapshotMaxImages : The maximum number of snapshot images to int required
...
save. Possible values are 1 to 100.
remoteSnapshotJpegQualityLevel intrequired
...
1 to 100
...
remoteSnapshotScreenOrientation : The screen orientation ("Landscape", "PortraitBottomRight", or "string required
...
PortraitBottomLeft")
...
remoteSnapshotHandlerUrl string
...
optional
...
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
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 enabledbool required
...
.
testWirelessEnabled : False is the default. If true, wireless testing during setup is enabledbool required
...
.
testInternetEnabled : False is the default. If true, internet testing during setup is enabled. bool required
...
useCustomSplashScreen bool
...
required
...
BrightWallName string required
...
BrightWallScreenNumber : The BrightWall display numberstring required
...
contentDownloadsRestricted bool
...
required
...
for simple file networking.
contentDownloadRangeStart time : The start time required
...
when content can be downloaded, from 00:00 to 23:59
contentDownloadRangeEnd time : The end time required
...
[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
...
when content can be downloaded, from 00:00 to 23:59
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 bool required
...
current network configuration settings of the player.
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