Skip to content

Commit a01edeb

Browse files
committed
update readme and examples
1 parent 853f677 commit a01edeb

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

src/arduino/app_bricks/wave_generator/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,17 @@ Change the waveform type.
195195
**Parameters:**
196196
- `wave_type`: One of "sine", "square", "sawtooth", "triangle"
197197

198-
#### `set_volume(volume: float)`
199-
Set master volume level.
198+
#### `set_volume(volume: int)`
199+
Set hardware speaker volume level.
200200

201201
**Parameters:**
202-
- `volume`: Master volume in range [0.0, 1.0]
202+
- `volume`: Hardware volume level (0-100)
203+
204+
#### `get_volume() -> int`
205+
Get current hardware speaker volume level.
206+
207+
**Returns:**
208+
- Current hardware volume level (0-100)
203209

204210
#### `set_envelope_params(attack=None, release=None, glide=None)`
205211
Update envelope parameters.
@@ -213,7 +219,7 @@ Update envelope parameters.
213219
Get current generator state.
214220

215221
**Returns:**
216-
- Dictionary with keys: `frequency`, `amplitude`, `wave_type`, `master_volume`, `phase`
222+
- Dictionary with keys: `frequency`, `amplitude`, `wave_type`, `volume`, `phase`
217223

218224
## Waveform Types
219225

@@ -287,7 +293,7 @@ Time to smoothly transition from current frequency to target frequency.
287293
### No Sound Output
288294
- Check USB speaker is connected and powered
289295
- Verify amplitude is > 0: `wave_gen.set_amplitude(0.5)`
290-
- Check master volume: `wave_gen.set_volume(0.8)`
296+
- Check hardware volume: `wave_gen.set_volume(80)`
291297

292298
### Choppy or Clicking Audio
293299
- Increase glide time: `wave_gen.set_envelope_params(glide=0.05)`

src/arduino/app_bricks/wave_generator/examples/01_basic_tone.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
# Set initial frequency and amplitude
2626
wave_gen.set_frequency(440.0) # A4 note (440 Hz)
2727
wave_gen.set_amplitude(0.7) # 70% amplitude
28-
wave_gen.set_volume(0.8) # 80% master volume
28+
wave_gen.set_volume(80) # 80% hardware volume
2929

3030
print("Playing 440Hz sine wave (A4 note)")
3131
print("Press Ctrl+C to stop")

src/arduino/app_bricks/wave_generator/examples/04_musical_scale.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
)
3434

3535
App.start_brick(wave_gen)
36-
wave_gen.set_volume(0.7)
36+
wave_gen.set_volume(70)
3737

3838

3939
def play_scale():

src/arduino/app_bricks/wave_generator/examples/05_envelope_control.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
App.start_brick(wave_gen)
1818

1919
wave_gen.set_frequency(440.0)
20-
wave_gen.set_volume(0.8)
20+
wave_gen.set_volume(80)
2121

2222

2323
def envelope_demo():

0 commit comments

Comments
 (0)