Management
To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.
All methods
| Method | Description | Supported since |
|---|---|---|
supports() | Enum of supported features | 2.0.0 |
getModel() | Information about device model | 2.0.0 |
getSerialNumber() | Information about device serial number | 2.1.0 |
getBatteryStatus() | Information about the battery level and battery charging status | 2.1.0 |
getNetworkInfo() | Information about network connections, IPs and DNS | 4.0.0 |
getTemperature() | Current device temperature | 3.0.0 |
resetSettings() | Clear all settings on device | 4.0.0 |
factoryReset() | Do a device factory reset | 4.0.0 |
getBrand() | Information about device brand | 5.7.0 |
Examples
GitHub Example
GitHub Example
- Getting basic management API data
- [Setting basic management API data](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-setters/">
supports()
Method supports() will show you what capabilities the deployed device currently has.
Javascript example
await sos.management.supports("NETWORK_INFO"); // Returns boolean
Capabilities
| Param |
|---|
| MODEL |
| SERIAL_NUMBER |
| BRAND |
| OS_VERSION |
| BATTERY_STATUS |
| STORAGE_UNITS |
| TEMPERATURE |
| SCREENSHOT_UPLOAD |
| NETWORK_INFO |
| WIFI |
| WIFI_SCAN |
| WIFI_AP |
| WIFI_STRENGTH |
| TIMERS_PROPRIETARY |
| BRIGHTNESS_SCHEDULING |
| TIMERS_NATIVE |
| SET_BRIGHTNESS |
| GET_BRIGHTNESS |
| SCREEN_RESIZE |
| SET_TIME |
| SET_TIMEZONE |
| GET_TIMEZONE |
| NTP_TIME |
| APP_UPGRADE |
| FIRMWARE_UPGRADE |
| PACKAGE_INSTALL |
| SET_VOLUME |
| GET_VOLUME |
| SET_REMOTE_CONTROL_ENABLED |
| SET_DEBUG |
| SYSTEM_REBOOT |
| APP_RESTART |
| DISPLAY_POWER |
| SERVLET |
| HARDWARE_LED_SET_COLOR |
| PROXIMITY_SENSOR |
| FACTORY_RESET |
| ORIENTATION_LANDSCAPE |
| ORIENTATION_PORTRAIT |
| ORIENTATION_LANDSCAPE_FLIPPED |
| ORIENTATION_PORTRAIT_FLIPPED |
| ORIENTATION_AUTO |
| SCHEDULE_POWER_ACTION |
| EXTENDED_MANAGEMENT |
| SYSTEM_CPU |
| SYSTEM_MEMORY |
| PROXY |
| AUTO_RECOVERY |
| PEER_RECOVERY |
| FILE_SYSTEM_WIPEOUT |
| REMOTE_DESKTOP |
getModel()
Method getModel() will display the model of your device.
await sos.management.getModel(); // Returns string ex. Philips-10BDL3051T
getSerialNumber()
Method getSerialNumber() will display device's serial number.
await sos.management.getSerialNumber(); // Returns string ex. AU1A1xxxxxx07502
getBatteryStatus()
Method getBatteryStatus() will display information about device's battery.
await sos.management.getBatteryStatus(); // Returns object
Example of response
{
"chargeType": "AC",
"isCharging": true,
"lastChargingTime": "2019-02-01T19:27:30.393Z",
"percentage": 100,
"updatedAt": "2019-02-01T19:27:31.247Z"
}
getTemperature()
Method getTemperature() will display information about the current temperature of the device.
await sos.management.getTemperature(); // Returns number values 0-100
getBrand()
Method getBrand() will display the manufacturer brand of your device.
await sos.management.getBrand(); // Returns string ex. Google, Samsung, signageOS for emulators