MMM-OralB / Bluetooth equipped toothbrush integration

[lavolp3]

A small heads-up: Still not getting to terms with noble.

But as I had some connection problems today, I used bluetoothctl again to connect to my brush.
And found out that scanning with bluetoothctl gets a constant output of the manufacturerData of the brush.

With bluetoothctl it would be able to get information on

• running time
• mode (on/off)
• quadrant
  in an interval of like 10 seconds

[timodejong95]

Hey guys,

I have tracked this topic for a while and I have created an own module for bluetooth devices based on (https://github.com/Hypfer/Cybele). Currently only Oral B toothbrush is supported: https://github.com/timodejong95/MMM-BluetoothDevices

I am still testing it but it seems to work stable’ish. Although I cannot test it with an actual mirror because that is still work in progress. If you want to check it out and test be my guest. If you have any improvements or tips let me know!

Hope this helps out.

[lavolp3]

@timodejong95 GREAT!!
I’ll try it out now.
One comment to the readme.
You have given the config entry in JSON style (with hyphens around the keys).
Config entries are in JS style.
I guess devices should also be an array of JS objects?

Then it should be like this:

    {
      module: "MMM-BluetoothDevices",
      position: "bottom_bar",
      config: {
        devices: [
          { type: "OralBToothbrush", name: "OralB", mac: "" }
        ]
      }
    },

[lavolp3]

@lavolp3 Also mentioning in the Readme that npm install is necessary would be helpful

[lavolp3]

OK I have a first error message

[15:04:46.174] [ERROR]  15:04:46 <error> (node:1454) UnhandledPromiseRejectionWarning: Error: No such interface found
    at /home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/dbus-native/lib/introspect.js:31:23
    at Parser.<anonymous> (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/xml2js/lib/parser.js:304:18)
    at Parser.emit (events.js:182:13)
    at SAXParser.onclosetag (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/xml2js/lib/parser.js:262:26)
    at emit (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/sax/lib/sax.js:624:35)
    at emitNode (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/sax/lib/sax.js:629:5)
    at closeTag (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/sax/lib/sax.js:889:7)
    at SAXParser.write (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/sax/lib/sax.js:1436:13)
    at Parser.exports.Parser.Parser.parseString (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/xml2js/lib/parser.js:323:31)
    at Parser.parseString (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/xml2js/lib/parser.js:5:59) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)

no Toothbrush activated yet. Only started the mirror with npm start dev.
Running on a RasPi 3b w/ on-board bluetooth

[timodejong95]

Ooh good one, I have some time tonight, will update the docs.

Hmm you running on raspberry pi do you got bluetooth enabled? Can you find the toothbrush if you use the GUI bluetooth?

If you got the time could we skype or call, it’s faster to tackle issueus, PM me about that.

[lavolp3]

@timodejong95 that’s rather difficult for me juggling with family, (home) office and several other things I have to say. Will think about this and let you know.

I have worked successfully with bluetoothctl and noble (npm).
Both were able to connect to the brush.
With bluetoothctl I got a constant stream of the manufacturer data that contains some info. (see above)
I used that straight from the console.

[lavolp3]

@timodejong95 OK I have identified the source of the error.
It originated from the connectDevice function on Dongle.js
I had a wrong mac address for the brush which leads to an unresolved promise.
Good luck finding the promise :smiling_face_with_open_mouth_smiling_eyes:
(I love/hate promises…)

Correcting the mac address I get new unresolved rejection errors.

[11:54:35.940] [LOG]    11:54:35 <log> Retrying Dirks OralB 2/3 (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/src/Device.js:42 Promise)
[11:54:35.964] [ERROR]  11:54:35 <error> (node:23373) UnhandledPromiseRejectionWarning: Software caused connection abort (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:54:35.970] [ERROR]  11:54:35 <error> (node:23373) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:54:35.975] [ERROR]  11:54:35 <error> (node:23373) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code. (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:16.260] [LOG]    11:55:16 <log> Retrying Dirks OralB 3/3 (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/src/Device.js:42 Promise)
[11:55:16.275] [ERROR]  11:55:16 <error> (node:23373) UnhandledPromiseRejectionWarning: Software caused connection abort (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:16.279] [ERROR]  11:55:16 <error> (node:23373) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 2) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:56.582] [ERROR]  11:55:56 <error> (node:23373) UnhandledPromiseRejectionWarning: Error: Couldn't connect to Dirks OralB after 4 tries.
    at Promise (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/src/Device.js:46:16)
    at new Promise (<anonymous>)
    at tryConnect (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/src/Device.js:40:14)
    at Object.iFace.Connect (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/src/Device.js:56:13)
    at EventEmitter.<anonymous> (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/dbus-native/lib/bus.js:140:19)
    at EventEmitter.emit (events.js:187:15)
    at /home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/dbus-native/index.js:106:14
    at Socket.<anonymous> (/home/pi/MagicMirror/modules/MMM-BluetoothDevices/node_modules/dbus-native/lib/message.js:55:9)
    at Socket.emit (events.js:182:13)
    at emitReadable_ (_stream_readable.js:540:12) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:56.588] [ERROR]  11:55:56 <error> (node:23373) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 3) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:56.593] [ERROR]  11:55:56 <error> (node:23373) UnhandledPromiseRejectionWarning: Software caused connection abort (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)
