Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
hilli committed Jan 15, 2024
1 parent 9c5f241 commit 409add3
Showing 1 changed file with 92 additions and 20 deletions.
112 changes: 92 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Library, CLI and Apps for controlling KEFs W2 platform based speakers over the network.

## Usage
## Library

### Usage

```go
package main
Expand Down Expand Up @@ -30,10 +32,6 @@ func main() {
}
```

## License

MIT License

## Command line tool

### Plan
Expand All @@ -43,35 +41,109 @@ MIT License
- [x] Select source
- [x] Get status
- [x] Turn on/off
- [ ] Backup/restore settings to file
- [ ] Get settings
- [ ] Set settings
- [x] Track next/previous
- [x] Discover speakers automatically
- [ ] Play Podcasts/Radio
- [ ] Play titles from built-in music streaming services (Tidal, Qobus)
- [ ] Backup/restore speaker settings/eq profiles to file

### Usage

```bash
Setup the speakers

```shell
kefw2 config speaker discover --save
```

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

```shell
kefw2 config speaker default <name or IP>
```

If you want to controll a speaker that is not the default use the `-s` global flag

```shell
kefw2 -s 10.0.0.93 status
```

Get status of the default speaker

```shell
kefw2 status
```

Get volume

```shell
kefw2 volume
# or
kefw2 vol
```

Set volume, 35%

```shell
kefw2 vol 35
```

Skip to next track if in wifi mode

```shell
kefw2 next
```

Select source

```shell
kefw2 source wifi
# or just display current source
kefw2 source
```

Play and pause in wifi mode

```shell
kefw2 play
kefw2 pause
```

Turn the speakers off

```shell
kefw2 off
```

All with tab completion available of the options.

## Player

UI for controlling the speakers, show whats playing etc.

### 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 (web)
- [ ] 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 (web)
- [ ] ?? Streaming page, playing Tidal, Qobus, podcasts, radio (web)

## Player

UI for controlling the speakers, show whats playing etc.

### Plan
## License

- [x] Cross compilation of Fyne apps
- [ ] Input selection buttons
- [ ] Volume/mute controll
- [ ] Play/pause button for available targets
MIT License

0 comments on commit 409add3

Please sign in to comment.