Skip to content

Latest commit

 

History

History
139 lines (97 loc) · 4.11 KB

DoggoPlugin.md

File metadata and controls

139 lines (97 loc) · 4.11 KB
Raw

Doggo Plugin

Version: 1.0

Status: ⚫⚫⚪

Doggo plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the Doggo 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 watchdog control plugin allows control a build-in kernel watchdog.

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: Doggo)
classname string Class name: Doggo
locator string Library name: libWPEDoggo.so
startmode string Determines if the plugin shall be started automatically along with the framework

Interfaces

This plugin implements the following interfaces:

  • IWatchDog (IWatchDog.h) (version 1.0.0) (compliant format)

Methods

The following methods are provided by the Doggo plugin:

WatchDog interface methods:

Method Description
touch Touch the watchdog as a sign of life

touch method

Touch the watchdog as a sign of life.

Parameters

Name Type Description
params object
params.callsign string In case a specific watchdog needs to be padded pass

Result

Name Type Description
result null Always null

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Doggo.1.touch",
  "params": {
    "callsign": "..."
  }
}

Response

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