[11:55:56.599] [ERROR]  11:55:56 <error> (node:23373) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 4) (/home/pi/MagicMirror/internal/process/warning.js:18 writeOut)

So… Software caused connection abort. Don’t know what that means unfortunately. Guess I need to learn a bit more about the connection process. But I get the feeling that this module is a bit too complex for just using with my toothbrush.
Let me know if you know my problem.

[timodejong95]

@lavolp3 Check, I will update the docs, with more info soon.

Yeah promises could be really nice if implemented correctly, now debugging is a pain because the error logs are not as useful. I will make this better in the coming week.

When you hit the web interfase the node_helper is triggered, do you then have your brush on? Because when you start up the first time, alle the devices should be on and ready to connect.

[timodejong95]

I have tweaked the code a bit towards better exception handling, this might be helpful for you

[djerik]

Works great with my Oral B 9000!

Notes:

• I had to change the git clone to https instead of git clone git@github.com:timodejong95/MMM-BluetoothDevices.git
• Copying the file MMM.conf requires administrative rights
• I used bluetoothctl to find the MAC of the toothbrush

[timodejong95]

@djerik Nice! Good to hear, and thanks for the feedback I will update the readme where needed!

[lavolp3]

@timodejong95 Hi Timo, it works for me now as well. Very good!
So now let’s go for the holy grail! The battery status.
It is there and I managed to get it out using noble. Don’t ask me how. Lol.
Find the code below where I meddled with Advertisements and Characteristics:

noble.on('discover', function(peripheral) {
  var ad = peripheral.advertisement || "";
  if (ad.localName == "Oral-B Toothbrush") {
    //console.log('Found device with local name: ' + ad.localName);
    //console.log('advertising the following service uuid\'s: ' + ad.serviceUuids);
    //console.log("ID: "+peripheral.id);
    //console.log("Advertisement: "+ad);
    if (ad.manufacturerData) {
        console.log('Found OralB Toothbrush with ID: ' + peripheral.id);
        console.log('ManufacturerData: '+ad.manufacturerData.toString('hex'));
        //noble.stopScanning();
        peripheral.connect(function(error) {
          if (error) {
            console.log("Error connecting to peripheral: " +error);
          } else {
            console.log('Connected to peripheral: ' + peripheral.uuid);
            peripheral.discoverServices([], function(error, services) {
              console.log("Discovering services...");
              if (error) {
                  console.log("ERROR while discovering peripherals: " + error);
              } else {
                  console.log('discovered the following services:');
                  for (var i in services) {
                      //console.log('  ' + i + ' uuid: ' + services[i].uuid);
                  }
                  discoverChars(services[3]);
                  /*setTimeout(() => {
                    noble.startScanning([], true);
                  }, 1000);*/

              }
              //peripheral.disconnect();
            });
          }
        });

        peripheral.on('disconnect', function() {
          process.exit(0);
          console.log("Peripheral disconnected. Scanning again!");
          noble.startScanning();
        });
    }
  }
});


function discoverChars(service) {
  service.discoverCharacteristics(null, function(error, characteristics) {
    //console.log("Characteristics: "+characteristics);
    for (let i in characteristics) {
      var charUUID = characteristics[i].uuid;
      console.log('  ' + i + ' uuid: ' + charUUID);
      if (characteristics[i].uuid == "a0f0ff0550474d5382084f72616c2d42") {
        let j = i;
        characteristics[j].on('data', function(data, isNotification) {
            console.log("Data: "+data);
            var valueInt = data.readInt8(0);
            console.log("Battery: "+valueInt+"%");
        });
        /*characteristics[j].read(function(error, data) {
            if (data) {
              var valueInt = data.readInt8(0);
              console.log("Battery: "+valueInt+"%");
            }
        });*/
        characteristics[j].subscribe(function(error) {
            if (error !== null) { console.log("error", error); }
        });

      }
    }
  });
}

