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 12 Next »


These are the device setup parameters:

  • [uiDeviceSetupErrors{}] uiDeviceSetupErrors: An array of device setup errors, if any
  • [string] version: "2.0.0" or "3.0.0"
  • [string] _id: The id of the device setup object, if any
  • [string] bDeploy: A B-Deploy Entity (DOCS-1116)
  • [firmwareUpdatesByFamily{}] firmwareUpdatesByFamily: An array of Package Name Entity (DOCS-1116)
  • [string] firmwareUpdateType:
  • [string] setupType: The device setup type (either "lfn", "sfn", "partner", "standalone", or "bsn")
  • [tokenEntity{}] bsnDeviceRegistrationTokenEntity: A Token Entity (DOCS-1116)
  • [bool] enableSerialDebugging: If true, serial debugging is enabled
  • [bool] enableSystemLogDebugging: If true, system log debugging is enabled
  • [bool] remoteDwsEnabled: If true, the remote DWS is enabled
  • [bool] dwsEnabled: If true, the DWS is enabled
  • [string] dwsPassword: The DWS password
  • [string] dwsPasswordPreviousSavedTimeStamp: The DWS password time stamp
  • [bool] lwsEnabled: If true, the LWS is enabled
  • [string] 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 server
  • [string] lwsPassword: The optional password for the lws server
  • [bool] lwsEnableUpdateNotifications: If true, update notifications are enabled on the LWS
  • [bool] bsnCloudEnabled: If true, bsn.cloud is enabled
  • [string] 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 package
  • [string] unitNamingMethod:
  • [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.
  • [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] useWireless: If true, wireless is used
  • [string] ssid: The SSID (seen by users as a wireless network name)
  • [string] passphrase:
  • [string] timeServer: The Url for time synchronization (probably "http://time.brightsignnetwork.com")
  • [idleScreenColor{}]idleScreenColor: An array of RGBA values
  • [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] healthDataTypeEnabledWirelessIf 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

  • [bool] useDHCP: If true, the network configuration is "DHCP" for ethernet or WiFi
  • [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_2: 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)

  • [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_2: The actual rate limit numerical values for ethernet or WiFi (2 is for the interface with lower priority)

  • [string] usbUpdatePassword: The password for the USB update feature

  • [bool] enablePhysicalLan: If true, physical LAN is enabled
  • [bool] inheritNetworkProperties: If true, the setup will use the existing network configuration settings of the player

  • [internalCaArtifacts{}] internalCaArtifacts:

  • [network{}] network: An array of Network Entity (DOCS-1116)




  • No labels