Skip to content

Latest commit

 

History

History
239 lines (178 loc) · 6.07 KB

InputSwitchPlugin.md

File metadata and controls

239 lines (178 loc) · 6.07 KB
Raw

Input Switch API

Version: 1.0

Status: ⚫⚪⚪

InputSwitch plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the InputSwitch plugin. It includes detailed specification of its configuration and methods provided.

Case Sensitivity

All identifiers on the interface 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

InputSwitch JSON-RPC interface

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
classname string Class name: InputSwitch
autostart boolean Determines if the plugin is to be started automatically along with the framework

Methods

The following methods are provided by the InputSwitch plugin:

InputSwitch interface methods:

Method Description
channel Enable or Disable the throughput through the given channel
select Enable the given channel, disabling all othe channels, whish are not immune
status Check the status of the requested channel

channel method

Enable or Disable the throughput through the given channel.

Parameters

Name Type Description
params object
params.name string Callsign that is the owner of this channel
params.enabled boolean Enable or disable the throughput of data through this channel

Result

Name Type Description
result null Always null

Errors

Code Message Description
22 ERROR_UNKNOWN_KEY Failed to scan

Example

Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "InputSwitch.1.channel",
    "params": {
        "name": "WebKitBrowser",
        "enabled": false
    }
}

Response

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

select method

Enable the given channel, disabling all othe channels, whish are not immune.

Parameters

Name Type Description
params object
params.name string Callsign that is the owner of this channel

Result

Name Type Description
result null Always null

Errors

Code Message Description
22 ERROR_UNKNOWN_KEY Failed to scan

Example

Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "InputSwitch.1.select",
    "params": {
        "name": "WebKitBrowser"
    }
}

Response

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

status method

Check the status of the requested channel.

Parameters

Name Type Description
params object
params.name string Callsign that is the owner of this channel

Result

Name Type Description
result array
result[#] object
result[#].name string Callsign associated with this channel
result[#].enabled boolean Is the channel enabled to receive info

Errors

Code Message Description
22 ERROR_UNKNOWN_KEY Could not find the designated channel

Example

Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "InputSwitch.1.status",
    "params": {
        "name": "WebKitBrowser"
    }
}

Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": [
        {
            "name": "WebKitBrowser",
            "enabled": false
        }
    ]
}