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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: melnor-bluetooth-0.0.15.tar.gz
  • Upload date:
  • Size: 9.6 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.15.tar.gz
Algorithm Hash digest
SHA256 89f00f00f750f8713ca422076fec66c4bc9a94da5e3d6b1b8c51b364e34eaf60
MD5 c9fe15c0e8f6589eae80647ee82c040e
BLAKE2b-256 26ab65d0b606cc1175eca5bce1c8d637a245e0bbef3e19cde01cc5a986032c22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 2c69dc20dc4e60623a4bbe332d7b02d9bf687e22400894cd85047875e4772240
MD5 1d1aa4d2815bab758ee22bd0be9c7ef7
BLAKE2b-256 6dc427354982007d2163cd61abe2b1a37b5bc6e45aa94aef72b7338cd2bf336e

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