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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.20-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: melnor-bluetooth-0.0.20.tar.gz
  • Upload date:
  • Size: 10.1 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.20.tar.gz
Algorithm Hash digest
SHA256 e5ae9e225ed44158aee1bbeedc7f753a25b4e0b9bd9aa9ea1804ea44a944905a
MD5 d11388dda98bdbd10c5c4b3a56f7dc0f
BLAKE2b-256 3a420f304f6c4c9108915414c55c12e05bf6ad6ced51fe49cf0cbc6b028b12ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 f6ee452a83fad0698267f92bfb5799eca2c05220c29fb076c98a4df8d7f3422a
MD5 6e40ba639700e5cb590661880e75f073
BLAKE2b-256 3a509a5143aa5863c614ff6d12046f1521d62ea8766956ce8a63e7ae7c203bcf

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