Skip to content

SystemCommands API

Version: 1.0.0

Status: ⚫⚪⚪

SystemCommands interface for Thunder framework.

(Defined with ISystemCommands in ISystemCommands.h)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the SystemCommands interface (version 1.0.0). It includes detailed specification about its methods provided.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

SystemCommands JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the SystemCommands interface:

Built-in methods:

Method Description
exists Checks if a JSON-RPC method or property exists

SystemCommands interface methods:

Method Description
usbreset Resets a USB device

exists method

Checks if a JSON-RPC method or property exists.

Description

This method will return True for the following methods/properties: exists, usbreset.

Parameters

Name Type M/O Description
params object mandatory ...
params.method string mandatory Name of the method or property to look up

Result

Name Type M/O Description
result boolean mandatory Denotes if the method exists or not

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.exists",
  "params": {
    "method": "methodName"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": false
}

usbreset method

Resets a USB device.

Parameters

Name Type M/O Description
params object mandatory ...
params.device string mandatory USB device to reset

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_GENERAL Failed to reset USB device
ERROR_UNAVAILABLE Unknown USB device

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.usbreset",
  "params": {
    "device": "/dev/usb/001"
  }
}

Response

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