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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for melnor_bluetooth-0.0.25.tar.gz
Algorithm Hash digest
SHA256 95a54cc9779174e44e021cd88a56926523bc89a2cf3d074c890709f4748ac314
MD5 d319c7c02bea574ae5575b19ce513c0f
BLAKE2b-256 827ac10cf5ff3ccb2b69ed94f9a5d2008d59d29780bee2cf6cb32657edb489e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.25-py3-none-any.whl
Algorithm Hash digest
SHA256 76e42e577466b4deed32e102f75983fa7f4689f77366e65abab736846ebed468
MD5 211b8e5a7bae9f613fb0855c36622c6b
BLAKE2b-256 f0d1e9285c0c5356e4cab81653f4ea831be5d5cab77203b02101cb89445f113a

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