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.
All APIs are standardized and available across all supported devices.
Basic information about Applets
General information required to use the signageOS JS API
Content-related JS APIs
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.
| Domain | Description |
|---|---|
| Applet Resources | Pre-load necessary files required by your HTML5 player/Applet |
| Browser | Opening managed web-browser on Android devices inc. whitelisting, blacklisting and other features |
| Command | Sending business or technical logs through signageOS in secured offline-ready way |
| Debug | Start debug session |
| Device Info | Device-related informations |
| Display | Query features supported by the display |
| File system | Full-featured file system API including ZIP and folder management |
| Fonts | Make it easy to load additional fonts into SoC devices |
| Hardware | Hardware-specific APIs like LED lights on Philips 10BDL |
| Inputs | Controller inputs like IR remote unified under one API |
| iFrames | Using JS SDK in iFrames |
| Proof of Play | Proof of Play API |
| Sensors | Using sensors and IoT devices in your application |
| Serial Port | Control external devices via serial |
| Synchronized playback | API for creating synced playback and videowalls |
| Video Inputs aka PiP | Show HDMI/DP/VGA as a part of your content via PiP feature |
| Video Playback | Playing accelerated gapless videos via native video player |
| Video Streams | Playing video streams (RTSP, HLS, UDP) via native video player |
Device control JS APIs
Device control features exposed via Javascript APIs.
For Device Management we strongly recommend using REST APIs. See the REST API documentation here.
| Domain | Description |
|---|---|
| Application | Get application version and upgrade application from remote location |
| Audio | Control system volume level |
| Debug | Enable/disable debug mode |
| Firmware | Get FW version and upgrade FW from remote location |
| Management | Information about the device and power action like Reboot, Restart,.. |
| Monitors | Information about monitors |
| Network | Manage network settings |
| OS | Get system information like CPU and Memory usage |
| Package | Install and manage packages |
| Power | Manage display power - timers, restart and reboot |
| Proxy | Manage display network proxy setup |
| IR Remote Control | Manage IR Remote control functionality |
| Screen | Manage brightness, orientation and resolution, display on/off |
| Security | Control system security (PIN code) |
| Time | Set time, timezone and get current settings |
| Wi-Fi | Manage 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