Skip to content

Commit fd2521c

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent 46c41bf commit fd2521c

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/api.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,7 @@ Predefined notes are available in the NOTES dictionary e.g. ModulinoBuzzer.NOTES
120120

121121
Dictionary with the notes and their corresponding frequencies.
122122
The supported notes are defined as follows:
123-
- B0
124-
- C1, CS1, D1, DS1, E1, F1, FS1, G1, GS1, A1, AS1, B1
125-
- C2, CS2, D2, DS2, E2, F2, FS2, G2, GS2, A2, AS2, B2
126-
- C3, CS3, D3, DS3, E3, F3, FS3, G3, GS3, A3, AS3, B3
123+
- FS3, G3, GS3, A3, AS3, B3
127124
- C4, CS4, D4, DS4, E4, F4, FS4, G4, GS4, A4, AS4, B4
128125
- C5, CS5, D5, DS5, E5, F5, FS5, G5, GS5, A5, AS5, B5
129126
- C6, CS6, D6, DS6, E6, F6, FS6, G6, GS6, A6, AS6, B6
@@ -161,7 +158,7 @@ If blocking is set to True, the function will wait until the tone is finished.
161158

162159
**Arguments**:
163160

164-
- `frequency` - The frequency of the tone in Hz
161+
- `frequency` - The frequency of the tone in Hz (freuqencies below 180 Hz are not supported)
165162
- `lenght_ms` - The duration of the tone in milliseconds. If omitted, the tone will play indefinitely
166163
- `blocking` - If set to True, the function will wait until the tone is finished
167164

0 commit comments

Comments
 (0)