internet-of-things/chapters/api_reference/buildingan_app_md.md

Netbeast Internet Of Things Open Source documentation packaged to run offline

# About this doc

The main goal of this documentation is to explain how the Netbeast API works. All the information that you need to start programming has been gathered here.

This API is quite new so it is continuously changing and growing. As it matures, some parts are more reliable tan others. Some methods are very new and could be redesigned in the future. Others are so tested and stable. You will see a stability index through all the documentation. We have defined the stability index as follow:

*   2 - reliable
*   1 - experimental
*   0 - deprecated

## Supported devices

With this API you can control this devices

-   [x] Philips Hue 
-   [x] Belkin WeMo
    -   [x] Switch
    -   [x] Insight
    -   [x] Bulbs
-   [x] Lifx
-   [x] Sonos
-   [ ] Parrot Flower Power
-   [ ] Chromecast
-   ...

## How to use it?

First of all, you need to install the npm package in your netbeast app
````
npm install netbeast
````
 Once the package is in the node_modules folder, you can require it from the code. You are able to require all the methods or only some specific areas.

```javascript
//  Option 1 - the whole netbeast API wrapper
var nb = require('netbeast')

nb.resources('lights').get()

//  Option 2 – directly only of those functions needed
var resources = require('netbeast').resources
var scene = require('netbeast').scene
var devices = require('netbeast').devices

resources('lights').get()
```