Home Assistant Sensor

[samnewman86]

Is it possible to enable a sensor in home assistant using this library so that I can detect if the shower or bath is running?
Thanks

[jcallaghan]

Firstly outstanding work here @alexpilotti. This is exactly what I was hoping to find or create!

@samnewman86 I'm about to embark on this journey myself having just fitted a Mira Mode shower and bath filler. One train of thought is for this library to post updates to MQTT and also receive command updates via MQTT that way you'd have control of the unit via Home Assistant too but this would only work if the shower/bath was always operated from this library. The app does update if the unit is controlled manually so it's likely there are some BLE updates that could be sniffed for continuous status. I'll clone this great work in the coming weeks and have a play.

[alexpilotti]

@samnewman86 @jcallaghan thanks!

Is it possible to enable a sensor in home assistant using this library so that I can detect if the shower or bath is running?
Thanks

Yes, just call miramode. get_state(address)

It will return the state if both outlets, I still have to add it to the README, sorry!

[alexpilotti]

Firstly outstanding work here @alexpilotti. This is exactly what I was hoping to find or create!

@samnewman86 I'm about to embark on this journey myself having just fitted a Mira Mode shower and bath filler. One train of thought is for this library to post updates to MQTT and also receive command updates via MQTT that way you'd have control of the unit via Home Assistant too but this would only work if the shower/bath was always operated from this library. The app does update if the unit is controlled manually so it's likely there are some BLE updates that could be sniffed for continuous status. I'll clone this great work in the coming weeks and have a play.

This is exactly what I’m working on at the moment: a Home Assistant WaterHeater component that controls remotely via MQTT the Miramode outlets.

The way I use it ATM, is a Home Assistant switch that runs remote SSH commands. It works very reliably, but the temperature is defined in the script, with slight changes based on the external temperature and season, eg in summer I prefer slightly colder showers compared to winter.

The hardest part of the work in this library was about finding out the CRC style algorithm they use to validate the write commands for turning on/off the outlets. This requires a 16 bits Id (I called it client_id), which is most probably assigned during the device pairing.
For the moment, I just retrieve the client_id by sniffing the BLE packets between the phone app and the Miramode device, doing the brute force math until I get a match. Since the id is 16bit, it is very quick.

If by any chance you have time, reversing the pairing between the app and the device would be great, as that’s the last missing piece to get the client_id, without a BLE sniffer.

[alexpilotti]

A brief update on this thread, since now we have a (near) complete protocol implementation, the next step consists in implementing a full HA sensor

[PTomlinson1]

Firstly, great work and thanks. I've got this up and running now with 2 shower / bath fillers. If it helps, I used ChatGPT to set up a polling service which publishes to HA using mqtt. I used a Raspberry Pi 3 with latest bookworm 64 bit OS lite.

Here's my full setup process:

Mira Shower MQTT Bridge -- Pi Setup

This guide explains how to bring up a Raspberry Pi as a Mira
→ MQTT status bridge, publishing sensor values to Home Assistant. This
is a read-only integration (no control), so you can use
outlet/bath/shower status in automations.

---

1. Prepare the Pi

Flash Raspberry Pi OS Lite and install required packages:

sudo apt update
sudo apt install -y git python3-venv python3-pip bluez

---

2. Install python-miramode in a venv

cd ~
git clone https://github.com/alexpilotti/python-miramode
cd python-miramode
python3 -m venv venv
. venv/bin/activate
pip install --upgrade pip
pip install .
pip install paho-mqtt

Quick check:

miramodecli --help

---

3. Pair with the shower

Wake the shower, then run:

. ~/python-miramode/venv/bin/activate
miramodecli devices-list   # note the MAC of this shower, e.g. C1:22:33:44:55:66

# pair (you can reuse the same client_id as the other Pi)
# put the shower unit in pairing mode by pressing the button for 5 seconds until it flashes

miramodecli client-pair -a C1:22:33:44:55:66 -c 123456 -n "HomeAssistant"

# make a note of the returned Slot, and put it in <slot> for the following command

# check
miramodecli device-state -a C1:22:33:44:55:66 -c 123456 -s <slot>

---

4. Add the MQTT status poller

Create the script (edit values for this shower):

