Resources

Netbeast API has methods for manage the smart devices stored on the Resources DB. With Netbeast we can:

  • Obtain the current state of devices.
    netbeast('lights').get()
  • Change the current state of devices.
    netbeast('switch').set({power: true})
  • Select a device through its group or location.
    netbeast('music').at('kitchen').get('track')
netbeast('music').groupBy('color-white').get('track')
  • Declare a object or resource on DB.
    netbeast('camera').create({ app: netatmo, hook: '/103.23.65.84'})
  • Delete it from DB.
    netbeast('lights').delete()

Index:

Manage DB

netbeast(topic).create(args)

Create method is used to register a resource on the database. Useful for creating plugins. Argument should be a JSON object which contain the name of the app, and the hook to talk to the device.

var args = {app: 'flower-power', hook: '/temperature/10.162.63.114'}
netbeast('temperature').create(args)
.then(function (data) {})
.catch(function (error) {})

The topic is always required on this method. You can pass the topic in the arguments also.

netbeast(topic).create(args)

This method is used tu update the DB after a discover. Similar to create. Argument should be a JSON object which contain the name of the app, and all hooks of the devices found. This method will register on DB the new resources and delete the ones that are no longer available.

var args = {app: 'flower-power', hook: ['/temperature/10.162.63.114', '/temperature/10.162.63.100', '/luminosity/10.162.63.114']}
netbeast('temperature').updateDB(args)
.then(function (data) {})
.catch(function (error) {})

The topic is always required on this method.

netbeast(id).changeAlias(alias)

This method allows us provide or change the alias of a certain resource. You will need to know the resource id stored on DB.

netbeast('0cc1fdb1bcc40c86eba95b1f6a1724ab634691').changeAlias('bed-light')
.then(function (data) {})
.catch(function (error) {})

netbeast(id).changeLocation(location)

This method allows us provide or change the location of a certain resource. You will need to know the resource id stored on DB.

netbeast('0cc1fdb1bcc40c86eba95b1f6a1724ab634691').changeLocation('bed-light')
.then(function (data) {})
.catch(function (error) {})

netbeast(topic).groupDevices(name, ids)

This functión allows us to make group of devices. The argument name defines de group name. Ids will be an array of ids of the devices that should be grouped.

var ids = [1,3, 7 }

netbeast().groupDevices('roof', ids)
.then(function (data) {})
.catch(function (error) {})

netbeast(topic).delete(args)

The delete method allow us to remove resources from the database. You can use an argument (args: json object) for this method that select an specific property of devices.

// Remove all the lights
netbeast('lights').delete()
.then(function (data) {})
.catch(function (error) {})

// Remove all the belkin-wemo lights group by 'colorful'
var args = { app: 'belkin-wemo'}

netbeast('lights').groupBy('colorful').delete(args)
.then(function (data) {})
.catch(function (error) {})

netbeast(topic).deleteById(id)

The deleteById method allows us to remove resources from the database. With the id argument we select a specific device from the db.

netbeast().deleteById(1)
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

netbeast(topic).deleteByAlias(alias)

The deleteByAlias method allows us to remove resources from the database. With the alias argument we select a specific device from the db.

netbeast().deleteByAlias('bed-light')
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

Read information from the resources

netbeast(topic).get(value)

The get method allows us to obtain information about the current state of the devices. You can obtain all the data about the state or specify a concrete value.

// Returns the state of all lights
netbeast('lights').get()
.then(function (data) {})
.catch(function (error) {})

You can ask for a specific parameter. Find all the parameters available here!

// Returns the brightness of all the lights
netbeast('lights').get('brightness')
.then(function (data) {})
.catch(function (error) {})

You can only ask for all values you want on the same request by including the parameters in an array.

 // Returns the brightness of all the lights
 netbeast('lights').get(['brightness', 'color'])
 .then(function (data) {})
 .catch(function (error) {})

netbeast(topic).getById(id)

The getById method allows us to get information about the current state of the devices. You will receive all the information of the specified device.

netbeast().getById(1)
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

netbeast(topic).getByAlias(alias)

The getByAlias method allows us to get information about the current state of the devices. You will receive all the information of the specified device.

netbeast().getByAlias('bed-light')
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

Change resources status

netbeast(topic).set(args)

The set method allows us to change the current state of the devices. You can modify different values at the same time.

// Change the color of all lights
netbeast('lights').set({color: '#52ff3c'})
.then(function (data) {})
.catch(function (error) {})

//  Change the brightness and color of all the lights
var netbeast = require('netbeast')

netbeast('lights').set({brightness: 80, hue: 350, saturation: 100})
.then(function (data) {})
.catch(function (error) {})

netbeast(topic).setById(id, args)

The setById method allows us to change the current state of the given device. You can modify different values of the specified device.

var args = { power: true, brightness: 50 }

netbeast().setById(1, args)
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

netbeast(topic).setByAlias(alias, args)

The setByAlias method allows us to change the current state of the given device. You can modify different values of the specified device.

var args = { power: true, brightness: 50 }

netbeast().setByAlias('bed-light', args)
.then(function (data) {})
.catch(function (error) {})

The topic is useless on this method.

Selectors

netbeast(topic).at(location).METHOD

This method allows us to select a group of devices form a specific location. It can´t be used alone and should be follow by other method.

netbeast('lights').at('bedroom').get()
.then(function (data) {})
.catch(function (error) {})

In this example, we get information about all the lights placed at the kitchen.

netbeast(topic).alias(alias).METHOD

This method allows us to select a group of devices with a specific alias. It can´t be used alone and should be follow by other method.

netbeast('lights').alias('bed-light').get()
.then(function (data) {})
.catch(function (error) {})

In this example, we get information about the light call bed-light.

netbeast(topic).groupBy(name).METHOD

This method allows us to select devices form a specific group. It can´t be used alone and should be follow by other method.

netbeast('lights').groupBy('roof').set({power: true})
.then(function (data) {})
.catch(function (error) {})

In this example, we switch all the lights of the group ‘roof’ on.

netbeast().topic(topic).METHOD

This method allows us to select a group of devices form a specific topic. It can´t be used alone and should be follow by other method.

netbeast().topic('video').get()
.then(function (data) {})
.catch(function (error) {})

In this example, we get information about all the cideo resources.

Discovery

netbeast().set({ address: ip, port: port })

If you are developing and testing and you know where is your Dashboard running. You can declare it directly with this auxiliar method.


netbeast().set({ adress: '192.168.0.16', port: 8000 })

netbeast().find()

This function is useful to know where the Netbeast Dashboard is running. It returns the IP address and the port and declare it on the process environment variables.


netbeast().find()
.then(function (data) {}) // data = {adress: IP, port: PORT}
.catch(function (error) {})

netbeast().discoverDevices(app-name)

This function allows us to activate the discovery process. With the app-name parameter you can specify a concrete app (like belkin-wemo, philips-hue). If you don´t include this argument, the discovery will be apply to all available brands.


netbeast().discoveryDevices('sonos')
.then(function (data) {})
.catch(function (error) {})

It methods update the database and return an JSON object containing the found devices.

results matching ""

    No results matching ""