rhasspy-microphone-cli-hermes 0.1.2

No project description provided

Rhasspy Microphone Hermes MQTT Service

Records audio from an external program and publishes WAV chunks according to the Hermes protocol.

Running With Docker

docker run -it rhasspy/rhasspy-microphone-cli-hermes:<VERSION> <ARGS>

Building From Source

Clone the repository and create the virtual environment:

git clone https://github.com/rhasspy/rhasspy-microphone-cli-hermes.git
cd rhasspy-microphone-cli-hermes
make venv

Run the bin/rhasspy-microphone-cli-hermes script to access the command-line interface:

bin/rhasspy-microphone-cli-hermes --help

Building the Debian Package

Follow the instructions to build from source, then run:

source .venv/bin/activate
make debian

If successful, you'll find a .deb file in the dist directory that can be installed with apt.

Building the Docker Image

Follow the instructions to build from source, then run:

source .venv/bin/activate
make docker

This will create a Docker image tagged rhasspy/rhasspy-microphone-cli-hermes:<VERSION> where VERSION comes from the file of the same name in the source root directory.

NOTE: If you add things to the Docker image, make sure to whitelist them in .dockerignore.

Command-Line Options

usage: rhasspy-microphone-cli-hermes [-h] --record-command RECORD_COMMAND
                                     --sample-rate SAMPLE_RATE --sample-width
                                     SAMPLE_WIDTH --channels CHANNELS
                                     [--host HOST] [--port PORT]
                                     [--siteId SITEID] [--debug]

optional arguments:
  -h, --help            show this help message and exit
  --record-command RECORD_COMMAND
                        Command to record raw audio data
  --sample-rate SAMPLE_RATE
                        Sample rate of recorded audio in hertz (e.g., 16000)
  --sample-width SAMPLE_WIDTH
                        Sample width of recorded audio in bytes (e.g., 2)
  --channels CHANNELS   Number of channels in recorded audio (e.g., 1)
  --host HOST           MQTT host (default: localhost)
  --port PORT           MQTT port (default: 1883)
  --siteId SITEID       Hermes siteId of this server
  --debug               Print DEBUG messages to the console