mkdir -p ~/mira-status
nano ~/mira-status/mira_status_mqtt.py

Paste this full script, ensuring that:

• MIRA_ADDR, CLIENT_SLOT are correct for this shower.
• BASE_TOPIC, DEVICE_ID, and DEVICE_NAME are unique so HA
  shows this as a unique device.
• MQTT_HOST, MQTT_USER, MQTT_PASS match your MQTT broker.

#!/usr/bin/env python3
import json, subprocess, time, re
import paho.mqtt.client as mqtt

# ====== EDIT THESE (UNIQUE FOR THIS SHOWER) ======
MIRA_ADDR     = "C1:22:33:44:55:66"   # <--- the MAC you just paired
CLIENT_ID     = "123456"
CLIENT_SLOT   = "1"                   # <--- the slot returned from client-pair

BASE_TOPIC    = "mira/family"         # <--- unique topic root for THIS shower
DEVICE_ID     = "mira_family"         # <--- unique HA device identifier
DEVICE_NAME   = "Mira Family Bathroom"# <--- friendly name shown in HA

MQTT_HOST     = "192.168.0.10"        # <--- your MQTT broker / HA IP
MQTT_PORT     = 1883
MQTT_USER     = None                  # or "user"
MQTT_PASS     = None                  # or "pass"

POLL_SECS     = 30                    # 30–60s is sensible
# ================================================

VENV_ACT = ". /home/pi/python-miramode/venv/bin/activate"

def run_cli(args, timeout=20):
    cmd = f'{VENV_ACT} && miramodecli ' + ' '.join(args)
    return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, timeout=timeout).decode()

def rediscover_address():
    try:
        out = run_cli(["devices-list"])
        for line in out.splitlines():
            m = re.search(r'([0-9A-F]{2}(?::[0-9A-F]{2}){5})', line, re.I)
            if m:
                return m.group(1)
    except Exception:
        pass
    return None

def parse_device_state(text:str):
    st = {
        "outlet1": "off",
        "outlet2": "off",
        "target_temperature": None,
        "actual_temperature": None,
        "timer_state": None,
        "remaining_seconds": None,
    }
    for line in text.splitlines():
        line = line.strip(); low = line.lower()
        if low.startswith("outlet 1:"):
            v = line.split(":",1)[1].strip().lower()
            st["outlet1"] = "on" if v in ("on","true","1") else "off"
        elif low.startswith("outlet 2:"):
            v = line.split(":",1)[1].strip().lower()
            st["outlet2"] = "on" if v in ("on","true","1") else "off"
        elif low.startswith("target temperature:"):
            nums = re.findall(r'[-+]?\d*\.\d+|\d+', line)
            if nums: st["target_temperature"] = int(round(float(nums[0])))
        elif low.startswith("actual temperature:"):
            nums = re.findall(r'[-+]?\d*\.\d+|\d+', line)
            if nums: st["actual_temperature"] = int(round(float(nums[0])))
        elif low.startswith("timer state:"):
            st["timer_state"] = line.split(":",1)[1].strip().lower()
        elif low.startswith("remaining seconds:"):
            nums = re.findall(r'\d+', line)
            if nums: st["remaining_seconds"] = int(nums[0])
    return st

def get_state():
    global MIRA_ADDR
    try:
        raw = run_cli(["device-state", "-a", MIRA_ADDR, "-c", str(CLIENT_ID), "-s", str(CLIENT_SLOT)])
        return parse_device_state(raw)
    except subprocess.CalledProcessError as e:
        msg = (e.output.decode() if e.output else "")
        if "Address not found" in msg:
            new_mac = rediscover_address()
            if new_mac:
                MIRA_ADDR = new_mac
                raw = run_cli(["device-state", "-a", MIRA_ADDR, "-c", str(CLIENT_ID), "-s", str(CLIENT_SLOT)])
                return parse_device_state(raw)
        raise

# ---------- MQTT ----------
client = mqtt.Client(protocol=mqtt.MQTTv311)
if MQTT_USER:
    client.username_pw_set(MQTT_USER, MQTT_PASS)
client.will_set(f"{BASE_TOPIC}/availability", "offline", retain=True)
client.connect(MQTT_HOST, MQTT_PORT, 60)
client.loop_start()
client.publish(f"{BASE_TOPIC}/availability", "online", retain=True)

