pulse_effect
Create a pulsing color animation for LIFX smart lights by specifying colors, cycle duration, and brightness peaks to add dynamic lighting effects.
Instructions
Perform a pulse effect
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| token | Yes | LIFX API token | |
| selector | No | Selector for filtering lights (default: 'all') | |
| color | Yes | Color to pulse | |
| from_color | No | Starting color | |
| period | No | Duration of one cycle in seconds | |
| cycles | No | Number of cycles | |
| persist | No | Persist the final color | |
| power_on | No | Turn on if off | |
| peak | No | Peak brightness (0.0 to 1.0) |
Implementation Reference
- src/index.ts:388-419 (handler)Handler for the 'pulse_effect' tool. Extracts parameters from input arguments, constructs the request body, and sends a POST request to the LIFX API endpoint `/lights/{selector}/effects/pulse` to initiate the pulse effect.case "pulse_effect": { const { token, selector = "all", ...effectParams } = args as { token: string; selector?: string; color: string; from_color?: string; period?: number; cycles?: number; persist?: boolean; power_on?: boolean; peak?: number; }; const body = Object.fromEntries( Object.entries(effectParams).filter(([_, value]) => value !== undefined) ); const result = await makeLIFXRequest(`/lights/${selector}/effects/pulse`, { method: "POST", body, token, }); return { content: [ { type: "text", text: `Pulse effect started for selector "${selector}". ${JSON.stringify(result, null, 2)}`, }, ], }; }
- src/index.ts:204-222 (schema)Schema and registration for the 'pulse_effect' tool, defining the input parameters, types, descriptions, and required fields in the ListTools response.{ name: "pulse_effect", description: "Perform a pulse effect", inputSchema: { type: "object", properties: { token: { type: "string", description: "LIFX API token" }, selector: { type: "string", description: "Selector for filtering lights (default: 'all')" }, color: { type: "string", description: "Color to pulse" }, from_color: { type: "string", description: "Starting color" }, period: { type: "number", minimum: 0.1, description: "Duration of one cycle in seconds" }, cycles: { type: "number", minimum: 1, description: "Number of cycles" }, persist: { type: "boolean", description: "Persist the final color" }, power_on: { type: "boolean", description: "Turn on if off" }, peak: { type: "number", minimum: 0, maximum: 1, description: "Peak brightness (0.0 to 1.0)" }, }, required: ["token", "color"], }, },
- src/index.ts:72-114 (helper)Shared helper function 'makeLIFXRequest' used by the pulse_effect handler (and other tools) to perform authenticated HTTP requests to the LIFX API.async function makeLIFXRequest( endpoint: string, options: { method?: string; body?: any; token: string; } ): Promise<any> { const { method = "GET", body, token } = options; const url = `${LIFX_API_BASE}${endpoint}`; const headers: Record<string, string> = { "Authorization": `Bearer ${token}`, "User-Agent": USER_AGENT, }; if (body && (method === "POST" || method === "PUT")) { headers["Content-Type"] = "application/json"; } try { const response = await fetch(url, { method, headers, body: body ? JSON.stringify(body) : undefined, }); if (!response.ok) { const errorText = await response.text(); throw new Error(`LIFX API error: ${response.status} ${response.statusText} - ${errorText}`); } // Some endpoints return empty responses const contentType = response.headers.get("content-type"); if (contentType?.includes("application/json")) { return await response.json(); } return await response.text(); } catch (error) { throw new Error(`Failed to make LIFX API request: ${error instanceof Error ? error.message : String(error)}`); } }