IO Connector API

Version: 1.0.0

Status:

IOConnector interface for Thunder framework.

(Defined by IOConnector.json)

Table of Contents

• Introduction
• Description
• Properties
• Notifications

Introduction

Scope

This document describes purpose and functionality of the IOConnector interface (version 1.0.0). It includes detailed specification about its 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
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

IO Connector JSON-RPC interface.

Properties

The following properties are provided by the IOConnector interface:

IOConnector interface properties:

Property	R/W	Description
pin	read/write	GPIO pin value

pin ^property

Provides access to the GPIO pin value.

Also see: activity

The pin id parameter shall be passed as the index to the property, i.e. pin@<pin-id>.

Index

Name	Type	M/O	Description
pin-id	string	mandatory	...

Value

Name	Type	M/O	Description
(property)	integer	mandatory	Value of the pin

Name	Type	M/O	Description
(property)	integer	mandatory	Value of the pin

Errors

Message	Description
ERROR_UNKNOWN_KEY	Unknown pin ID given

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.pin@189"
}

Get Response

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

Set Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.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 interface:

IOConnector interface events:

Notification	Description
activity	Notifies about GPIO pin activity

activity ^notification

Notifies about GPIO pin activity.

Description

Register to this event to be notified about pin value changes

Parameters

The pin ID parameter shall be passed within the id parameter to the register call, i.e. <pin id>.<client-id>.

Notification Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.value	integer	mandatory	Value of the pin

Example

Registration

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.register",
  "params": {
    "event": "activity",
    "id": "189.myid"
  }
}

Notification

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

The client ID parameter is passed within the notification designator, i.e. <pin id>.<client-id>.activity.

The pin ID parameter is passed within the notification designator, i.e. <pin id>.<client-id>.activity.