go-kef-w2

CLI, library and apps (planed) for controlling KEFs W2 platform based speakers over the network.

Command line tool

Installation

General

Grap a version for your OS from the releases page.

macOS

Install with Homebrew:

brew install hilli/tap/kefw2

Linux

Install with Homebrew:

brew install hilli/tap/kefw2

Windows

Install with Scoop

In a Windows Powershell window:

# Install Scoop if it's not already on your system
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
scoop install git
# Add repo for kefw2
scoop bucket add hilli https://github.com/hilli/scoop-bucket.git
# Install kefw2
scoop install hilli/go-kef-w2

Note that speaker discovery might not work in Windows.

Usage

Setup the speakers

# Auto discovery
kefw2 config speaker discover --save
# Manually add a speaker
kefw2 config speaker add 10.0.0.149

If you only have one set of speakers, then that will be the default, otherwise configure that with

kefw2 config speaker default <name or IP>

If you want to control a speaker that is not the default use the -s global flag. Eksample:

kefw2 -s 10.0.0.93 status

Get status of the default speaker

kefw2 status

Get detailed info

kefw2 info

Get volume

kefw2 volume
# or
kefw2 vol

Set volume, 35%

kefw2 vol 35

Skip to next track if in wifi mode

kefw2 next

Select source

kefw2 source wifi
# or just display current source
kefw2 source

Play and pause in wifi mode

kefw2 play
kefw2 pause

Turn the speakers off

kefw2 off

Backup the current EQ Profile

kefw2 config eq_profile > my_profile.json

Set the max volume limit

kefw2 config maxvol 65

All with tab completion available of the options, where applicable.

Plan

• Set volume
• Mute/unmute
• Select source
• Get status
• Turn on/off
• Track next/previous
• Discover speakers automatically
• Display cover art in ASCII (wifi media)
• Backup speaker settings/eq profiles to file
• Restore speaker settings/eq profiles to file
• Play Podcasts/Radio
• Play titles from built-in music streaming services (Amazon Music, Deezer, Qobus, Spotify, Tidal)

Library

Installation

go get github.com/hilli/go-kef-w2/kefw2

Basic Usage

package main

import (
  "context"
  "fmt"
  "log"
  "time"

  "github.com/hilli/go-kef-w2/kefw2"
)

func main() {
  // Create a speaker connection
  speaker, err := kefw2.NewSpeaker("10.0.0.93")
  if err != nil {
    log.Fatal(err)
  }

  // Print speaker info
  fmt.Printf("Name: %s\n", speaker.Name)
  fmt.Printf("Model: %s\n", speaker.Model)
  fmt.Printf("Firmware: %s\n", speaker.FirmwareVersion)
  fmt.Printf("MAC: %s\n", speaker.MacAddress)

  // Control volume
  volume, _ := speaker.GetVolume()
  fmt.Printf("Volume: %d\n", volume)
  speaker.SetVolume(30)

  // Change source
  speaker.SetSource(kefw2.SourceWiFi)
}

Configuration Options

// With custom timeout
speaker, err := kefw2.NewSpeaker("10.0.0.93",
  kefw2.WithTimeout(5*time.Second),
)

// With custom HTTP client
customClient := &http.Client{Timeout: 10 * time.Second}
speaker, err := kefw2.NewSpeaker("10.0.0.93",
  kefw2.WithHTTPClient(customClient),
)

Context Support

All operations have context-aware variants for cancellation and timeout control:

ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()

volume, err := speaker.GetVolumeContext(ctx)
if err != nil {
  log.Fatal(err)
}

Speaker Discovery

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

speakers, err := kefw2.DiscoverSpeakers(ctx, 5*time.Second)
if err != nil {
  log.Fatal(err)
}

for _, s := range speakers {
  fmt.Printf("Found: %s at %s\n", s.Name, s.IPAddress)
}

Event Streaming

Subscribe to real-time speaker events:

client, err := speaker.NewEventClient()
if err != nil {
  log.Fatal(err)
}

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

go client.Start(ctx)

for event := range client.Events() {
  switch e := event.(type) {
  case *kefw2.VolumeEvent:
    fmt.Printf("Volume changed: %d\n", e.Volume)
  case *kefw2.SourceEvent:
    fmt.Printf("Source changed: %s\n", e.Source)
  case *kefw2.PlayerDataEvent:
    fmt.Printf("Now playing: %s - %s\n", e.Artist, e.Title)
  }
}

Player

UI for controlling the speakers, show whats playing etc.

The idea is to create a Fyne App that will let you select inputs, show whats playing etc. My own needs is to have a Raspberry Pi with a touch screen interact with the speakers and not least control the brigtness of the screen.

Plan

• Cross compilation of Fyne apps
• Input selection buttons
• Volume/mute controll
• Play/pause button for available targets
• Display artwork and track info in wifi mode
• ?? Streaming page, playing Tidal, Qobus, podcasts, radio

Web interface & HomeKit HUB

Not there yet.

Plan

• Turn on/off
• Set volume
• Mute/unmute
• Select source
• Status page, refreshing, display artwork and track info in wifi mode (web)
• Settings page, editing (web)
• Backup/restore settings to file download (web)
• ?? Streaming page, playing Tidal, Qobus, podcasts, radio, etc (web)

License

MIT License