Skip to content

Latest commit

 

History

History
207 lines (157 loc) · 5.86 KB

TraceControlPlugin.md

File metadata and controls

207 lines (157 loc) · 5.86 KB

Trace Control Plugin

Version: 1.0

Status: ⚫⚫⚫

TraceControl plugin for WPEFramework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the TraceControl 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
WPEF WPEFramework API Reference

Description

The Trace Control plugin provides ability to disable/enable trace output an set its verbosity level.

The plugin is designed to be loaded and executed within the WPEFramework. For more information on WPEFramework refer to [WPEF].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: TraceControl)
classname string Class name: TraceControl
locator string Library name: libWPEFrameworkTraceControl.so
autostart boolean Determines if the plugin is to be started automatically along with the framework

Methods

The following methods are provided by the TraceControl plugin:

TraceControl interface methods:

Method Description
status Retrieves general information
set Sets traces

status method

Retrieves general information

Description

Retrieves the actual trace status information for targeted module and category, if either category nor module is given, all information is returned.

Parameters

Name Type Description
params object
params.module string Module name
params.category string Category name

Result

Name Type Description
result object
result.console boolean Config attribute (Console)
result.remote object
result.remote.port number Config attribute (port)
result.remote.binding string Config attribute (binding)
result.settings array
result.settings[#] object
result.settings[#].module string Module name
result.settings[#].category string Category name
result.settings[#].state string State value (must be one of the following: disabled, enabled, tristated)

Example

Request

{
    "jsonrpc": "2.0", 
    "id": 1234567890, 
    "method": "TraceControl.1.status", 
    "params": {
        "module": "Plugin_Monitor", 
        "category": "Information"
    }
}

Response

{
    "jsonrpc": "2.0", 
    "id": 1234567890, 
    "result": {
        "console": false, 
        "remote": {
            "port": 2200, 
            "binding": "0.0.0.0"
        }, 
        "settings": [
            {
                "module": "Plugin_Monitor", 
                "category": "Information", 
                "state": "disabled"
            }
        ]
    }
}

set method

Sets traces

Description

Disables/Enables all/select category traces for particular module.

Parameters

Name Type Description
params object
params.module string Module name
params.category string Category name
params.state string State value (must be one of the following: disabled, enabled, tristated)

Result

Name Type Description
result null Always null

Example

Request

{
    "jsonrpc": "2.0", 
    "id": 1234567890, 
    "method": "TraceControl.1.set", 
    "params": {
        "module": "Plugin_Monitor", 
        "category": "Information", 
        "state": "disabled"
    }
}

Response

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