Add OralB Toothbrush

[arnog23]

Hello,
Would it be possible to add OralB Toothbrush to the Decoder ?

message received: topic: home/TGW_32/BTtoMQTT/XXXXXXXXXXXX, payload: b'{"manufacturerdata": "dc000202060220000001010004", "id": "XX:XX:XX:XX:XX:XX", "rssi": -77, "mfr": "Procter & Gamble"}', userdata: None

I was using the folllowing code with BLEA in Jeedom

from bluepy import btle
import time
import logging
import globals
import struct
from multiconnect import Connector
from notification import Notification

class OralB():
	def __init__(self):
		self.name = 'oralb'
		self.ignoreRepeat = False
		self.characteristicHandles = {
			'battery': '0x002d'
		}

	def isvalid(self,name,manuf='',data='',mac=''):
		if manuf.lower().startswith("dc00"):
			return True

	def parse(self,data,mac,name,manuf):
		action={}
		action['present'] = 1
		logging.debug('OralB------ Parse => Manufacturer : ' + manuf )
		status = manuf[10:12]
		if status == '02':
			logging.debug('OralB------ Advertising Data => Status : ' + str(status) + ' => Brushing stopped')
			action['status'] = 0
		elif status == '03':
			logging.debug('OralB------ Advertising Data => Status : ' + str(status) + ' => Brushing in progress')
			action['status'] = 1
		pressure = int(manuf[12:14],16)
		logging.debug('OralB------ Advertising Data => Pressure : ' + str(pressure))
		action['pressure'] = pressure
		brushingDurationMin = int(manuf[14:16],16)
		brushingDurationSec = int(manuf[16:18],16)
		brushingDuration = brushingDurationMin * 60 + brushingDurationSec
		logging.debug('OralB------ Advertising Data => Brushing Duration : ' + str(brushingDuration) + ' seconde(s)')
		action['brushingDuration'] = brushingDuration
		if status == '02' and brushingDuration > 0:
			logging.debug('OralB------ Advertising Data => Previous Brushing Duration : ' + str(brushingDuration) + ' seconde(s)')
			action['previousBrushingDuration'] = brushingDuration
		mode = manuf[18:20]
		if mode == '01':
			action['mode'] = 'Propreté'
			logging.debug('OralB------ Advertising Data => Mode : ' + str(mode) + ' => Propreté')
		elif mode =='02':
			action['mode'] = 'Douceur'
			logging.debug('OralB------ Advertising Data => Mode : ' + str(mode) + ' => Douceur')
		elif mode =='03':
			action['mode'] = 'Massage'
			logging.debug('OralB------ Advertising Data => Mode : ' + str(mode) + ' => Massage')
		elif mode =='04':
			action['mode'] = 'Blanchiment'
			logging.debug('OralB------ Advertising Data => Mode : ' + str(mode) + ' => Blanchiment')
		elif mode =='05':
			action['mode'] = 'Nettoyage Approfondi'
			logging.debug('OralB------ Advertising Data => Mode : ' + str(mode) + ' => Nettoyage Approfondi')
		quadrant = int(manuf[20:22],16)
		logging.debug('OralB------ Advertising Data => Quadrant : ' + str(quadrant))
		action['quadrant'] = quadrant
		if status == '02' and brushingDuration == 0 and quadrant == 15:
			try:
				conn = Connector(mac)
				conn.connect()
				if not conn.isconnected:
					conn.connect()
					if not conn.isconnected:
						return
				battery = conn.readCharacteristic(self.characteristicHandles['battery'])
				logging.debug('OralB------ Refreshing Data => Battery Hex : ' + str(battery.hex()) + ' / Dec :' + str(int(str(battery.hex()),16)) + ' %')
				action['battery'] = int(str(battery.hex()),16)
				action['id'] = mac
				logging.debug('OralB------'+str(action))
			except Exception as e:
				logging.error(str(e))
		return action

	def read(self,mac):
		result={}
		try:
			conn = Connector(mac)
			conn.connect()
			if not conn.isconnected:
				conn.connect()
				if not conn.isconnected:
					return
			battery = conn.readCharacteristic(self.characteristicHandles['battery'])
			logging.debug('OralB------ Refreshing Data => Battery Hex : ' + str(battery.hex()) + ' / Dec :' + str(int(str(battery.hex()),16)) + ' %')
			result['battery'] = int(str(battery.hex()),16)
			result['id'] = mac
			logging.debug('OralB------'+str(result))
			return result
		except Exception as e:
			logging.error(str(e))


      
globals.COMPATIBILITY.append(OralB)

Thanks

[DigiH]

Hi @arnog23,

There have been requests before for the inclusion of a Oral-B toothbrush advertising data decoder, but without continued user's help and testing it always seems to come to nothing in regards to a final releasable decoder …

Last trial so far

1technophile/OpenMQTTGateway#767

with one user having kept the latest test decoder. If you can create custom OpenMQTTGateway builds with PlatformIO I could bring this test decoder back online for further testing and verification, and I would also look more closely at your above quoted decoding.

