pylutron-caseta
A Python API to control Lutron Caséta devices.
Getting started
If you don't know the IP address of the bridge, the leap-scan tool (requires the cli extra, pip install pylutron_caseta[cli]) will search for LEAP devices on the local network and display their address and LEAP port number.
Authentication
In order to communicate with the bridge device, you must complete the pairing process. This generates certificate files for authentication. pylutron_caseta can do this two ways.
lap-pair
If pylutron_caseta is installed with the cli extra (pip install pylutron_caseta[cli]), the lap-pair tool can be used to generate the certificate files. Simply running lap-pair <BRIDGE HOST> (note the LEAP port number should not be included) will begin the pairing process. The certificate files will be saved in $XDG_CONFIG_HOME/pylutron_caseta (normally ~/.config/pylutron_caseta) in the files [BRIDGE HOST]-bridge.crt, [BRIDGE HOST].crt, [BRIDGE HOST].key. Check lap-pair --help if you want to use different files.
The pairing module
If pylutron_caseta is being integrated into a larger application, the pairing functionality can be reused to allow pairing from within that application.
async def pair(host: str):
def _ready():
print("Press the small black button on the back of the bridge.")
data = await async_pair(host, _ready)
with open("caseta-bridge.crt", "w") as cacert:
cacert.write(data["ca"])
with open("caseta.crt", "w") as cert:
cert.write(data["cert"])
with open("caseta.key", "w") as key:
key.write(data["key"])
print(f"Successfully paired with {data['version']}")
Connecting to the bridge
Once you have the certificate files, you can connect to the bridge and start controlling devices.
import asyncio
from pylutron_caseta.smartbridge import Smartbridge
async def example():
# `Smartbridge` provides an API for interacting with the Caséta bridge.
bridge = Smartbridge.create_tls(
"YOUR_BRIDGE_IP", "caseta.key", "caseta.crt", "caseta-bridge.crt"
)
await bridge.connect()
# Get the first light.
# The device is represented by a dict.
device = bridge.get_devices_by_domain("light")[0]
# Turn on the light.
# Methods that act on devices expect to be given the device id.
await bridge.turn_on(device["device_id"])
await bridge.close()
# Run the example function within an asyncio loop.
asyncio.run(example())
The leap tool
For development and testing of new features, there is a leap command in the cli extras (pip install pylutron_caseta[cli]) which can be used for communicating directly with the bridge, similar to using curl.
Getting information about the bridge:
$ leap 192.168.86.49/server | jq
{
"Servers": [
{
"href": "/server/1",
"Type": "LEAP",
"NetworkInterfaces": [
{
"href": "/networkinterface/1"
}
],
"EnableState": "Enabled",
"LEAPProperties": {
"PairingList": {
"href": "/server/leap/pairinglist"
}
},
"Endpoints": [
{
"Protocol": "TCP",
"Port": 8081,
"AssociatedNetworkInterfaces": null
}
]
}
]
}
Turning on the first dimmer:
$ ip=192.168.86.49
$ device=$(leap "${ip}/zone/status/expanded?where=Zone.ControlType:\"Dimmed\"" | jq -r '.ZoneExpandedStatuses[0].Zone.href')
$ leap -X CreateRequest "${ip}${device}/commandprocessor" -d '{"Command":{"CommandType":"GoToLevel","Parameter":[{"Type":"Level","Value":100}]}}'
Release files for pylutron-caseta 0.29.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pylutron_caseta-0.29.0.tar.gz | 56.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pylutron_caseta-0.29.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 92.6 kB
Release files / pylutron_caseta-0.29.0.tar.gz
| Download URL | pylutron_caseta-0.29.0.tar.gz |
|---|---|
| Size | 56.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
562b450c15778733886cb9bd15c743559868173152978ea690d6ffc881476335
|
|
BLAKE2b-256 checksum How to use checksums |
3c4c5593e3fef7358994fa71cdc53703a18d0a64c03a1f7e9413bf6954a6e782
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.5 cpython/3.13.13 HTTPX/0.28.1
|
Release files / pylutron_caseta-0.29.0-py3-none-any.whl
| Download URL | pylutron_caseta-0.29.0-py3-none-any.whl |
|---|---|
| Size | 35.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c49efb2728c368e7383c9be0905a9599055813d405d4095e22505b201470a96
|
|
BLAKE2b-256 checksum How to use checksums |
8112feea1bb6ed2bf1f1a6448a3de4b3fb4e4bb604dfab0ae6c535c13c74870c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.5 cpython/3.13.13 HTTPX/0.28.1
|
