Octoblu
Repository| Issues
Open Communications Network and API for the internet of things.
For more info about the Octoblu platform click here.
How to Install
Install the module with:
$ npm install cylon cylon-octoblu
How to Use
You use the connection object only, when working with the cylon-octoblu module.
var Cylon = require("cylon"); Cylon.robot({ connections: { arduino: { adaptor: "firmata", port: "/dev/tty.usbmodem1411" }, octoblu: { adaptor: "octoblu", uuid: "SKYNET_UUID", token: "SKYNET_TOKEN" } }, devices: { led: { driver: "led", pin: 13, connection: "arduino" } }, work: function(my) { my.octoblu.on("message", function(data) { console.log(data); if (data.payload.red === "on") { my.led.turnOn(); } else if (data.payload.red === "off") { my.led.turnOff(); } }); } }).start();
How to Connect
First, you need to register a device on the Octoblu network. You can do this with a curl command similar to this one:
$ curl -X POST http://meshblu.octoblu.com/devices
This will return the new registration information for the device, most importantly the uuid and token:
{"geo":{"range":[1344446976,1344447487],"country":"ES","region":"56","city":"Cornellá De Llobregat","ll":[41.35,2.0833],"metro":0},"ipAddress":"80.34.162.160","online":false,"timestamp":"2015-03-05T14:35:23.638Z","uuid":"db895340-c344-11e4-9f09-df7578d68eac","token":"d0a9f0d7e321657a38d25dd492492ffed0baf773"}
Commands
message
Posts a message to Octoblu
Params
-
data (
Object) to be posted
Returns
- (
undefined)
subscribe
Subscribes to data from Octoblu
Params
-
opts (
Object) what to subscribe to
Returns
- (
undefined)
register
Register a device on Octoblu
Params
-
opts (
Object) device data
Returns
- (
undefined)
unregister
Unregister a device on Octoblu
Params
-
opts (
Object) device data
Returns
- (
undefined)
update
Update a device on Octoblu
Params
-
data (
Object) device data to update
Returns
- (
undefined)
whoami
Get device info for current device from Octoblu
Params
-
opts (
Object) device data -
callback (
Function) to be triggered with device info
Returns
- (
undefined)
status
Get network status from Octoblu
Params
-
callback (
Function) to be triggered with network info
Returns
- (
undefined)
Events
message
Emitted when Octoblu has received a new message
Values
- data
Drivers
There are no specific drivers for the Octoblu platform.