One thing to note though is which model of an Oral-B toothbrush you have, as there do seem to be differences in decoding for different models.

Without users' help and support though it is not really possible for us, who do not have Oral-B BT toothbrushes, to confidently release an official decoder ;)

[arnog23]

Brushing stopped and put back on the docking but the status remains running. The stop message do not seems to be sent by the toothbrush.

I have tried again. When stopping it, I receive 3 times the "idle" state. May be I was too far when I have done the test the first time.

{"manufacturerdata": "dc0002020602200209010f1e04", "id": "5C:F8:21:FC:3C:00", "rssi": -50, "brand": "Oral-B", "model": "BT Toothbrush", "model_id": "OralB_BT", "type": "BODY", "state": "idle", "mode": "daily clean", "pressure": 32, "time": 129, "mfr": "Procter & Gamble"}

Thanks a lot for these data sets @arnog23 !

Thanks to you for this decoder ;-)

Correct, the battery level would need a connection, so not in the scope of this decoder.

Is there something existing or planned to get information using connections in another project? I would have been interested in getting information from Hydrao Shower head but it needs a connection to get them as it is not doing advertising.

I will also look into your raw manufacturerdata some more, just to see if anything has been missed, especially also with no sectors >4, and after brushing I would have expected the state to show "charging" when back on the dock.

I tried to take it from the dock:

{"manufacturerdata": "dc0002020602200000010f0004", "id": "5C:F8:21:FC:3C:00", "rssi": -73, "brand": "Oral-B", "model": "BT Toothbrush", "model_id": "OralB_BT", "type": "BODY", "state": "idle", "mode": "daily clean", "pressure": 32, "time": 0, "mfr": "Procter & Gamble"}

and wait until the bluetooth led turned off without using it. I put it back on the dock but nothing is sent.

I tried again to go after sector 4 and it shows again 0f and no charging state. It seems nothing is sent when putting it back on the dock. May be, it is needed to connect to it to get the charging state like the Battery level.

We have decided to include the Oral-B toothbrush decoder as it is now,

Thanks a lot 👍

[DigiH]

I have tried again. When stopping it, I receive 3 times the "idle" state. May be I was too far when I have done the test the first time.

Thanks for this confirmation.

Is there something existing or planned to get information using connections in another project? I would have been interested in getting information from Hydrao Shower head but it needs a connection to get them as it is not doing advertising.\

OpenMQTTGateway allows you to READ and WRITE service/chars through connections - currently only if no pin is required. But this only wirks with OpenMQTTGateway so far on an ESP32.

It would allow you to retrieve the battery status of your Oral-B as well and like your Hydrao Shower head.

The latter doesn't seem to be related to the Amphiro/Oras/Hansa shower head, which does indeed broadcast its data in the advertising data.

[arnog23]

The latter doesn't seem to be related to the Amphiro/Oras/Hansa shower head, which does indeed broadcast its data in the advertising data.

Thanks for this information. I did not noticed this device in the Theengs compatible BLE devices. Interesting to know it is broadcasting its information and supported. It makes me want to try it .... but Amphiro is twice the price of the Hydrao :( and I do not see the equivalent of the Rain Shower Head .

[arnog23]

I saw your commit:

[Oral-B Bluetooth Toothbrush](88279fe)

So does it means Theengs Gateway can, from now, decode Oral B without installing any special version of the decoder or is there something to do on Theengs Gateway side to take it into account?

[DigiH]

Not quite yet. The commit has been merged into the development branch of Theengs Decoder, so a custom build of development is still needed for the new decoder to work, until the next release of Decoder which is shortly followed by a new release of Theengs Gateway including all these new changes.

[MatrixEditor]

I don't know if it's relevant for your project anymore, but the full advertisement structure is now available at oralb/blesdk/brush.py. Maybe it helps you integrating the new parser for OralB toothbrushes.

For instance, the data shared in this discussion (dc000202060320000001010004) would be decoded into the following (after removing the company ID at the beginning).

>>> data = binascii.unhexlify(b"0202060320000001010004")
>>> data
b'\x02\x02\x06\x03 \x00\x00\x01\x01\x00\x04'
>>> unpack(data, BrushAdvertisement)
BrushAdvertisement(
    protocol=<ProtocolVersion.V002: 2>,
    type=<BrushType.D36_5_MODE: 2>,
    version=6,
    state=<State.RUN: 3>,
    status=32,
    brush_time_min=0,
    brush_time_sec=0,
    brush_mode=<Mode.DAILY_CLEAN: 1>,
    brush_progress=1,
    quadrant_completion=<Quadrant.FIRST_QUADRANT: 0>,
    total_quadrants=4
)

As this data conforms to protocol version 2, the status field contains the pressure value.

[DigiH]

Thanks a lot for this info @MatrixEditor

An Oral-B decoder has been implemented and merged with @arnog23's help above, but I will look into the full advertisement structure to see hiow we can extend the decoder.