Porcupine Wake Word
Go Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• Raspberry Pi (3, 4, 5)

Requirements

• Picovoice Account & AccessKey
• Go 1.16+
• Windows only: a gcc compiler like Mingw in $PATH

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Download and install Go language.

2. Install the Porcupine Wake Word Go Package using the Go CLI:

go get github.com/Picovoice/porcupine/binding/go/v2

Usage

Create an instance of Porcupine Wake Word that detects the included built-in wake words porcupine and bumblebee using the Porcupine struct:

import . "github.com/Picovoice/porcupine/binding/go"

porcupine := Porcupine{
    AccessKey: "${ACCESS_KEY}",
    BuiltInKeywords: []BuiltInKeyword{PORCUPINE, BUMBLEBEE}}
err := porcupine.Init()

Pass in frames of audio to the .Process function:

func getNextAudioFrame() []int16 {
    // ..
}

for {
   audioFrame := getNextAudioFrame()
   keywordIndex, err := porcupine.Process(audioFrame)
   if keywordIndex == 0 {
      // detected `porcupine`
   } else if keywordIndex == 1 {
      // detected `bumblebee`
   }
}

Release resources explicitly when done with Porcupine:

porcupine.Delete()

Custom Keywords

Create custom keywords using the Picovoice Console. Download the custom wake word file (.ppn) and create an instance of Porcupine Wake Word using the KeywordPaths parameter:

porcupine := Porcupine{
    AccessKey: "${ACCESS_KEY}",
    KeywordPaths: []string{"${KEYWORD_FILE_PATH}"}}
err := porcupine.Init()

Non-English Languages

Use the corresponding model file (.pv) to detect non-English wake words. The model files for all supported languages are available on the Porcupine Wake Word GitHub repository.

Pass in the model file using the ModelPath parameter to change the detection language:

porcupine := Porcupine{
    AccessKey: "${ACCESS_KEY}",
    KeywordPaths: []string{"${KEYWORD_FILE_PATH}"},
    ModelPath: "${MODEL_FILE_PATH}"}
err := porcupine.Init()

Demo

For the Porcupine Wake Word Go SDK, we offer demo applications that demonstrate how to use the Wake Word engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

Clone the Porcupine Wake Word GitHub Repository:

git clone --recurse-submodules https://github.com/Picovoice/porcupine.git

Usage

Use the -h flag to see the usage options for the demo:

cd porcupine/demo/go
go run micdemo/porcupine_mic_demo.go -h

Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword porcupine:

go run micdemo/porcupine_mic_demo.go -access_key "${ACCESS_KEY}" -keywords porcupine

For more information on our Porcupine Wake Word demos for Go, head over to our GitHub repository.

Resources