Skip to content

Latest commit

 

History

History
150 lines (104 loc) · 4.45 KB

SystemCommandsPlugin.md

File metadata and controls

150 lines (104 loc) · 4.45 KB
Raw

System Commands Plugin

Version: 1.0

Status: ⚫⚫⚪

SystemCommands plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the SystemCommands plugin. It includes detailed specification about its configuration and 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

The System Commands plugin allows executing of low level actions on the system.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: SystemCommands)
classname string Class name: SystemCommands
locator string Library name: libThunderSystemCommands.so
startmode string Determines if the plugin shall be started automatically along with the framework

Interfaces

This plugin implements the following interfaces:

Methods

The following methods are provided by the SystemCommands plugin:

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 Description
params object
params.device string USB device to reset

Result

Name Type Description
result null Always null

Errors

Code Message Description
1 ERROR_GENERAL Failed to reset the USB device
2 ERROR_UNAVAILABLE Unknown USB device

Example

Request

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

Response

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