HTML Widget Plugins

Widget API Version 1.0.1

HTML widget plugins extend iCUE widget functionality, and are registered using the required_plugins property in manifest.json.

Supported Plugins

Plugin	Module name	Plugin name	Version	Description
Sensors Data Provider	widgetbuilder.sensorsdataprovider	Sensors	1.0	Sensor data from connected devices
Media Data Provider	widgetbuilder.mediadataprovider	Media	1.0	Media playback control
Link Provider	widgetbuilder.linkprovider	Url	1.0	Open links in the system browser

Declaration

Plugins are declared in the manifest.json file in the "required_plugins" section.

Single plugin:

manifest.json

"required_plugins": [
    "widgetbuilder.sensorsdataprovider:Sensors:1.0"
]

Multiple plugins:

manifest.json

"required_plugins": [
    "widgetbuilder.sensorsdataprovider:Sensors:1.0",
    "widgetbuilder.mediadataprovider:Media:1.0"
]

Plugin Interface

Initialization Check

Boolean variable indicating plugin load status: plugin<<module_name>>_initialized

Examples:

• pluginSensorsdataprovider_initialized
• pluginMediadataprovider_initialized
• pluginLinkprovider_initialized

Initialization Callback

plugin<<module_name>>Events = {
    "onInitialized": <<callback_function>>
};

Sensors plugin example:

pluginSensorsdataproviderEvents = {
	onInitialized: onSensorsdataproviderInitialized,
};

Media plugin example:

pluginMediadataproviderEvents = {
	onInitialized: onMediadataproviderInitialized,
};

Link plugin example:

pluginLinkproviderEvents = {
	onInitialized: onLinkproviderInitialized,
};

Plugin Access

Access plugins via window.plugins.<<module_name>>:

• window.plugins.Sensorsdataprovider
• window.plugins.Mediadataprovider
• window.plugins.Linkprovider

Each plugin has its own interface documented in the plugin-specific documentation.