Skip to content

Packager Plugin

Version: 1.0

Status: ⚫⚪⚪

Packager plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the Packager 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 Packager plugin allows installation of OPKG, IPKG and DEB packages to the system from a remote repository.

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 M/O Description
callsign string mandatory Plugin instance name (default: Packager)
classname string mandatory Class name: Packager
locator string mandatory Library name: libThunderPackager.so
startmode string mandatory Determines in which state the plugin should be moved to at startup of the framework

Interfaces

This plugin implements the following interfaces:

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

    This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Methods

The following methods are provided by the Packager plugin:

Packager interface methods:

Method Description
install Install a package given by a name, an URL or a file path
synchronizerepository / synchronize Synchronize repository manifest with a repository

install method

Install a package given by a name, an URL or a file path.

Parameters

Name Type M/O Description
params object mandatory ...
params.name string mandatory Name, URL or file path of the package to install
params.version string mandatory Version of the package to install
params.arch string mandatory Architecture of the package to install

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_INPROGRESS Other installation/synchronization is already in progress
ERROR_GENERAL Opkg package manager not initialized successfully

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Packager.1.install",
  "params": {
    "name": "thunder-plugin-netflix",
    "version": "1.0",
    "arch": "arm"
  }
}

Response

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

synchronizerepository method

Synchronize repository manifest with a repository.

synchronize is an alternative name for this method. This name is deprecated and may be removed in the future. It is not recommended for use in new implementations.

Parameters

This method takes no parameters.

Result

Name Type M/O Description
result null mandatory Always null

Errors

Message Description
ERROR_INPROGRESS Other installation/synchronization is already in progress
ERROR_GENERAL Opkg package manager not initialized successfully

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "Packager.1.synchronizerepository"
}

Response

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