I guess you can find the same using bluez?

If I find the time, I’ll also try out which way works better (for me).
Noble or your blues dbus way. I had several issues using noble but it had its charme (like the battery status :-) and only sending data when I activate or deactivate the brush)

[dfuerst]

@timodejong95 nice that there was someone realizing this project at the end.

tried your app and getting a blank WHITE SCREEN.
so maybe u can help me troubleshooting

1 cloned via https
2 did npm install
3 sudo cp MMM.conf
4 added conf including MAC (sidenote, white screen with wrong MAC address aswell)
5 paired the toothbrush via bluetooth

tried to start mirror -> white screen, and whoops message in the log

any idea what could cause this? or where to start troubleshooting?

[timodejong95]

@lavolp3 Thanks for the code share and great to hear it works. This weekend I will spend some to see if I can fix it, I let you know.

@dfuerst Hmm oké, thats weird normally you would see a black screen. Doest the mirror work if you disable the plugin, if so what does the logs say?

FYI: I had some issues with my git commits so I deleted and recreated the repo, no worries it’s still under the same url and won’t go away.

[lavolp3]

@timodejong95 Hi Timo,

since I really want to have the battery status I am currently trying to use the front end code with noble as backend in node_helper. Your backend code and all the GATT bluez stuff is much too complicated for me.

Also, I have done some tweaks on the frontend:

• Hide timer after some time
• convert time to m:ss
• also count on beyond 2 minutes (circle is filled after 2 Minutes)
• make timer bright and circle blue when the brush is running and dim it back again if it is not running.

Like it very much. Very simple tweaks in the main.js. Let me know if you want to see any of it.

Also, two brushes work perfectly! :ok_hand:

Impressive work man!

[timodejong95]

Thanks I really appreciate that! Yeah sure I am willing to refactor it a bit, if needed, and make it a configurable option.
Again sorry for deleting the repo, I pushed wit the wrong git user (work one). I saw that you starred/forked it.

Can you show me the changes or make a PR?

The GATT is a bit bugged I am not sure why but the services are not resolving. I am trying to fix that and I think that after that the battery status should be that hard anymore.

[timodejong95]

This post is deleted!

[lavolp3]

I can’t PR to your new repo, so here’s the code from MMM-BluetoothDevices.js:

/*jshint esversion: 6 */
//'use strict';

