/rust-lifx

Implementation of LiFX Lan Protocol in Rust

Primary LanguageRustMIT LicenseMIT

rust-lifx

Build Status

Description

rust-lifx provides a simple implementation of a client that can talk to any number of lifx bulbs, and provides an implementation of the payload, header, messages, and serialization procedures described in the LAN protocol on the LiFX developer webpage.

Currently, the implementation targets V2.0 of the LAN protocol.

Full Protocol

Contributing

Everyone is encouraged to contribute! Please create a pull request if you want to add to or modify the code!

Setup

Setup is done using cargo. Just run:

  cargo build

There are a number of examples you can run to test things out. To see some info about bulbs configured on your network, you can run:

  cargo run  --example lifx_get_service

Configure the logger to print while running examples

To configure the logger to print out useful information while running the examples run:

  export RUST_LOG=device.in=info,device.out=info

For more detailed control, you can set the logging level for the following loggers:

  • device.in - all messages from any device that the client can intercept
  • device.out - all output messages from the client

License

The MIT License (MIT)

Copyright (c) <2015, 2016, 2017, 2018>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.