CHANGELOG.md

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.8.3 - 2026-09-09

Added

• Date-of-birth based user profiles: the user profile stores an optional date_of_birth instead of collecting an age; the current age is derived from it with a birthday-aware calculation, so it never needs a manual yearly update. The handshake and body-composition math receive the derived age (HA-local date, no UTC off-by-one around birthdays), and derived sensors refresh once per HA-local day.
• Safe migration for existing profiles: profiles created before DOB support keep their stored age and load unchanged; no DOB is ever fabricated. Enter a date of birth once through Options → Edit user and it becomes the source of truth (the age key is dropped on save). A blank DOB stays allowed for legacy profiles while they keep using their stored age.
• DOB input validation: invalid dates and future dates are rejected with clear UI errors (YYYY-MM-DD, year 1900+).
• Unit tests: birthday-aware age math (including leap days), DOB validation, legacy profile loading, serialization round-trips, handshake age byte and multi-user independence (tests/test_dob.py).

Changed

• Options/Config flow user forms: "Age" replaced by "Date of birth" with an explanatory note ("your age is calculated automatically from this date"). No stable ids, device/entity relationships, Person links, measurement history or deletion behavior changed.

0.8.2 - 2026-09-09

Changed (repository presentation only - no functionality changes)

• README redesigned for HACS and general readability: release/HACS/ license/CI badges, grouped feature blocks, dedicated hardware and requirements sections, HACS-first installation, clearer multi-user and configuration guidance, and an accurate description of the offline last-known-value behavior introduced in v0.8.1.
• Privacy sanitization pass across the whole repository: no personal names, addresses, e-mail addresses, phone numbers, real Bluetooth MACs, private IPs/hostnames, or credentials are present in any tracked file. Protocol UUIDs and documentation placeholders (AA:BB:CC:DD:EE:FF, user@example.invalid) are kept.

0.8.1 - 2026-09-08

Fixed

• Sensor state persistence across BLE disconnects: user measurement and derived sensors no longer gate availability on the BLE connection state. Once a valid measurement exists, entities keep their last known value (and stay available) while the scale sleeps/disconnects, so history graphs keep a continuous line instead of showing a gap. The scale-level Connected binary sensor still reports link state independently.

0.8.0 - 2026-09-08

Changed (UI/UX polish only - no functionality/storage changes)

• Device branding: physical scale device friendly name is now the canonical Realme Smart Scale (MAC no longer part of the primary name; model metadata is RMH2011). User devices are named by the person only (no repeated "Realme Smart Scale - ..." prefix) under the scale via via_device. Stable device identifiers are unchanged.
• Entity metadata: Last Measured is now categorized DIAGNOSTIC; icons aligned (Muscle -> mdi:arm-flex, BMI -> mdi:human, Ideal Weight -> mdi:target); entity unique ids/entity ids are untouched.
• Handshake-profile select shows the person's name (no internal user id) unless names collide.
• Options flow copy: Remove-user screens now clearly state that removal permanently deletes the user's measurements, sensors and device (matching v0.7 deletion); "Home Assistant person (optional)" labels. No flow logic or deletion implementation changed.

Added

• Static UI-metadata tests (tests/test_ui_metadata.py).

0.7.0 - 2026-09-08

Changed

• Complete user deletion: coordinator.async_remove_user(user_id) (invoked only from Options → Remove User → Save & Close) now removes everything belonging to the user, keyed on the stable user_id:

  1. the user's HA entities (entity registry),
  2. the user's virtual device (device registry, stable (DOMAIN, f"{address}_{user_id}") identifier),
  3. the user's persisted measurement records (store deletion),
  4. all runtime state (users, _user_by_id, latest_by_user, _identity_state, last_measurement, active fallback).

  The physical scale device, other users, HA Person links and dashboard configuration are never touched. Deletion is idempotent and works with or without a Person link.

• Deletion only on explicit Options-Flow action: setup/reload never call the removal path, so HACS updates and restarts can never erase users or data. Users live in config_entry.options; measurements live in Home Assistant's .storage via Store (never the source directory).

Added

• Regression tests: full-cleanup implementation, registry API usage, deletion never invoked during startup/reload, save-close-only invocation, and persistent-storage-outside-source-dir guarantees.

0.6.3 - 2026-09-08

Fixed

• Save & Close "a coroutine was expected, got None": the config-entry options update listener _async_options_updated was a synchronous @callback function returning None, but HA awaits the listener. It is now an async def that directly awaits config_entries.async_reload (no async_create_task), keeping the no-change/no-coordinator early returns. @callback remains only where it is actually used (_register_services_once).

0.6.2 - 2026-09-08

Fixed

• Options menu displayed internal ids (e.g. add_user) instead of the human-readable labels: async_show_menu treats a dict as explicit labels, so _build_menu() now returns a list of step ids, letting Home Assistant resolve each entry through the menu_options translations. Action constants and async_step_* handlers are unchanged; strings.json/en.json labels are untouched.

0.6.1 - 2026-09-08

Fixed

