Skip to main content

Simple scripting language for LIFX lights

Project description

logo https://www.bardolph.org

Bardolph Project

Al Fontes - bardolph@fontes.org

Bardolph is a facility for controlling LIFX (https://www.lifx.com) lights through a simple scripting language. It is targeted at people who would like to control or experiment with their lights in an automated way, using a minimal amount of coding.

Using their names, you can control individual lights, groups or locations. Or, just pick a color for all the lights on your network. If you have any multi-zone lights, the language allows you to set colors for specific zones.

The program does not use the Internet to access the bulbs, and no login is required; all of its communication occurs over the local WiFi network. You can edit scripts with a basic text editor and run them from the command line.

The language may be missing some constructs you might expect, such as arrays, string manipulation, and data structures, but it's still under development and you will probably find it very useful.

Quick Examples

Here is a script, named all_on.ls, that will turn on all your lights:

duration 1.5 on all

You run it with:

lsrun all_on.ls

In this case, lsrun is a bash shell script that become available after you install Bardolph.

The duration parameter says to slowly shut off the lights over a period of 1.5 seconds, which is a much nicer experience than abruptly turning them off with no dimming.

Another example, red.ls, sets all the lights to a deep shade of red:

duration 1.5 hue 350 saturation 80 brightness 80 kelvin 2700
set all

To run it:

lsrun red.ls

The application executes in the foreground as long as a script is running. In this example, the application will run for 5 minutes.

As a convenience, you can pass a script as a command-line parameter using lsrun -s, followed by the script code in a quoted string. For example, to turn off all the lights from the keyboard:

lsrun -s 'off all'

Web Server

web screenshot

The web server component makes scripts available in a user-friendly manner. It implements a simple web page that lists available scripts and provides a 1:1 mapping betwen scripts and URL's. The server is designed to run locally, on your WiFi network.

For example, if have a machine with the hostname myserver.local, you could launch the all_on.ls script by going to http://myserver.local/all-on with any browser on your WiFi network. Because scripts can run over a long period of time, even indefinitely, a cheap, dedicated device like a Raspberry Pi is an ideal way to host the web server.

Python API

I've attempted to make it easy to use Bardolph scripts in your Python code. For some uses, this may be significantly easier than learning and using a full-purpose Python library. For example, here's a complete program that waits 5 seconds, turns all the lights off, and turns them on again after another 5 seconds:

from bardolph.controller import ls_module

ls_module.configure()
ls_module.queue_script('time 5 off all on all')

System Requirements

The program has been tested on Python versions at or above 3.7.

Because I haven't done any stress testing, I don't know the limits on script size. Note that the application loads the encoded script into memory before executing it.

I've tested the program on MacOS Monterey 12.0.1, a Raspberry Pi Zero W controlling 6 devices, a Raspberry Pi 3 and Raspberry Pi 4.

Go Try It

For full documentation and download options, please see the main website.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bardolph-0.2.8.tar.gz (831.3 kB view details)

Uploaded Source

Built Distribution

bardolph-0.2.8-py3-none-any.whl (109.9 kB view details)

Uploaded Python 3

File details

Details for the file bardolph-0.2.8.tar.gz.

File metadata

  • Download URL: bardolph-0.2.8.tar.gz
  • Upload date:
  • Size: 831.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for bardolph-0.2.8.tar.gz
Algorithm Hash digest
SHA256 6a8a2c3c1e5913056586afd4d72645fe79f62f87130402294877de6d2d9b5b03
MD5 4b0db46e37870e3f0a32f8846e1b9e98
BLAKE2b-256 ff889157128821ae3b9ec60278fffdecdcc091280f4bb7f6d427ec44b33ec6b3

See more details on using hashes here.

File details

Details for the file bardolph-0.2.8-py3-none-any.whl.

File metadata

  • Download URL: bardolph-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 109.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for bardolph-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f8e15d10a9b8a202925809e90246dccad7da855022d86a6243a8cad2a388bed5
MD5 c12197b977b27abb2047f61b96e3dc45
BLAKE2b-256 eb2ed26fb15c6c298b12a8b696a394da5acc95896bb7f2dde2199065e7a4daaf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page