Skip to main content

Async client library for the Mahlkönig X54 grinder

Project description

Mahlkönig X54 Client

A Python client for the Mahlkönig X54 coffee grinder with WebSocket API support.

Installation

uv add mahlkoenig

or

pip install mahlkoenig

Features

  • Asynchronous WebSocket communication with the X54 grinder
  • API coverage for common grinder operations
  • Type-safe request and response handling
  • Automatic connection management and authentication
  • Easy access to grinder status, recipes, and statistics

Quick Start

import asyncio
from mahlkoenig import Grinder, AutoSleepTimePreset

async def main():
    # Connect to your grinder (default password is empty)
    async with X54Client(host="10.10.10.10") as client:
        # Get machine information
        machine_info = await client.request_machine_info()
        print(f"Connected to X54 grinder: {machine_info.serial_no}")
        print(f"Software version: {machine_info.sw_version}")
        
        # Get all recipes
        recipes = await client.request_recipe_list()
        for recipe_no, recipe in recipes.items():
            print(f"Recipe {recipe_no}: {recipe.name} - {recipe.grind_time}")
        
        # Set auto sleep time to 10 minutes
        await client.set_auto_sleep_time(AutoSleepTimePreset.MIN_10)
        print(f"Set auto sleep time to 10min")
        
        # Get grinding statistics
        stats = await client.request_statistics()
        print(f"Total grinding shots: {stats.total_grind_shots}")
        print(f"Total grinding time: {stats.total_grind_time}")

if __name__ == "__main__":
    asyncio.run(main())

API Reference

The Grinder class provides these main methods:

  • connect() - Establishes connection to the grinder
  • close() - Closes the connection
  • request_machine_info() - Gets machine information
  • request_wifi_info() - Gets WiFi settings
  • request_system_status() - Gets current grinder status
  • request_recipe_list() - Gets all programmed recipes
  • request_auto_sleep_time() - Gets current auto-sleep setting
  • set_auto_sleep_time() - Changes auto-sleep setting
  • request_statistics() - Gets usage statistics

The client also supports context manager syntax for automatic connection management.

Development

See DEVELOP.md for instruction on how to use mitmproxy to intercept the communication between the app and the grinder

License

MIT

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

mahlkoenig-0.1.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mahlkoenig-0.1.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file mahlkoenig-0.1.0.tar.gz.

File metadata

  • Download URL: mahlkoenig-0.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.2

File hashes

Hashes for mahlkoenig-0.1.0.tar.gz
Algorithm Hash digest
SHA256 994b09e1f968702ea2f382e87c61f53ea578b6b13bebd72f4f073245946dba08
MD5 907e128bbd8c7896e7cb3ed286fdabc0
BLAKE2b-256 df51b101d3e51d09a86fdd6bffde5d756cf8226ab639c44468f5038cd84bdc28

See more details on using hashes here.

File details

Details for the file mahlkoenig-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mahlkoenig-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2668046ac11d533749d783d454b569340c6cc2c311ce3165d56746491a808e2
MD5 6f79bcd712e5a21daf4047d994200967
BLAKE2b-256 617805ad0ca9658d8d62034b052c5a8cd643134b6aeba85822e011b0379b84da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page