https://github.com/netbeast/base-plugin

Plugin structure for start integrating new products on Netbeast
https://github.com/netbeast/base-plugin

Last synced: over 1 year ago
JSON representation

Plugin structure for start integrating new products on Netbeast

• Host: GitHub
• URL: https://github.com/netbeast/base-plugin
• Owner: netbeast
• Created: 2016-05-17T09:58:02.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-05-18T14:26:35.000Z (about 10 years ago)
• Last Synced: 2025-01-22T13:46:27.984Z (over 1 year ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Example plugin

This file contains the skeleton of a common plugin for the Netbeast dashboard.

You can use it, in order to give support for a device through the dashboard.

We have already developed plugins to control devices like:

* Belkin WeMo

* Philips Hue

* Lifx

* Sonos

* Chromecast

* Parrot Flower Power

* ...

I encourage you to help us growing this list, by adding new devices plugins

## Good to know

#### Testing

The plugins are installed at the dashboard like applications so, you should

install it for testing. You can do it through:

 1. The user interface of the dashboard

 2. Command line, by copying your folder to dashboard/.sandbox/NAME_PLUGIN

#### Resources Database

All the physical devices available are include on the resources database.

You can check the discovered devices by searching the database on

`sqlite3 dashboard/.database.sqlite`

Once you are in, check the following table:

`select * from resources;`

#### Data structure

All the **topics** declared have a defined structured, that you can check on the [Docs](http://docs.netbeast.co/chapters/api_reference/methods.html).

If you are going to work on this topic, please follow this structures:

* switch & bridge

    * power:  `true || false`

* lights

    * power:    `true || false`

    * hue:           `0..360`

    * saturation:    `0..100`

    * brightness:    `0..100`

    * color: `{r: 0, g: 0, b: 0} || #FF13AA`

* music & video

    * volume:       `0..100`

    * status:       `play || pause || stop || mute || unmute || info`

    * track:        `must be the url of the song/video`

* temperature       `ºC`

* humidity          `0..100`

* luminosity        `photons per square meter`

* battery           `0..100`

If you need to define a new **topic**, you should think in a general structure that can be

used for all devices with the same topic.

Topics are: lights, sound, temperature, switch, camera, video, lock, etc...

Example. If we are working with music:

1. GET method will only accept volume, status and track as parameters

2. POST method will accept the same parameters.