Skip to main content

Python Library for Ember Mugs.

Project description

Python Ember Mug

pypi python Build Status codecov Project Maintenance Maintainer License pre-commit

Python Library for interacting with Ember Mugs, Cups, and Travel Mugs via Bluetooth

Summary

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

All known Ember Mugs, Cups, Tumblers and Travel Mugs have been tested and seem to work well. If I missed one, or you have new feature ideas or issues, please create an issue, if it isn't already there, and we'll figure it out.

Device Tested
Mug
Mug 2
Cup
Tumbler
Travel Mug
Travel Mug 2

Features

  • Finding devices
  • Connecting to devices
  • Reading/Writing most values
  • Poll for changes

Attributes by device:

Attribute Mug Cup Tumbler Travel Mug Description
Name R/W N/A N/A R Name to give device
LED Colour R/W R/W R/W N/A Colour of front LED
Current Temperature R R R R Current temperature of the liquid in the mug
Target Temperature R/W R/W R/W R/W Desired temperature for the liquid
Temperature Unit R/W R/W R/W R/W Internal temperature unit for the app (C/F)
Liquid Level R R R R Approximate level of the liquid in the device
Volume level N/A N/A N/A R/W Volume of the button press beep
Battery Percent R R R R Current battery level
On Charger R R R R Device is on it's charger

Note Writing may only work if the devices has been set up in the app previously

Usage

Python

from ember_mug.scanner import find_device, discover_devices
from ember_mug.utils import get_model_info_from_advertiser_data
from ember_mug.mug import EmberMug

# if first time with mug in pairing
devices = await discover_devices()

# after paired you can simply use
device, advertisement = await find_device()
model_info = get_model_info_from_advertiser_data(advertisement)
mug = EmberMug(device, model_info)
await mug.update_all()
print(mug.data.formatted)
await mug.disconnect()

# You can also use connection as a context manager
# if you want to ensure connection before starting and cleanup on exit
async with mug.connection():
    print('Connected.\nFetching Info')
    await mug.update_all()
    print(mug.data.formatted)

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
ember-mug get name target-temp  # Prints name and target temp of mug
ember-mug set --name "My mug" --target-temp 56.8  # Sets the name and target temp to specified values

Basic options:

Command Use
discover Find/List all detected unpaired devices in pairing mode
find Find one already paired devices
info Connect to one device and print its current state
poll Connect to one device and print its current state and keep watching for changes
get Get the value(s) of one or more attribute(s) by name
set Set one or more values on the device

Example:

$ ember-mug poll
Found device: C9:0F:59:D6:33:F9: Ember Ceramic Mug
Connecting...
Connected.
Fetching Info
Device Data
+--------------+----------------------+
| Device Name  | Jesse's Mug          |
+--------------+----------------------+
| Meta         | None                 |
+--------------+----------------------+
| Battery      | 64.0%                |
|              | not on charging base |
+--------------+----------------------+
| Firmware     | None                 |
+--------------+----------------------+
| LED Colour   | #ff0fbb              |
+--------------+----------------------+
| Liquid State | Empty                |
+--------------+----------------------+
| Liquid Level | 0.00%                |
+--------------+----------------------+
| Current Temp | 24.50°C              |
+--------------+----------------------+
| Target Temp  | 55.00°C              |
+--------------+----------------------+
| Use Metric   | True                 |
+--------------+----------------------+

Watching for changes
Current Temp changed from "24.50°C" to "25.50°"
Battery changed from "64.0%, on charging base" to "65.5%, on charging base"

Caveats

  • Since this api is not public, a lot of guesswork and reverse engineering is involved, so it's not perfect.
  • If the device has not been set up in the app since it was reset, writing is not allowed. I don't know what they set in the app, but it changes something, and it doesn't work without it.
  • Once that device has been set up in the app, you should ideally forget the device or at least turn off bluetooth whilst using it here, or you will probably get disconnected often
  • I haven't figured out some attributes like udsk, dsk, location and timezone, but they are not very useful anyway.

Troubleshooting

Systematic timeouts or le-connection-abort-by-local

If your mug gets stuck in a state where it refuses to connect, you get constant reconnects, timeouts, and/or le-connection-abort-by-local messages in the debug logs, you may need to remove your mug via bluetoothctl remove my-mac-address and factory reset your device. It should reconnect correctly afterward. You may also need to re-add it to the app in order to make it writable again as well.

'Operation failed with ATT error: 0x0e' or another connection error

This seems to be caused by the bluetooth adaptor being in some sort of passive mode. I have not yet figured out how to wake it programmatically so sadly, you need to manually open bluetoothctl to do so. Please ensure the device is in pairing mode (ie the light is flashing blue or says "PAIR") and run the bluetoothctl command. You don't need to type anything. run it and wait until the mug connects.

Development

Install:

pip install hatch
# Use CLI interface
hatch run ember-mug --help
# Run Tests
hatch run test:cov
# View docs
hatch docs:serve
# Lint code
pre-commit run --all-files

Credits

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

Notice of Non-Affiliation and Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Ember.

The name Ember as well as related names, marks, emblems and images are registered trademarks of their respective owners.

Project details


Release history Release notifications | RSS feed

This version

1.1.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-1.1.0.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

python_ember_mug-1.1.0-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_ember_mug-1.1.0.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for python_ember_mug-1.1.0.tar.gz
Algorithm Hash digest
SHA256 34156a9c4abd8ba3a56c20fe89c7099266ffd9bb1666812a6ebc0f4515e686e8
MD5 dc8e9aa72ccd8106d5b6dee275ac6b57
BLAKE2b-256 34e0ebe5edf7d75f658eb84eeec75da2e4f0b66f79d9e2efa5a75782b01e2c61

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for python_ember_mug-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 613f61e957be5e6bc9feb53acf3ff2acb8004d34c9b0482de9a6238e1951b4f8
MD5 b8dfde9824959bb9ec6929d99d9ee718
BLAKE2b-256 d9c66f170acad1a8dd1a98576e8b8e61495ffc76459f060d9859b82d84014200

See more details on using hashes here.

Provenance

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