Sound Encoding API

Overview

Voodoo Robotics Cloud Display Devices can play custom tunes when the button lights up. This allows you to create distinct audio cues for different types of picks, alerts, or workflows — helping workers quickly identify the type of action required without looking at the display.

Sounds are specified in the sound field when sending commands to devices. You can use pre-built tunes or create your own custom melodies.

Sound Encoding Format

Sound encoding follows a simple comma-separated format:

Components

Simple Example

140,c5,2,d5,2,e5,2,f5,2,g5,2

This plays a C major scale at 140ms per beat, with each note held for 2 beats.

Available Notes

Notes range from the 5th to 7th octave. Sharp notes are indicated by adding 's' after the note name.

Pre-Built Tunes

Use these ready-made tunes by copying the encoding string into the sound field:

Usage Examples

Using Pre-Built Tunes

import requests

# Simple beep
response = requests.post(
    "https://www.voodoodevices.com/api/devices/",
    headers={"API-KEY": "your_api_key_here"},
    json={
        "deviceid": "ABC123:DEF456",
        "command": "flash",
        "line1": "Pick Item A",
        "color": "blue",
        "sound": "15,c5,4",  # Regular beep
        "seconds": 600
    }
)

# Different tune for different pick type
response = requests.post(
    "https://www.voodoodevices.com/api/devices/",
    headers={"API-KEY": "your_api_key_here"},
    json={
        "deviceid": "ABC123:DEF456",
        "command": "flash",
        "line1": "Pick Priority Item",
        "color": "red",
        "sound": "140,c5,2,f5,2,a5,2,c6,3,a5,1,c6,3",  # Charge
        "seconds": 600
    }
)

Creating Custom Tunes

Build your own tune by combining tempo, notes, and durations:

# Create a simple "success" jingle
success_sound = "180,c5,1,e5,1,g5,2"

# Create an "alert" sound with pauses
alert_sound = "100,g6,1,p,1,g6,1,p,1,g6,1"

# Create a longer melody
melody = "150,c5,2,d5,2,e5,2,f5,2,g5,4,p,2,g5,2,f5,2,e5,2,d5,2,c5,4"

response = requests.post(
    "https://www.voodoodevices.com/api/devices/",
    headers={"API-KEY": "your_api_key_here"},
    json={
        "deviceid": "ABC123:DEF456",
        "command": "display",
        "line1": "Task Complete!",
        "color": "green",
        "sound": success_sound,
        "seconds": 300
    }
)

Common Use Cases

Tips for Creating Custom Tunes

• Keep it short: Most effective tunes are 1-3 seconds. Longer tunes may delay worker response and consume more battery power.
• Minimize sound usage: Playing sounds significantly reduces battery life. Use sound sparingly and only when necessary for critical alerts or differentiation.
• Use pauses strategically: Pauses (p) can create rhythmic patterns that are more distinctive.
• Test tempo: Faster tempos (100-140) work well for alerts; slower tempos (200-300) for confirmations.
• Octave matters: Higher octaves (6th, 7th) are more attention-grabbing; 5th octave is more pleasant for routine use.
• Repetition helps recognition: Repeating a short pattern makes it easier for workers to learn and recognize.
• Avoid complexity: Simple melodies are more recognizable in noisy warehouse environments.
• Test in real conditions: The speaker volume may not be sufficient in loud environments with conveyors or other machinery. Always test in actual working conditions.