Firmware

Firmware management API allows you to remotely upgrade firmware version and check version on your current device.

All methods

Method	Description	Supported since
upgrade()	Allows you to upgrade device FW	3.0
getVersion()	Get current FW version	3.0
getType()	Get current FW type	5.0

upgrade()

Method upgrade() will upgrade current firmware version to a specified one.

Param	Type	Required	Description
baseUrl	string	Yes	Location of the FW package for specific device
^^	^^	^^	https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem
version	string	No	FW version
^^	^^	^^	T-HKMLAKUC-2080.4
(progress: number)	callback	No	FW progress upgrade

Javascript example

await sos.management.firmware.upgrade(
	'https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem',
	'T-HKMLAKUC-2080.4',
	(progress: number) => {
	    console.log(progress + "%");
    }
);

await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');

warning

Always check if your absolute firmware URL ends with firmware file. Example: https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw

info

For BrightSign firmware upgrade please ensure that you have txt file with SHA1 hash of that firmware file.

• Firmware file path: https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw
• SHA1 txt file: https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt

GitHub Example

How to upgrade firmware

getVersion()

Method getVersion() will specify what current version of firmware is installed on a device.

Javascript example

sos.management.firmware.getVersion().then((version) => { 
    console.log(version); // Returns String e.g. T-HKMLAKUC-2020.5
});

getType()

Returns a string identifier that, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.

Type	Description
rpi	any Raspberry Pi 3 or Compute Module 3
rpi4	any Raspberry Pi 4 or Compute Module 4
benq-	any Benq display
philips-	any Philips display
sharp-	any Sharp display
elo-	any Elo display

Javascript example

const type = await sos.management.firmware.getType(); 
console.log(type); // e.g. rpi4