---
title: Setup Package Entity (v2)
slug: develop/setup-package-entity-v2
docTags: 
createdAt: 2025-07-28T17:33:17.813Z
---

- `_id` <font color="#704ae0">string</font><font color="#01a0af"> read-only</font>: A unique identifier of a given Setup package&#x20;
- `version` <font color="#704ae0">semver</font> <font color="#01a0af">read-only</font>:<font color="#01a0af"> </font>A semantic version which defines the format of this Setup package entity, "2.0.0" by default
- `bDeploy` <font color="#704ae0">OwnershipInfo</font> <font color="#01a0af">read-only</font>: An [Ownership Info Entity  (v2)](docId:4bWEdvEQFCxy47VVPOfle) which defines the creator of this Setup package
- `firmwareUpdatesByFamily`<font color="#704ae0"> FirmwareUpdateCollection</font> <font color="#01a0af">read-write</font>: A [Firmware Update Collection Entity (v2)](docId\:nCRLIRJQpV-x4f6VjGgRd) which defines the BOS version of each player family
- `firmwareUpdateType` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: One of "standard", "different", "newer", "save" enumeration values which determine the kind of target BOS version.
- `setupType` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: Either "standalone", "bsn", "lfn", "sfn", or "partnerApplication"
- `bsnDeviceRegistrationTokenEntity`:
  - `token`: <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The token granted for authentication purposes
  - `scope`: <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The scope granted by the token. For example, a successful user authentication response will contain both "Full" and "Self"  values. 
  - `validFrom` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: The token will be valid from this date and time. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
  - `validTo` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: The date and time that the token expires. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `enableSerialDebugging` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>:  A flag specifying whether serial debugging should be enabled for all players assigned to the Group instance
- `enableSystemLogDebugging` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag specifying whether system log debugging should be enabled for players assigned to the Group instance
- `remoteDwsEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag which defines wherever the Remote Diagnostic Web Server should be enabled
- `dwsEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag which defines wherever the Local Diagnostic Web Server should be enabled
- `dwsPassword` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The password associated with the Local Diagnostic Web Server
- `dwsPasswordPreviousSavedTimeStamp` <font color="#704ae0">long</font> <font color="#01a0af">read-write</font>: A UNIX timestamp which defines when the local DWS password was last saved<font color="hsl(var(--ab-gray-900))"> </font>
- `lwsEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag which defines wherever the Local Web Server should be enabled
- `lwsConfig` <font color="#704ae0">string </font><font color="#01a0af">read-write</font>: A local web server operation mode which can be either "content" for LFN setup type and "status" for the other setup types. The difference is if the LWS server should be used for content publish.
- `lwsUserName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The Local Web Server username (for example, "admin")
- `lwsPassword` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The Local Web Server password&#x20;
- `lwsEnableUpdateNotifications` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not enable update notifications is enabled&#x20;
- `bsnCloudEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag that indicates whether a player should connect and register in BSN.Cloud
- `deviceName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The player name. The maximum length of this string is 128 characters.
- `deviceDescription` <font color="#704ae0">string </font><font color="#01a0af">read-write</font>: A customer-defined description of the player. The description does not need to be unique within the scope of the account.&#x20;
- `unitNamingMethod` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The player-naming method:&#x20;
  - `appendNameAndSerial` indicates that clients should append the player serial number to the player name.
  - `unitNameOnly` indicates that nothing should be appended to the player name.
