You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update hardware documentation and README (#48)
* docs: update hardware documentation and README
- Rename `hardware_respeaker-lite.md` to `hardware_respeaker_lite.md`
- Update hardware compatibility in `hardware_2mic_v1.md` and `hardware_sattelite1.md` to include Raspberry Pi Zero 2 WH
- Refine formatting and text in `README.md`
- Improve clarity in `hardware_sattelite1.md` regarding 3D printing instructions
* docs(hardware): remove Raspberry Pi Zero 2WH references and workarounds
- Remove Raspberry Pi Zero 2WH support from 2-mic v1 documentation
- Remove obsolete workaround section for Raspberry Pi Zero 2W in ReSpeaker Lite documentation
- Clean up whitespace in hardware files
Copy file name to clipboardExpand all lines: README.md
+19-21Lines changed: 19 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,7 @@
2
2
3
3
[](https://github.com/florian-asche/PiCompose/actions/workflows/build-image.yml)[](https://github.com/florian-asche/PiCompose/releases)[](https://github.com/florian-asche/PiCompose/blob/main/LICENSE)[](https://github.com/florian-asche/PiCompose/commits)
4
4
5
-
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) and soon more.
6
-
5
+
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).
7
6
8
7
## Overview
9
8
@@ -18,13 +17,12 @@ The image is configured to:
18
17
5. Set audio volume to 100%
19
18
6. Set hostname
20
19
7. Search for Docker Compose files in a special directory on the main partition
21
-
💡 **Note:** If you use the Linux-Voice-Assistant Image LVA and Snapcast will be included in the project directory.
20
+
💡 **Note:** If you use the Linux-Voice-Assistant Image LVA and Snapcast will be included in the project directory.
22
21
8. Automatically deploy each Docker Compose project found
23
22
9. Optionally set up regular re-deployments via Crontab
24
23
25
24
This repository contains fully prepared images for specific voice hardware of Homeassistant with all needed drivers.
26
25
27
-
28
26
## Features
29
27
30
28
- 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
34
32
- Image prepared for audio usage with the pipewire server
35
33
- Prebuild images with drivers for various devices
36
34
37
-
38
35
## Usage
39
36
40
37
### Hardware
@@ -45,34 +42,38 @@ There is a seperated page for the supported hardware. You can find the link to i
45
42
46
43
Here is a Overview for the specific images of each hardware:
|**Base Image**| If you use other hardware... | • Docker & Docker Compose (piCompose)<br>• Automatic Docker Compose deployment<br>• Pipewire Audio Server<br>• SSH enabled (pi User) |
51
-
|**[Sattelite1](docs/hardware_sattelite1.md)**| <imgsrc="docs/sattelite1-hat.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Base Image<br>• Satellite1 Hat Driver<br><br><spanstyle="color: red;">Image is currently work in progress!</span> |
52
-
|**[Sattelite1](docs/hardware_sattelite1.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/sattelite1-hat.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Satellite1 Hat Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant<br><br><spanstyle="color: red;">Image is currently work in progress!</span> |
53
-
|**[ReSpeaker 2-Mic HAT v1](docs/hardware_2mic_v1.md)**| <imgsrc="docs/respeaker_2michats.webp"alt="ReSpeaker 2-Mics Pi HAT"style="width: 200px; height: auto;"> | • Base Image<br>• Seeed Voicecard Driver |
54
-
|**[ReSpeaker 2-Mic HAT v1](docs/hardware_2mic_v1.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/respeaker_2michats.webp"alt="ReSpeaker 2-Mics Pi HAT"style="width: 200px; height: auto;"> | • 2-Mic HAT Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• 2-Mic HAT GPIO LED Control<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant |
55
-
|**[ReSpeaker Lite](docs/hardware_respeaker_lite.md)**| <imgsrc="docs/respeaker_lite.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Base Image<br>• Audio keep-alive service<br>• Workaround for connectivity issues in combination with the Pi Zero 2W.<br><br><spanstyle="color: red;">There is a USB connectivity issue with the Pi Zero 2W. I cannot recommend this board if you want to use it with that. Use Pi3 or higher.</span> |
56
-
|**[ReSpeaker Lite](docs/hardware_respeaker_lite.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/respeaker_lite.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • ReSpeaker Lite Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant<br>• Workaround for connectivity issues in combination with the Pi Zero 2W.<br><br><spanstyle="color: red;">There is a USB connectivity issue with the Pi Zero 2W. If you want to use it with that, you need to use Pi3 or higher.</span> |
|**[Sattelite1](docs/hardware_sattelite1.md)**| <imgsrc="docs/sattelite1-hat.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Base Image<br>• Satellite1 Hat Driver<br><br><spanstyle="color: red;">Image is currently work in progress!</span> |
50
+
|**[Sattelite1](docs/hardware_sattelite1.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/sattelite1-hat.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Satellite1 Hat Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant<br><br><spanstyle="color: red;">Image is currently work in progress!</span> |
51
+
|**[ReSpeaker 2-Mic HAT v1](docs/hardware_2mic_v1.md)**| <imgsrc="docs/respeaker_2michats.webp"alt="ReSpeaker 2-Mics Pi HAT"style="width: 200px; height: auto;"> | • Base Image<br>• Seeed Voicecard Driver |
52
+
|**[ReSpeaker 2-Mic HAT v1](docs/hardware_2mic_v1.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/respeaker_2michats.webp"alt="ReSpeaker 2-Mics Pi HAT"style="width: 200px; height: auto;"> | • 2-Mic HAT Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• 2-Mic HAT GPIO LED Control<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant |
53
+
|**[ReSpeaker Lite](docs/hardware_respeaker_lite.md)**| <imgsrc="docs/respeaker_lite.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • Base Image<br>• Audio keep-alive service<br>• Workaround for connectivity issues in combination with the Pi Zero 2W.<br><br><spanstyle="color: red;">There is a USB connectivity issue with the Pi Zero 2W. Use this board with at least Raspberry PI 3.</span> |
54
+
|**[ReSpeaker Lite](docs/hardware_respeaker_lite.md)**<br>**+Linux-Voice-Assistant**<br>**+Snapcast**| <imgsrc="docs/respeaker_lite.jpg"alt="ReSpeaker Lite Board"style="width: 200px; height: auto;"> | • ReSpeaker Lite Image<br>• Linux-Voice-Assistant (OpenHomeFoundation)<br>• Snapcast MultiRoom Audio Client<br>• Pre-configured for Home Assistant<br>• Workaround for connectivity issues in combination with the Pi Zero 2W.<br><br><spanstyle="color: red;">There is a USB connectivity issue with the Pi Zero 2W. Use this board with at least Raspberry PI 3.</span> |
55
+
56
+
57
57
58
58
### Installation
59
59
60
60
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.
61
61
62
62
Windows
63
-
```sh
63
+
64
+
```sh
64
65
"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
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.
74
75
75
-
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.
76
+
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.
76
77
77
78
### Configuration
78
79
@@ -88,7 +89,7 @@ You can also add your own docker-compose projects to the system:
88
89
89
90
The configuration file is named `picompose.conf` and is located in specific application directories.
90
91
91
-
```ini
92
+
```ini
92
93
# Disable this deployment
93
94
DISABLED=false
94
95
@@ -135,7 +136,6 @@ The process can take some time, since it downloads images from the internet!
135
136
136
137
Snapcast is disabled by default. You can change that in the `picompose.conf` and reboot.
137
138
138
-
139
139
## Development
140
140
141
141
See [DEVELOPMENT.md](DEVELOPMENT.md) for information on the development and build process.
@@ -145,8 +145,6 @@ See [DEVELOPMENT.md](DEVELOPMENT.md) for information on the development and buil
145
145
-[docker-snapcast](https://github.com/florian-asche/docker-snapcast) - A Docker image for Snapcast server and client, providing multi-room audio streaming capabilities
146
146
-[linux-voice-assistant](https://github.com/OHF-Voice/linux-voice-assistant) - A remote voice satellite implementation using the ESPHome protocol
147
147
148
-
149
148
## License
150
149
151
150
This project is released under the [BSD-3-Clause License](LICENSE).
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
-
34
29
### Firmware:
35
30
36
31
In order to use this board with the Raspberry Pi Zero 2W you need to flash the usb-firmware. <br>
37
32
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)
-[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)
0 commit comments