firmware

The sos.management.firmware API groups together methods for working with the firmware of the device.

Methods

getType()

The getType() method returns the type of the firmware currently installed on the device.

This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.

getType(): Promise<string>;

Example

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

getVersion()

The getVersion() method returns the version of the firmware currently installed on the device.

getVersion(): Promise<string>;

Example

const version = await sos.management.firmware.getVersion();
console.log(version); // Returns String e.g. T-HKMLAKUC-2020.5

upgrade(baseUrl, version)

The upgrade(baseUrl, version) does the same as upgrade(version, baseUrl).

upgrade(baseUrl: string, version: string): Promise<void>;

Params

Name	Type	Required	Description
baseUrl	string	Yes	The server URL where firmware files are located.
version	string	Yes	The version of the firmware being installed.

Example

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

upgrade(fwUri)

The upgrade(fwUri) method initializes a firmware upgrade. Open users can upgrade fw passing FQN uri where the firmware main file is located.

This file type/extension differs for every platform. E.g.:

• SSSP: http://example.com/fw/T-0.0.0.msd
• Tizen: http://example.com/fw/T-0.0.0.bem
• Webos: http://example.com/fw/0.0.0.epk
• Brightsign: http://example.com/fw/hd2-0.0.0.bsfw
• Linux: http://example.com/fw/rpi-0.0.0.img.zip
• Android: http://example.com/fw/FB-00.0.0.zip

upgrade(fwUri: string): Promise<void>;

Params

Name	Type	Required	Description
fwUri	string	Yes	FQN uri where the firmware main file is located.

Example

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

upgrade(version, baseUrl)

The upgrade(version, baseUrl?) method initializes a firmware upgrade using version and baseUrl. Platform users can install general firmware version directly with passing just version number. Optionally, the baseUrl can be passed as argument to specify server where the firmware files are accessible.

upgrade(version: string, baseUrl?: string): Promise<void>;

Params

Name	Type	Required	Description
version	string	Yes	The version of the firmware being installed.
baseUrl	string	No	Optional server URL where firmware files are located. (Default value: "https://2.signageos.io")