Skip to content

Commit 06c7051

Browse files
committed
Update speaker API docs.
1 parent 3426c15 commit 06c7051

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

neotron-bmc-commands/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,16 +211,20 @@ TODO
211211

212212
### Address 0x70 - Speaker Tone Duration
213213

214-
TODO
214+
Sets the duration of the tone to be played, and starts the tone playing. You
215+
should set the other three registers (if required) before setting this register.
216+
217+
There is no way to know when the tone is ended; the host should keep track of
218+
the duration it set and wait the appropriate period of time.
215219

216220
### Address 0x71 - Speaker Tone Period (High)
217221

218-
TODO
222+
Sets the upper 8 bits of the tone period. This is the inverse of frequency, in 48 kHz units.
219223

220224
### Address 0x72 - Speaker Tone Period (Low)
221225

222-
TODO
226+
Sets the lower 8 bits of the tone period. See *Speaker Tone Period (High)* for details.
223227

224228
### Address 0x73 - Speaker Tone Duty Cycle
225229

226-
TODO
230+
Sets the duty-cycle of the speaker tone. A value of 127 is 50:50 (a square wave).

0 commit comments

Comments
 (0)