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.2.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: melnor-bluetooth-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 e6abcfa9b9b52c8ac9d0db408c3373b3fa522cbc5800d994c1caff10e8697cdc
MD5 dcbbac4876b699ea8c16e151ed8019b8
BLAKE2b-256 73641729772c6efd572b3f0ed8f2bbdb5c3d1345238b0ba894455f8446ded799

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 83f4201a5c5ce0734b97d55106681729bdd2db4828221bc84b965c8f8b15d08c
MD5 4af3e40f33818f9121a99c8365ba2520
BLAKE2b-256 77cdf9113465dc4617c1d0b70ed54494ba394cce268050fed8f630bf9509ea53

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