Skip to content

Latest commit

 

History

History
216 lines (152 loc) · 6.05 KB

IOConnectorPlugin.md

File metadata and controls

216 lines (152 loc) · 6.05 KB
Raw

IO Connector Plugin

Version: 1.0

Status: ⚫⚫⚫

IOConnector plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the IOConnector plugin. It includes detailed specification about its configuration, properties provided and notifications sent.

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
GPIO General-Purpose Input/Output
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 IO Connector plugin provides access to GPIO pins.

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: IOConnector)
classname string Class name: IOConnector
locator string Library name: libWPEIOConnector.so
startmode string Determines if the plugin shall be started automatically along with the framework
pins array List of GPIO pins available on the system
pins[#] object Pin properties
pins[#].id number Pin ID
pins[#].mode string Pin mode (must be one of the following: Low, High, Both, Active, Inactive, Output)
pins[#]?.activelow boolean (optional) Denotes if pin is active in low state (default: false)

Interfaces

This plugin implements the following interfaces:

Properties

The following properties are provided by the IOConnector plugin:

IOConnector interface properties:

Property Description
pin GPIO pin value

pin property

Provides access to the GPIO pin value.

Also see: activity

Value

Name Type Description
(property) number GPIO pin value

The pin id argument shall be passed as the index to the property, e.g. IOConnector.1.pin@189.

Result

Name Type Description
result number

Errors

Code Message Description
22 ERROR_UNKNOWN_KEY Unknown pin ID given

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "IOConnector.1.pin@189"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "IOConnector.1.pin@189",
  "params": 1
}

Set Response

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

Notifications

Notifications are autonomous events triggered by the internals of the implementation and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the IOConnector plugin:

IOConnector interface events:

Event Description
activity Notifies about GPIO pin activity

activity event

Notifies about GPIO pin activity.

Description

Register to this event to be notified about pin value changes

Parameters

Name Type Description
params object
params.value number GPIO pin value

The pin ID argument shall be passed within the designator, e.g. 189.client.events.1.

Example

{
  "jsonrpc": "2.0",
  "method": "189.client.events.1.activity",
  "params": {
    "value": 1
  }
}