Module.register('MMM-BluetoothDevices', {
  // Default module config.
  defaults: {
    name: 'raspberrypi',
    mode: 'le',
    hci: 'hci0',
    interfaceName: 'org.bluez.Adapter1',
    services: [
      { type: 'CurrentTimeService' },
    ],
    devices: [],
    layout: {
      title: {
        position: 'bottom',
        key: 'name',
      },
      data: {
        position: 'bottom',
        fields: [
          { key: 'mode', text: 'mode' },
        ],
      },
    },
    hideAfter: 10 * 60,
  },

  getStyles() {
    return ['MMM-BluetoothDevices.css'];
  },

  // Override dom generator.
  getDom() {
    const wrapper = document.createElement('div');
    wrapper.classList.add('toothbrushes');

    if (this.loading) {
      wrapper.innerHTML = 'Loading...';
      wrapper.className = 'light small';

      return wrapper;
    }

    const table = document.createElement('table');
    const row = document.createElement('tr');

    for (const deviceKey in this.devices) {
      const deviceType = this.devices[deviceKey].device.type;

      if (deviceType === 'OralBToothbrush') {
        row.appendChild(this.renderToothbrush(deviceKey));
      } else {
        throw new Error(`Unknown device type: ${deviceType}`);
      }
    }

    table.appendChild(row);
    wrapper.appendChild(table);

    return wrapper;
  },

  renderToothbrush(deviceKey) {
    const device = this.devices[deviceKey];
    const deviceTd = document.createElement('td');
    deviceTd.classList.add('toothbrush');
    deviceTd.style.textAlign = "center";

    const deviceCircle = document.createElement('div');
    deviceCircle.classList.add('toothbrush-circle-container');
    deviceCircle.classList.add(`toothbrush-circle-${device.data.state}`);

    const deviceCircleText = document.createElement('div');
    deviceCircleText.classList.add('toothbrush-circle-text');

    const deviceCircleSvg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
    deviceCircleSvg.classList.add('toothbrush-circle-ring');

    const deviceCircleSvgCircle = document.createElementNS('http://www.w3.org/2000/svg', 'circle');
    deviceCircleSvgCircle.classList.add('toothbrush-circle');
    deviceCircleSvgCircle.setAttribute('stroke-width', 15);
    deviceCircleSvgCircle.setAttribute('fill', 'transparent');
    deviceCircleSvgCircle.setAttribute('r', 52);
    deviceCircleSvgCircle.setAttribute('cx', 60);
    deviceCircleSvgCircle.setAttribute('cy', 60);

    deviceCircleSvg.append(deviceCircleSvgCircle);
    deviceCircle.append(deviceCircleSvg);
    deviceCircle.append(deviceCircleText);

    //const time = device.data.time > 120 ? 120 : device.data.time;
    const time = device.data.time;

    // initial start
    this.updateCircle(deviceCircleSvgCircle, deviceCircleText, time);

    if (device.data.state === 'running') {
      deviceTd.style.display = 'block';
      deviceCircleText.classList.add('bright');
      deviceCircleSvgCircle.setAttribute('stroke', '#0080fe');
      this.counters[deviceKey] = {
        time,
        interval: setInterval(() => {

          this.counters[deviceKey].time += 1;

          this.updateCircle(
            deviceCircleSvgCircle,
            deviceCircleText,
            this.counters[deviceKey].time
          );
        }, 1000),
      };
    } else {
      deviceCircleText.classList.remove("bright");
      deviceCircleSvgCircle.setAttribute('stroke', '#aaa');
      setInterval(() => {
        deviceTd.style.display = "none";
      }, this.config.hideAfter * 1000);
    }

    const deviceLabel = document.createElement('div');
    deviceLabel.classList.add('title');
    deviceLabel.classList.add('small');
    deviceLabel.innerText = device.device[this.config.layout.title.key];

    const dataContainer = document.createElement('div');
    dataContainer.classList.add('small');
    dataContainer.classList.add('light');
    for (const key in this.config.layout.data.fields) {
      const data = this.config.layout.data.fields[key];
      const field = document.createElement('div');
      field.innerText = `${data.key}: ${device.data[data.key]}`;
      dataContainer.appendChild(field);
    }

    if (this.config.layout.title.position === 'top') {
      deviceTd.appendChild(deviceLabel);
    }
    if (this.config.layout.data.position === 'top') {
      deviceTd.appendChild(dataContainer);
    }

    deviceTd.appendChild(deviceCircle);

    if (this.config.layout.title.position === 'bottom') {
      deviceTd.appendChild(deviceLabel);
    }
    if (this.config.layout.data.position === 'bottom') {
      deviceTd.appendChild(dataContainer);
    }

    return deviceTd;
  },

  updateCircle(deviceCircleSvgCircle, deviceCircleText, time) {
    var secs = time % 60;
    deviceCircleText.innerText = Math.floor(time / 60) + ":" + (secs < 10 ? "0" + secs : secs);

    const radius = parseInt(deviceCircleSvgCircle.getAttribute('r'));
    const circumference = radius * 2 * Math.PI;
    if (time > 120) { time = 120; }
    const percent = (100 / 120) * time;
    const offset = circumference - percent / 100 * circumference;
    deviceCircleSvgCircle.style.strokeDasharray = `${circumference} ${circumference}`;
    deviceCircleSvgCircle.style.strokeDashoffset = offset;
  },

  start() {
    Log.info(`Starting module: ${this.name}`);

    this.devices = {};
    this.counters = {};
    this.loading = true;

    this.sendSocketNotification('FETCH_TOOTHBRUSHES', this.config);
  },

  socketNotificationReceived(notification, payload) {
    if (notification === 'FETCH_TOOTHBRUSHES_RESULTS') {
      Log.info('MMM-Toothbrush: Got toothbrush results');
      this.devices = payload;

      for (const counterKey in this.counters) {
        const counter = this.counters[counterKey];
        clearInterval(counter.interval);
      }

      if (this.loading) {
        this.loading = false;
        this.updateDom(1000);
      } else {
        this.updateDom(0);
      }
    }
  },
});

it’s also in the develop branch of my module

[timodejong95]

@lavolp3 Thanks, I will have a look at that this weekend.

Also managed to connect to the services and characteristics. But how did you know the one you needed?

Because you only connecting to the 3th key in the services array and a hardcoded uuid for the characteristics. I am curious how you find the one you needed.