Beebotte Node.JS SDK
what | where |
---|---|
overview | http://beebotte.com/overview |
tutorials | http://beebotte.com/tutorials |
apidoc | http://beebotte.com/docs/restapi |
source | https://github.com/beebotte/bbt_node |
Bugs / Feature Requests
Think you.ve found a bug? Want to see a new feature in beebotte? Please open an issue in github. Please provide as much information as possible about the issue type and how to reproduce it.
https://github.com/beebotte/bbt_node/issues
Install
To install the most recent release from npm, run:
npm install beebotte
Introduction
This Node.js library provides:
- REST client, and,
- Stream pub/sub client to Beebotte API
The Stream API supports two transports:
- MQTT
- Socket.io
Remember, Beebotte resource description uses a two levels hierarchy:
- Channel: physical or virtual connected object (an application, an arduino, a coffee machine, etc) providing some resources
- Resource: most elementary part of Beebotte, this is the actual data source (temperature from a domotics sensor)
Usage
REST Connector
//Include the Beebotte SDK for nodejs var bbt = ; //Create a Beebotte connector //Replace API key and secret key by those of your account var client = apiKey: 'API KEY' secretKey: 'SECRET KEY'; //write (persistent message) to a given channel & resource client; //publishe (transient message) to a given channel & resource client; //read persistent messages from a given channel & resource client;
Stream Connector - MQTT transport
//Include the Beebotte SDK for nodejs var bbt = ; //Replace API and secret keys by those of your account var transport = type: 'mqtt' apiKey: 'API KEY' secretKey: 'SECRET KEY' //Create a Stream connector client = transport: transport ; //On successful connection client;
You can use the Channel Token to authenticate the connection. Using the Channel Token grants read and write access to any resource of that channel. This is the recommended authentication sc heme.
//Replace Channel Token by that of your account var transport = type: 'mqtt' token: 'CHANNEL_TOKEN'
Stream Connector - Socket.io transport
//Include the Beebotte SDK for nodejs var bbt = ; //Replace API and secret keys by those of your account var transport = type: 'socketio' apiKey: 'API KEY' secretKey: 'SECRET KEY' // Alternatively, you could specify an authentication endpoint (see beebotte.com/docs/clientauth) //Replace API key by that of your account var transport = type: 'socketio' apiKey: 'API KEY' auth_endpoint: 'YOUR AUTH ENDPOINT' //See https://beebotte.com/docs/clientauth //Create a Stream connector client = transport: transport ; //On successful connection client;
You can use the Channel Token to authenticate the connection. Using the Channel Token grants read and write access to any resource of that channel. This is the recommended authentication scheme.
//Replace Channel Token by that of your account var transport = type: 'socketio' token: 'CHANNEL_TOKEN'
Alternatively, you could specify an authentication endpoint (see client authentication)
//Replace API key by that of your account var transport = type: 'socketio' apiKey: 'API KEY' auth_endpoint: 'YOUR AUTH ENDPOINT' //See https://beebotte.com/docs/clientauth
License
Copyright 2020 Beebotte.