• Options → Reassign menu UnknownStep: ACTION_REASSIGN now resolves to reassign_pick (canonical step), matching async_step_reassign_pick; the stale reassign_measurement menu key/label reference was removed from code and both translation files. assign_pick remains the canonical assign step.
• Save & Close while the scale is asleep/offline no longer fails: async_setup_entry() no longer refuses to start when the scale is not currently reachable (async_resolve_ble_device() gate removed). The coordinator keeps its background BLE retry loop, so config saves/reloads always persist and the scale reconnects when it becomes available.

Added

• Regression/structure tests: ACTION_REASSIGN == reassign_pick, every menu option maps to an implemented async_step_* handler, no stale assign_unknown/reassign_measurement navigation references remain, and async_setup_entry is not gated on BLE reachability while the coordinator retry loop is preserved.

0.6.0 - 2026-09-08

Architecture (identity model)

• Separated concepts: handshake profile (BLE), configured user (profile), detected user (owner of a measurement) are distinct; "Active user" UI is renamed Scale handshake profile everywhere and documented as not being the detected person.
• Identity baseline is separate from latest measurement. Baselines are rebuilt only from identity-valid stored records. With an expected weight configured, an out-of-range assignment (e.g. 52 kg handed to a 73 kg user) can never poison the identity range - the next ~52 kg reading still identifies the correct lighter user.
• Per-user identity fields: Expected weight (kg), Identification tolerance (kg), Impedance tolerance (Ohm); 0 falls back to the global automatic-identification defaults.
• User devices show only identity-valid measurements as their "latest".

Automatic identification (assignment.py rewrite, pure)

• Identity-range gating (expected +/- tolerance), impedance as secondary tie-breaker, no-match/ambiguous stay unassigned, single-user easy mode.
• Returns method (automatic_weight, automatic_weight_impedance, none) and confidence; both persist on records and are included in the measurement event payload.

Fixes

• Canonical flow step name assign_pick everywhere; the stale assign_unknown menu key/step reference is gone (menu key, Python action, strings and translations now all use assign_pick).
• Manual assignment returns a friendly "measurement no longer available" message instead of a raw traceback for stale records.

0.5.1 - 2026-09-08

Changed

• Options Flow follows the current HA API: async_get_options_flow is a @staticmethod @callback synchronous hook returning a no-argument RealmeScaleOptionsFlow(); the flow reads the entry from the parent OptionsFlow.config_entry property.
• Bluetooth metadata per current guidance: manifest depends on bluetooth_adapters (not bluetooth) and only advertises connectable discovery matchers (service UUID + scale-like names) — no connectable: false entries, since the RMH2011 needs an active GATT session.
• Discovery rejects non-connectable sources (not_connectable abort with a clear message/translation) instead of half-configuring a scale it cannot connect to.
• Menu wording: Add User / Edit User / Remove User / Active User / Assignment Settings / Assign Unknown Measurement / Reassign Measurement / Save & Close, first screen shows "Configured users: {count} / Unknown measurements: {pending}".
• README: "Adding additional users" section + Active User vs Assigned User explanation.

Added

• Regression/structure tests for the options flow: tests/test_user_management.py (step & hook presence, translation coverage for every menu action/step/error/abort, and the full add → edit → remove → zero-users storage journey).

0.5.0 - 2026-09-08

Changed

• Multi-user management spec: the scale stays a single config entry with users as profiles inside it (stable UUID ids, shared BLE coordinator, per-user devices under the scale). Add/edit/delete users from the entry's Options → Users & measurements.
• Zero-user support: the last user may now be deleted; the scale remains configured and measurements arrive as unassigned until a user is added.
• Delete confirmation: deleting a user now asks for explicit confirmation.
• History preserved on delete: a deleted user's stored measurements are kept and become unassigned records (re-attributable later), instead of being dropped.
• Wording aligned with the spec: Users / Add user / Edit user / Delete user throughout the options flow (no per-user "devices" language).

Fixed

• parse_user_options no longer invents a fallback user when the stored users list is explicitly empty (previously blocked zero-user mode).

0.4.4 - 2026-09-08

Fixed

• Opening entry Options returned "500 / Config flow could not be loaded": async_get_options_flow was declared async def, but Home Assistant invokes it synchronously and expects the flow instance; an un-awaited coroutine caused the 500. The hook is now a plain (non-async) static method, so the Users & measurements menu opens.

0.4.3 - 2026-09-08

Fixed

• Entry "Options" menu (Users & measurements) was missing entirely: RealmeScaleConfigFlow never registered async_get_options_flow, so Home Assistant did not expose the entry's Options at all. The hook is now wired and RealmeScaleOptionsFlow accepts the config entry it is constructed with. Add / edit / remove users now works from the entry card.

0.4.2 - 2026-09-08

Fixed

• "Add Integration → Realme Smart Scale" reported not_implemented: a refactor had left async_step_user / async_step_profile defined outside the RealmeScaleConfigFlow class, so Home Assistant could not find the starting step. The steps are proper class methods again.
• The address step now always uses a plain, universally serializable MAC text field (discovered scales are shown as a hint instead of a dropdown that some Home Assistant versions cannot render).

0.4.1 - 2026-09-07

