Skip to main content

Python Library for Ember Mugs.

Project description

Python Ember Mug

pypi python Build Status codecov

Python Library for Ember Mugs

Summary

Library to attempt to interact with Ember Mugs via Bluetooth using the bleak library. This was created for use with my Home Assistant integration, but could be useful separately and has a simple CLI interface too.

Note: I have only tested with my Ember Mug 2, but others should work. (Please let me know)

Features

  • Finding mugs
  • Connecting to Mugs
  • Reading Information (Colour, temp, liquid level, etc.)
  • Polling for changes

Usage

Python

from ember_mug.scanner import find_mug, discover_mugs
from ember_mug.mug import EmberMug

# if first time with mug in pairing
mugs = await discover_mugs()
device = mugs[0]
# after paired you can simply use
device = await find_mug()
mug = EmberMug(device)
async with mug.connection() as con:
    print('Connected.\nFetching Info')
    await con.update_all()
    print(mug.formatted_data)

CLI

It can also be run via command line either directly with ember-mug --help or as a module with python -m ember_mug --help There are four options with different subsections. You can see them by specifying them before help. eg ember-mug poll --help

ember-mug discover  # Finds the mug in pairing mode for the first time
ember-mug poll  # fetches info and keeps listening for notifications

Basic options:

Command Use
discover Find/List all detected unpaired mugs in pairing mode
find Find one already paired mugs
info Connect to one mug and print its current state
poll Connect to one mug and print its current state and keep watching for changes

CLI Example

Caveats

  • Since this api is not public, a lot of guesswork and reverse engineering is involved, so it's not perfect.
  • Only works with one mug at a time
  • These mugs do not broadcast data unless paired. So you can only have one device connected to it. You need to reset them to change to another device and make sure the previous device doesn't try to reconnect.
  • Reading data from the mug seems to work pretty well, but I have been unable to write to it so far... I always get NotPermitted errors.
  • I haven't figured out some attributes like udsk, dsk, location,

Credits

This package was created with Cookiecutter and the waynerv/cookiecutter-pypackage project template.

Project details


Release history Release notifications | RSS feed

This version

0.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-ember-mug-0.3.0.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

python_ember_mug-0.3.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file python-ember-mug-0.3.0.tar.gz.

File metadata

  • Download URL: python-ember-mug-0.3.0.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for python-ember-mug-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e372a21b54765ed5fa4e0e982de1535244b3e8601d8ad0f22db09c0593556eba
MD5 646774ba51cb2e29118322a50b9756d4
BLAKE2b-256 6debb4d0ea7c78c30f752b03a7246efeb3e0fa59e1a98506108e6eda475b0b89

See more details on using hashes here.

File details

Details for the file python_ember_mug-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python_ember_mug-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9f832fb46ff446f18c9f031da07a8300d6437e6bcdb539a7a32e90b5b99a086
MD5 a080d07ea9ad91b148732196b4ba3568
BLAKE2b-256 c2802fbe2b35ccfeb289d9e62668e3555919ed2c5d0b5642824f626df05bfea4

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