Skip to main content

Plugins

With signageOS, you can use Plugins to extend the functionality of Core Apps with your own persistent logic. A Plugin behaves just like a native signageOS feature (e.g., volume, brightness) and is fully integrated into the Policy engine and device telemetry system. This allows you to add custom, versioned features that are managed at scale.

info

 How to create your Plugins?

Head to the getting started guide.

Assigning and managing plugins

Once your Plugins are uploaded to your organization, you can assign and manage them in several ways:

  1. Device detail: Navigate to Box and open any device detail. In the "Plugins" tab, you can assign a Plugin, select its version, and provide a specific configuration.
  2. Policies: For large-scale management, you can add a Plugin directly to a Policy. The devices will then automatically receive and apply the Plugin's configuration.
  3. Bulk actions: You can assign, configure, or unassign Plugins across thousands of devices at once using bulk actions.

How Plugins work

Unlike a one-off Custom script, a Plugin is persistent. Once assigned, it runs periodically based on the device's telemetry and policy update cycle. Its state and configuration are managed just like any other device setting, making it a seamless extension of the core device functionality.

Telemetry and results

A Plugin can report custom data back to signageOS, which can be viewed as telemetry. You can see the latest reported values directly in the device detail view in Box under the specific Plugin's section.

You can also retrieve all reported data via the signageOS REST API. You can find the Plugins REST API documentation under the following link.

Alerting on Plugin telemetry

Beyond simply viewing telemetry data, you can use it to build powerful, automated alerts. This allows you to move from reactive to proactive management, letting the system notify you automatically when a device reports an unexpected or non-compliant state.

Plugin list

The Plugins page in Box displays all Plugins available in your organization. You can navigate to it from the main sidebar.

Use the search bar at the top of the page to find Plugins by name. The search is applied instantly as you type.

Filtering

Click the Filter button to open the filter drawer. You can narrow down the list by:

FilterDescription
PlatformSelect one or more platforms (Tizen, webOS, Android, Linux, etc.) to show only Plugins that target those platforms.
TagsSelect one or more tags to show only Plugins that have been tagged with them. Tags are organized in a tree structure matching your organization's tag hierarchy.

Active filters are shown as removable labels above the list. Click the x on any label to remove that filter, or use the Reset button inside the filter drawer to clear all filters at once.

Sorting and pagination

The Plugin list supports sorting and configurable page sizes. Filters, search terms, and sort settings are persisted in the URL, so you can bookmark or share a filtered view.