Skip to content

Commit 69a4dc9

Browse files
committed
Update README
1 parent cce8bed commit 69a4dc9

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,26 @@
77
Chirp is a library enabling Arduino-based devices to send and receive data using sound. You'll need:
88

99
* A compatible Arduino board
10-
* A digital I2S MEMS microphone
10+
* A digital I2S MEMS microphone (if your board does not contain a microphone)
1111
* A digital I2S amplifier and compatible speaker
1212

13-
For sound input you will need a digital MEMS microphone such as the SPH0645 or ICS-43434. (Not necessary for the Nano 33 Sense as it comes with an on board microphone)
14-
For sound output it is recommended to use a digital I2S output such as the UDA1334A or MAX98357A connected to a compatible speaker.
13+
For receiving data, you will need a digital MEMS microphone. Some boards (for example, the Nano 33 Sense and Microsoft MXChip) already include a MEMS mic so you are good to go. For others, you will need an external mic such as the [SPH0645](https://www.adafruit.com/product/3421) or [ICS-43434](https://www.mouser.co.uk/ProductDetail/TDK-InvenSense/ICS-43434?qs=u4fy%2FsgLU9PAgmWRI7%252BqXA%3D%3D).
1514

16-
You can quickly test the sound input by playing random chirps from the [Developer Hub](https://developers.chirp.io).
17-
The easiest way to test the sound output would be to use Chirp on the [command line](https://developers.chirp.io/docs/tutorials/command-line) to receive data from the Arduino.
15+
For sending data, we recommend using a digital I2S audio output such as the [UDA1334A](https://www.adafruit.com/product/3678) or [MAX98357A](https://www.adafruit.com/product/3006), connected to a compatible speaker.
16+
17+
You can quickly test that your device is receiving chirps by playing some random test signals from the [Developer Hub](https://developers.chirp.io).
18+
19+
To test whether your device is sending chirps OK, we recommend setting up the [Python command-line tools](https://developers.chirp.io/docs/tutorials/command-line) to receive data from the Arduino.
1820

1921
## Supported hardware
2022

21-
Send and receive capabilities
23+
The following Arduino-compatible boards are able to both send and receive chirps:
2224

2325
* Arduino Nano 33 Sense
2426
* Microsoft MXChip
2527
* ESP32
2628

27-
Send only
29+
The following Arduino-compatible boards are only able to send chirps, as they are not able to do on-chip DSP:
2830

2931
* Arduino MKRZero
3032
* Arduino Vidor 4000
@@ -36,17 +38,21 @@ Send only
3638

3739
Chirp is written for the Arduino IDE versions 1.8.6 and above.
3840

39-
Install ChirpSDK as a library. For instructions, see
41+
Install ChirpSDK as a library using "Manage Libraries". For instructions, see
4042

4143
[http://arduino.cc/en/Guide/Libraries](http://arduino.cc/en/Guide/Libraries)
4244

43-
Once installed, you can access the example programs from the menu :
45+
Once installed, you can access the example programs from the menu:
4446

45-
```File > Examples > ChirpSDK > Example ```
47+
```
48+
File > Examples > ChirpSDK > Example
49+
```
4650

47-
and you can include the headers to use Chirp in your own code by adding :
51+
and you can include the headers to use Chirp in your own code by adding:
4852

49-
```#include "chirp_connect.h"```
53+
```
54+
#include "chirp_connect.h"
55+
```
5056

5157
## Usage
5258

0 commit comments

Comments
 (0)