Skip to content

Commit 5576417

Browse files
committed
bug #397: update documentation
1 parent 9c6b3dd commit 5576417

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/troubleshooting.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
# Troubleshooting
22

3+
34
## No Microphone Input
45
*For beta only*
56

6-
There is a known issue where the microphone may not initialize correctly. The best way to resolve this is to reboot the microphone array using [xvf_host](https://github.com/respeaker/reSpeaker_XVF3800_USB_4MIC_ARRAY/tree/master/host_control):
7+
There is a known issue where the microphone may not initialize correctly. You can use the `--fix-audio` argument to force the audio card to reset before starting the daemon.
8+
9+
Make sure your firmware is updated to version 2.1.2. You may need to run the [update script](../src/reachy_mini/assets/firmware/update.sh). Linux users should also install the proper udev rules using [this script](../src/reachy_mini/assets/firmware/install_udev_rules.sh). Then run:
710

811
```bash
9-
xvf_host(.exe) REBOOT 1
12+
reachy-mini-daemon --fix-audio
1013
```
1114

12-
Then run [examples/debug/sound_record.py](../examples/debug/sound_record.py) to check that everything is working properly.
15+
Afterwards, run [examples/debug/sound_record.py](../examples/debug/sound_record.py) to check that everything is working properly.
1316

1417
If the problem persists, check the connection of the flex cables ([see slides 45 to 47](https://huggingface.co/spaces/pollen-robotics/Reachy_Mini_Assembly_Guide)).
1518

19+
1620
## Sound Direction of Arrival Not Working
1721
*For beta only*
1822

19-
The microphone array requires firmware version 2.1.0 or higher to support this feature. The firmware is located in `src/reachy_mini/assets/firmware/*.bin`.
23+
The microphone array requires firmware version 2.1.0 or higher to support this feature. The firmware files are located in `src/reachy_mini/assets/firmware/*.bin`.
2024

2125
Refer to the [Seeed documentation](https://wiki.seeedstudio.com/respeaker_xvf3800_introduction/#update-firmware) for the upgrade process.
2226

27+
A [helper script](../src/reachy_mini/assets/firmware/update.sh) is available for Unix users.
28+
29+
2330
## Volume Is Too Low
2431
*Linux only*
2532

26-
Check with `alsamixer` that PCM1 is set to 100%. Then use PCM,0 to adjust the volume.
33+
Check in `alsamixer` that PCM1 is set to 100%. Then use PCM,0 to adjust the volume.
2734

2835
To make this change permanent:
2936
```bash
@@ -32,6 +39,7 @@ amixer -c "$CARD" set PCM,1 100%
3239
sudo alsactl store "$CARD"
3340
```
3441

42+
3543
## Circular Buffer Overrun Warning
3644

3745
When starting a client with `with ReachyMini() as mini:` in Mujoco (--sim mode), you may see the following warning:

0 commit comments

Comments
 (0)