Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acte-technology/thingsboard-js-sdk
Integrate Thingsboard backend to Javascript front-end frameworks and NodeJS
https://github.com/acte-technology/thingsboard-js-sdk
iot nodejs reactjs thingsboard
Last synced: 3 months ago
JSON representation
Integrate Thingsboard backend to Javascript front-end frameworks and NodeJS
- Host: GitHub
- URL: https://github.com/acte-technology/thingsboard-js-sdk
- Owner: acte-technology
- Created: 2021-02-11T05:48:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-01T12:01:47.000Z (over 2 years ago)
- Last Synced: 2024-07-22T03:23:00.967Z (4 months ago)
- Topics: iot, nodejs, reactjs, thingsboard
- Language: JavaScript
- Homepage:
- Size: 36.1 KB
- Stars: 16
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
- awesome-thingsboard - Thingsboard Javascript SDK
README
# 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
### Import client class
```js
import tbClient from 'thingsboard-js-sdk';
const client = new tbClient(config);
```
### Connect to public device
```js
const client = new tbClient({
host: 'localhost',
publicId: 'xxx-xxx-xxx-xxx' // dashboard public id
});
const connect = async () => {
const token = await client.connect(true); //true for public login
}
```
### Connect with user/password
```js
const client = new tbClient({
host: 'localhost',
username: 'username',
password: 'password'
});
const connect = async () => {
const token = await client.connect();
}
```
### Get Tenant Devices
*must be logged as a tenant*
```js
const params = {
pageSize: 100,
page: 0,
sortProperty: 'name',
sortOrder: 'ASC'
}
//...
let devices = await client.getTenantDevices(params, callback)
```
### Get Keys
```js
const params = {
entityId: 'xxx-xxx-xxx',
scope: 'timeseries', //timeseries | client | shared | server
}
//...
let keys = await client.getKeys(params, callback)
```
### Get Attributes By Scope
```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)
```
### Delete keys
```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)
```
### Get timeseries
```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)
```
### WSS Websocket subscribe
```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
## Working examples:
- Public data integration: https://acte.ltd/iot/dashboards/aqi
- Tenant access: https://acte.ltd/iot/client/login