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

Uploaded Source

Built Distribution

melnor_bluetooth-0.0.18-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for melnor-bluetooth-0.0.18.tar.gz
Algorithm Hash digest
SHA256 8764ca26cb5fa00c73a66f8a85605b912d980c854099acd972d7fb2f4cf4ba55
MD5 0bd33f8c1311d52de0989498a7e8a69f
BLAKE2b-256 f98c44ef2ebbcbd401c72a05f2941da5c2330f6bbc6fab3c03fce744cb5a193b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for melnor_bluetooth-0.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 bd015ee0d775d45b8ad34bfc0077cd0bb5ceb9b16b9baf53e6cbae646fba465b
MD5 a7a4d5e4c6c76b131577cc9565419353
BLAKE2b-256 0b884c751dfd1ffe2e50c55ed9df78a8303919fa2fbc2870c30b33af5fefa3ef

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