Device Setup Entity (v3)

the device setup entity contains the following required properties version string string required required this value should be "3 0 0" id string string required required the id of the device setup object this is only required for a “put” call (not “post”) bdeploy object object required required a b deploy entity (v3) docid\ t4fie7rscbtpg11t1 gkf setuptype string string required required the device setup type which is one of "legacylfn", "localtobsn", "lfn", "sfn", "partnerapplication", "standalone", or "bsn" bsndeviceregistrationtokenentity object object required required a token entity (v3) docid\ xftpkrowdwpe6dqhynwfe timezone string string required required the time zone (for example, "pst") see rosystemtime docid\ hwr0zojgtzxxnuhdlhlf9 for the available time zone options bsngroupname string string required required if the setup type is bsn, this is required the name of the bsn cloud group to which provisioned devices will be assigned this value defaults to the "default" group if the value is not provided network object object required required the network entity (v3) docid\ q84emt6m9ggaj8smutpq7 this will contain default values unless the user specifies parameters these optional properties can also be used firmwareupdatesbyfamily object object optional optional the firmwareupdatebyfamily entity (v3) docid\ neuqnmtq0qldmbx4jlpop if a firmware update is required with your setup, this field is required firmwareupdatetype string string optional optional the firmware update type which is one of "different", "newer", "save", and "standard" the default type is “standard” see firmwareupdatedifferenttargetfilename , firmwareupdatenewertargetfilename , firmwareupdatesavetargetfilename , and firmwareupdatestandardtargetfilename in firmwareupdatebyfamily entity (v3) docid\ neuqnmtq0qldmbx4jlpop for more information about these types and usage examples if a firmware update is required with your setup, this field is required enableserialdebugging bool bool optional optional false is the default if true, serial debugging is enabled enablesystemlogdebugging bool bool optional optional false is the default if true, system log debugging is enabled remotedwsenabled bool bool optional optional false is the default if true, the remote dws is enabled on the player and can be accessed remotely dwsenabled bool bool optional optional false is the default if true, the dws is enabled on local network of the player dwspassword string string optional optional the dws password (this can be an empty string) although this is not required, you should add this password for security purposes the default password is the player serial number lwsenabled bool bool optional optional false is the default if true, the lws is enabled lwsusername string string optional optional the user name of the lws server (this can be an empty string) lwspassword string string optional optional the password for the lws server (this can be an empty string) lwsenableupdatenotifications bool bool optional optional false is the default if true, update notifications are enabled on the lws bsncloudenabled bool bool optional optional the default, true, indicates that bsn cloud is enabled devicename string string optional optional the user defined device name for devices that are provisioned with the device setup package this can be an empty string devicedescription string string optional optional the user defined description give to devices that are provisioned with the device setup package this can be an empty string unitnamingmethod string string optional optional either "appendunitidtounitname" or "unitnameonly", which determines whether or not to append the serial number to the device name timebetweennetconnects int int optional optional how often the autorun checks for content (in seconds) the default is 300 seconds (5 minutes) timebetweenheartbeats int int optional optional how often the player reports health to bsn (in seconds) the default is 900 seconds (15 minutes) sfnwebfolderurl string string optional optional this is only required if the setup type is sfn the url address for the web accessible folder that contains the simple file networking presentation this can be an empty string sfnenablebasicauthentication bool bool optional optional if this is true, the password and username are required false is the default sfnusername string string the username for the sfn file server, which is only required if the sfn server is password protected this string can be empty sfnpassword string string the password for the sfn server this string can be empty playbackloggingenabled bool bool optional optional false is the default if true, playback logging is enabled eventloggingenabled bool bool optional optional false is the default if true, event logging is enabled diagnosticloggingenabled bool bool optional optional false is the default if true, diagnostic logging is enabled stateloggingenabled bool bool optional optional false is the default if true, state logging is enabled variableloggingenabled bool bool optional optional false is the default if true, variable logging is enabled uploadlogfilesatboot bool bool optional optional false is the default if true, log files will be uploaded at player startup uploadlogfilesatspecifictime bool bool optional optional false is the default if true, log files will be uploaded at a specific time uploadlogfilestime int int the time that log files will be uploaded, if any, in minutes this is required if uploadlogfilesatspecifictime is enabled loghandlerurl string string optional optional the custom log handler url to which the logs are uploaded this is only enabled for simple file networking (otherwise it will be an empty string) enableremotesnapshot bool bool optional optional false is the default if true, remote snapshot is enabled the following parameters are required if you enable this boolean remotesnapshotinterval int int the number of minutes to wait between capturing each snapshot zero is the default, but this value should be set if enableremotesnapshot is true remotesnapshotmaximages int int the maximum number of snapshot images to save possible values are 1 to 100 remotesnapshotjpegqualitylevel int int the jpeg quality level for the remote snapshot, on a scale from 1 to 100 remotesnapshotscreenorientation string string the screen orientation ("landscape", "portraitbottomright", or "portraitbottomleft") remotesnapshothandlerurl string string the url for the remote snapshot handler idlescreencolor object object optional optional an object with rgba properties the default color is black networkdiagnosticsenabled bool bool optional optional false is the default if true, network diagnostics are enabled this must be enabled in order to enable testethernetenabled , testwirelessenabled , or testinternetenabled testethernetenabled bool bool false is the default if true, ethernet testing during setup is enabled testwirelessenabled bool bool false is the default if true, wireless testing during setup is enabled testinternetenabled bool bool false is the default if true, internet testing during setup is enabled usecustomsplashscreen bool bool optional optional false is the default if true, a custom splash screen will be used brightwallname string string optional optional the name of the brightwall settings brightwallscreennumber string string optional optional the brightwall display number contentdownloadsrestricted bool bool optional optional false is the default if true, content downloads are restricted for sfn and bsn if the value is true, the following fields are required contentdownloadrangestart int int the start time when content can be downloaded, from 00 00 to 23 59 (in minutes) contentdownloadrangeend int int the end time when content can be downloaded, from 00 00 to 23 59 (in minutes) usbupdatepassword string string optional optional the password for the usb update feature inheritnetworkproperties bool bool optional optional false is the default (it will use the network properties from the device setup file) if true, the setup will use the current network configuration settings of the player internalcaartifacts internalcaartifacts\[] internalcaartifacts\[] optional optional a list of certificate objects each object has a name and an asset (the certificate file object) this can be an empty object example the firmwareupdatebyfamily entity (v3) docid\ neuqnmtq0qldmbx4jlpop entity is not included this example since it is only required for firmware updates { "version" "3 0 0", " id" "", "bdeploy" { "username" "anon\@brightsign biz", "networkname" "admin", "packagename" "test2023" }, "firmwareupdatetype" "standard", "setuptype" "standalone", "bsndeviceregistrationtokenentity" { "token" "{{token}}", "scope" "cert", "validfrom" "2023 01 26t23 21 48 000z", "validto" "2025 01 25t23 21 48 000z" }, "enableserialdebugging"\ false, "enablesystemlogdebugging"\ false, "remotedwsenabled"\ true, "dwsenabled"\ false, "dwspassword" "", "lwsenabled"\ true, "lwsusername" "", "lwspassword" "", "lwsenableupdatenotifications"\ true, "bsncloudenabled"\ true, "devicename" "", "devicedescription" "", "unitnamingmethod" "appendunitidtounitname", "timezone" "pst", "bsngroupname" "default", "timebetweennetconnects" 300, "timebetweenheartbeats" 900, "sfnwebfolderurl" "", "sfnusername" "", "sfnpassword" "", "sfnenablebasicauthentication"\ false, "playbackloggingenabled"\ false, "eventloggingenabled"\ false, "diagnosticloggingenabled"\ false, "stateloggingenabled"\ false, "variableloggingenabled"\ false, "uploadlogfilesatboot"\ false, "uploadlogfilesatspecifictime"\ false, "uploadlogfilestime" 0, "loghandlerurl" "", "enableremotesnapshot"\ false, "remotesnapshotinterval" 15, "remotesnapshotmaximages" 5, "remotesnapshotjpegqualitylevel" 50, "remotesnapshotscreenorientation" "landscape", "remotesnapshothandlerurl" "", "idlescreencolor" { "r" 0, "g" 0, "b" 0, "a" 1 }, "networkdiagnosticsenabled"\ false, "testethernetenabled"\ false, "testwirelessenabled"\ false, "testinternetenabled"\ false, "usecustomsplashscreen"\ false, "brightwallname" "", "brightwallscreennumber" "", "contentdownloadsrestricted"\ false, "contentdownloadrangestart" 0, "contentdownloadrangeend" 0, "heartbeatsrestricted"\ false, "heartbeatsrangestart" 0, "heartbeatsrangeend" 0, "usbupdatepassword" "", "inheritnetworkproperties"\ false, "internalcaartifacts" \[ ], "network" { "timeservers" \[ "http //time brightsignnetwork com" ], "hostname"\ null, "dns"\ null, "proxyserver"\ null, "proxybypass"\ null, "interfaces" \[ { "id" "wired eth0", "name" "eth0", "type" "ethernet", "proto" "dhcpv4", "ip" \[ ], "gateway"\ null, "dns" \[ ], "ratelimitduringinitialdownloads" 0, "ratelimitinsidecontentdownloadwindow" 0, "ratelimitoutsidecontentdownloadwindow"\ null, "contentdownloadenabled"\ true, "textfeedsdownloadenabled"\ true, "mediafeedsdownloadenabled"\ true, "healthreportingenabled"\ true, "logsuploadenabled"\ true, "wpasettings" { "enablewpaenterpriseauthentication"\ false, "wpaenterprisevariant" "wpaenterpriseeaptls", "eapcertificatetype" "wpaeaptlspkcs", "eapcertificatefile"\ null, "eapcertificatepassphrase" "", "eappemorderkeyfile"\ null, "peapusername" "", "peappassphrase" "", "cacertificatefile"\ null } }, { "id" "wireless wlan0", "name" "wlan0", "type" "wifi", "proto" "dhcpv4", "ip" \[ ], "gateway"\ null, "dns" \[ ], "ratelimitduringinitialdownloads"\ null, "ratelimitinsidecontentdownloadwindow"\ null, "ratelimitoutsidecontentdownloadwindow"\ null, "contentdownloadenabled"\ true, "textfeedsdownloadenabled"\ true, "mediafeedsdownloadenabled"\ true, "healthreportingenabled"\ true, "logsuploadenabled"\ true, "ssid" "dadmom", "passphrase" "", "security" { "authentication" { "mode" "shared", "passphrase" "{{passphrase}}" }, "encryption" { "mode" "tkip, ccmp" } }, "wpasettings" { "enablewpaenterpriseauthentication"\ false, "wpaenterprisevariant" "wpaenterpriseeaptls", "eapcertificatetype" "wpaeaptlspkcs", "eapcertificatefile"\ null, "eapcertificatepassphrase" "", "eappemorderkeyfile"\ null, "peapusername" "", "peappassphrase" "", "cacertificatefile"\ null } } ] } }