moving things around and adding examples for mic hat code

2023-04-27 10:34:53 -07:00
parent 91671ef554
commit 77c085ba69
121 changed files with 1273 additions and 0 deletions
@@ -0,0 +1,67 @@
+# seeed-voicecard
+
+The drivers for [ReSpeaker Mic Hat](https://www.seeedstudio.com/ReSpeaker-2-Mics-Pi-HAT-p-2874.html), [ReSpeaker 4 Mic Array](https://www.seeedstudio.com/ReSpeaker-4-Mic-Array-for-Raspberry-Pi-p-2941.html), [6-Mics Circular Array Kit](), and [4-Mics Linear Array Kit]() for Raspberry Pi.
+
+### Install seeed-voicecard
+Get the seeed voice card source code and install all linux kernel drivers
+```bash
+git clone https://github.com/respeaker/seeed-voicecard
+cd seeed-voicecard
+sudo ./install.sh
+sudo reboot
+```
+
+**Note** If you have 64-bit version of Rasperry Pi OS, use install_arm64.sh script for driver installation. 
+
+## ReSpeaker Documentation
+
+Up to date documentation for reSpeaker products can be found in [Seeed Studio Wiki](https://wiki.seeedstudio.com/ReSpeaker/)!
+![](https://files.seeedstudio.com/wiki/ReSpeakerProductGuide/img/Raspberry_Pi_Mic_Array_Solutions.png)
+
+
+### Coherence
+
+Estimate the magnitude squared coherence using Welch’s method.
+![4-mics-linear-array-kit coherence](https://user-images.githubusercontent.com/3901856/37277486-beb1dd96-261f-11e8-898b-84405bfc7cea.png)  
+Note: 'CO 1-2' means the coherence between channel 1 and channel 2.
+
+```bash
+# How to get the coherence of the captured audio(a.wav for example).
+sudo apt install python-numpy python-scipy python-matplotlib
+python tools/coherence.py a.wav
+
+# Requirement of the input audio file:
+- format: WAV(Microsoft) signed 16-bit PCM
+- channels: >=2
+```
+
+### uninstall seeed-voicecard
+If you want to upgrade the driver , you need uninstall the driver first.
+
+```
+pi@raspberrypi:~/seeed-voicecard $ sudo ./uninstall.sh 
+...
+------------------------------------------------------
+Please reboot your raspberry pi to apply all settings
+Thank you!
+------------------------------------------------------
+```
+
+Enjoy !
+
+### Technical support
+
+For hardware testing purposes we made a Rasperry Pi OS 5.10.17-v7l+ 32-bit image with reSpeaker drivers pre-installed, which you can download by clicking on [this link](https://files.seeedstudio.com/linux/Raspberry%20Pi%204%20reSpeaker/2021-05-07-raspios-buster-armhf-lite-respeaker.img.xz).
+
+We provide official support for using reSpeaker with the following OS:
+- 32-bit Raspberry Pi OS
+- 64-bit Raspberry Pi OS (experimental support)
+
+And following hardware platforms:
+- Raspberry Pi 3 (all models), Raspberry Pi 4 (all models), Raspberry Pi Zero and Zero W
+
+Anything beyond the scope of official support is considered to be community supported. Support for other OS/hardware platforms can be added, provided MOQ requirements can be met. 
+
+If you have a technical problem when using reSpeaker with one of the officially supported platforms/OS, feel free to create an issue on Github. For general questions or suggestions, please use [Seeed forum](https://forum.seeedstudio.com/c/products/respeaker/15). 
+
+