{"_id":"5823c26b0c90d02d00fe65a9","version":{"_id":"55f28172f9f3991900f38a13","project":"54ebb40d6423300d003672c0","__v":2,"createdAt":"2015-09-11T07:23:30.065Z","releaseDate":"2015-09-11T07:23:30.065Z","categories":["55f28172f9f3991900f38a14","55f28172f9f3991900f38a15","55f28172f9f3991900f38a16","55f66acb297b37170058accb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":0,"project":"54ebb40d6423300d003672c0","category":{"_id":"55f28172f9f3991900f38a15","version":"55f28172f9f3991900f38a13","__v":1,"pages":["55f28173f9f3991900f38a17","55f28173f9f3991900f38a18","55f28173f9f3991900f38a19","55f28173f9f3991900f38a1a","55f28173f9f3991900f38a1b","55f28173f9f3991900f38a1c"],"project":"54ebb40d6423300d003672c0","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-17T04:27:26.544Z","from_sync":false,"order":1,"slug":"overview","title":"Overview"},"user":"57c653757e0b250e000d6559","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-10T00:42:19.005Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Infrared illumination is available on our \"LIFX +\" range of lights available in A19 and BR30 form factors. Products that can do IR will return a `\"has_ir\": true` when queried over the HTTP api.\n\nWhile you can send commands to any light or group of lights our API service will ignore the IR set commands on lights that do not support it. To verify that a light does support Infrared commands do an authenticated `GET` operation on the `/v1/lights/:selector` path. this will return a json object listing the light information.\n\nPlease see the [List Lights](doc:list-lights) page for full details on this call. \nEach bulb will return an object similar to the below snippet. If the `has_ir` key in the map is set to true the light supports Infrared.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"product\\\": {\\n    \\\"name\\\": \\\"LIFX+ A19\\\",\\n    \\\"company\\\": \\\"LIFX\\\",\\n    \\\"identifier\\\": \\\"lifx_plus_a19\\\",\\n    \\\"capabilities\\\": {\\n        \\\"has_color\\\": true,\\n        \\\"has_variable_color_temp\\\": true,\\n        \\\"has_ir\\\": true,\\n        \\\"has_multizone\\\": false\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThe infrared channel works differently to the other LIFX color channels (Hue, Saturation, Brightness and Kelvin). When the brightness of the primary channels drops below a certain threshold the light will turn on the Infrared channel. In the future other metrics such as ambient light levels and the overall temperature of the bulb may also be used to adjust the Infrared channel. In addition to this limitation the infrared channel does not support waveforms or durations. \n\nA brightness value of 0.0 indicates that the infrared LEDs will not be used, and a value of 1.0 indicates that the bulb should set the infrared channel to the maximum possible value given the other sensor information. \n\nRetrieving and setting the maximum brightness of the infrared channel is done via [GET](list-light)s or [PUTs](set-state#infrared) on the state endpoint. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Viewing Infrared Light\",\n  \"body\": \"Unfortunately testing the LIFX infrared capabilities can be difficult as it is invisible to the naked eye. The easiest way to see infrared light is to use a camera. Not all cameras will work as some contain lenses that filter out IR. You should be able to test by pointing a TV remote at the camera while pressing a button. If the camera can see infrared light while you press a button on the remote you should be able to look through the camera and see the remotes LED flash.\"\n}\n[/block]","excerpt":"Controlling Infrared behaviour.","slug":"infrared","type":"basic","title":"Infrared"}

Infrared

Controlling Infrared behaviour.

Infrared illumination is available on our "LIFX +" range of lights available in A19 and BR30 form factors. Products that can do IR will return a `"has_ir": true` when queried over the HTTP api. While you can send commands to any light or group of lights our API service will ignore the IR set commands on lights that do not support it. To verify that a light does support Infrared commands do an authenticated `GET` operation on the `/v1/lights/:selector` path. this will return a json object listing the light information. Please see the [List Lights](doc:list-lights) page for full details on this call. Each bulb will return an object similar to the below snippet. If the `has_ir` key in the map is set to true the light supports Infrared. [block:code] { "codes": [ { "code": "\"product\": {\n \"name\": \"LIFX+ A19\",\n \"company\": \"LIFX\",\n \"identifier\": \"lifx_plus_a19\",\n \"capabilities\": {\n \"has_color\": true,\n \"has_variable_color_temp\": true,\n \"has_ir\": true,\n \"has_multizone\": false\n }\n}", "language": "json" } ] } [/block] The infrared channel works differently to the other LIFX color channels (Hue, Saturation, Brightness and Kelvin). When the brightness of the primary channels drops below a certain threshold the light will turn on the Infrared channel. In the future other metrics such as ambient light levels and the overall temperature of the bulb may also be used to adjust the Infrared channel. In addition to this limitation the infrared channel does not support waveforms or durations. A brightness value of 0.0 indicates that the infrared LEDs will not be used, and a value of 1.0 indicates that the bulb should set the infrared channel to the maximum possible value given the other sensor information. Retrieving and setting the maximum brightness of the infrared channel is done via [GET](list-light)s or [PUTs](set-state#infrared) on the state endpoint. [block:callout] { "type": "info", "title": "Viewing Infrared Light", "body": "Unfortunately testing the LIFX infrared capabilities can be difficult as it is invisible to the naked eye. The easiest way to see infrared light is to use a camera. Not all cameras will work as some contain lenses that filter out IR. You should be able to test by pointing a TV remote at the camera while pressing a button. If the camera can see infrared light while you press a button on the remote you should be able to look through the camera and see the remotes LED flash." } [/block]