- `timeZone` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The time zone a player should operate in, which is one of the values in [Supported Time Zones](docId\:HWR0ZojGTZxXnUHDLHlf9)&#x20;
- `bsnGroupName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name of the group instance to which the player is assigned
- `timeBetweenNetConnects` <font color="#704ae0">ushort</font> <font color="#01a0af">read-write</font>: An interval in seconds of player settings and schedule synchronization with a BSN or SFN server
- `timeBetweenHeartbeats` <font color="#704ae0">ushort</font> <font color="#01a0af">read-write</font>: An interval in seconds of player heartbeat reporting to a BSN or SFN server
- `sfnWebFolderUrl` <font color="#704ae0">URL</font> <font color="#01a0af">read-write</font>: The base URL of the target SFN folder which contains sync spec and related media content
- `sfnUserName` <font color="#704ae0">string </font><font color="#01a0af">read-write</font>: The username the player should provide to authenticate on an SFN server using the basic authentication method
- `sfnPassword` <font color="#704ae0">string </font><font color="#01a0af">read-write</font>: The password the player should provide to authenticate on an SFN server using the basic authentication method
- `sfnEnableBasicAuthentication` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether basic authentication is required by the SFN server
- `playbackLoggingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not playback logging is enabled on the associated player.
- `eventLoggingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not event logging is enabled on the associated player.
- `diagnosticLoggingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not diagnostic logging is enabled on the associated player
- `stateLoggingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not state logging is enabled on the associated player.
- `variableLoggingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not variable logging is enabled on the associated player.
- `uploadLogFilesAtBoot` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether autorun logs will be uploaded when the player boots.
- `uploadLogFilesAtSpecificTime` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether autorun logs should be uploaded at a specific time of the day.
- `uploadLogFilesTime` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: The time in minutes when the player should upload autorun logs to the server if the `uploadLogFilesAtSpecificTime` flag is set.
- `logHandlerUrl` <font color="#704ae0">URL </font><font color="#01a0af">read-write</font>: The optional address of a custom endpoint which handles the uploaded autorun logs
- `enableRemoteSnapshot` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>:  Whether a player should capture and upload screenshots to the server.&#x20;
- `remoteSnapshotInterval` <font color="#704ae0">int </font><font color="#01a0af">read-write</font>: The number of minutes to wait between capturing each snapshot.&#x20;
- `remoteSnapshotMaxImages` <font color="#704ae0">int </font><font color="#01a0af">read-write</font>: The maximum number of snapshot images to keep in the player storage. Possible values are 1 to 100.
- `remoteSnapshotJpegQualityLevel`<font color="#704ae0"> int </font><font color="#01a0af">read-write</font>: The JPEG quality level for the  snapshot images, on a scale from 1 to 100
- `remoteSnapshotScreenOrientation` <font color="#704ae0">string </font><font color="#01a0af">read-write</font>: The image orientation, which is one of "Landscape", "PortraitBottomRight", or "PortraitBottomLeft"
- `remoteSnapshotHandlerUrl` <font color="#704ae0">URL </font><font color="#01a0af">read-write</font>: The optional address of a custom endpoint which handles the uploaded snapshot images
- `idleScreenColor` <font color="#704ae0">object</font> <font color="#01a0af">optional</font>: An object with RGBA properties. The default color is black.
  - `r` <font color="#704ae0">byte</font> <font color="#01a0af">read-write</font>: The value of the red color channel in byte code&#x20;
  - `g` <font color="#704ae0">byte</font> <font color="#01a0af">read-write</font>: The value of the green color channel in byte code&#x20;
  - `b` <font color="#704ae0">byte</font> <font color="#01a0af">read-write</font>: The value of the blue color channel in byte code&#x20;
  - `a` <font color="#704ae0">byte</font> <font color="#01a0af">read-write</font>: The value of the alpha channel in byte code&#x20;
- `networkDiagnosticsEnabled` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should perform network diagnostics during setup and display the results on the screen.
- `testEthernetEnabled` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should perform Ethernet connection diagnostics during setup and display the results on the screen.
- `testWirelessEnabled` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should perform Wi-Fi connection during setup and display the results on the screen.
- `testInternetEnabled` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should check whether the BSN server is accessible during setup and display the results on the screen.
- `useCustomSplashScreen` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should display a custom splash screen during setup&#x20;
- `BrightWallName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The optional name of the BrightWall instance to which the player should be assigned
- `BrightWallScreenNumber` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The optional number of the BrightWall screen to which the player should be assigned
- `contentDownloadsRestricted` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: A flag which defines whether a player should download media content only within the specified time window&#x20;
- `contentDownloadRangeStart` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: A time of the day in minutes when the player may start the media content download
- `contentDownloadRangeEnd` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: A time of the day in minutes when the player should stop the media content download
- `heartbeatsRestricted` <font color="#704ae0">bool </font><font color="#01a0af">read-write</font>: Whether a player should report heartbeats to the BSN.Cloud server
- `heartbeatsRangeStart` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: A time of the day in minutes when the player may start the heartbeat reporting period
- `heartbeatsRangeEnd` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: A time of the day in minutes when the player should finish the heartbeat reporting period
- `usbUpdatePassword` <font color="#704ae0">string</font> <font color="#01a0af">optional</font>: The password for the USB update feature
- `inheritNetworkProperties` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether a player should keep the existing network settings during registration
- `internalCaArtifacts` <font color="#704ae0">internalCaArtifacts[]</font> <font color="#01a0af">optional</font>: A list of certificate objects. Each object has a name and an asset (the certificate file object). This can be an empty object.