Wyoming

`services.wyoming.faster-whisper.package`

The wyoming-faster-whisper package to use. Type: package

Default

pkgs.wyoming-faster-whisper

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers`

Attribute set of faster-whisper instances to spawn.

Type: attribute set of (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.beamSize`

The number of beams to use in beam search.

Type: unsigned integer, meaning >=0

Default

1

Example

5

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.device`

Determines the platform faster-whisper is run on. CPU works everywhere, CUDA requires a compatible NVIDIA GPU.

Type: one of "cpu", "cuda", "auto"

Default

"cpu"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.enable`

Whether to enable Wyoming faster-whisper server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.extraArgs`

Extra arguments to pass to the server commandline.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.language`

The language used to to parse words and sentences.

Type: one of "auto", "af", "am", "ar", "as", "az", "ba", "be", "bg", "bn", "bo", "br", "bs", "ca", "cs", "cy", "da", "de", "el", "en", "es", "et", "eu", "fa", "fi", "fo", "fr", "gl", "gu", "ha", "haw", "he", "hi", "hr", "ht", "hu", "hy", "id", "is", "it", "ja", "jw", "ka", "kk", "km", "kn", "ko", "la", "lb", "ln", "lo", "lt", "lv", "mg", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "ne", "nl", "nn", "no", "oc", "pa", "pl", "ps", "pt", "ro", "ru", "sa", "sd", "si", "sk", "sl", "sn", "so", "sq", "sr", "su", "sv", "sw", "ta", "te", "tg", "th", "tk", "tl", "tr", "tt", "uk", "ur", "uz", "vi", "yi", "yo", "zh"

Example

"en"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.model`

Name of the voice model to use.

Check the 2.0.0 release notes for possible values.

Type: string

Default

"tiny-int8"

Example

"Systran/faster-distil-whisper-small.en"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.faster-whisper.servers.<name>.uri`

URI to bind the wyoming server to.

Type: string matching the pattern ^(tcp|unix)://.*$

Example

"tcp://0.0.0.0:10300"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/faster-whisper.nix

`services.wyoming.openwakeword.customModelsDirectories`

Paths to directories with custom wake word models (*.tflite model files).

Type: list of path

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.enable`

Whether to enable Wyoming openWakeWord server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.extraArgs`

Extra arguments to pass to the server commandline.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.package`

The wyoming-openwakeword package to use. Type: package

Default

pkgs.wyoming-openwakeword

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.preloadModels`

List of wake word models to preload after startup.

Type: list of string

Default

["ok_nabu"]

Example

["alexa""hey_jarvis""hey_mycroft""hey_rhasspy""ok_nabu"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.threshold`

Activation threshold (0-1), where higher means fewer activations.

See trigger level for the relationship between activations and wake word detections.

Type: floating point number

Default

0.5

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.triggerLevel`

Number of activations before a detection is registered.

A higher trigger level means fewer detections.

Type: signed integer

Default

1

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.openwakeword.uri`

URI to bind the wyoming server to.

Type: string matching the pattern ^(tcp|unix)://.*$

Default

"tcp://0.0.0.0:10400"

Example

"tcp://192.0.2.1:5000"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/openwakeword.nix

`services.wyoming.piper.package`

The wyoming-piper package to use. Type: package

Default

pkgs.wyoming-piper

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers`

Attribute set of piper instances to spawn.

Type: attribute set of (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.enable`

Whether to enable Wyoming Piper server. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.extraArgs`

Extra arguments to pass to the server commandline.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.lengthScale`

Phoneme length value.

Type: floating point number

Default

1.0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.noiseScale`

Generator noise value.

Type: floating point number

Default

0.667

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.noiseWidth`

Phoneme width noise value.

Type: floating point number

Default

0.333

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.piper`

The piper-tts package to use. Type: package

Default

pkgs.piper-tts

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.speaker`

ID of a specific speaker in a multi-speaker model.

Type: unsigned integer, meaning >=0

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.uri`

URI to bind the wyoming server to.

Type: string matching the pattern ^(tcp|unix)://.*$

Example

"tcp://0.0.0.0:10200"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.piper.servers.<name>.voice`

Name of the voice model to use. See the following website for samples: https://rhasspy.github.io/piper-samples/

Type: string

Example

"en-us-ryan-medium"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/piper.nix

`services.wyoming.satellite.area`

Area to the satellite.

Type: null or string

Default

null

Example

"Kitchen"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.enable`

Whether to enable Wyoming Satellite. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.extraArgs`

Extra arguments to pass to the executable.

Check wyoming-satellite --help for possible options.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.group`

Group to run wyoming-satellite under.

Type: string

Default

"users"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.microphone.autoGain`

Automatic gain control in dbFS, with 31 being the loudest value. Set to 0 to disable.

Type: integer between 0 and 31 (both inclusive)

Default

5

Example

15

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.microphone.command`

Program to run for audio input.

Type: string

Default

"arecord -r 16000 -c 1 -f S16_LE -t raw"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.microphone.noiseSuppression`

Noise suppression level with 4 being the maximum suppression, which may cause audio distortion. Set to 0 to disable.

Type: integer between 0 and 4 (both inclusive)

Default

2

Example

3

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.name`

Name of the satellite.

Type: string

Default

config.networking.hostName

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.package`

The wyoming-satellite package to use. Type: package

Default

pkgs.wyoming-satellite

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.sound.command`

Program to run for sound output.

Type: null or string

Default

"aplay -r 22050 -c 1 -f S16_LE -t raw"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.sounds.awake`

Path to audio file in WAV format to play when wake word is detected.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.sounds.done`

Path to audio file in WAV format to play when voice command recording has ended.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.uri`

URI where wyoming-satellite will bind its socket.

Type: string

Default

"tcp://0.0.0.0:10700"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.user`

User to run wyoming-satellite under.

Type: string

Example

"alice"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix

`services.wyoming.satellite.vad.enable`

Whether to enable voice activity detection.

Enabling will result in only streaming audio, when speech gets detected.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/wyoming/satellite.nix