clifx 1.1.0rc0

Cross-platform CLI for LIFX devices

CLIFX

Cross-platform CLI for LIFX devices

Table of Contents

• Installation
• Usage
  • Interactive
  • Examples
  • Options
• Script Template
  • Windows
  • Linux/Mac
• Development
  • Installation
  • Usage
  • Build
• Contributing
• Links

Installation

pip install clifx

Usage

Interactive

clifx  # interactive prompt - specify device and new hue, saturation, brightness and colour temp

Examples

# set the device labelled 'Strip' to...
clifx -l Strip -h 50 -s 50 -v 50 -k 6500 # soft cyan with a daylight colour temp
clifx -l Strip -h 0 -s 100 -v 100 -k 6500 # pure red at 100% brightness

Options

clifx --help  # display help

Script Template

Windows

Contents of <your-preset>.ps1

# TODO

Linux/Mac

Contents of <your-preset>.sh:

#!/bin/bash
clifx -l <device-label> -h <hue> -s <saturation> -v <value> -k <kelvin>

Development

Installation

git clone https://gitlab.com/DrTexx/CLIFX/
cd CLIFX
poetry install

Usage

Identical to typical usage except commands must be prefixed by poetry run.

For example, instead of writing the following:

clifx

You would write this:

poetry run clifx

Build

./development-scripts/build.sh

Contributing

Issues and pull requests welcome!

Links

• Documentation: https://gitlab.com/DrTexx/CLIFX#clifx
• PyPI Releases: https://pypi.org/project/clifx
• Source Code: https://gitlab.com/DrTexx/CLIFX/
• Issue Tracker: https://gitlab.com/DrTexx/CLIFX/-/issues
• Twitter: @DrTexx
• Email: [e-mail]