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

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

Uploaded Source

Built Distribution

python_ember_mug-0.3.3-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file python_ember_mug-0.3.3.tar.gz.

File metadata

  • Download URL: python_ember_mug-0.3.3.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for python_ember_mug-0.3.3.tar.gz
Algorithm Hash digest
SHA256 4145200528c700ad65f1091ab14df7f728a3f614fed9a75938920999efca9e33
MD5 83b070ce18dce28f22a11f2613b76c42
BLAKE2b-256 ce8b22983c1495263e472ee40d409a787be0b2afdfa6438acdd9a2bc1dad2501

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_ember_mug-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 29423eed3bd51d412445d634a7c3f5cde48fc355db7878f85d462098f15946fa
MD5 bea0b32936019da9a04d4dee30385d6f
BLAKE2b-256 6eb9b2e0360fcd4f4aff7e2b9bae5a1ba4d4e1dfd3d51636ff1eac764267e68b

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