Plugins deployment

Deploying a plugin means making it accessible to end-users after the development phase. While the deployment process can differ across the different plugin types, there's a consistent step: uploading the plugin's source files to the Ubidots Developer console. At a high level, the process looks like this:

Developer console

To access the Developer console, open the Ubidots account where the plugin will be used. Then go to DevicesPlugins. There, you will see the following icon:

The following screenshot shows what the Developer console looks like:

From here, you can:

  • Create new plugins

  • Visualize and edit all previously created plugins

In this context, creating a plugin means setting up a repository where the plugin's source code can be uploaded and hosted.

Create a new plugin

Click the add new plugin button. A modal slides in from the right side of the screen and asks for the plugin's name and description. Fill in those fields, then click the check mark icon to continue.

When the modal collapses, you will see the plugin you just created:

Click it to display its options.

Plugin's general information tab

From here you can:

  • Set an icon for your plugin

  • Edit the plugin's name and description

  • Set the README for the plugin

Guidelines for setting a proper plugin icon

Image requirements

  • The icon must be in png format.

  • The icon must be a 512x512 pixels square image.

Using a format other than png causes an error when you try to upload the image.

Using a different image size, or an image without a square aspect ratio, might cause resizing. This can alter its appearance compared to the original image.

Using Ubidots style in the plugins icons

If you want to match the style of Ubidots native plugin icons, use the following setting:

  • Border radius: 86 px

Version tab

Click the Add new plugin version icon, as shown above. A dialog opens for you to upload the ZIP file that contains the plugin files mentioned in the Plugins development section:

After you upload the ZIP file, the plugin's version page looks like this:

From here you can:

  • View the plugin's version

  • View the plugin's price

  • View the plugin's status (Draft, Released, Published)

  • View the number of users using the plugin

  • Release the plugin (paper airplane icon)

Click the release button and accept the pop-up:

The plugin's status changes from Draft to Released.

For Cron and Webhook plugins, the deployment process ends here. For widget plugins, a few steps remain.

To learn how to use your new Cron or Webhook plugin, go to Cron and Webhook.

To continue deploying a widget plugin, go to Widget.

Last updated

Was this helpful?