Add macOS support

[barak-obama]

• Python Ember Mug version: 1.0.0
• Python version: 3.11.6
• Operating System: macOS 14.2.1 (23C71)

Description

The software stopped working, probably due to changed in the Bleak Library.
I have runned "ember-mug discover" and got an error.

ember-mug discover

Traceback (most recent call last):
  File "/opt/homebrew/bin/ember-mug", line 8, in <module>
    sys.exit(run_cli())
             ^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/ember_mug/cli/__init__.py", line 13, in run_cli
    asyncio.run(cli.run())
  File "/opt/homebrew/Cellar/python@3.11/3.11.6_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/asyncio/runners.py", line 190, in run
    return runner.run(main)
           ^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/python@3.11/3.11.6_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/asyncio/runners.py", line 118, in run
    return self._loop.run_until_complete(task)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/python@3.11/3.11.6_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/asyncio/base_events.py", line 653, in run_until_complete
    return future.result()
           ^^^^^^^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/ember_mug/cli/commands.py", line 257, in run
    await self._commands[args.command](args)
  File "/opt/homebrew/lib/python3.11/site-packages/ember_mug/cli/commands.py", line 64, in discover
    mugs = await discover_mugs(mac=args.mac)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/lib/python3.11/site-packages/ember_mug/scanner.py", line 47, in discover_mugs
    return [
           ^
  File "/opt/homebrew/lib/python3.11/site-packages/ember_mug/scanner.py", line 49, in <listcomp>
    for (d, a) in scanner.discovered_devices_and_advertisement_data
        ^^^^^^
ValueError: too many values to unpack (expected 2)

[sopelj]

Oops, no, this is a mistake on my end. Sorry about that. Should be fixed in v1.0.1b1

[barak-obama]

I've downloaded v1.0.1b1 and lots of other stuff are broken, I suspect its AdvertisementData related. I've tried to poke around but its byonde my skill limit.

[sopelj]

Do you have any more information than that it's "broken"? I'd be happy to try and fix it, but I'd need more information. Such as the actual errors and what you are trying to do.

I did run this and the "discover" method now works fine for me, however. So, I'd be tempted to resolve this issue. I see that you are on macOS, so I think if you are running into issues it is likely that, that is the reason. If you would like to open issues for that I'd be happy to try and resolve them, however I do not have a Mac to test with.

[blissdev]

It seems to be working for me, although I am seeming to have issues with MAC addresses when attempting to connect to a paired device.

uvx --from python-ember-mug ember-mug find -m-"FAF8A63E-6937-8CC4-3E7B-90A60CC6XXXX"
usage: ember-mug find [-h] [-m MAC] [-d] [--log-file [LOG_FILE]] [-r]
ember-mug find: error: argument -m/--mac: Invalid MAC Address

This is the MAC address that reported in both the discover and poll commands when unpaired.

---

I guess that's the UUID and not the MAC address? Bit hard to discover. But otherwise I think this works on macOS.

[sopelj]

Hi! Yeah, macOS uses UUIDs and don't allow applications to directly access the MAC Address. This means my validation prevents you from passing it. I changed the code to accept a UUID on main if you want to try it. If you have issues installing from main I can create a new beta release package.

[sopelj]

There is a package now. You can install 1.3.0b6 if you want to test it.

[blissdev]

This did seem to find it, which is great, but when I tried to query it, it didn't work.

Now I did it in pairing mode, but then turned that off. Could that be the reason?

Edit: Yea, putting it back into pairing mode, it did work. Can this working without pairing mode?

│ uvx --from python-ember-mug@1.3.0b6 ember-mug info -m FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F
Found device: FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F: Ember Ceramic Mug
Connecting...
Traceback (most recent call last):
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak/backends/corebluetooth/CentralManagerDelegate.py", line 334, in connect
    await future
asyncio.exceptions.CancelledError

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak_retry_connector/__init__.py", line 476, in establish_connection
    await client.connect(
    ...<2 lines>...
    )
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak/__init__.py", line 620, in connect
    await self._backend.connect(self._pair_before_connect, **kwargs)
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak/backends/corebluetooth/client.py", line 135, in connect
    await manager.connect(self._peripheral, disconnect_callback, timeout=timeout)
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak/backends/corebluetooth/CentralManagerDelegate.py", line 333, in connect
    async with async_timeout(timeout):
               ~~~~~~~~~~~~~^^^^^^^^^
  File "/Users/jordan/.local/share/uv/python/cpython-3.14.2-macos-aarch64-none/lib/python3.14/asyncio/timeouts.py", line 114, in __aexit__
    raise TimeoutError from exc_val
TimeoutError

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/bin/ember-mug", line 12, in <module>
    sys.exit(run_cli())
             ~~~~~~~^^
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/cli/__init__.py", line 14, in run_cli
    asyncio.run(cli.run())
    ~~~~~~~~~~~^^^^^^^^^^^
  File "/Users/jordan/.local/share/uv/python/cpython-3.14.2-macos-aarch64-none/lib/python3.14/asyncio/runners.py", line 204, in run
    return runner.run(main)
           ~~~~~~~~~~^^^^^^
  File "/Users/jordan/.local/share/uv/python/cpython-3.14.2-macos-aarch64-none/lib/python3.14/asyncio/runners.py", line 127, in run
    return self._loop.run_until_complete(task)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/Users/jordan/.local/share/uv/python/cpython-3.14.2-macos-aarch64-none/lib/python3.14/asyncio/base_events.py", line 719, in run_until_complete
    return future.result()
           ~~~~~~~~~~~~~^^
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/cli/commands.py", line 263, in run
    await self._commands[args.command](args)
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/cli/commands.py", line 95, in fetch_info_cmd
    async with mug.connection(adapter=args.adapter):
               ~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/jordan/.local/share/uv/python/cpython-3.14.2-macos-aarch64-none/lib/python3.14/contextlib.py", line 214, in __aenter__
    return await anext(self.gen)
           ^^^^^^^^^^^^^^^^^^^^^
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/mug.py", line 532, in connection
    await self._ensure_connection()
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/mug.py", line 177, in _ensure_connection
    raise error
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/ember_mug/mug.py", line 167, in _ensure_connection
    client = await establish_connection(
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<5 lines>...
    )
    ^
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak_retry_connector/__init__.py", line 499, in establish_connection
    _raise_if_needed(name, device.address, exc)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/jordan/.cache/uv/archive-v0/5pjKIUh5NVqk-PTYbSbXr/lib/python3.14/site-packages/bleak_retry_connector/__init__.py", line 429, in _raise_if_needed
    raise BleakNotFoundError(msg) from exc
bleak_retry_connector.BleakNotFoundError:  (FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F) - FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F: Failed to connect after 4 attempt(s): TimeoutError

[sopelj]

Hey, thanks for testing!

For initial discovery, you do need to put it into pairing mode. But once the "find" command has been used, the others should work without it being in pairing mode. That may differ on macOS however, as it might change MAC addresses and confuse the mug. I know they use random MAC addresses on iOS.

Did you run find before trying to get the info?

[blissdev]

Yes.

Steps I took:

1. Turn on pairing mode
2. Run uvx --from python-ember-mug@1.3.0b6 ember-mug discover
3. Run uvx --from python-ember-mug@1.3.0b6 ember-mug find -m FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F
   • Found device: FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F: Ember Ceramic Mug
4. Turn off pairing mode
5. Run uvx --from python-ember-mug@1.3.0b6 ember-mug info -m FAF8A63E-6937-8CC4-3E7B-90A60CC6A65F
6. Times out again.

[sopelj]

Awesome, thanks!

That's very strange. I wonder if macOS is changing the MAC address it gives to the mug. That's the only reason I can image. You don't have any other devices connecting to your mug at the same time like your phone or Home Assistant, do you?