This entity contains an array of the following properties by device family (Cobra, Raptor, Impala, Pantera, Tiger, Pagani, Malibu, and Sebring). These fields are only required if you need to do a firmware update.
firmwareUpdateSource
string required: The enum source from which to get the firmware update. Possible values are “Production”, “Beta”, “MinimumCompatible”, “SpecificUrl”, “None”, or “Existing”. If you use “Production”, “Beta”, or “MinimumCompatible”, no additional values need to be defined.
firmwareUpdateSourceUrl
string: Required if the source is “SpecificUrl”. This can be a source URL for the firmware update, or an empty string.
firmwareUpdateStandardTargetFileName
string required: The name of the .bsfw firmware file that is targeted for updates. The update contained in the file is applied and if successful the file is deleted from the storage medium containing it. If the delete succeeds then the system reboots. If it fails then the device behaves as if the file had been named *_save.bsfw
- see below. The delete always fails if the card uses an NTFS or HFS+ filesystem.
firmwareUpdateDifferentTargetFileName
string required: The name of a.bsfw firmware file. In run mode the update contained in this file is applied only if the version it contains does not match the version that is currently running. The file is not deleted but the infinite loop is avoided because on subsequent boots the version number will be the same so the update file will be ignored. In rescue mode the update is always applied.
firmwareUpdateNewerTargetFileName
string required: The name of a .bsfw firmware file. In run mode the update contained in the file is applied only if the version it contains is strictly newer than the version that is currently running. The file is not deleted but the infinite loop is avoided because on subsequent boots the version number will be the same so the update file will be ignored. In rescue mode the update is always applied because the version of run mode cannot be checked and the infinite loop won't occur because the device will reboot into run mode.
firmwareUpdateSaveTargetFileName
string required: The name of a .bsfw firmware file. The update contained in the file is applied but the file is not deleted. Because if the device rebooted at this point it would just apply the update again the device and will not automatically reboot when applying updates named like this until the storage device containing the update has been removed. This makes this filename useful if you wish to update many units from a USB key.
firmwareUpdateVersion
string required: This can be an empty string or the version number of the firmware you want to update to
productionReleaseURL
string required: The URL to the .bsfw file that the device will pull the setup files from for use in production
betaReleaseURL
string required: The URL to the .bsfw file for the beta release version in production
compatibleReleaseURL
string required: The URL to the .bsfw file for the minimum compatible release version in production
productionVersion
string required: The current firmware production version number. See roDeviceInfo#GetVersionNumber()AsInteger for more information on how this number is generated.
betaVersion
string required: The current firmware beta version number. See roDeviceInfo#GetVersionNumber()AsInteger for more information on how this number is generated.
compatibleVersion
string required: The minimum compatible firmware version number. See roDeviceInfo#GetVersionNumber()AsInteger for more information on how this number is generated.
productionVersionNumber
int required: The firmware production version id
betaVersionNumber
int required: The firmware beta version id
compatibleVersionNumber
int required: The firmware minimum compatible version id
productionReleaseSHA1
string required: The manifest file SHA/hash value of the production release
betaReleaseSHA1
string required: The manifest file SHA/hash value of the beta release
compatibleReleaseSHA1
string required: The manifest file SHA/hash value of the compatible release
productionReleaseFileLength
int required: The file length of the production release in bytes
betaReleaseFileLength
int required: The file length of the beta release in bytes
compatibleReleaseFileLength
int required: The file length of the compatible release in bytes
existingFWContentID
string required: The firmware content id or an empty string
Example
{ "version":"3.0.0", "_id":"", "bDeploy":{ "username":"anon@brightsign.biz", "networkName":"admin", "client":"bacon", "packageName":"testjan2023" }, "firmwareUpdatesByFamily":{ "Impala":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"impala-update.bsfw", "firmwareUpdateDifferentTargetFileName":"impala-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"impala-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"impala-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/impala-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/impala-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/impala-8.0.119-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.0.119", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524407, "productionReleaseSHA1":"2880a46fe283ebceff9fcc29e3a3080518fcdc89", "betaReleaseSHA1":"2880a46fe283ebceff9fcc29e3a3080518fcdc89", "compatibleReleaseSHA1":"65bdcc34479b2eec47a656aec260a849cce37ea0", "productionReleaseFileLength":148724028, "betaReleaseFileLength":148724028, "compatibleReleaseFileLength":134766338, "existingFWContentID":"" }, "Pantera":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"pantera-update.bsfw", "firmwareUpdateDifferentTargetFileName":"pantera-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"pantera-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"pantera-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pantera-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pantera-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pantera-8.0.119-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.0.119", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524407, "productionReleaseSHA1":"d0504fb7e6a023a9ce742ce40f13066ef79b462a", "betaReleaseSHA1":"d0504fb7e6a023a9ce742ce40f13066ef79b462a", "compatibleReleaseSHA1":"56b95119bd99440decbcf2cfda6ef68a775c9ebd", "productionReleaseFileLength":148263106, "betaReleaseFileLength":148263106, "compatibleReleaseFileLength":134457680, "existingFWContentID":"" }, "Tiger":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"tiger-update.bsfw", "firmwareUpdateDifferentTargetFileName":"tiger-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"tiger-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"tiger-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/tiger-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/tiger-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/tiger-8.0.119-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.0.119", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524407, "productionReleaseSHA1":"0f0485cd24b32529692378dc2e9c73cd33e9841c", "betaReleaseSHA1":"0f0485cd24b32529692378dc2e9c73cd33e9841c", "compatibleReleaseSHA1":"c5c448183ed51acc6cf5681239bcc094c5273a9f", "productionReleaseFileLength":160765442, "betaReleaseFileLength":160765442, "compatibleReleaseFileLength":144375550, "existingFWContentID":"" }, "Pagani":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"pagani-update.bsfw", "firmwareUpdateDifferentTargetFileName":"pagani-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"pagani-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"pagani-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pagani-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pagani-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/pagani-8.0.119-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.0.119", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524407, "productionReleaseSHA1":"711caa8b86adb045767b340731c4c01d9aa229ac", "betaReleaseSHA1":"711caa8b86adb045767b340731c4c01d9aa229ac", "compatibleReleaseSHA1":"4408683416b1265a0c69708b807ac3a5a303ec71", "productionReleaseFileLength":194572248, "betaReleaseFileLength":194572248, "compatibleReleaseFileLength":164257912, "existingFWContentID":"" }, "Malibu":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"malibu-update.bsfw", "firmwareUpdateDifferentTargetFileName":"malibu-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"malibu-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"malibu-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/malibu-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/malibu-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/malibu-8.0.119-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.0.119", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524407, "productionReleaseSHA1":"ecda439f6e39be950b3e6070b1ad254c0e10ef18", "betaReleaseSHA1":"ecda439f6e39be950b3e6070b1ad254c0e10ef18", "compatibleReleaseSHA1":"a2fa8e63e86f78db2829e3b12803e5fdfb62b9f2", "productionReleaseFileLength":195873138, "betaReleaseFileLength":195873138, "compatibleReleaseFileLength":174740222, "existingFWContentID":"" }, "Sebring":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"sebring-update.bsfw", "firmwareUpdateDifferentTargetFileName":"sebring-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"sebring-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"sebring-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/sebring-8.5.33-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/sebring-8.5.33-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/sebring-8.2.17.3-update.bsfw", "productionVersion":"8.5.33", "betaVersion":"8.5.33", "compatibleVersion":"8.2.17.3", "productionVersionNumber":525601, "betaVersionNumber":525601, "compatibleVersionNumber":524817, "productionReleaseSHA1":"4baaaa6cc304c679617561cad89f656c821988c5", "betaReleaseSHA1":"4baaaa6cc304c679617561cad89f656c821988c5", "compatibleReleaseSHA1":"399b5dd4203a8283f8e357a41e0168c33eb2418a", "productionReleaseFileLength":85372336, "betaReleaseFileLength":85372336, "compatibleReleaseFileLength":74604516, "existingFWContentID":"" }, "Raptor":{ "firmwareUpdateSource":null, "firmwareUpdateSourceFilePath":"", "firmwareUpdateSourceUrl":"", "firmwareUpdateStandardTargetFileName":"raptor-update.bsfw", "firmwareUpdateDifferentTargetFileName":"raptor-update_different.bsfw", "firmwareUpdateNewerTargetFileName":"raptor-update_newer.bsfw", "firmwareUpdateSaveTargetFileName":"raptor-update_save.bsfw", "firmwareUpdateVersion":"", "productionReleaseURL":"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.22.3-update.bsfw", "betaReleaseURL":"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.22.3-update.bsfw", "compatibleReleaseURL":"https://bsncloud.s3.amazonaws.com/public/raptor-9.0.22.3-update.bsfw", "productionVersion":"9.0.22.3", "betaVersion":"9.0.22.3", "compatibleVersion":"9.0.22.3", "productionVersionNumber":589846, "betaVersionNumber":589846, "compatibleVersionNumber":589846, "productionReleaseSHA1":"245ef90811a7bcd2e1ca862b451c4d8abfaa5526", "betaReleaseSHA1":"245ef90811a7bcd2e1ca862b451c4d8abfaa5526", "compatibleReleaseSHA1":"245ef90811a7bcd2e1ca862b451c4d8abfaa5526", "productionReleaseFileLength":343723720, "betaReleaseFileLength":343723720, "compatibleReleaseFileLength":343723720, "existingFWContentID":"" } }, "firmwareUpdateType":"standard", "setupType":"standalone", "bsnDeviceRegistrationTokenEntity":{ "token":"8CVgJ2COmDev5F6y8OYtFyPldJYonXBdnKwZzQDXkT1mw4Nkm4kZbbfEaNAAr4WojXO85MyP4QiB4Bn1yhMh9y2tF4GnCUWunoR2S06iIHcm8gPTGIXj4yB1cm", "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":"", "dwsPasswordPreviousSavedTimeStamp":1674773831541, "lwsEnabled":true, "lwsConfig":"status", "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":"dadcadsc", "passphrase":"", "security":{ "authentication":{ "mode":"Shared", "passphrase":"RKrQcBNw3+Bmqh3yu66+JJMWKr4TImIeboAVeItDbqT/qHzYGOpoEVH/oEDv8gFcJpCCQkDrqzLfbqdPAtqSmIs43X1iAjsO6mgCuGfC5BwYmYVx2qMkwbpvovbFBPR+UIRGryoUHLWDl8Ki0Dc92Ld/L1I24LB5OmX1woTTzozvThI7IGWLrqX+uAXcFVu/H45GquJPd/DTRQm7ZvRAwI0AKAvjuwJQv6pnuMUwFMAt5EUsWIX8Ubd3uGrxqLNwQD/9HvlMBnwXgAIiMt3SLw7XBMhSFfxmPO1BzDzFrpPUB/ddl//kpYZpIRx0iCDCLMWTjP02QjzSZhX7x7oiVgQMI57g6E1Bx/Dbe3J9NBpT1TF0/B99Z/hGME+xcSlTC7abKpxibaMiNTJsHaqDf84+PYtVlzONUfn6MsMFGiVm23U0ruEgE4oYC6oJfp7oDqH3fXI6KXBl2SFfYnj1klG++3mQ+yHvP4uFYFgzqkIs8l3zRinafAguD5uCI1+LKBuxmRM5Mxna5sIfexIsuGoS/uYgjzXW/56GCA7FamFFrMjNHxqg+hSRi59KFb/VXlIvCuVY1djIJnk2Zu0/rGQCujl0QUe1v9lWhHfRkvkAuAZrxMSE5sj6S4MA7hEKN7a6G97VXSn9TAt0XYJ9yBg03WFz+Wmpl4m5S3cBGZBk=" }, "encryption":{ "mode":"TKIP, CCMP" } }, "wpaSettings":{ "enableWPAEnterpriseAuthentication":false, "wpaEnterpriseVariant":"WPAEnterpriseEapTls", "eapCertificateType":"WPAEapTlsPKCS", "eapCertificateFile":null, "eapCertificatePassphrase":"", "eapPemOrDerKeyFile":null, "peapUsername":"", "peapPassphrase":"", "caCertificateFile":null } } ] } }