assistant.echo

assistant.echo

class platypush.plugins.assistant.echo.AssistantEchoPlugin(avs_config_file: Optional[str] = None, audio_device: str = 'default', audio_player: str = 'default', **kwargs)[source]

Amazon Echo/Alexa assistant plugin.

In order to activate the Echo service on your device follow these steps:

  1. Install avs (pip install git+https://github.com/BlackLight/avs.git)

  2. Run the alexa-auth script. A local webservice will start on port 3000

  3. If a browser instance doesn’t open automatically then head to http://localhost:3000

  4. Log in to your Amazon account

  5. The required credentials will be stored to ~/.avs.json

Triggers:

Requires:

  • avs (pip install avs)

__init__(avs_config_file: Optional[str] = None, audio_device: str = 'default', audio_player: str = 'default', **kwargs)[source]
Parameters:
  • avs_config_file – AVS credentials file - default: ~/.avs.json. If the file doesn’t exist then an instance of the AVS authentication service will be spawned. You can login through an Amazon account either in the spawned browser window, if available, or by opening http://your-ip:3000 in the browser on another machine.

  • audio_device – Name of the input audio device (default: ‘default’)

  • audio_player – Player to be used for audio playback (default: ‘default’). Supported values: ‘mpv’, ‘mpg123’, ‘gstreamer’

is_detecting() bool
Returns:

True if the asistant is detecting, False otherwise.

pause_detection()

Put the assistant on pause. No new conversation events will be triggered.

resume_detection()

Resume the assistant hotword detection from a paused state.

start_conversation(**kwargs)[source]

Start a conversation.

stop_conversation()[source]

Stop a conversation.