gleeds / cloudbbq

A Bluetooth to MQTT bridge for the Tenergy Solis Digital Meat Thermometer and other similar devices.
MIT License
45 stars 12 forks source link
bluetooth bluetooth-le ibbq inkbird iot mqtt mqtt-bridge solis tenergy

Cloud BBQ

A Bluetooth to MQTT bridge for the Tenergy Solis Digital Meat Thermometer.

This code should run on MacOS or Linux. Ideally you could run this on a Raspberry Pi to act as a small dedicated bridge device.

This code will also likely work with other similar Bluetooth probes that show up with the bluetooth device name "iBBQ", but may require a different pairing key. See autoPairKey in constHelper.js.

Known Working Devices

Cloud BBQ is known to work on the following devices:

Feel free to open a ticket or PR to add other tested devices to this list.

Using Cloud BBQ

MacOS

Xcode is required for Noble's node-gyp compilation.

Noble library fails to install in most recent versions of node on Mac. Use NVM and try using Node 10.

Linux setup

See the Noble Linux setup.

Known Issues

Noble has been abandoned by it's maintainer and a fork has been taken up by the community at @abandonware/noble. Cloud BBQ has switched over to this library and it has been tested on NodeJS 10 and 8, at this point 10 is recommended. Newer versions of NodeJS are not currently compatible.

Device Configuration

Cloud BBQ defaults to expecting a 6 probe device. If your device has less probes, adjust the number in your default.json:

"device": {
    "probes":6
},

Localization

Set your favored temperature unit to either F or C in your default.json:

"localization":{
    "units":"F"
},

Using with Adafruit IO

To setup to work with Adafruit IO, create a group, and then add 6 topics, then edit your default.json to look something like this:

{
    "mqtt": {
        "username" : "USERNAME",
        "key":"KEY",
        "protocol":"mqtts",
        "url":"io.adafruit.com:8883",
        "topics":[
            "USERNAME/feeds/ibbq1",
            "USERNAME/feeds/ibbq2",
            "USERNAME/feeds/ibbq3",
            "USERNAME/feeds/ibbq4",
            "USERNAME/feeds/ibbq5",
            "USERNAME/feeds/ibbq6"
        ],
        "probeMessagePerPublish":12
    }
}

Note that Adafruit IO will only accept 30 messages per minute, and each message can only have 1 data point, so you need to dial down probeMessagePerPublish to keep under that limit. The Solis sends one update per second, so you can set this to 2 if you have only one probe connected, or leave it at 12 if you have all 6 probes connected.

Other MQTT Options

Cloud BBQ should be generally compatible with other MQTT services, however some like AWS IoT may require an additional library to make authentication easier. Starting with Adafruit is recommended since it's both easy and has out of the box support for live updating graphs of temperature.

Optional: Using with Google Home and Google Assistant for Notifications

Cloud BBQ can be configured to send a notification to Google Home devices using the Google Assistant's Broadcast functionality. Unfortunately the setup is a bit convoluted, especially if you're not already comfortable with GCP.

Configuration

  1. Follow the instructions here Configure Google Assistant API (This should be free, but still require setting up a Google Cloud Platform account I already had an account so I'm not sure)
  2. Create a "OAuth client ID" on the Credentials screen. Make sure you have your newly created project selected. Select the type of "Other".
  3. Click the Download icon next to your new client ID and save the file into the /config folder of Cloud BBQ.
  4. Update default.json with the name of your downloaded file, and set enabled to true.

Usage

  1. Set targets for any probe by starting Cloud BBQ with node app.js --probe1 150 --probe3 175 (npm doesn't seem to pass the arguments right)
  2. The first time it starts, your browser will launch asking you to grant permission to connect your instance of Cloud BBQ to your Google Account. THis should be the account that your Google Home devices are associated to if you used a different account Google Cloud Platform.
  3. You will be given a code to copy from your browser and past into your terminal.
  4. Subsequent launches should not require steps 2-3. When a probe crosses the set threshold, you should get a broadcast on every Google Home device in your house.
  5. Probes will only broadcast once each, even if they later fall below the set threshold. Restarting Cloud BBQ will reset this.

Protips