Added README; cleaned up the repo
This commit is contained in:
33 files changed
+270
-9330
No files matched your search
@@ -1,3 +1,127 @@
|
||||
# beatglow
|
||||
# BeatGlow
|
||||
|
||||
BeatGlow is a music visualiser for embedded audio players
|
||||
Visualizer for audiophile streamers (or enthousiasts alike).
|
||||
|
||||
## State of the project
|
||||
|
||||
Work in progress!
|
||||
|
||||
## Features
|
||||
|
||||
### Main display
|
||||
|
||||
Showing what track is currently playing.
|
||||
|
||||
Features:
|
||||
- Audio format, bitrate and output sample rate display
|
||||
- Track elapsed and duration
|
||||
- Track album art
|
||||
- Spectrum analyzer / Waterfall display of the track playing
|
||||
|
||||

|
||||
|
||||
### Settings
|
||||
|
||||
Live adjust settings from the rotary dail.
|
||||
|
||||

|
||||
|
||||
## Setup
|
||||
|
||||
Minimal requirements:
|
||||
- Linux Computer (Raspberry Pi 3B+)
|
||||
- Supported display
|
||||
|
||||
### Setup Raspberry Pi & SSD1322 256x64 OLED display
|
||||
|
||||
Requirements:
|
||||
- Raspberry Pi 3B+/4B+
|
||||
- SSD1322 OLED Display 3.12" 256x64
|
||||
- Display purchase options:
|
||||
- [AliExpress](https://s.click.aliexpress.com/e/_onJsYxJ) [^1]
|
||||
- [AudioPhonics.fr](https://www.audiophonics.fr/en/screens-vu-meters/white-spi-iic-256x64-oled-312-screen-p-14604.html)
|
||||
|
||||
|
||||
#### Wiring
|
||||
|
||||
Wiring the display is as follows, looking at the OLED display connector from the back (pin 1 on the top left, pin 16 on the bottom right):
|
||||
|
||||

|
||||
|
||||
| Wire | Function | Raspberry Pi | Display |
|
||||
| -------------------------------- | --------- | --------------- | ------- |
|
||||
|  | Ground | Pin 20 (GND) | Pin 1 |
|
||||
|  | 3.3V | Pin 17 (3.3V) | Pin 2 |
|
||||
|  | SPI Clock | Pin 23 (GPIO11) | Pin 4 |
|
||||
|  | SPI Data | Pin 19 (GPIO10) | Pin 5 |
|
||||
|  | SPI D/C | Pin 18 (GPIO24) | Pin 14 |
|
||||
|  | SPI Reset | Pin 22 (GPIO25) | Pin 15 |
|
||||
|  | SPI C/E | Pin 24 (GPIO8) | Pin 16 |
|
||||
|
||||
#### Configuration
|
||||
|
||||
The display configuration in `beatglow.conf` is as follows:
|
||||
|
||||
```ini
|
||||
# Display hardware configuration.
|
||||
display {
|
||||
# Target frame rate, actual frame rate depends on hardware options.
|
||||
fps = 25
|
||||
|
||||
# Main display is where all the magic happens.
|
||||
main {
|
||||
# Type of display
|
||||
type = "ssd1322"
|
||||
size = "256x64"
|
||||
|
||||
# Mode (spi or i2c)
|
||||
mode = "spi"
|
||||
|
||||
# SPI settings
|
||||
port = "spi0.0"
|
||||
reset = "GPIO25"
|
||||
dc = "GPIO24"
|
||||
bl = "GPIO23"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Setup Raspberry Pi & ST7789 170x320 IPS display
|
||||
|
||||
Requirements:
|
||||
- Raspberry Pi 3B+/4B+
|
||||
- ST7735/ST8889 IPS display
|
||||
- Display purchase options:
|
||||
- [AliExpress](https://s.click.aliexpress.com/e/_onuTZPb) [^1]
|
||||
- [Waveshare](https://www.waveshare.com/1.9inch-lcd-module.htm)
|
||||
|
||||
#### Configuration
|
||||
|
||||
The display configuration in `beatglow.conf` is as follows:
|
||||
|
||||
```ini
|
||||
|
||||
display {
|
||||
# Target frame rate, actual frame rate depends on hardware options.
|
||||
fps = 25
|
||||
|
||||
# Main display is where all the magic happens.
|
||||
main {
|
||||
# Type of display
|
||||
type = "st7789" # or st7735
|
||||
size = "320x130"
|
||||
rotate = "left"
|
||||
|
||||
# Mode (spi or i2c)
|
||||
mode = "spi"
|
||||
|
||||
# SPI settings
|
||||
port = "spi0.0"
|
||||
reset = "GPIO25"
|
||||
dc = "GPIO24"
|
||||
bl = "GPIO23"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
[^1]: Affiliate links, by clicking them and making an order there is a small kick back for me, which allows me to order parts for testing. There is usually no additional costs for the purchaser.
|
||||
Reference in new issue
Block a user