@netzoio/plugins

Plugin repository for Netzo, a Web of Things platform to interconnect IoT devices, platforms and services over the web.


Keywords
netzo, wot, web-of-things, iot, internet-of-things, w3c, opensource, plugins
License
MIT
Install
npm install @netzoio/plugins@0.2.14

Documentation

Asterisc Plugin Repository (Work in Progress!)

Plugin repository for Asterisc, an open Web of Things platform to interconnect IoT devices, platforms and services over the web.

This repository lists all officially supported plugins listed on asterisc.io and used by the Asterisc Application Enablement Platform.

We review all plugins before they are published. This means that it may take some time before we can review your plugin.

To submit a plugin for review:

  1. Fork this repository
  2. Add your plugin to plugins.json
  3. Create a pull request

Plugin Schema

Property Type Description
uid String A unique ID. Needs to match the plugin UID in plugin.json
version String Plugin semantic version. Needs to match the version in plugin.json
type String Plugin type, e.g. thing-model, thing-importer, or app-template
name String A human-friendly display name for the plugin
description String A brief description of the plugin
keywords String[] URL to the plugin's GitHub project page
author String The name of the plugin's author or owner
license String A string indicating licensing information

Plugin Assets Schema

The assets array must conform to an array of image resource objects.

Property Type Description
logo Object Object with form { light, dark } indicating URLs to logos
images Link[] Array of Link Objects

Plugin Link Schema

Property Type Description
rel String Object with form { light, dark } indicating URLs to logos
name String The human-friendly display name
href String

Example plugin.json

Here's an example of a plugin:

{
  "uid": "wot-button",
  "version": "1.0.0",
  "type": "web-component",
  "name": "Button",
  "description": "Button web component for Asterisc",
  "assets": {
    "logo": {
      "light": "https://raw.githubusercontent.com/asteriscio/plugins/main/web-components/wot-button/src/assets/images/logo-light.png",
      "dark": "https://raw.githubusercontent.com/asteriscio/plugins/main/web-components/wot-button/src/assets/images/logo-dark.png"
    },
    "images": [
      {
        "name": "Demo",
        "path": "https://raw.githubusercontent.com/asteriscio/plugins/main/web-components/wot-button/src/assets/images/screenshot.png"
      },
      {
        "name": "Options",
        "path": "https://raw.githubusercontent.com/asteriscio/plugins/main/web-components/wot-button/src/assets/images/options.png"
      }
    ]
  },
  "links": [
    {
      "name": "Homepage",
      "rel": "homepage",
      "href": "https://github.com/asteriscio/plugins/tree/main/widgets/button"
    },
    {
      "name": "Repository",
      "rel": "repository",
      "href": "https://github.com/asteriscio/plugins"
    },
    {
      "name": "MIT License",
      "rel": "license",
      "href": "https://raw.githubusercontent.com/asteriscio/plugins/main/web-components/wot-button/LICENSE"
    }
  ],
  "keywords": ["asterisc", "plugin", "widget", "button"],
  "author": "asterisc",
  "license": "MIT"
}

Resources