Skip to content

Latest commit

 

History

History
232 lines (164 loc) · 7.35 KB

AVSPlugin.md

File metadata and controls

232 lines (164 loc) · 7.35 KB
Raw

AVS Plugin

Version: 1.0

Status: ⚫⚪⚪

AVS plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the AVS plugin. It includes detailed specification about its configuration, methods 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

The Alexa Voice Service Headless Client serves as a personal assistant.

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: AVS)
classname string Class name: AVS
locator string Library name: libThunderAVS.so
startmode string Determines if the plugin shall be started automatically along with the framework
configuration object (optional)
configuration.alexaclientconfig string The path to the AlexaClientSDKConfig.json (e.g /usr/share/Thunder/AVS/AlexaClientSDKConfig.json)
configuration?.smartscreenconfig string (optional) The path to the SmartScreenSDKConfig.json (e.g /usr/share/Thunder/AVS/SmartScreenSDKConfig.json). This config will be used only when SmartScreen functionality is enabled
configuration?.kwdmodelspath string (optional) Path to the Keyword Detection models (e.g /usr/share/Thunder/AVS/models). The path mus contain the localeToModels.json file
configuration?.loglevel string (optional) Capitalized log level of the AVS components. Possible values: NONE, CRITICAL, ERROR, WARN, INFO. Debug log levels start from DEBUG0 up to DEBUG0
configuration.audiosource string The callsign of the plugin that provides the voice audio input or PORTAUDIO, when the portaudio library should be used. (e.g BluetoothRemoteControll, PORTAUDIO)
configuration?.enablesmartscreen boolean (optional) Enable the SmartScreen support in the runtime. The SmartScreen functionality must be compiled in
configuration?.enablekwd boolean (optional) Enable the Keyword Detection engine in the runtime. The KWD functionality must be compiled in

Interfaces

This plugin implements the following interfaces:

  • IAVSController (IAVSClient.h) (version 1.0.0) (uncompliant-collapsed format)

Methods

The following methods are provided by the AVS plugin:

AVSController interface methods:

Method Description
mute Mutes the audio output of AVS
record Starts or stops the voice recording, skipping keyword detection

mute method

Mutes the audio output of AVS.

Parameters

Name Type Description
muted boolean

Result

Name Type Description
result null Always null

Errors

Code Message Description
ERROR_GENERAL when there is a fatal error or authorisation is not possible

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "AVS.1.mute",
  "params": false
}

Response

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

record method

Starts or stops the voice recording, skipping keyword detection.

Parameters

Name Type Description
started boolean

Result

Name Type Description
result null Always null

Errors

Code Message Description
ERROR_GENERAL when there is a fatal error or authorisation is not possible

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "AVS.1.record",
  "params": false
}

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 AVS plugin:

AVSController interface events:

Event Description
dialoguestatechange notifies about dialogue state changes

dialoguestatechange event

notifies about dialogue state changes.

Parameters

Name Type Description
state string The new state (must be one of the following: Idle, Listening, Expecting, Thinking, Speaking)

Example

{
  "jsonrpc": "2.0",
  "method": "client.events.1.dialoguestatechange",
  "params": "SPEAKING"
}