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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.14-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for melnor-bluetooth-0.0.14.tar.gz
Algorithm Hash digest
SHA256 c757b83ee842dba76f3f43c1450aa16b1d340a41a4c86a4d159ce2efbe0d6993
MD5 f68c5c226ef2b966bf92c0a1a7ae4420
BLAKE2b-256 ccd74a40c4778f2a1a1cd0d5aa5afd390006512cd8c47f88bf012b15291b3a24

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ee3a3c8c45f1623a7f23b1e1d81b3c6558738120542faf1f2d54ff16a479a59f
MD5 a9cac2aac161e38950ac5760cd4983ff
BLAKE2b-256 cf5a4bad64f54a64307884474179692d138da5b1b9158b63ebef88e245a65a69

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