Buzzer

Play a specific frequency (Hz) for a duration (ms). Non-blocking – JS timer schedules the silence; the Arduino also enforces the duration via its own tick loop. hz = 0 plays silence for the duration.

playNote(note: Note | null, durationMs: number)

Play a musical note for a duration (ms). null or unknown note is treated as silence.

stop()

Stop any playing tone or in-progress song immediately.

get value→ boolean | undefinedfrom ComponentBase

Get the current value of the component.

#Example

JavaScript

import { Board, Buzzer } from "@blokdots/components";

const board = new Board("/dev/ttyACM0");
await board.open();

const buzzer = new Buzzer({ board, pin: "D5" });

#C++ (Arduino)

ClassBuzzerextends ComponentBase

#Setup

C++

#include "blokdots.h"

Buzzer myComponent(5);

#Constructor

Buzzer(pin, invert, defaultHz)

Basic constructor (no EventBus)

Parameter	Type	Default
`pin`	`uint8_t`	required
`invert`	`bool`	`false`
`defaultHz`	`uint16_t`	`2000`

Buzzer(bus, pin, evtChange, invert, defaultHz)

Constructor with EventBus for trigger support (emits evtChange on state/frequency changes)

Parameter	Type	Default
`bus`	`EventBus`	required
`pin`	`uint8_t`	required
`evtChange`	`uint8_t`	required
`invert`	`bool`	`false`
`defaultHz`	`uint16_t`	`2000`

#Methods

isOn()→ bool

emittedValue()→ int

0 = off, otherwise current frequency (Hz)

on()

off()

toggle()

setFrequency(hz)

Parameter	Type	Default
`hz`	`uint16_t`	required

frequency()→ uint16_t

playFrequency(hz, durationMs)→ Buzzer&

hz==0 behaves like a rest (silence) for the duration.

Parameter	Type	Default
`hz`	`uint16_t`	required
`durationMs`	`uint16_t`	required

beep(hz, durationMs)→ Buzzer&

Alias for backwards naming

Parameter	Type	Default
`hz`	`uint16_t`	required
`durationMs`	`uint16_t`	required

beep(durationMs)→ Buzzer&

Default beep uses defaultHz

Parameter	Type	Default
`durationMs`	`uint16_t`	`100`

playNote(note, durationMs)→ Buzzer&

NOTE_REST = silence for duration.

Parameter	Type	Default
`note`	`NoteId`	required
`durationMs`	`uint16_t`	required

pattern(onMs, offMs, durationMs)→ Buzzer&

Parameter	Type	Default
`onMs`	`uint16_t`	required
`offMs`	`uint16_t`	required
`durationMs`	`uint32_t`	`0`

pattern(hz, onMs, offMs, durationMs)→ Buzzer&

Parameter	Type	Default
`hz`	`uint16_t`	required
`onMs`	`uint16_t`	required
`offMs`	`uint16_t`	required
`durationMs`	`uint32_t`	`0`

playSong(steps, length, tempoBpm, repeat)

Parameter	Type	Default
`steps`	`const SongStep`	required
`length`	`uint16_t`	required
`tempoBpm`	`uint16_t`	required
`repeat`	`bool`	`false`

playSong_P(stepsProgmem, length, tempoBpm, repeat)

Parameter	Type	Default
`stepsProgmem`	`const SongStep`	required
`length`	`uint16_t`	required
`tempoBpm`	`uint16_t`	required
`repeat`	`bool`	`false`

stopSong()

stop()→ Buzzer&

Stop beep/pattern/song and turn OFF