Skip to main content

A small python library for discovery and interacting with Melnor, Aquastar, etc bluetooth water timers.

Project description

Melnor Bluetooth

PyPI Codecov branch GitHub Workflow Status (branch) PyPI - Downloads

Melnor Bluetooth is a reverse engineered implementation of the Bluetooth protocol for all "smart" bluetooth-enabled watering valves under the Melnor, EcoAquastar, Eden, and other brands.

The library should run on MacOS, Linux, or Windows. It's primarily developed on MacOS and other platforms likely have bugs. PRs and tests are welcome to improve quality across all platforms.

Getting Started

CLI

A simple CLI has been provided for basic debugging purposes. It's not intended for any real use and isn't suitable for running a valve in the real world.

This project uses poetry for dependency management and building. Running this project locally is as simple as the following steps:

  1. Clone the repository
  2. poetry install
  3. poetry run cli.py

The python API has been designed to be as easy to use as possible. A few examples are provided below:

Read battery state

  import asyncio

  from melnor_bluetooth.constants import BATTERY_UUID
  from melnor_bluetooth.device import Device

  address = '00:00:00:00:00' # fill with your device mac address

  async main():
    device = Device(address, 4)
    await device.connect()

    print(device.battery_life);

    await device.disconnect();

  asyncio.run(main())

Turn on a zone

  import asyncio

  from melnor_bluetooth.device import Device

  address = '00:00:00:00:00' # fill with your device mac address

  async main():
    device = Device(address, 4)
    await device.connect()

    device.zone1.is_watering = True;

    await device.push_state();
    await device.disconnect();

  asyncio.run(main())

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

melnor-bluetooth-0.0.3.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file melnor-bluetooth-0.0.3.tar.gz.

File metadata

  • Download URL: melnor-bluetooth-0.0.3.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for melnor-bluetooth-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b928088742e4c9535dd276e0e31c66e43aa77b011ce7b0169d374088b1a0c85f
MD5 e6740cdc199a4b190b423dccc65c5c54
BLAKE2b-256 d724a25eacd3ae836e1350c8a3566d202eff90c6320c95d930cbc9e2c5fe4949

See more details on using hashes here.

File details

Details for the file melnor_bluetooth-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db606e3c75f5c39d7dff85cd48cd39908733cac5becb046907176b5f8f97d84a
MD5 905d7af35a24a9dc37da09497a3eea4f
BLAKE2b-256 7b9fe1a4498795dd470fa0c2933cdfbaac1468732d087c8aa01f2807b540641d

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