Tidbyt Client for Node.js
Unofficial API client for the Tidbyt API. Use this client to control Tidbyt devices and integrate with other services.
Installation
You can install the package with npm:
> npm install tidbyt
Usage
const Tidbyt = require('tidbyt')
async function main() {
const deviceId = process.argv[2]
const tidbyt = new Tidbyt(process.env.TIDBYT_API_TOKEN)
// get our requested device
const device = await tidbyt.devices.get(deviceId)
const { displayName, lastSeen } = device
console.log(displayName, `Last Seen: (${lastSeen})`)
// get a list of officially available apps
// return as map so we can lookup app name/descriptions by id
const apps = await tidbyt.apps.list({ asMap: true })
// get the list of installations for this device
const installations = await device.installations.list()
for (const { id, appID } of installations) {
const {
name = 'Custom',
description = `Unlike a regular Tidbyt app, this "installation" was pushed to ${displayName} via Tidbyt's API.`,
} = apps.get(appID) || {}
console.log(``)
console.log(` ${name} - ${id}`)
console.log(` ${description}`)
}
}
main()
Classes
TidbytDevice
Kind: global class
Scope: Tidbyt
- TidbytDevice
- new TidbytDevice(options, client)
- .installations :
object- .list() ⇒
Promise.<Array.<TidbytDeviceInstallation>> - .update(installationID, image) ⇒
Promise.<Object> - .delete(installationID) ⇒
Promise.<Object>
- .list() ⇒
- .update(updates) ⇒
Promise.<TidbytDevice> - .push(image, [installationID]) ⇒
Promise.<Object>
new TidbytDevice(options, client)
Construct a TidbytDevice with provided options.
A valid client is required to use any methods.
Available options:
- `id`: the device id
- `lastSeen`: the last time the device was seen
- `brightness`: the brightness of the device from 0-100
- `displayName`: the display name of the device
- `autoDim`: whether the device is auto dimming at night
| Param | Type |
|---|---|
| options | Object |
| client | TidByt |
tidbytDevice.installations : object
Kind: instance property of TidbytDevice
- .installations :
object- .list() ⇒
Promise.<Array.<TidbytDeviceInstallation>> - .update(installationID, image) ⇒
Promise.<Object> - .delete(installationID) ⇒
Promise.<Object>
- .list() ⇒
installations.list() ⇒ Promise.<Array.<TidbytDeviceInstallation>>
Return a list of installations on the device from the Tidbyt API.
Kind: instance method of installations
installations.update(installationID, image) ⇒ Promise.<Object>
Update an existing installation with a new image.
Throws if not client is intialized.
Kind: instance method of installations
| Param | Type | Description |
|---|---|---|
| installationID | String |
Optional installation ID to create/update |
| image | Buffer |
Buffer containing the images to push |
installations.delete(installationID) ⇒ Promise.<Object>
Delete an existing installation from the device.
Throws if not client is intialized.
Kind: instance method of installations
| Param | Type | Description |
|---|---|---|
| installationID | String |
Optional installation ID to create/update |
tidbytDevice.update(updates) ⇒ Promise.<TidbytDevice>
Update a device with the provided values.
Throws if not client is intialized.
Available fields:
- `autoDim`: whether the device is auto dimming at night
- `brightness`: the brightness of the device from 0-100
- `displayName`: the display name of the device
Kind: instance method of TidbytDevice
| Param | Type |
|---|---|
| updates | Object |
tidbytDevice.push(image, [installationID]) ⇒ Promise.<Object>
Push a new installation to the device.
Throws if not client is intialized.
Kind: instance method of TidbytDevice
| Param | Type | Description |
|---|---|---|
| image | Buffer |
Buffer containing the images to push |
| [installationID] | String |
Optional installation ID to create/update |
Tidbyt
Kind: global class
- Tidbyt
- new Tidbyt(apiToken, version)
- .apps :
object- .list(options) ⇒
Promise.<(Array.<Object>|Map)>
- .list(options) ⇒
- .devices :
object - .request(path, method, body, headers, raw, encoding) ⇒
Promise.<(Object|Buffer)>
new Tidbyt(apiToken, version)
Construct a Tidbyt with provided options.
Available options:
- `apiToken`: the API token
- `apiVersion`: the API version. Defaults to `v0`
| Param | Type | Default |
|---|---|---|
| apiToken | String |
|
| version | String |
'v0' |
tidbyt.apps : object
Kind: instance property of Tidbyt
apps.list(options) ⇒ Promise.<(Array.<Object>|Map)>
Return a list of available apps from the Tidbyt API.
Available options:
- `asMap`: Defaults to false. If true, returns a map of app ids to app objects instead of an array of app objects.
Kind: instance method of apps
| Param | Type |
|---|---|
| options | Object |
tidbyt.devices : object
Kind: instance property of Tidbyt
- .devices :
object
devices.get(deviceId) ⇒ Promise.<TidbytDevice>
Get a device by id from the Tidbyt API.
Kind: instance method of devices
| Param | Type | Description |
|---|---|---|
| deviceId | String |
The device id |
devices.update(deviceId, updates) ⇒ Promise.<TidbytDevice>
Update a device with the provided values by ID.
Available updates:
- `autoDim`: whether the device is auto dimming at night
- `brightness`: the brightness of the device from 0-100
- `displayName`: the display name of the device
Kind: instance method of devices
| Param | Type | Description |
|---|---|---|
| deviceId | String |
The device id |
| updates | Object |
devices.push(deviceId, image, [installationID]) ⇒ Promise.<Object>
Push a new installation to a device by ID.
Throws if not client is intialized.
Kind: instance method of devices
| Param | Type | Description |
|---|---|---|
| deviceId | String |
The device id |
| image | Buffer |
Buffer containing the images to push |
| [installationID] | String |
Optional installation ID to create/update |
tidbyt.request(path, method, body, headers, raw, encoding) ⇒ Promise.<(Object|Buffer)>
Send a request to the Tidbyt API.
Kind: instance method of Tidbyt
| Param | Type | Default |
|---|---|---|
| path | String |
|
| method | String |
'GET' |
| body | Object |
|
| headers | Object |
{} |
| raw | Boolean |
|
| encoding | String |
10 Jul 21, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
4 Jun 23, 2022
4 Sep 19, 2022
6 Nov 11, 2022
4 Jul 6, 2022
39 Dec 2, 2022
9 Dec 25, 2022