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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.24-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: melnor_bluetooth-0.0.24.tar.gz
  • Upload date:
  • Size: 11.7 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.24.tar.gz
Algorithm Hash digest
SHA256 6cd503ab9eb14034618e8338887451c0ca73ea396297ad059315268e83e58a2d
MD5 9c90fe6f647701d0988169baf9900bc9
BLAKE2b-256 6efd034341dd4f8f5586cb0e2419042b5c9f88cfd2414efc9907c6ce9fb417d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.24-py3-none-any.whl
Algorithm Hash digest
SHA256 cd680a7f0e77df9c173f2f486fcc3f7f0f68b600f1fae575386626ca7ec5beb3
MD5 bf386ab6bbac3aaaee410052ab76ffff
BLAKE2b-256 4032883939798c86f51debd71743d6de483405c64d0d9c94c0d80a9d704df37a

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