Skip to content

Subsystem Control API

Version: 1.0.0

Status: ⚫⚪⚪

SubsystemControl interface for Thunder framework.

(Defined by SubsystemControl.json)

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the SubsystemControl 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

SubsystemControl JSON-RPC interface.

Methods

The following methods are provided by the SubsystemControl interface:

SubsystemControl interface methods:

Method Description
activate Activates a subsystem
deactivate Deactivates a subsystem

activate method

Activates a subsystem.

Description

This method allows a subsystem to be activated from the outside. This is usefull in case Thunder can not determine the availability of a subsystem but it needs to be triggered from the outside.

Parameters

Name Type M/O Description
params object mandatory ...
params.system string mandatory Subsystem to activate (must be one of the following: bluetooth, cryptography, decryption, graphics, identifier, installation, internet, location, network, platform, provisioning, security, streaming, time, websource)
params?.configuration string optional A JSON string that holds the information applicable to the subsystem to be activated

Result

Name Type M/O Description
result integer mandatory The result of the activating anythin unequal to 0 means somthing failed

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.activate",
  "params": {
    "system": "network",
    "configuration": "..."
  }
}

Response

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

deactivate method

Deactivates a subsystem.

Description

This method allows a subsystem to be deactivated from the outside. This is usefull in case Thunder can not determine the availability of a subsystem but it needs to be triggered from the outside.

Parameters

Name Type M/O Description
params string mandatory Subsystem to deactivate (must be one of the following: bluetooth, cryptography, decryption, graphics, identifier, installation, internet, location, network, platform, provisioning, security, streaming, time, websource)

Result

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

Example

Request

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

Response

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