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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.22-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file melnor_bluetooth-0.0.22.tar.gz.

File metadata

  • Download URL: melnor_bluetooth-0.0.22.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for melnor_bluetooth-0.0.22.tar.gz
Algorithm Hash digest
SHA256 b03eb761a95d4315a05878c5d7d0eb14012aec3107c08d0776692fcb4f8f47a4
MD5 62ce66c07bbee7553e741ac8926eb0a6
BLAKE2b-256 7c95363f0b8c10071d8f6317bb8d306270a29c85cc293bb954c7f79450b1ad79

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 4bf714d1a74b8bfe48aecd32dd21fda01ff74a49845371a7894911e8c2838ae5
MD5 cd38074e3173476356491e5a719df177
BLAKE2b-256 1d77e9d638565d94b2e8106daa3dc2b030871cd45a9e759b1a9ef1e32bcdd369

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