Changed

• Repository branding: realme logo added as repo-root icon.png/logo.png (HACS) and as component brand assets custom_components/realme_scale/brand/{icon,logo}{,@2x}.png for Home Assistant 2026.3+.
• README: contributor credits section.

Fixed

• Integration Help link now points to this repository's documentation (was the upstream openScale repo).
• Options-flow Back navigation no longer raises not_implemented (missing async_step_menu handler for the menu step).

0.4.0 - 2026-09-07

Added

• Derived metric sensors per user (computed on the fly): BMI, body fat mass (kg), BMR (Schofield/WHO), ideal weight (Devine), protein % (Wang).
• Interpretation text sensors per user: BMI category (WHO), body-fat category (Gallagher age/sex bands), body-water level, visceral-fat rating and a simple body-type heuristic.
• realme_scale_measurement events for unassigned readings now also carry candidate_user_ids (parallel to candidate_users).
• Interactive confirm blueprint (blueprints/ realme_scale_confirm_measurement.yaml): push notification with one quick action per likely user; tapping assigns the measurement.
• README: derived-metrics reference table, medical disclaimer and formula sources.
• Unit tests for the metrics module (tests/test_metrics.py).

0.3.0 - 2026-09-07

Added

• CI: GitHub Actions workflow runs the pure-python test suite on push/PR.
• HA People integration: user setup/edit forms offer a dropdown of existing person.* entities; picking one auto-fills the profile name and links the profile (every sensor of that user then exposes person / person_entity_id attributes).
• Discovery filtering: only devices advertising the scale service UUID (0000a602) or a scale-like name token are offered by the integration — other realme BLE devices (e.g. "realme Buds Air7") are no longer detected as a scale.
• Multi-user support: every scale entry now holds a list of user profiles; users can be added / edited / removed after install from a menu-driven options flow.
• One HA device per user: each user's latest attributed measurement is exposed as its own device with the full sensor set.
• Active-user select entity plus options action to pick which profile is written into the scale handshake (reconnects to apply).
• Two-signal auto-attribution (weight + impedance fingerprints, both with configurable tolerances): measurements are matched to the user whose last reading is consistent with the new one.
• Confirm-before-assign semantics: readings that match nobody - or match several users - are not silently attributed; they stay unassigned and the event reports candidate_users (nearest first) for a confirm prompt.
• Persistent measurement store (per entry): every packet is recorded with a measurement_id; the bounded unassigned queue survives restarts.
• Assign unassigned measurements to a user later from Options → Assign unassigned measurements or via the new realme_scale.assign_measurement service; BIA figures are recomputed under the assigned user's profile.
• Reassign already-assigned records (Options → Reassign a recent measurement, or the same service) to fix wrong auto-assignments; the affected users' "latest" sensors are refreshed from the store.
• realme_scale_measurement events now carry measurement_id and status (assigned | unknown), plus candidate_users for ambiguous readings.
• README: per-user dashboard guide with example YAML and entity ids.
• Unit tests for attribution, record serialization and user-options parsing/migration (tests/test_assignment.py, test_records.py, test_options.py).

Fixed

• Config flow 500 on current Home Assistant: the manual MAC field no longer uses cv.matches_regex (newer schema serializers reject it); the MAC is validated in code instead.
• Discovery no longer matches unrelated realme BLE devices (see "Discovery filtering" above).
• Import of the measurement-id constant in store.py tidied up.

Changed

• Old single-profile entries migrate transparently: the flat profile becomes a one-user registry with the legacy user id.
• Sensor unique ids are now user-scoped (<unique>_user_<user_id>_<metric>). After upgrading, previously configured sensors appear as separate per-user entities; orphaned v0.1 entities may need to be removed from the entity registry.

0.1.1 - 2026-02-09

Added

• hacs.json (HACS-ready metadata for the custom component).
• CHANGELOG.md.
• GitHub Actions CI (pytest for the protocol/BIA unit tests).

Changed

• GATT write type now mirrors openScale's GattScaleAdapter: write-with-response is used unless the characteristic only advertises PROPERTY_WRITE_NO_RESPONSE.

0.1.0 - 2026-02-09

Added

• Initial release.
• Home Assistant custom integration for the realme Smart Scale RMH2011.
• Byte-faithful port of the openScale RealmeSmartScaleHandler protocol:
  • service 0000a602, characteristics a621 (notify), a622 (keep-alive), a624 (handshake), a625 (notify);
  • 6-step handshake to a624 with MAC-keyed XOR (MAC[i % 6]) body cipher;
  • keep-alive 00 01 D9 to a622 every 1 s;
  • live measurement stream on a621 (weight u16BE/100, scale time u32BE, impedance u16BE).
• Local body-composition engine ported from openScale YunmaiLib (body fat, water, muscle, bone mass, lean body mass, visceral fat).
• Config flow with BLE discovery and a user profile step (sex / age / height / activity level / initial weight), plus options flow.
• Nine sensors and a connectivity binary sensor.
• realme_scale_measurement HA event and realme_scale.reconnect service.
• Unit tests + hardware-free protocol smoke test (tests/).