{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/lights/:selector/effects/pulse","auth":"required","method":"post","params":[{"name":"selector","type":"string","default":"","desc":"The [selector](doc:selectors) to limit which lights will run the effect.","required":true,"in":"path","ref":"","_id":"5581116804ae5b0d0026287d"},{"name":"color","type":"string","default":"","desc":"The [color](doc:colors) to use for the pulse effect.","required":true,"in":"body","ref":"","_id":"558112dfa5474a0d00d94392"},{"name":"from_color","type":"string","default":"current bulb color","desc":"The [color](doc:colors) to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d94391"},{"name":"period","type":"double","default":"1.0","desc":"The time in seconds for one cyles of the effect.","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d94390"},{"name":"cycles","type":"double","default":"1.0","desc":"The number of times to repeat the effect.","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d9438f"},{"name":"persist","type":"boolean","default":"false","desc":"If false set the light back to its previous value when effect ends, if true leave the last effect color.","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d9438e"},{"name":"power_on","type":"boolean","default":"true","desc":"If true, turn the bulb on if it is not already on.","required":false,"in":"body","ref":"","_id":"558112dfa5474a0d00d9438d"}],"results":{"codes":[{"language":"json","status":"2XX","name":"","code":"{\n  \"results\": [\n    {\n      \"id\": \"d3b2f2d97452\",\n      \"label\": \"Left Lamp\",\n      \"status\": \"ok\"\n    }\n  ]\n}"}]},"settings":"","examples":{"codes":[{"code":"curl -X POST \"https://api.lifx.com/v1/lights/all/effects/pulse\" \\\n     -H \"Authorization: Bearer [[app:Token]]\" \\\n     -d 'period=2' \\\n     -d 'cycles=5' \\\n     -d 'color=green'","language":"curl"},{"code":"<?php\n\n$link = \"https://api.lifx.com/v1/lights/all/effects/pulse\";\n$authToken = \"[[app:Token]]\";\n\n$headers = array('Authorization: Bearer ' . $authToken);\n$data = 'period=2&cycles=5&color=green';\n\n$ch = curl_init($link);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($ch, CURLOPT_POST, true);\n$response = curl_exec($ch);\n\n?>","language":"php"},{"code":"import requests\n\ntoken = \"[[app:Token]]\"\n\nheaders = {\n    \"Authorization\": \"Bearer %s\" % token,\n}\n\ndata = {\n    \"period\": 2,\n    \"cycles\": 5,\n    \"color\": \"green\",\n}\n\nresponse = requests.post('https://api.lifx.com/v1/lights/all/effects/pulse', data=data, headers=headers)","language":"python"}]}},"next":{"description":"","pages":[]},"title":"Pulse Effect","type":"endpoint","slug":"pulse-effect","excerpt":"","body":"Performs a pulse effect by quickly flashing between the given colors. Use the parameters to tweak the effect.","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55f28173f9f3991900f38a22","user":"557e2561eb75d80d00af3dab","__v":1,"editedParams2":true,"project":"54ebb40d6423300d003672c0","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["55f28172f9f3991900f38a14","55f28172f9f3991900f38a15","55f28172f9f3991900f38a16","55f66acb297b37170058accb","5d229ff5e59b8e003ab3a9da"],"_id":"55f28172f9f3991900f38a13","project":"54ebb40d6423300d003672c0","releaseDate":"2015-09-11T07:23:30.065Z","createdAt":"2015-09-11T07:23:30.065Z","__v":3},"createdAt":"2015-06-17T06:28:06.125Z","editedParams":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["55f28173f9f3991900f38a1d","55f28173f9f3991900f38a1e","55f28173f9f3991900f38a1f","55f28173f9f3991900f38a20","55f28173f9f3991900f38a21","55f28173f9f3991900f38a22","55f28173f9f3991900f38a23","55f28173f9f3991900f38a24","55f28173f9f3991900f38a25","55f28173f9f3991900f38a26","55f28173f9f3991900f38a27","55f63d46fe4cce21005c785e","55f65cc16be5ea0d00bbbf4c"],"title":"API Endpoints","slug":"api-endpoints","order":2,"from_sync":false,"reference":false,"_id":"55f28172f9f3991900f38a16","__v":3,"createdAt":"2015-06-17T05:23:31.147Z","project":"54ebb40d6423300d003672c0","version":"55f28172f9f3991900f38a13"},"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

selector:
required
string
The [selector](doc:selectors) to limit which lights will run the effect.

Body Params

color:
required
string
The [color](doc:colors) to use for the pulse effect.
from_color:
stringcurrent bulb color
The [color](doc:colors) to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.
period:
double1.0
The time in seconds for one cyles of the effect.
cycles:
double1.0
The number of times to repeat the effect.
persist:
booleanfalse
If false set the light back to its previous value when effect ends, if true leave the last effect color.
power_on:
booleantrue
If true, turn the bulb on if it is not already on.

Examples


Result Format


Documentation

Performs a pulse effect by quickly flashing between the given colors. Use the parameters to tweak the effect.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}