JSON API

WLED JSON API

Buzzer commands can be included in normal WLED /json/state requests under the buzzer object.

Play once

{"buzzer":{"play":"victory"}}

Repeat

{"buzzer":{"play":"alarm","repeat":3}}

Infinite loop

{"buzzer":{"play":"alarm","loop":true}}

Stop

{"buzzer":{"stop":true}}

Tone

{"buzzer":{"tone":1000,"duration":200}}

Beep

{"buzzer":{"beep":150,"frequency":2000}}

Playback state

The usermod adds a buzzer object to WLED JSON state with fields including:

• ready
• playing
• sound
• loop
• repeatRemaining
• note
• notes
• frequency

Repeat validation

The JSON API applies strict command validation and aligns repeat semantics with the HTTP API:

• omitted repeat -> normal one-shot playback, or infinite loop when loop:true;
• repeat from 1 to 255 -> finite total execution count;
• explicit repeat:0 -> invalid command, ignored;
• repeat above 255 -> invalid command, ignored;
• loop:true together with repeat -> invalid command, ignored.
• Numeric tone/beep/duration/frequency values must be JSON integers within the same 20-20000 Hz / 1-60000 ms limits as HTTP.
• Stringified numbers, negative values, and requests containing multiple command categories are ignored.

Examples:

{"buzzer":{"play":"alarm","repeat":3}}

{"buzzer":{"play":"alarm","repeat":0}}

The second command is invalid and does not start playback.