goPorcupine — Go Quick Start

Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • BeagleBone
  • NVIDIA Jetson Nano
  • Raspberry Pi (2, 3, 4)

Requirements

Picovoice Account & AccessKey

  1. Login or signup for a free account on the Picovoice Console.
  2. Go to the AccessKey tab to create one or use an existing AccessKey. Be sure to keep your AccessKey secret.

Quick Start

Setup

  1. Download and install Go.

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

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

Usage

Create an instance of Porcupine 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 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 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 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 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 demos for Go, head over to our GitHub repository.

Resources

Packages

API

GitHub

Benchmark


Issue with this doc? Please let us know.