Command-line interface for LIFX device control.
Clifx is a simple yet powerful command line utility for controlling LIFX devices over the LAN, or even your local machine (see Implifx). As such, every possible device message is able to be sent and received, along with their appropriate payloads. Commands are simple. For example, to set the color of the lights in your bedroom to a nice green shade specified in RGB, you can use clifx -g bedroom lightcolor --rgb 75 221 88
In addition, responses are able to be received and printed in JSON form. This makes it easy to parse the responses sent back by devices.
Contents:
If you have Go installed and $GOPATH/bin in your path, just run go get -u github.com/lifx-tools/clifx and the clifx binary will be available. Otherwise, download the latest release for your platform, unarchive it, and move the binary to some location in your path (try /usr/bin/).
When these flags are not used, the message you send will be emitted to every device on the LAN. However, if you only want to target certain devices, you can filter them by their label, group, MAC address, IP address, or simply by the number of devices to receive it. All of these options can be combined to be as specific or as general as you want.
This gets the power state of devices with a label of "nightstand", case insensitive:
$ clifx -l nightstand powerThis gets the power state of devices belonging to the group "bedroom", case insensitive:
$ clifx -g bedroom powerThis gets the power state the device with the given MAC address:
$ clifx -m 4d:bc:12:d5:73:d0 powerThis gets the power state of the device with the given IP address:
$ clifx -i 10.0.0.23 powerOnly a certain number of devices will receive this message. If you have more devices on the network than this number, the devices that the message is sent to is nondeterministic, as it depends on which devices reply to the initial discover request first:
$ clifx -c 3 powerYou can set the color of your lights to a hex, RGB, or HSL value with a color temperature. All of the following examples will set the color of your lights to the same shade of yellow.
This example uses a hex triplet for specifying the color, along with the -k option to specify the color temperature. This value must be within the range 2500..9000, inclusive. The lower the saturation, the more the color temperature comes into play:
$ clifx lightcolor d0bb71 -k 2500
$ clifx lightcolor d0bb71 -k 9000$ clifx lightcolor ffd642When the --rgb flag is used, instead of parsing the 3 arguments as HSL (hue, saturation, and lightness), they'll be recognized as red, green, and blue, in that order. All 3 values must be within the range 0..255, inclusive:
$ clifx lightcolor --rgb 255 214 66The first value is the hue, which is within the range 0..360, inclusive. The saturation and lightness come next, in order, which are in the range 0..100, inclusive.
The color temperature (Kelvin) is optional. This value becomes more noticeable as the saturation becomes lower.
Without a color temperature:
$ clifx lightcolor 47 100 63With a color temperature:
$ clifx lightcolor 47 50 63 2500
$ clifx lightcolor 47 50 63 9000Sometimes you may only care about getting an acknowledgement that a message was received. Or, you may wish to have the JSON output from either an acknowledgement or response to be pretty printed. Also, some commands, like power <on|off>, won't return a response unless you ask for one. Here's how to do all of that...
An acknowledgement is simply a response sent from the device to acknowledge that it received and processed a message. The -a flag requires such a response, and only prints out the device address and its MAC address. This flag cannot be used in addition to the -r flag, as mentioned below:
$ clifx -a power onExample output:
[{"Device":{"Addr":{"IP":"10.0.0.23","Port":56700,"Zone":""},"Mac":85470165169104}}]
Normally, clifx power would print something like this:
[{"Device":{"Addr":{"IP":"10.0.0.23","Port":56700,"Zone":""},"Mac":85470165169104},"Response":{"Level":65535}}]
However, and especially when you have many devices on the network, it would be easier to read if the JSON was formatted. Use the -p flag to pretty print:
$ clifx -p powerExample output:
[
{
"Device": {
"Addr": {
"IP": "10.0.0.23",
"Port": 56700,
"Zone": ""
},
"Mac": 85470165169104
},
"Response": {
"Level": 65535
}
}
]
You'll notice that clifx power on won't give you a response. To force the device to send one back, use the -r flag. This flag cannot be used in addition to the -a flag, as mentioned above:
$ clifx -r power onExample output:
[{"Device":{"Addr":{"IP":"10.0.0.23","Port":56700,"Zone":""},"Mac":85470165169104},"Response":{"Level":0}}]
Run clifx or clifx <command> --help to learn more about all or one of the commands, flags, and options. Visit #lifx-tools on chat.freenode.net to get help, ask questions, or discuss ideas.