Device Module

Version Device 1.2.0

Table of Contents

• Table of Contents
• Usage
• Overview
• Methods
  • listen
  • name
  • once
  • provision
• Events
  • deviceNameChanged
  • nameChanged
• Types

Usage

To use the Device module, you can import it into your project from the Firebolt SDK:

import { Device } from '@firebolt-js/manage-sdk'

Overview

A module for querying about the device and it’s capabilities.

Methods

listen

To listen to a specific event pass the event name as the first parameter:

listen(event: string, callback: (data: any) => void): Promise<number>

Parameters:

Promise resolution:

Callback parameters:

To listen to all events from this module pass only a callback, without specifying an event name:

listen(callback: (event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

name

The human readable name of the device

To get the value of name call the method like this:

function name(): Promise<string>

Promise resolution:

Capabilities:

Examples

Default example #1

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let value = await Device.name()
console.log(value)

Value of value:

'Living Room'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.name",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Living Room"
}

Default example #2

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let value = await Device.name()
console.log(value)

Value of value:

'Living Room'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.name",
  "params": {}
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Kitchen"
}

To set the value of name call the method like this:

function name(value: string): Promise<void>

Parameters:

Promise resolution:

Examples

Default example #1

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let result = await Device.name('Living Room')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.setName",
  "params": {
    "value": "Living Room"
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

Default example #2

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let result = await Device.name('Kitchen')
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.setName",
  "params": {
    "value": "Kitchen"
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

To subscribe to notifications when the value changes, call the method like this:

function name(callback: (value) => string): Promise<number>

Promise resolution:

number

Examples

Default example #1

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let listenerId = await name((value) => {
  console.log(value)
})
console.log(listenerId)

Value of value:

'Living Room'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.onNameChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Living Room"
}

Default example #2

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let listenerId = await name((value) => {
  console.log(value)
})
console.log(listenerId)

Value of value:

'Living Room'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.onNameChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Kitchen"
}

once

To listen to a single instance of a specific event pass the event name as the first parameter:

once(event: string, callback: (data: any) => void): Promise<number>

The once method will only pass the next instance of this event, and then dicard the listener you provided.

Parameters:

Promise resolution:

Callback parameters:

To listen to the next instance only of any events from this module pass only a callback, without specifying an event name:

once(callback: (event: string, data: any) => void): Promise<number>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

provision

Used by a distributor to push provision info to firebolt.

function provision(
  accountId: string,
  deviceId: string,
  distributorId: string,
): Promise<void>

Parameters:

Promise resolution:

Capabilities:

Examples

Default Example

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let result = await Device.provision('12345678910', '987654321111', null)
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.provision",
  "params": {
    "accountId": "12345678910",
    "deviceId": "987654321111"
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

With distributor id

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

let result = await Device.provision(
  '12345678910',
  '987654321111',
  'global_partner',
)
console.log(result)

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.provision",
  "params": {
    "accountId": "12345678910",
    "deviceId": "987654321111",
    "distributorId": "global_partner"
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": null
}

Events

deviceNameChanged

function listen('deviceNameChanged', () => void): Promise<number>

See also: listen(), once(), clear().

Event value:

Capabilities:

Examples

Getting the device name

JavaScript:

import { Device } from '@firebolt-js/manage-sdk'

Device.listen('deviceNameChanged', (value) => {
  console.log(value)
})

Value of value:

'Living Room'

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Device.onDeviceNameChanged",
  "params": {
    "listen": true
  }
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "Living Room"
}

nameChanged

See: name

Types