Giter Club home page Giter Club logo

netatmo's Introduction

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.

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.

netatmo's People

Contributors

pablopi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

franrios

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤ī¸ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.