Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/quadule/knobby

A little Spotify remote to remind you that there's a lot of music out there.
https://github.com/quadule/knobby

3d-printing arduino esp32 esp32-s3 lilygo lilygo-tdisplay-s3 music playlists remote-control spotify spotify-api spotify-connect ttgo-t-display

Last synced: 2 months ago
JSON representation

A little Spotify remote to remind you that there's a lot of music out there.

Host: GitHub
URL: https://github.com/quadule/knobby
Owner: quadule
License: mit
Created: 2019-08-27T19:15:26.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-03-10T01:58:22.000Z (4 months ago)
Last Synced: 2024-03-11T02:49:12.747Z (4 months ago)
Topics: 3d-printing, arduino, esp32, esp32-s3, lilygo, lilygo-tdisplay-s3, music, playlists, remote-control, spotify, spotify-api, spotify-connect, ttgo-t-display
Language: C
Homepage:
Size: 12.3 MB
Stars: 156
Watchers: 11
Forks: 13
Open Issues: 1
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Code of conduct: code_of_conduct.md

Lists

awesome-esp - Knobby - A handheld Spotify remote that encourages you to explore unfamiliar music. (Projects / Music and Audio)

README

# Knobby: a little remote for Spotify and more

[![Latest release](https://img.shields.io/github/v/release/quadule/knobby?logo=github)](https://github.com/quadule/knobby/releases/latest)
[![Build status](https://github.com/quadule/knobby/actions/workflows/main.yml/badge.svg)](https://github.com/quadule/knobby/actions/workflows/main.yml)
![Downloads](https://img.shields.io/github/downloads/quadule/knobby/total?color=orange&logo=github)

## Knobby is the remote control made for discovering music and rediscovering your own collection; _your one-click cure for musical boredom_.

example of playing a random genre with a Knobby

### One knob controls your musical universe

* Spin and explore **6,000+** microgenre and country playlists from [everynoise.com](https://everynoise.com)
* Or hold the knob to randomize — **put all of Spotify on shuffle!**
* Enjoy fast access to your own playlists and liked songs
* See what's playing and control playback on any Spotify Connect device

### Untether music from your phone

Always ready, free from distractions, and designed to be shared: Knobby is the perfect partner to any smart speaker. Show off your meticulously curated collection in your home, or pass it around a party and let your guests take control.

### Make it yours(elf)

Knobby’s minimal design is easy to build and customize, with open source firmware based on the Arduino framework. The 3D printed enclosure is designed around a common ESP32 development board and a single rotary encoder. You can [buy one from me](https://www.tindie.com/products/milowinningham/knobby-a-little-remote-for-spotify-and-more/) to support this project, or [build one yourself](#build-your-own).

### See it in action

https://user-images.githubusercontent.com/15299/221440478-d7a543d5-4e82-4146-b03c-dc35ea191b35.mp4

### Read more

- [**Hackaday**: Small Spotify Remote Broadens Musical Horizons](https://hackaday.com/2020/10/21/small-spotify-remote-broadens-musical-horizons/)
- [**Hackster**: Knobby Is a Unique Handheld Remote That Controls Spotify Connect Devices](https://www.hackster.io/news/knobby-is-a-unique-handheld-remote-that-controls-spotify-connect-devices-e3428e100ab6)
- [**Tindie Blog**: Knobby! Explore Music in a New Way](https://blog.tindie.com/2022/11/knobby-explore-music-in-a-new-way/)

## Usage

* Turn the knob to navigate between menu items.
* Click the knob to select or play something.
* Push in and rotate the knob to switch menus.
* Hold the knob for couple seconds for a random genre, country, or playlist from the last open menu.
- Keep holding the knob until the progress bar reaches the end to play immediately.
- Release the knob before the progress bar reaches the end to keep browsing.
* When browsing genres, double click the knob to switch sort modes: _name_ (the default alphabetical order), _suffix_, _ambience_, _modernity_, and _popularity_.
* When playing something, double click the knob to skip to the next track.

### Requirements

* **Spotify Premium** is required — Knobby will not function properly on a free account.
* An always-on playback Spotify Connect device is highly recommended. Knobby can control any Spotify app or device, but a smart speaker or home audio system usually works best. If using a mobile app or some devices such as Chromecast, playback must be started before it can be controlled though Knobby.

## Build your own

### Get the parts

* [LilyGO TTGO T-Display ESP32 board with ST7789 240x135 display](https://www.aliexpress.com/item/33048962331.html)
* [Bourns PEC11R-4215F-S0024 rotary encoder](https://www.mouser.com/ProductDetail/Bourns/PEC11R-4215F-S0024?qs=Zq5ylnUbLm5lAqmKF80wzQ%3D%3D)
* [MakerFocus 1100mAh LiPo battery](https://www.makerfocus.com/products/makerfocus-3-7v-1100mah-lithium-rechargeable-battery-1s-3c-lipo-battery-with-protection-board-pack-of-4)
* [3D printed case and knob](https://www.printables.com/model/156363)

#### Other rotary encoders

If you use a different rotary encoder in your build and find that the knob must be turned two clicks to move one item through the menu, you can configure the encoder’s pulse count.

1. Edit `data/data.json` and replace `null` with `2` for `pulseCount`.
2. Run `pio run --target uploadfs` to upload the configuration file.

### Wire it up

wiring diagram of rotary encoder with t-display board

1. Connect the rotary encoder A and B pins to GPIO pins 12 and 13.
2. Connect one pole of the switch to GPIO pin 15.
3. Connect other pole of the switch and the encoder’s remaining middle pin to ground.

soldering rotary encoder’s wires to the circuit board

### Install the firmware
#### ➡️ [setup.knobby.net](https://setup.knobby.net)

The [Knobby setup tool](https://setup.knobby.net) can flash the latest firmware and configure wifi credentials over USB (requires Google Chrome or Microsoft Edge for Web Serial API support).

Alternatively, you can download [the latest release](https://github.com/quadule/knobby/releases/latest) and flash it yourself. You will need to have Python and [esptool.py](https://github.com/espressif/esptool) installed. With the USB cable connected, run the flash script in the directory of the extracted firmware zip:

- on Linux or Mac: `./flash.sh`
- on Windows: `flash.bat`

### Compile from source

1. Edit `data/data.json` and enter your wifi network information (if you want; it can also be configured later)
2. Build and upload with [PlatformIO](https://platformio.org/): `pio run && pio run --target upload && pio run --target uploadfs`

If data.json is not configured or there is a problem connecting to your network, knobby will enter configuration mode. Join the temporary wifi network displayed on screen and wait for the configuration portal to appear or visit http://192.168.4.1. Enter your wifi network information, then switch back to your normal wifi network and visit http://knobby.local to continue.

## License

All code is released under the MIT license. The case design is released under the [CC-BY-NC 4.0 license](https://creativecommons.org/licenses/by-nc/4.0/).

## Credits

* Spotify playlists and inspiration from Glenn McDonald's wonderful [Every Noise at Once](https://everynoise.com).
* Icons from [Google Material](https://material.io/resources/icons/) and [Typicons](https://www.s-ings.com/typicons/).