Skip to main content
Version: 6.5.7

Javascript SDK for Applet development

Javascript SDK gives you access to device's native features and functionalities. You can use the same functions across all devices with the same result.

tip

All APIs are standardized and available across all supported devices.

Start here

Basic information about Applets

General information required to use the signageOS JS API

Content-related APIs help you with content part of your application /Applet/.

Universal APIs for File system, access to accelerated video playback, sensor management and more provide you with robust tool set for creating extensive experiences.

DomainDescription
Applet ResourcesPre-load necessary files required by your HTML5 player/Applet
BrowserOpening managed web-browser on Android devices inc. whitelisting, blacklisting and other features
CommandSending business or technical logs through signageOS in secured offline-ready way
DebugStart debug session
Device InfoDevice-related informations
DisplayQuery features supported by the display
File systemFull-featured file system API including ZIP and folder management
FontsMake it easy to load additional fonts into SoC devices
HardwareHardware-specific APIs like LED lights on Philips 10BDL
InputsController inputs like IR remote unified under one API
iFramesUsing JS SDK in iFrames
Proof of PlayProof of Play API
SensorsUsing sensors and IoT devices in your application
Serial PortControl external devices via serial
Synchronized playbackAPI for creating synced playback and videowalls
Video Inputs aka PiPShow HDMI/DP/VGA as a part of your content via PiP feature
Video PlaybackPlaying accelerated gapless videos via native video player
Video StreamsPlaying video streams (RTSP, HLS, UDP) via native video player

Device control JS APIs

Device control features exposed via Javascript APIs.

tip

For Device Management we strongly recommend using REST APIs. See the REST API documentation here.

DomainDescription
ApplicationGet application version and upgrade application from remote location
AudioControl system volume level
DebugEnable/disable debug mode
FirmwareGet FW version and upgrade FW from remote location
ManagementInformation about the device and power action like Reboot, Restart,..
MonitorsInformation about monitors
NetworkManage network settings
OSGet system information like CPU and Memory usage
PackageInstall and manage packages
PowerManage display power - timers, restart and reboot
ProxyManage display network proxy setup
IR Remote ControlManage IR Remote control functionality
ScreenManage brightness, orientation and resolution, display on/off
SecurityControl system security (PIN code)
TimeSet time, timezone and get current settings
Wi-FiManage Wi-Fi

Testing Framework SDK

Write and then run automated tests for your applet on physical devices, streamlining your development and QA efforts.

See full documentation on GitHub

Node.JS SDK

Library which allows you to fully manage signageOS applets, devices, management & monitoring using Node.JS and REST API.

See full documentation on GitHub

REST API

Large collection of REST API endpoints for device management and monitoring.

See full documentation on Postman