openble-sonicare 0.1.0__py3-none-any.whl

openble/sonicare/__init__.py

@@ -0,0 +1,5 @@
+"""Philips Sonicare toothbrush GATT map and advertisement matching.
+
+``uuids`` names the characteristics the protocol manual records. Most byte
+layouts are still open; see docs/sonicare-toothbrush-protocol.md.
+"""

openble/sonicare/identify.py

@@ -0,0 +1,23 @@
+"""Match an advertisement to a Sonicare toothbrush."""
+
+from __future__ import annotations
+
+from openble.sonicare.uuids import CONDOR_SCAN_SERVICE, SONICARE_SCAN_SERVICE
+
+
+def classify(name: str, service_uuids: list[str]) -> tuple[list[str], list[str]]:
+    """Return the kinds (``toothbrush``, ``toothbrush-condor``) and the reasons."""
+    kinds: list[str] = []
+    reasons: list[str] = []
+    lowered = {item.lower() for item in service_uuids}
+    if SONICARE_SCAN_SERVICE in lowered:
+        kinds.append("toothbrush")
+        reasons.append("service 477ea600-…0001")
+    if "philips sonicare" in name.lower():
+        if "toothbrush" not in kinds:
+            kinds.append("toothbrush")
+        reasons.append("name Philips Sonicare")
+    if CONDOR_SCAN_SERVICE in lowered:
+        kinds.append("toothbrush-condor")
+        reasons.append("service e50ba3c0-…")
+    return kinds, reasons

openble/sonicare/uuids.py

@@ -0,0 +1,62 @@
+"""UUIDs named in the Sonicare protocol manual.
+
+Sonicare suffixes are the last four hex digits of
+477ea600-a260-11e4-ae37-0002a5d5. Comparison is case-insensitive.
+"""
+
+from __future__ import annotations
+
+CBT_PREFIX = "477ea600-a260-11e4-ae37-0002a5d5"
+
+SONICARE_SCAN_SERVICE = CBT_PREFIX + "0001"
+CONDOR_SCAN_SERVICE = "e50ba3c0-af04-4564-92ad-fef019489de6"
+
+# suffix -> (name, value kind). Kinds: hex, int, utf8.
+# int means the manual says the app parses an integer. Endianness is not recorded.
+CBT_CHARS = {
+    "4010": ("handle state", "hex"),
+    "4050": ("handle time", "int"),
+    "4020": ("available brushing routines", "hex"),
+    "4022": ("routine ids", "hex"),
+    "4040": ("cumulative motor runtime", "hex"),
+    "4090": ("brushing time", "hex"),
+    "4080": ("routine id", "hex"),
+    "4091": ("routine length", "hex"),
+    "4070": ("current session id", "hex"),
+    "40b0": ("intensity", "hex"),
+    "4082": ("routine state", "hex"),
+    "40d0": ("latest session id", "int"),
+    "40d5": ("session type", "hex"),
+    "40e0": ("active session id", "hex"),
+    "4110": ("sacp", "hex"),
+    "4100": ("session data", "hex"),
+    "40d2": ("available session count", "hex"),
+    "4130": ("sensor notification", "hex"),
+    "4120": ("selected sensor data", "hex"),
+    "4210": ("brush head 4210", "hex"),
+    "4230": ("brush head serial or nfc tag version", "hex"),
+    "4220": ("factory mode", "hex"),
+    "4280": ("lifetime limit", "hex"),
+    "4290": ("lifetime usage", "hex"),
+    "42c0": ("ring id", "hex"),
+    "4310": ("error value persistent", "hex"),
+    "4320": ("error value volatile", "hex"),
+    "4330": ("proximity", "hex"),
+    "4340": ("external flash", "hex"),
+    "4350": ("pressure sensor", "hex"),
+    "4360": ("invalid charger count", "hex"),
+    "4370": ("debug information", "hex"),
+    "4420": ("handle settings", "hex"),
+}
+
+
+def cbt(suffix: str) -> str:
+    return CBT_PREFIX + suffix.lower()
+
+
+def cbt_suffix(uuid: str) -> str | None:
+    """Return the four-digit Sonicare suffix, or None for any other uuid."""
+    text = uuid.lower()
+    if text.startswith(CBT_PREFIX):
+        return text[-4:]
+    return None

openble_sonicare-0.1.0.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.5
+Name: openble-sonicare
+Version: 0.1.0
+Summary: Philips Sonicare toothbrush GATT map and advertisement matching.
+Project-URL: Source, https://github.com/kadima-tech/openble/tree/main/packages/openble-sonicare
+Project-URL: Issues, https://github.com/kadima-tech/openble/issues
+Author: Kadima Tech
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ble,bluetooth,philips,sonicare,toothbrush
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# openble-sonicare
+
+The Philips Sonicare toothbrush GATT map, read from the Sonicare app's bytecode.
+
+- `openble.sonicare.uuids`: the `477ea600-…` service and characteristic ids, each with the name and value kind the app uses.
+- `openble.sonicare.identify`: matches advertisements to a Sonicare handle (`toothbrush`) or the second plugin family (`toothbrush-condor`).
+
+Pure Python 3.11+ with no dependencies. Most byte layouts, and the SACP writes, are still open. The protocol manual records what is known and what is not.
+
+```
+pip install openble-sonicare
+```
+
+```python
+from openble.sonicare.identify import classify
+from openble.sonicare.uuids import CBT_CHARS, cbt, cbt_suffix
+
+classify("Philips Sonicare", [cbt("0001")])
+# (['toothbrush'], ['service 477ea600-…0001', 'name Philips Sonicare'])
+
+CBT_CHARS[cbt_suffix(cbt("4050"))]
+# ('handle time', 'int')
+```
+
+## Protocol notes
+
+[docs/sonicare-toothbrush-protocol.md](https://github.com/kadima-tech/openble/blob/main/packages/openble-sonicare/docs/sonicare-toothbrush-protocol.md): discovery, connect, bonding and the GATT catalog.
+
+Not affiliated with Philips. The names identify the devices this interoperates with.
+
+## License
+
+[MIT License](https://github.com/kadima-tech/openble/blob/main/packages/openble-sonicare/LICENSE), copyright 2026 Kadima Tech.

openble_sonicare-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+openble/sonicare/__init__.py,sha256=j_ux20FfXgjahsP1gtNu66hNpmNBAIqval4bh6uwRBk,214
+openble/sonicare/identify.py,sha256=BE1kSFeyO8C7e2py-kdQ7s04N9uOBGJUBr_x_-g_yME,896
+openble/sonicare/uuids.py,sha256=2FH38AVgdatmDvYiJvkrF-uRyJC3lWzxPJXkMVGaHqM,2148
+openble_sonicare-0.1.0.dist-info/METADATA,sha256=zEsRLHKZVHl47w83Xd2ukLziCH6oZvhg4LhrWd89WUw,2108
+openble_sonicare-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+openble_sonicare-0.1.0.dist-info/licenses/LICENSE,sha256=2ADkKbgMDodZbkCMTH4VqSEweX3QaN52awlDvRoMPWQ,1068
+openble_sonicare-0.1.0.dist-info/RECORD,,

openble_sonicare-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

openble_sonicare-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kadima Tech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.