DeveloperTools Module

Version 0.1.0-alpha.4

A module for supporting off-device developer tools.

Firebolt APIs are maintained in the rdkcentral/firebolt-manage-sdk.git GitHub repository.

You can see this API in the developertools.json OpenRPC JSON-Schema document.

• Overview

• OpenRPC

• Usage

• Methods

  • find
  • listen
  • once
  • pair
  • unpair
  • Additional Methods

• Events

  • Additional Events

• Schemas

  • DeveloperTool

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

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

Starts a long-running DNS-SD search for a list of developer tools that match the standard ‘Firebolt Developer Tool’ service type

function find(add: function, remove: function): Promise<Process>

Parameters:

Promise resolution:

interface Process {
    stop(): void // Stops updating this temporal set with DeveloperTool[] objects
}

Examples

Default Example

JavaScript:

const process = DeveloperTools.find(function(
    tool => {
        console.log('Added to temporal set:')
        console.dir(tool)
    },
    tool => {
        console.log('Removed from temporal set:')
        console.dir(tool)
    })

setTimeout( () => process.stop(), 10000)

Value of tool:

[
  {
    "id": "ff6340fb-8576-494c-97c6-e60e9a4eeba9",
    "name": "A tool"
  }
]

[
    {
  "jsonrpc": "2.0",
  "id": 1,
  "method": "developertools.find",
  "params": {}
},
    {
        "id": 2,
        "method": "ontoolAvailable",
        "params": {
            "listen": true
        }
    }
]

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "id": "ff6340fb-8576-494c-97c6-e60e9a4eeba9",
      "name": "A tool"
    }
  ]
}

Listen for events from this module.

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

DeveloperTools.listen(event: string, (data: any) => void): Promise<bigint>

Parameters:

Promise resolution:

Callback parameters:

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

DeveloperTools.listen((event: string, data: any) => void): Promise<bigint>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

Listen for only one occurance of an event from this module. The callback will be cleared after one event.

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

DeveloperTools.once(event: string, (data: any) => void): Promise<bigint>

Parameters:

Promise resolution:

Callback parameters:

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

DeveloperTools.once((event: string, data: any) => void): Promise<bigint>

Parameters:

Callback parameters:

Promise resolution:

See Listening for events for more information and examples.

Configures Firebolt to accept incoming Firebolt JSON RPC messages from the developer tool identified by the given developer tool ID

function pair(id: string): Promise<void>

Parameters:

Promise resolution:

void

Examples

Default Example

JavaScript:

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

DeveloperTools.pair("ff6340fb-8576-494c-97c6-e60e9a4eeba9")
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "developertools.pair",
  "params": {
    "id": "ff6340fb-8576-494c-97c6-e60e9a4eeba9"
  }
}

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

Disconnect Firebolt as a web socket client from the web socket that corresponds to the given developer tool ID

function unpair(id: string): Promise<void>

Parameters:

Promise resolution:

void

Examples

Default Example

JavaScript:

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

DeveloperTools.unpair("ff6340fb-8576-494c-97c6-e60e9a4eeba9")
    .then(result => {
        console.log(result)
    })

Value of result:

null

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "developertools.unpair",
  "params": {
    "id": "ff6340fb-8576-494c-97c6-e60e9a4eeba9"
  }
}

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

The following methods are documented as part of a related set of method APIs.

For more information, follow the links under the “Documentation” column.

The following events are documented as part of a related set of method APIs.

For more information, follow the links under the “Documentation” column.

type DeveloperTool = {
  id: string            // The ID that uniquely identifies this instance of a developer tool
  name: string          // Developer-visible 'friendly name' for the developer tool
}