📄️ Introduction
New in Plugin API 6.2.3 (available starting from Logi Options+ 1.97 and Loupedeck 6.2.4).
📄️ Using the SDK
The sample plugin will already have the following code added to the index.js file. Here we will describe the functionality of the SDK class, but it is not required to run the sample plugin.
📄️ Creating an Action
Actions are how Logitech devices interact with your plugin. There are two types of actions:
📄️ Working with Assets
Plugins may require external non-source files as part of their functionality. These can be text files, executables, databases, images, etc. The JS SDK provides the “assets.yml” file to allow users to specify files which are to be included as part of the plugin build process.
📄️ Working with External Packages
A JS plugin is not a typical Node application as it must be bundled and registered with Logi Plugin Service in order for it to run. If a plugin was created using the logitoolkit create command, the build NPM script will include external JS dependencies as part of a bundling process. However, some packages may include certain assets in order to function. These may be non-JS script files, binaries, json files, etc. that are used by the package during runtime. If these files are not included as part of the build process, then there will likely be issues using these packages at runtime.
📄️ Debugging
Console output from the plugin can be accessed by enabling developer mode in Logi Plugin Service.
📄️ API Documentation
The Node.js SDK provides comprehensive API documentation to help you understand and use all available classes, methods, and types in your plugin development.