disc = "homeassistant"
uid_base = BASE_TOPIC.replace("/","_")
device_obj = {
    "identifiers": [DEVICE_ID],
    "name": DEVICE_NAME,
    "manufacturer": "Mira",
    "model": "Mode",
    "connections": [["bluetooth", MIRA_ADDR]],
}

def pub(topic, payload):
    client.publish(topic, payload, retain=True)

def publish_discovery():
    pub(f"{disc}/binary_sensor/{uid_base}_outlet1/config", json.dumps({
        "name": "Outlet 1 Running",
        "uniq_id": f"{uid_base}_outlet1",
        "stat_t": f"{BASE_TOPIC}/outlet1",
        "pl_on": "on", "pl_off": "off",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))
    pub(f"{disc}/binary_sensor/{uid_base}_outlet2/config", json.dumps({
        "name": "Outlet 2 Running",
        "uniq_id": f"{uid_base}_outlet2",
        "stat_t": f"{BASE_TOPIC}/outlet2",
        "pl_on": "on", "pl_off": "off",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))
    pub(f"{disc}/sensor/{uid_base}_target_temp/config", json.dumps({
        "name": "Target Temperature",
        "uniq_id": f"{uid_base}_target_temp",
        "stat_t": f"{BASE_TOPIC}/target_temperature",
        "dev_cla": "temperature",
        "unit_of_meas": "°C",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))
    pub(f"{disc}/sensor/{uid_base}_actual_temp/config", json.dumps({
        "name": "Actual Temperature",
        "uniq_id": f"{uid_base}_actual_temp",
        "stat_t": f"{BASE_TOPIC}/actual_temperature",
        "dev_cla": "temperature",
        "unit_of_meas": "°C",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))
    pub(f"{disc}/sensor/{uid_base}_timer_state/config", json.dumps({
        "name": "Timer State",
        "uniq_id": f"{uid_base}_timer_state",
        "stat_t": f"{BASE_TOPIC}/timer_state",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))
    pub(f"{disc}/sensor/{uid_base}_remaining_seconds/config", json.dumps({
        "name": "Remaining Seconds",
        "uniq_id": f"{uid_base}_remaining_seconds",
        "stat_t": f"{BASE_TOPIC}/remaining_seconds",
        "unit_of_meas": "s",
        "avty_t": f"{BASE_TOPIC}/availability",
        "device": device_obj
    }))

publish_discovery()

last = {
    "outlet1": None,
    "outlet2": None,
    "target_temperature": None,
    "actual_temperature": None,
    "timer_state": None,
    "remaining_seconds": None,
}
delay = POLL_SECS

while True:
    try:
        st = get_state()
        for key, old in last.items():
            val = st.get(key)
            if val is not None and val != old:
                pub(f"{BASE_TOPIC}/{key}", str(val))
                last[key] = val
        pub(f"{BASE_TOPIC}/availability", "online")
        delay = POLL_SECS
    except Exception:
        pub(f"{BASE_TOPIC}/availability", "offline")
        delay = min(max(5, delay * 2), 120)
    time.sleep(delay)

Make executable:

chmod +x ~/mira-status/mira_status_mqtt.py

---

5. Autostart on boot with systemd

Create a service file:

sudo nano /etc/systemd/system/mira-status.service

Contents:

[Unit]
Description=Mira status → MQTT (read-only)
After=network-online.target bluetooth.service
Wants=network-online.target

[Service]
Type=simple
User=pi
ExecStart=/home/pi/python-miramode/venv/bin/python /home/pi/mira-status/mira_status_mqtt.py
Restart=always
RestartSec=5
Environment=PYTHONUNBUFFERED=1

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl daemon-reload
sudo systemctl enable --now mira-status.service
systemctl status mira-status.service --no-pager

---

6. Home Assistant

When running, HA (with MQTT Discovery enabled) will create a new
device with entities:

• Outlet 1 Running (binary_sensor)
• Outlet 2 Running (binary_sensor)
• Target Temperature (sensor)
• Actual Temperature (sensor)
• Timer State (sensor)
• Remaining Seconds (sensor)

Each Mira appears separately thanks to unique BASE_TOPIC and
DEVICE_ID values.