Play RTTTL tone

With this action, you can play a melody on the built-in buzzer of SMLIGHT Ultima devices using RTTTL—a compact text format for encoding simple tunes. If you want to learn more about the format, refer to Ring Tone Text Transfer Language. You can find and preview example tones using the RTTTL Player.

Use it to add audible notifications to your automations, like a chime when someone arrives or an alert when a sensor triggers.

If your source tone is a full RTTTL string like Doorbell:d=4,o=5,b=100:e,c, split it across the action fields as follows: set duration to 4, octave to 5, bpm to 100, and notes to "e,c".

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To play a tone from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. From the search box, search for and select SMLIGHT SLZB: Play RTTTL tone.
  6. Select the SMLIGHT Ultima device to play the tone on.
  7. Set the Notes field to the note sequence you want to play, and set the default Octave.
  8. Optional: set Duration and BPM to control the default note length and tempo.
  9. Select Save.

Options in the UI

Device

The SMLIGHT Ultima device to play the tone on. Supported models include the SLZB-Ultima3 and SLZB-Ultima4.

Duration (Optional)

Default note duration shared across all notes that don’t specify their own. Valid values are 1, 2, 4, 8, 16, and 32.

Octave

Default octave for notes that don’t specify their own. Valid values are 4 to 7.

BPM (Optional)

Tempo of the tone in beats per minute.

Notes

The note sequence in RTTTL format, for example 8d,8d#,8e,c6. A leading number sets the duration for that note individually.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as smlight.play_rtttl. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: smlight.play_rtttl
data:
  device_id: 1234567890abcdef1234567890abcdef
  octave: 5
  notes: "8e,c"

This plays a short two-note tone on the SMLIGHT Ultima device with the given ID.

Options in YAML

device_id string Required

The ID of the SMLIGHT Ultima device to play the tone on. Supported models include the SLZB-Ultima3 and SLZB-Ultima4.

duration integer

Default note duration applied to all notes that don’t specify their own duration. Valid values are 1, 2, 4, 8, 16, and 32.

octave integer Required

Default octave for notes that don’t specify their own. Valid values are 4 to 7.

bpm integer

Tempo of the tone in beats per minute.

notes string Required

The note sequence in RTTTL format, for example 8d,8d#,8e,c6. A leading number sets an individual note duration, so 8d is an eighth note. Notes without a leading number use the value set in duration.

Good to know

  • Only SMLIGHT Ultima devices (for example, the SLZB-Ultima3 and SLZB-Ultima4) have a built-in buzzer. This action has no effect on other SLZB models.
  • You can preview RTTTL tones before using them in an automation with the RTTTL Player.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Automation: play a chime when the front door opens

Play a ding-dong doorbell chime whenever the front door sensor detects the door opening.

  • Trigger: State: Front door sensor changes to on
  • Action: SMLIGHT SLZB: Play RTTTL tone
    • Device: SLZB-Ultima3
    • Octave: 5
    • BPM: 100
    • Notes: 8e,c
YAML example for a doorbell chime on door open
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]
alias: "Play chime when front door opens"
triggers:
  - trigger: state
    entity_id: binary_sensor.front_door
    to: "on"
actions:
  - action: smlight.play_rtttl
    data:
      device_id: 1234567890abcdef1234567890abcdef
      duration: 4
      octave: 5
      bpm: 100
      notes: "8e,c"

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.