Skip to main content

A small python library for discovery and interacting with Melnor, Eden, 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 bleak import BleakScanner  # type: ignore - bleak has bad export types

from melnor_bluetooth.device import Device

ADDRESS = "00:00:00:00:00"  # fill with your device mac address


async def main():

    ble_device = await BleakScanner.find_device_by_address(ADDRESS)
    if ble_device is not None:
        device = Device(ble_device)
        await device.connect()
        await device.fetch_state()

        print(device.battery_level)

        await device.disconnect()


asyncio.run(main())

Turn on a zone

import asyncio

from bleak import BleakScanner  # type: ignore - bleak has bad export types

from melnor_bluetooth.device import Device

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


async def main():
    ble_device = await BleakScanner.find_device_by_address(ADDRESS)
    if ble_device is not None:
        device = Device(ble_device)
        await device.connect()
        await device.fetch_state()

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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.17-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: melnor-bluetooth-0.0.17.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for melnor-bluetooth-0.0.17.tar.gz
Algorithm Hash digest
SHA256 25db97035c4dc7624560b8268c590f262e1f617ff7e64454287cac97cc789457
MD5 fca7063900b6f1d0ef561647bb9e8e68
BLAKE2b-256 f35787b6027c88af605cf9478a1e17b1148f08c6e3c929e24db618acee0e4c81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 66ac8d894b3f6d9a79cda72d3d7a49a53ef010eb4210e0b7a9d9e5be41b7354d
MD5 819c70ec835d947cea73d46ff32a2071
BLAKE2b-256 e4e7de45ec8e098e9152ecf8bc244100442ad0ba8765410eca332179410201ea

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