Thingsboard Javascript SDK

Thingsboard Javascript SDK

Dev version, work in progress.

Installation

``bash
npm install thingsboard-js-sdk
`

Examples

* Reactjs, checkout docs/reactjs.js component.

Methods

- connect
- disconnect
- subscribe (websocket)
- getTenantDevices
- getKeys (timeseries & attributes)
- deleteEntityKeys (timeseries & attributes)
- getAttributesByScope
- getTimeseries

$3

`js
import tbClient from 'thingsboard-js-sdk';
const client = new tbClient(config);
`

$3

`js
const client = new tbClient({
host: 'localhost',
publicId: 'xxx-xxx-xxx-xxx'
});

const connect = async () => {

const token = await client.connect(true); //true for public login

}
`

$3

`js
const client = new tbClient({
host: 'localhost',
username: 'username',
password: 'password'
});

const connect = async () => {

const token = await client.connect();

}
`

$3

must be logged as a tenant

`js
const params = {
pageSize: 100,
page: 0,
sortProperty: 'name',
sortOrder: 'ASC'
}
//...
let devices = await client.getTenantDevices(params, callback)
`

$3

`js
const params = {
entityId: 'xxx-xxx-xxx',
scope: 'timeseries', //timeseries | client | shared | server
}
//...
let keys = await client.getKeys(params, callback)
`

$3

`js
const params = {
entityId: 'xxx-xxx-xxx',
scope: 'CLIENT_SCOPE', // CLIENT_SCOPE | SHARED_SCOPE | SERVER_SCOPE
keys: ['temperature', 'humidity']
}
//...
let attrs = await client.getAttributesByScope(params, callback)
`

$3

`js
const params = {
entityId: 'xxx-xxx-xxx',
keys: ['temperature', 'humidity'],
olderThan: Date.now()-3600, //delete older than 1 hour
scope: 'timeseries' // timeseries, client, shared, server
}
//...
let response = await client.deleteEntityKeys(params, callback)
`

$3

`js
const now = Date.now();

const params = {
entityId: 'xxx-xxx-xxx',
keys: ['temperature', 'humidity']
limit: 500,
agg: 'AVG',
interval: 60000,
startTs: now-3600000,
endTs: now,
useStrictDataTypes: true
}
//...
let timeseries = await client.getTimeseries(params, callback)
`

$3

`js
const params = {
entityId: 'xxx-xxx-xxx',
cmdId: 10 //websocket id
}
//...
let keys = await client.subscribe(params, callback)
``

Issues

Github: https://github.com/acte-technology/thingsboard-js-sdk/issues