Sample Plugin <- put the name of your plugin here

Version 1.x.y

Describe the purpose of the plugin right here. (What is the plugin good for?)

Change history

If you want, you can add a change history here:

Changes Since version 1.x.x

  • Fixed this

Changes Since version 1.x.w

  • Added that feature

Requirements

List the requirements of your plugin. Does it need special software or hardware?

Needed software

  • list

  • the

  • needed

  • software

Including Python modules and SmartHomeNG modules

Supported Hardware

  • list

  • the

  • supported

  • hardware

Configuration

plugin.yaml

Please refer to the documentation generated from plugin.yaml metadata.

items.yaml

Please refer to the documentation generated from plugin.yaml metadata.

logic.yaml

Please refer to the documentation generated from plugin.yaml metadata.

Methods

Please refer to the documentation generated from plugin.yaml metadata.

Examples

If you have extensive examples, you could describe them here.

Web Interfaces

For building a web interface for a plugin, we deliver the following 3rd party components with the HTTP module:

  • JQuery 3.4.1:

    • JS: <script src=“/gstatic/js/jquery-3.4.1.min.js“></script>

  • Bootstrap :

    • CSS: <link rel=“stylesheet“ href=“/gstatic/bootstrap/css/bootstrap.min.css“ type=“text/css“/>

    • JS: <script src=“/gstatic/bootstrap/js/bootstrap.min.js“></script>

  • Bootstrap Tree View:

    • CSS: <link rel=“stylesheet“ href=“/gstatic/bootstrap-treeview/bootstrap-treeview.css“ type=“text/css“/>

    • JS: <script src=“/gstatic/bootstrap-treeview/bootstrap-treeview.min.js“></script>

  • Bootstrap Datepicker v1.8.0:

    • CSS: <link rel=“stylesheet“ href=“/gstatic/bootstrap-datepicker/dist/css/bootstrap-datepicker.min.css“ type=“text/css“/>

    • JS:

      • <script src=“/gstatic/bootstrap-datepicker/dist/js/bootstrap-datepicker.min.js“></script>

      • <script src=“/gstatic/bootstrap-datepicker/dist/locales/bootstrap-datepicker.de.min.js“></script>

  • popper.js:

    • JS: <script src=“/gstatic/popper.js/popper.min.js“></script>

  • CodeMirror 5.46.0:

    • CSS: <link rel=“stylesheet“ href=“/gstatic/codemirror/lib/codemirror.css“/>

    • JS: <script src=“/gstatic/codemirror/lib/codemirror.js“></script>

  • Font Awesome 5.8.1:

    • CSS: <link rel=“stylesheet“ href=“/gstatic/fontawesome/css/all.css“ type=“text/css“/>

For addons, etc. that are delivered with the components, see /modules/http/webif/gstatic folder!

If you are interested in new „global“ components, contact us. Otherwise feel free to use them in your plugin, as long as the Open Source license is ok.