System Commands API

Version: 1.0.0

Status:

SystemCommands interface for Thunder framework.

(Defined by SystemCommands.json)

Table of Contents

• Introduction
• Description
• Methods

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

System Commands JSON-RPC interface.

Methods

The following methods are provided by the SystemCommands interface:

SystemCommands interface methods:

Method	Description
usbreset	Resets a USB device

usbreset ^method

Resets a USB device.

Description

With this method a USB device can be reset using USBFS_RESET ioctl command.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.device	string	mandatory	USB device to reset (default: /dev/usb/001)

Result

Name	Type	M/O	Description
result	null	mandatory	Always null (default: None)

Errors

Message	Description
ERROR_GENERAL	Failed to reset the 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
}