Skip to main content

Python library to provide a reliable communication link with LightWaveRF lights, switches and TRVs.

Project description

lightwave

Python library to provide a reliable communication link with LightWaveRF lights, switches and TRVs.

Installation

Either clone this repository and run python setup.py install, or install from pip using pip install lightwave.

API

This library makes use of the public API provided by lightwave that can be found here: https://api.lightwaverf.com/lighting_power.html

Lights and Switches

The library supports the following functions:

turn_on_light(device_id, name)
turn_on_switch(device_id, name)
turn_on_with_brightness(device_id, name, brightness)
turn_off(device_id, name)

Where:

  • device_id takes the form R#D# where R# is the room number and D# is the device number.
  • name is the text that will be displayed on the hub.
  • brightness is a value from 0 (off) to 255 (full on).

Usage

Initialise a link to the hub by passing in the IP address required. Then call a method on the object to modify the device. The first time a switch is turned on or off the device will attempt to pair to the hub. This should then show a message on your WiFi Link asking you to pair the device. You have 12 seconds to push the button on the WiFi Link to accept this.

import asyncio
import time
from lightwave.lightwave import LWLink

async def main():
    lwLink = LWLink('192.168.15.226')

    print("Off")
    ### R1D3 is room 1 device 3
    lwLink.turn_off('R1D3', "Wall Lights")
    lwLink.turn_off('R1D4', "Ceiling Lights")

    time.sleep(5)
    print("On")
    lwLink.turn_on_light('R1D3', "Wall Lights")
    lwLink.turn_on_light('R1D4', "Ceiling Lights")

    time.sleep(5)
    print("Off")
    lwLink.turn_off('R1D3', "Wall Lights")
    lwLink.turn_off('R1D4', "Ceiling Lights")


    time.sleep(5)
    print("On")
    lwLink.turn_on_with_brightness('R1D3', "Wall Lights", 25)
    lwLink.turn_on_with_brightness('R1D4', "Ceiling Lights", 50)
    lwLink.turn_on_switch('R1D1', "Sockets one")
    lwLink.turn_on_switch('R1D2', "Sockets two")


loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()

TRV Support

The library also supports TRVs with the following function:

set_temperature (device_id, temp, name)

Where:

  • device_id takes the form R#D# where R# is the room number and D# is the device identifier (normally Dh).
  • temp is the target temperature (0.5 increments)
  • name is the text that will be displayed on the hub.

TRV Proxy

The Proxy is now optional. A built in listener is now available via the async function LW_listen().

Alternativly, to read the TRV status (current temperature, target_temperature, battery status and current output) a Lightwave TRV Proxy can be used. To use the proxy:

set_trv_proxy (proxy_ip, proxy_port)
(temp, targ, batt, output) = read_trv_status(serial)

Where:

  • proxy_ip is the IP address of the proxy
  • proxy_port is the IP Port of the proxy
  • serial is the serial number of the TRV of interest (NB: This is the serial number, and NOT device_id they are different).

Contributors

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

lightwave-0.24.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

lightwave-0.24-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file lightwave-0.24.tar.gz.

File metadata

  • Download URL: lightwave-0.24.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.5 importlib-metadata/4.12.0 keyring/23.8.2 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.11 CPython/3.10.6

File hashes

Hashes for lightwave-0.24.tar.gz
Algorithm Hash digest
SHA256 97d8707402aba5d5e3fe992b8328ae85b3da1a04fab637e83b0fd306947e9352
MD5 2b76b6af4f1be8dd08513860fef39ad9
BLAKE2b-256 961a7754f0a3639b3c8c7c05310de7ba67af3bf1e36a20537bde0473bbc91793

See more details on using hashes here.

File details

Details for the file lightwave-0.24-py3-none-any.whl.

File metadata

  • Download URL: lightwave-0.24-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.5 importlib-metadata/4.12.0 keyring/23.8.2 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.11 CPython/3.10.6

File hashes

Hashes for lightwave-0.24-py3-none-any.whl
Algorithm Hash digest
SHA256 ed8634bf6477cd68cf66de3ab4405838490b5216f674a02cf450532e965f30b1
MD5 4356e0036f79f12dbb5e38bfc2e18bfd
BLAKE2b-256 93fe0a3276b6f33af4263a973eeebf1850a74aab4ba0426f0c43c349b0112df6

See more details on using hashes here.

Supported by

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