Run a hardware effect of the device
set_effectSwitches LED control to a device-native effect such as Static, Breathing, or Wave, pausing the status animation until a state update resumes it.
Instructions
Hand the LEDs over to one of the device's own effects (for example 'Static', 'Breathing', 'Wave' - the available names depend on the device and are listed by list_devices). This stops the status animation; call set_state again to resume it.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"effect": "<effect>"
},
"name": "set_effect"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| color | No | ||
| effect | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | Yes | ||
| port | Yes | ||
| quota | No | (remaining, total) | |
| ratio | No | ||
| state | Yes | ||
| total | No | ||
| zones | No | ||
| agents | No | all agents currently sharing the lamp | |
| detail | Yes | ||
| device | Yes | ||
| animate | Yes | ||
| control | No | 'global' = the whole strip is controlled as one unit, 'per_led' = every LED is written individually | global |
| percent | No | ||
| agent_id | No | id of this agent in the shared registry | |
| progress | No | 0..1 | |
| restored | No | ||
| led_count | Yes | ||
| remaining | No | ||
| brightness | Yes | ||
| last_error | Yes | ||
| active_mode | Yes | ||
| filled_leds | No | ||
| render_mode | No | 'hardware' = the controller animates on its own, 'per_led' = colours are written LED by LED | per_led |
| state_age_s | Yes | ||
| custom_color | Yes | ||
| display_state | No | state currently shown on the lamp (highest priority of all agents) | idle |
| protocol_version | Yes | ||
| animation_running | Yes |