Skip to content

Commit 4257302

Browse files
Merge branch 'main' into fix/build_images
2 parents 1d53645 + d28e123 commit 4257302

4 files changed

Lines changed: 12 additions & 24 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
Ready to use Raspberry Pi Images with Docker for projects like [linux-voice-assistant](https://github.com/OHF-Voice/linux-voice-assistant) or [docker-snapcast](https://github.com/florian-asche/docker-snapcast).
66

7-
87
## Overview
98

109
PiCompose uses the official [pi-gen](https://github.com/RPi-Distro/pi-gen) tool from Raspberry Pi to create a customized Raspberry Pi OS image.
@@ -24,7 +23,6 @@ The image is configured to:
2423

2524
This repository contains fully prepared images for specific voice hardware of Homeassistant with all needed drivers.
2625

27-
2826
## Features
2927

3028
- Automated build of a customized Raspberry Pi OS image using GitHub Actions
@@ -34,7 +32,6 @@ This repository contains fully prepared images for specific voice hardware of Ho
3432
- Image prepared for audio usage with the pipewire server
3533
- Prebuild images with drivers for various devices
3634

37-
3835
## Usage
3936

4037
### Hardware
@@ -57,19 +54,20 @@ Here is a Overview for the specific images of each hardware:
5754
You can burn the image to your sd card with the [Raspberry Pi Imager tool](https://www.raspberrypi.com/software/). You can set wifi credentials, ssh public keys and other settings before you burn the image to your sd card. In order to use the feature where you can change the settings in the `Raspberry Pi Imager >=v2.5.0` you need to set a custom image repository.
5855

5956
Windows
60-
``` sh
57+
58+
```sh
6159
"C:\Program Files (x86)\Raspberry Pi Imager\rpi-imager.exe" --repo https://github.com/florian-asche/PiCompose/releases/download/rpi-imager-json/rpi-imager.json
6260
```
6361

6462
Linux
6563

66-
``` sh
64+
```sh
6765
rpi-imager --repo https://github.com/florian-asche/PiCompose/releases/download/rpi-imager-json/rpi-imager.json
6866
```
6967

7068
You can also put the [URL](https://github.com/florian-asche/PiCompose/releases/download/rpi-imager-json/rpi-imager.json) in Settings - Image Repository - Use own URL.
7169

72-
If you dont want to use the Raspberry Pi Imager tool you can also [download](https://github.com/florian-asche/PiCompose/releases) the image and configure keyboard, timezone and wifi credentials with the `raspi-config` tool.
70+
If you dont want to use the Raspberry Pi Imager tool you can also [download](https://github.com/florian-asche/PiCompose/releases) the image and configure keyboard, timezone and wifi credentials with the `raspi-config` tool.
7371

7472
### Configuration
7573

@@ -85,7 +83,7 @@ You can also add your own docker-compose projects to the system:
8583

8684
The configuration file is named `picompose.conf` and is located in specific application directories.
8785

88-
``` ini
86+
```ini
8987
# Disable this deployment
9088
DISABLED=false
9189

@@ -132,7 +130,6 @@ The process can take some time, since it downloads images from the internet!
132130

133131
Snapcast is disabled by default. You can change that in the `picompose.conf` and reboot.
134132

135-
136133
## Development
137134

138135
See [DEVELOPMENT.md](DEVELOPMENT.md) for information on the development and build process.
@@ -142,8 +139,6 @@ See [DEVELOPMENT.md](DEVELOPMENT.md) for information on the development and buil
142139
- [docker-snapcast](https://github.com/florian-asche/docker-snapcast) - A Docker image for Snapcast server and client, providing multi-room audio streaming capabilities
143140
- [linux-voice-assistant](https://github.com/OHF-Voice/linux-voice-assistant) - A remote voice satellite implementation using the ESPHome protocol
144141

145-
146142
## License
147143

148144
This project is released under the [BSD-3-Clause License](LICENSE).
149-

docs/hardware_2mic_v1.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
<img src="respeaker_2michats.webp" alt="ReSpeaker 2-Mics Pi HAT" style="width: 300px; height: auto;"></img>
44

55
Features:
6-
- Support the Raspberry Pi 3B,4B
76
- Two microphones (Mic L and Mic R)
87
- Two Grove connectors
98
- One User-defined button
@@ -15,15 +14,14 @@ Features:
1514

1615
### Base:
1716

18-
- [Raspberry Pi Zero 2 W](https://amzn.to/3M0G4hC)
17+
- Raspberry Pi Zero 2 WH (currently no link) or if you can solder the pins yourself [Raspberry Pi Zero 2 W](https://amzn.to/3M0G4hC)
1918
- [SD-Card](https://amzn.to/4qfx06l)
2019
- [US MicroUSB Power Supply](https://amzn.to/4c52mt3)
21-
- [Cable for Speaker](https://amzn.to/3ZvU0Dz)
2220

2321
### ReSpeaker 2-Mics Pi HAT v1
2422

2523
- [ReSpeaker 2Mic HAT](https://wiki.keyestudio.com/Ks0314_keyestudio_ReSpeaker_2-Mic_Pi_HAT_V1.0)
26-
24+
- [Cable for Speaker](https://amzn.to/3ZvU0Dz)
2725

2826
## Additional information:
2927

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,28 @@ Features:
99
- Interference Cancellation (IC)
1010
- Voice-to-Noise Ratio (VNR)
1111

12-
1312
## Order
1413

1514
### Base:
1615

17-
- [Raspberry Pi Zero 2 W](https://amzn.to/3M0G4hC)
16+
- [Raspberry Pi 3 B+](https://amzn.to/3P0bwhC)
1817
- [SD-Card](https://amzn.to/4qfx06l)
1918
- [US MicroUSB Power Supply](https://amzn.to/4c52mt3)
20-
- [Cable for Speaker](https://amzn.to/3ZvU0Dz)
2119

2220
### Mic Array (ReSpeaker Lite Board):
2321

2422
- [ReSpeaker Lite](https://www.seeedstudio.com/ReSpeaker-Lite-p-5928.html?srsltid=AfmBOopODKrejEe7WIXSLV5fjLuhhK8PO-AXG3WnDI1N1pwBu-PTWQHf)
2523
- [USB-Cable](https://de.aliexpress.com/item/1005004792246478.html?spm=a2g0o.order_list.order_list_main.5.4dac5c5fKkDzIc&gatewayAdapt=glo2deu)
24+
- [Cable for Speaker](https://amzn.to/3ZvU0Dz)
2625

2726

2827
## Important information:
2928

30-
### Workaround:
31-
32-
In connection with the Raspberry Pi Zero 2W there is a bug in RPI-OS where the board stops working after 7 or 8 sound outputs with a reconnect to the audio card. I implemented a workaround for that where a constant not hearable output is played to the card.
33-
3429
### Firmware:
3530

3631
In order to use this board with the Raspberry Pi Zero 2W you need to flash the usb-firmware. <br>
3732
More information in the official Seeedstudio Wiki.<br>
38-
I am currently running the [respeaker_lite_usb_dfu_firmware_v2.0.7.bin](https://github.com/respeaker/ReSpeaker_Lite/blob/master/xmos_firmwares/respeaker_lite_usb_dfu_firmware_v2.0.7.binhttps:/)
33+
I am currently running the [respeaker_lite_usb_dfu_firmware_v2.0.7.bin](https://github.com/respeaker/ReSpeaker_Lite/blob/master/xmos_firmwares/respeaker_lite_usb_dfu_firmware_v2.0.7.bin)
3934

4035

4136
## Additional information:

docs/hardware_sattelite1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ What you need to buy:
1919

2020
### Base:
2121

22-
- [Raspberry Pi Zero 2 W](https://amzn.to/3M0G4hC)
22+
- Raspberry Pi Zero 2 WH (currently no link) or if you can solder the pins yourself [Raspberry Pi Zero 2 W](https://amzn.to/3M0G4hC)
2323
- [SD-Card](https://amzn.to/4qfx06l)
2424

2525
### Satellite1 HAT Board:
@@ -32,7 +32,7 @@ What you need to buy:
3232

3333
- [Whole Speaker kit](https://futureproofhomes.net/products/satellite1-smart-speaker-enclosure-kit)
3434

35-
Or if you want to print it yourself:
35+
Or if you want to build and 3D-Print it yourself:
3636

3737
- [Speaker](https://amzn.to/4k9gkfu) or [Aliexpress](https://de.aliexpress.com/item/1005011560142502.html?spm=a2g0o.productlist.main.3.33c9JJacJJacEB&algo_pvid=64814943-53f2-4063-858b-24b8bff7bd47&algo_exp_id=64814943-53f2-4063-858b-24b8bff7bd47-2&pdp_ext_f=%7B%22order%22%3A%22-1%22%2C%22eval%22%3A%221%22%2C%22fromPage%22%3A%22search%22%7D&pdp_npi=6%40dis%21EUR%217.78%213.89%21%21%2162.89%2131.44%21%402103868817699707030983290ea297%2112000055921741746%21sea%21DE%21797676231%21X%211%210%21n_tag%3A-29919%3Bd%3A64670a7c%3Bm03_new_user%3A-29895&curPageLogUid=uNvseW668v4i&utparam-url=scene%3Asearch%7Cquery_from%3A%7Cx_object_id%3A1005011560142502%7C_p_origin_prod%3A)
3838
- Optional: [Alternative Speaker](https://amzn.to/3ZIgnFA)

0 commit comments

Comments
 (0)