![\"MicroPython](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/MicroPython-ESP32-ESP8266-NodeMCU-MQTT-Publish-BME680-Temperature-Humidity-Pressure-Gas-Readings.jpg?resize=1200%2C675&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nRecommended reading:<\/strong> What is MQTT and How It Works<\/a> <\/p>\n\n\n\n Note: <\/strong> this tutorial is compatible with both the ESP32 and ESP8266 development boards.<\/em><\/p>\n\n\n\n The following diagram shows a high-level overview of the project we’ll build.<\/p>\n\n\n\n Before continuing with this tutorial, make sure you complete the following prerequisites:<\/p>\n\n\n\n To follow this tutorial you need MicroPython firmware installed in your ESP32 or ESP8266 boards. You also need an IDE to write and upload the code to your board. We suggest using Thonny IDE or uPyCraft IDE:<\/p>\n\n\n\n To use MQTT, you need a broker. We’ll be using Mosquitto broker<\/a> installed on a Raspberry Pi. Read How to Install Mosquitto Broker on Raspberry Pi<\/a>.<\/p>\n\n\n\n If you’re not familiar with MQTT make sure you read our introductory tutorial: What is MQTT and How It Works<\/a><\/p>\n\n\n\n For this tutorial you need the following parts:<\/p>\n\n\n\n You can use the preceding links or go directly to MakerAdvisor.com\/tools<\/a> to find all the parts for your projects at the best price!<\/p> To use MQTT with the ESP32\/ESP8266 and MicroPython, we’ll use the umqttsimple<\/em>.py library. Follow the next set of instructions for the IDE you’re using:<\/p>\n\n\n\n View raw code<\/a><\/p>\n\n\n\n 1.<\/strong> Create a new file by pressing the New File<\/strong> button.<\/p>\n\n\n\n 2.<\/strong> Copy the umqttsimple<\/em> library code into it. You can access the umqttsimple<\/em> library code in the following link:<\/p>\n\n\n\n 3.<\/strong> Save the file by pressing the Save<\/strong> button.<\/p>\n\n\n\n 4.<\/strong> Call this new file \u201cumqttsimple.py<\/strong>\u201d and press ok<\/strong>.<\/p>\n\n\n\n 5.<\/strong> Click the Download and Run<\/strong> button.<\/p>\n\n\n\n 6.<\/strong> The file should be saved on the device<\/em> folder with the name \u201cumqttsimple.py<\/strong>\u201d as highlighted in the figure below.<\/p>\n\n\n\n Now, you can use the library functionalities in your code by importing the library.<\/p>\n\n\n\n 1.<\/strong> Copy the library code to a new file. The umqttsimple library code can be found here<\/a>.<\/p>\n\n\n\n 2.<\/strong> Go to File<\/strong> > Save as…<\/strong><\/p>\n\n\n\n 3.<\/strong> Select save to “MicroPython device<\/strong>“:<\/p>\n\n\n\n 4.<\/strong> Name your file as umqttsimple.py<\/em> and press the OK button:<\/p>\n\n\n\n And that’s it. The library was uploaded to your board. To make sure that it was uploaded successfully, go to File > Save as… and select the MicroPython device. Your file should be listed there:<\/p>\n\n\n\n After uploading the library to your board, you can use the library functionalities in your code by importing the library.<\/p>\n\n\n\n The library to read from the BME680 sensor isn\u2019t part of the standard MicroPython library by default. So, you need to upload the following library to your ESP32\/ESP8266 board (save it with the name bme680.py<\/em>).<\/p>\n\n\n View raw code<\/a><\/p>\n\n\n\n Wire the BME680 sensor<\/a> to the ESP32 development board as shown in the following schematic diagram. <\/p>\n\n\n\n Learn how to use the ESP32 GPIOs with our guide: ESP32 Pinout Reference: Which GPIO pins should you use?<\/a> <\/p>\n\n\n\n If you’re using an ESP8266 NodeMCU, follow the next diagram instead.<\/p>\n\n\n\n Learn how to use the ESP8266 GPIOs with our guide: ESP8266 Pinout Reference: Which GPIO pins should you use?<\/a><\/p>\n\n\n\n After uploading the libraries to the ESP32 or ESP8266, copy the following code to the main.py<\/em> file. It publishes the temperature, humidity and pressure on the esp\/bme680\/temperature<\/strong>, esp\/bme680\/humidity<\/strong>, esp\/bme680\/pressure<\/strong>, and esp\/bme680\/gas<\/strong> topics every 5 seconds.<\/p>\n\n\n View raw code<\/a><\/p>\n\n\n\n Import the following libraries:<\/p>\n\n\n\n In the following variables, you need to enter your network credentials and your broker IP address.<\/p>\n\n\n\n For example, our broker IP address is: 192.168.1.106.<\/p>\n\n\n\n Note:<\/strong> read this tutorial<\/a> to see how to get your broker IP address.<\/p>\n\n\n\n To create an MQTT client, we need to get the ESP unique ID. That\u2019s what we do in the following line (it is saved on the client_id<\/span> variable).<\/p>\n\n\n\n Next, create the topics you want your ESP to be publishing in. In our example, it will publish temperature on the esp\/bme680\/temperature<\/strong> topic, humidity on the esp\/bme680\/humidity<\/strong> topic, pressure on the esp\/bme680\/pressure<\/strong> topic, and gas on the esp\/bme680\/gas<\/strong> topic .<\/p>\n\n\n\n Then, create the following variables:<\/p>\n\n\n\n The last_message<\/span> variable will hold the last time a message was sent. The message_interval<\/span> is the time between each message sent. Here, we\u2019re setting it to 5 seconds (this means a new message will be sent every 5 seconds). You can change it, if you want. <\/p>\n\n\n\n After that, connect the ESP to your local network.<\/p>\n\n\n\n Create an i2c<\/span> instance on the ESP32 I2C pins to communicate with the BME680 sensor:<\/p>\n\n\n\n If you’re using an ESP8266, use the following line instead (to use the ESP8266 default I2C pins).<\/p>\n\n\n\n Create a BME680 instance on the ESP I2C pins:<\/p>\n\n\n\n The connect_mqtt()<\/span> function creates an MQTT Client and connects to your broker.<\/p>\n\n\n\n If your MQTT broker requires username and password, you should use the following line to pass your broker username and password as arguments.<\/p>\n\n\n\n The restart_and_reconnect()<\/span> function resets the ESP32\/ESP8266 board. This function will be called if we’re not able to publish the readings via MQTT in case the broker disconnects.<\/p>\n\n\n\n We created a function called read_bme_sensor()<\/span> that returns the current temperature, humidity and pressure readings from the BME680 sensor and handles any exceptions, in case we’re not able to get readings from the sensor.<\/p>\n\n\n\n In the while loop, we publish new BME680 readings every 5 seconds.<\/p>\n\n\n\n First, we check if it is time to get new readings:<\/p>\n\n\n\n If it is, request new readings from the BME680 sensor by calling the read_bme_sensor()<\/span> function. The temperature is saved on the temp<\/span> variable, the humidity is saved on the hum<\/span> variable and the pressure on the pres<\/span> variable.<\/p>\n\n\n\n Finally, publish the readings by using the publish()<\/span> method on the client<\/span> object. The publish()<\/span> method accepts as arguments the topic and the message, as follows:<\/p>\n\n\n\n Finally, update the time when the last message was sent:<\/p>\n\n\n\n In case the ESP32 or ESP8266 disconnects from the broker, and we’re not able to publish the readings, call the restart_and_reconnect()<\/span> function to reset the ESP board and try to reconnect to the broker.<\/p>\n\n\n\n After uploading the code, you should get new sensor readings on the shell every 5 seconds.<\/p>\n\n\n\n Now, go to the next section to prepare Node-RED to receive the readings the ESP is publishing.<\/p>\n\n\n\n The ESP32 or ESP8266 is publishing temperature readings every 10 seconds on the esp\/bme680\/temperature<\/strong>, esp\/bme680\/humidity<\/strong>, esp\/bme680\/pressure<\/strong> and esp\/bme680\/gas<\/strong> topics. Now, you can use any dashboard that supports MQTT or any other device that supports MQTT to subscribe to those topics and receive the readings.<\/p>\n\n\n\n As an example, we’ll create a simple flow using Node-RED to subscribe to those topics and display the readings on gauges.<\/p>\n\n\n\n If you don’t have Node-RED installed, follow the next tutorials:<\/p>\n\n\n\n Having Node-RED running on your Raspberry Pi, go to your Raspberry Pi IP address followed by :1880.<\/p>\n\n\n\n The Node-RED interface should open. Drag four MQTT in nodes, two gauge nodes, and two text fields to the flow.<\/p>\n\n\n\n Click the MQTT node and edit its properties.<\/p>\n\n\n\n The Server field refers to the MQTT broker. In our case, the MQTT broker is the Raspberry Pi, so it is set to localhost:1883. If you’re using a Cloud MQTT broker, you should change that field. <\/p>\n\n\n\n Insert the topic you want to be subscribed to and the QoS. This previous MQTT node is subscribed to the esp\/bme680\/temperature<\/strong> topic. <\/p>\n\n\n\n Click on the other MQTT in nodes and edit its properties with the same server, but for the other topics: esp\/bme680\/humidity<\/strong>, esp\/bme680\/pressure<\/strong>, and esp\/bme680\/gas<\/strong>.<\/p>\n\n\n\n Click on the gauge nodes and edit its properties for each reading. The following node is set for the temperature readings. Edit the other chart node for the humidity readings.<\/p>\n\n\n\n Wire your nodes as shown below:<\/p>\n\n\n\n Finally, deploy your flow (press the button on the upper right corner).<\/p>\n\n\n\n Alternatively, you can go to Menu <\/strong>> Import <\/strong>and copy the following to your Clipboard<\/strong> to create your Node-RED flow.<\/p>\n\n\nProject Overview<\/h2>\n\n\n\n
![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/ESP32-ESP8266-NodeMCU-Overview-MQTT-Publish-BME680-Temperature-Humidity-Pressure-Gas-Readings.png?resize=886%2C632&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nPrerequisites<\/h2>\n\n\n\n
MQTT Broker<\/h3>\n\n\n\n
![\"Mosquitto](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/01\/mosquitto-broker.png?resize=200%2C197&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nParts Required<\/h3>\n\n\n\n
![](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/10\/header-200.png?w=1200&quality=100&strip=all&ssl=1\")
<\/a><\/p>\n\n\n\numqtttsimple Library<\/h2>\n\n\n\n
try:\n import usocket as socket\nexcept:\n import socket\nimport ustruct as struct\nfrom ubinascii import hexlify\n\nclass MQTTException(Exception):\n pass\n\nclass MQTTClient:\n\n def __init__(self, client_id, server, port=0, user=None, password=None, keepalive=0,\n ssl=False, ssl_params={}):\n if port == 0:\n port = 8883 if ssl else 1883\n self.client_id = client_id\n self.sock = None\n self.server = server\n self.port = port\n self.ssl = ssl\n self.ssl_params = ssl_params\n self.pid = 0\n self.cb = None\n self.user = user\n self.pswd = password\n self.keepalive = keepalive\n self.lw_topic = None\n self.lw_msg = None\n self.lw_qos = 0\n self.lw_retain = False\n\n def _send_str(self, s):\n self.sock.write(struct.pack("!H", len(s)))\n self.sock.write(s)\n\n def _recv_len(self):\n n = 0\n sh = 0\n while 1:\n b = self.sock.read(1)[0]\n n |= (b & 0x7f) << sh\n if not b & 0x80:\n return n\n sh += 7\n\n def set_callback(self, f):\n self.cb = f\n\n def set_last_will(self, topic, msg, retain=False, qos=0):\n assert 0 <= qos <= 2\n assert topic\n self.lw_topic = topic\n self.lw_msg = msg\n self.lw_qos = qos\n self.lw_retain = retain\n\n def connect(self, clean_session=True):\n self.sock = socket.socket()\n addr = socket.getaddrinfo(self.server, self.port)[0][-1]\n self.sock.connect(addr)\n if self.ssl:\n import ussl\n self.sock = ussl.wrap_socket(self.sock, **self.ssl_params)\n premsg = bytearray(b"\\x10\\0\\0\\0\\0\\0")\n msg = bytearray(b"\\x04MQTT\\x04\\x02\\0\\0")\n\n sz = 10 + 2 + len(self.client_id)\n msg[6] = clean_session << 1\n if self.user is not None:\n sz += 2 + len(self.user) + 2 + len(self.pswd)\n msg[6] |= 0xC0\n if self.keepalive:\n assert self.keepalive < 65536\n msg[7] |= self.keepalive >> 8\n msg[8] |= self.keepalive & 0x00FF\n if self.lw_topic:\n sz += 2 + len(self.lw_topic) + 2 + len(self.lw_msg)\n msg[6] |= 0x4 | (self.lw_qos & 0x1) << 3 | (self.lw_qos & 0x2) << 3\n msg[6] |= self.lw_retain << 5\n\n i = 1\n while sz > 0x7f:\n premsg[i] = (sz & 0x7f) | 0x80\n sz >>= 7\n i += 1\n premsg[i] = sz\n\n self.sock.write(premsg, i + 2)\n self.sock.write(msg)\n #print(hex(len(msg)), hexlify(msg, ":"))\n self._send_str(self.client_id)\n if self.lw_topic:\n self._send_str(self.lw_topic)\n self._send_str(self.lw_msg)\n if self.user is not None:\n self._send_str(self.user)\n self._send_str(self.pswd)\n resp = self.sock.read(4)\n assert resp[0] == 0x20 and resp[1] == 0x02\n if resp[3] != 0:\n raise MQTTException(resp[3])\n return resp[2] & 1\n\n def disconnect(self):\n self.sock.write(b"\\xe0\\0")\n self.sock.close()\n\n def ping(self):\n self.sock.write(b"\\xc0\\0")\n\n def publish(self, topic, msg, retain=False, qos=0):\n pkt = bytearray(b"\\x30\\0\\0\\0")\n pkt[0] |= qos << 1 | retain\n sz = 2 + len(topic) + len(msg)\n if qos > 0:\n sz += 2\n assert sz < 2097152\n i = 1\n while sz > 0x7f:\n pkt[i] = (sz & 0x7f) | 0x80\n sz >>= 7\n i += 1\n pkt[i] = sz\n #print(hex(len(pkt)), hexlify(pkt, ":"))\n self.sock.write(pkt, i + 1)\n self._send_str(topic)\n if qos > 0:\n self.pid += 1\n pid = self.pid\n struct.pack_into("!H", pkt, 0, pid)\n self.sock.write(pkt, 2)\n self.sock.write(msg)\n if qos == 1:\n while 1:\n op = self.wait_msg()\n if op == 0x40:\n sz = self.sock.read(1)\n assert sz == b"\\x02"\n rcv_pid = self.sock.read(2)\n rcv_pid = rcv_pid[0] << 8 | rcv_pid[1]\n if pid == rcv_pid:\n return\n elif qos == 2:\n assert 0\n\n def subscribe(self, topic, qos=0):\n assert self.cb is not None, "Subscribe callback is not set"\n pkt = bytearray(b"\\x82\\0\\0\\0")\n self.pid += 1\n struct.pack_into("!BH", pkt, 1, 2 + 2 + len(topic) + 1, self.pid)\n #print(hex(len(pkt)), hexlify(pkt, ":"))\n self.sock.write(pkt)\n self._send_str(topic)\n self.sock.write(qos.to_bytes(1, "little"))\n while 1:\n op = self.wait_msg()\n if op == 0x90:\n resp = self.sock.read(4)\n #print(resp)\n assert resp[1] == pkt[2] and resp[2] == pkt[3]\n if resp[3] == 0x80:\n raise MQTTException(resp[3])\n return\n\n # Wait for a single incoming MQTT message and process it.\n # Subscribed messages are delivered to a callback previously\n # set by .set_callback() method. Other (internal) MQTT\n # messages processed internally.\n def wait_msg(self):\n res = self.sock.read(1)\n self.sock.setblocking(True)\n if res is None:\n return None\n if res == b"":\n raise OSError(-1)\n if res == b"\\xd0": # PINGRESP\n sz = self.sock.read(1)[0]\n assert sz == 0\n return None\n op = res[0]\n if op & 0xf0 != 0x30:\n return op\n sz = self._recv_len()\n topic_len = self.sock.read(2)\n topic_len = (topic_len[0] << 8) | topic_len[1]\n topic = self.sock.read(topic_len)\n sz -= topic_len + 2\n if op & 6:\n pid = self.sock.read(2)\n pid = pid[0] << 8 | pid[1]\n sz -= 2\n msg = self.sock.read(sz)\n self.cb(topic, msg)\n if op & 6 == 2:\n pkt = bytearray(b"\\x40\\x02\\0\\0")\n struct.pack_into("!H", pkt, 2, pid)\n self.sock.write(pkt)\n elif op & 6 == 4:\n assert 0\n\n # Checks whether a pending message from server is available.\n # If not, returns immediately with None. Otherwise, does\n # the same processing as wait_msg.\n def check_msg(self):\n self.sock.setblocking(False)\n return self.wait_msg()\n<\/code><\/pre>\n\tA. Upload umqttsimple library with uPyCraft IDE<\/h3>\n\n\n\n
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/uPycraft-ide-tools-menu-new-file.png?resize=135%2C41&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/uPycraft-ide-tools-menu-save-file.png?resize=142%2C47&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"save](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/12\/import-umqttsimple-library.png?resize=750%2C305&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/uPycraft-ide-tools-menu-download-and-run.png?resize=238%2C45&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"save](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/12\/umqttsimple-library-installed.png?resize=750%2C468&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nB. Upload umqttsimple library with Thonny IDE<\/h3>\n\n\n\n
![\"Thonny](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/Thonny-IDE-ESP32-ESP8266-MicroPython-Save-file-library-to-device-save-as.png?resize=206%2C294&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"Thonny](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/Thonny-IDE-ESP32-ESP8266-MicroPython-Save-file-library-to-device-select.png?resize=220%2C202&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"umqttsimple](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/umqttsimple-library-new-MicroPython-file-Thonny-IDE.png?resize=553%2C263&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"umqttsimple](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/umqttsimple-library-MicroPython-file-created-Thonny-IDE.png?resize=553%2C289&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nBME680 MicroPython Library<\/h2>\n\n\n\n
# Spaces, comments and some functions have been removed from the original file to save memory\n# Original source: https:\/\/github.com\/adafruit\/Adafruit_CircuitPython_BME680\/blob\/master\/adafruit_bme680.py\nimport time\nimport math\nfrom micropython import const\nfrom ubinascii import hexlify as hex\ntry:\n import struct\nexcept ImportError:\n import ustruct as struct\n_BME680_CHIPID = const(0x61)\n_BME680_REG_CHIPID = const(0xD0)\n_BME680_BME680_COEFF_ADDR1 = const(0x89)\n_BME680_BME680_COEFF_ADDR2 = const(0xE1)\n_BME680_BME680_RES_HEAT_0 = const(0x5A)\n_BME680_BME680_GAS_WAIT_0 = const(0x64)\n_BME680_REG_SOFTRESET = const(0xE0)\n_BME680_REG_CTRL_GAS = const(0x71)\n_BME680_REG_CTRL_HUM = const(0x72)\n_BME280_REG_STATUS = const(0xF3)\n_BME680_REG_CTRL_MEAS = const(0x74)\n_BME680_REG_CONFIG = const(0x75)\n_BME680_REG_PAGE_SELECT = const(0x73)\n_BME680_REG_MEAS_STATUS = const(0x1D)\n_BME680_REG_PDATA = const(0x1F)\n_BME680_REG_TDATA = const(0x22)\n_BME680_REG_HDATA = const(0x25)\n_BME680_SAMPLERATES = (0, 1, 2, 4, 8, 16)\n_BME680_FILTERSIZES = (0, 1, 3, 7, 15, 31, 63, 127)\n_BME680_RUNGAS = const(0x10)\n_LOOKUP_TABLE_1 = (2147483647.0, 2147483647.0, 2147483647.0, 2147483647.0, 2147483647.0,\n 2126008810.0, 2147483647.0, 2130303777.0, 2147483647.0, 2147483647.0,\n 2143188679.0, 2136746228.0, 2147483647.0, 2126008810.0, 2147483647.0,\n 2147483647.0)\n_LOOKUP_TABLE_2 = (4096000000.0, 2048000000.0, 1024000000.0, 512000000.0, 255744255.0, 127110228.0,\n 64000000.0, 32258064.0, 16016016.0, 8000000.0, 4000000.0, 2000000.0, 1000000.0,\n 500000.0, 250000.0, 125000.0)\ndef _read24(arr):\n ret = 0.0\n for b in arr:\n ret *= 256.0\n ret += float(b & 0xFF)\n return ret\nclass Adafruit_BME680:\n def __init__(self, *, refresh_rate=10):\n self._write(_BME680_REG_SOFTRESET, [0xB6])\n time.sleep(0.005)\n chip_id = self._read_byte(_BME680_REG_CHIPID)\n if chip_id != _BME680_CHIPID:\n raise RuntimeError('Failed 0x%x' % chip_id)\n self._read_calibration()\n self._write(_BME680_BME680_RES_HEAT_0, [0x73])\n self._write(_BME680_BME680_GAS_WAIT_0, [0x65])\n self.sea_level_pressure = 1013.25\n self._pressure_oversample = 0b011\n self._temp_oversample = 0b100\n self._humidity_oversample = 0b010\n self._filter = 0b010\n self._adc_pres = None\n self._adc_temp = None\n self._adc_hum = None\n self._adc_gas = None\n self._gas_range = None\n self._t_fine = None\n self._last_reading = 0\n self._min_refresh_time = 1000 \/ refresh_rate\n @property\n def pressure_oversample(self):\n return _BME680_SAMPLERATES[self._pressure_oversample]\n @pressure_oversample.setter\n def pressure_oversample(self, sample_rate):\n if sample_rate in _BME680_SAMPLERATES:\n self._pressure_oversample = _BME680_SAMPLERATES.index(sample_rate)\n else:\n raise RuntimeError("Invalid")\n @property\n def humidity_oversample(self):\n return _BME680_SAMPLERATES[self._humidity_oversample]\n @humidity_oversample.setter\n def humidity_oversample(self, sample_rate):\n if sample_rate in _BME680_SAMPLERATES:\n self._humidity_oversample = _BME680_SAMPLERATES.index(sample_rate)\n else:\n raise RuntimeError("Invalid")\n @property\n def temperature_oversample(self):\n return _BME680_SAMPLERATES[self._temp_oversample]\n @temperature_oversample.setter\n def temperature_oversample(self, sample_rate):\n if sample_rate in _BME680_SAMPLERATES:\n self._temp_oversample = _BME680_SAMPLERATES.index(sample_rate)\n else:\n raise RuntimeError("Invalid")\n @property\n def filter_size(self):\n return _BME680_FILTERSIZES[self._filter]\n @filter_size.setter\n def filter_size(self, size):\n if size in _BME680_FILTERSIZES:\n self._filter = _BME680_FILTERSIZES[size]\n else:\n raise RuntimeError("Invalid")\n @property\n def temperature(self):\n self._perform_reading()\n calc_temp = (((self._t_fine * 5) + 128) \/ 256)\n return calc_temp \/ 100\n @property\n def pressure(self):\n self._perform_reading()\n var1 = (self._t_fine \/ 2) - 64000\n var2 = ((var1 \/ 4) * (var1 \/ 4)) \/ 2048\n var2 = (var2 * self._pressure_calibration[5]) \/ 4\n var2 = var2 + (var1 * self._pressure_calibration[4] * 2)\n var2 = (var2 \/ 4) + (self._pressure_calibration[3] * 65536)\n var1 = (((((var1 \/ 4) * (var1 \/ 4)) \/ 8192) *\n (self._pressure_calibration[2] * 32) \/ 8) +\n ((self._pressure_calibration[1] * var1) \/ 2))\n var1 = var1 \/ 262144\n var1 = ((32768 + var1) * self._pressure_calibration[0]) \/ 32768\n calc_pres = 1048576 - self._adc_pres\n calc_pres = (calc_pres - (var2 \/ 4096)) * 3125\n calc_pres = (calc_pres \/ var1) * 2\n var1 = (self._pressure_calibration[8] * (((calc_pres \/ 8) * (calc_pres \/ 8)) \/ 8192)) \/ 4096\n var2 = ((calc_pres \/ 4) * self._pressure_calibration[7]) \/ 8192\n var3 = (((calc_pres \/ 256) ** 3) * self._pressure_calibration[9]) \/ 131072\n calc_pres += ((var1 + var2 + var3 + (self._pressure_calibration[6] * 128)) \/ 16)\n return calc_pres\/100\n @property\n def humidity(self):\n self._perform_reading()\n temp_scaled = ((self._t_fine * 5) + 128) \/ 256\n var1 = ((self._adc_hum - (self._humidity_calibration[0] * 16)) -\n ((temp_scaled * self._humidity_calibration[2]) \/ 200))\n var2 = (self._humidity_calibration[1] *\n (((temp_scaled * self._humidity_calibration[3]) \/ 100) +\n (((temp_scaled * ((temp_scaled * self._humidity_calibration[4]) \/ 100)) \/\n 64) \/ 100) + 16384)) \/ 1024\n var3 = var1 * var2\n var4 = self._humidity_calibration[5] * 128\n var4 = (var4 + ((temp_scaled * self._humidity_calibration[6]) \/ 100)) \/ 16\n var5 = ((var3 \/ 16384) * (var3 \/ 16384)) \/ 1024\n var6 = (var4 * var5) \/ 2\n calc_hum = (((var3 + var6) \/ 1024) * 1000) \/ 4096\n calc_hum \/= 1000\n if calc_hum > 100:\n calc_hum = 100\n if calc_hum < 0:\n calc_hum = 0\n return calc_hum\n @property\n def altitude(self):\n pressure = self.pressure\n return 44330 * (1.0 - math.pow(pressure \/ self.sea_level_pressure, 0.1903))\n @property\n def gas(self):\n self._perform_reading()\n var1 = ((1340 + (5 * self._sw_err)) * (_LOOKUP_TABLE_1[self._gas_range])) \/ 65536\n var2 = ((self._adc_gas * 32768) - 16777216) + var1\n var3 = (_LOOKUP_TABLE_2[self._gas_range] * var1) \/ 512\n calc_gas_res = (var3 + (var2 \/ 2)) \/ var2\n return int(calc_gas_res)\n def _perform_reading(self):\n if (time.ticks_diff(self._last_reading, time.ticks_ms()) * time.ticks_diff(0, 1)\n < self._min_refresh_time):\n return\n self._write(_BME680_REG_CONFIG, [self._filter << 2])\n self._write(_BME680_REG_CTRL_MEAS,\n [(self._temp_oversample << 5)|(self._pressure_oversample << 2)])\n self._write(_BME680_REG_CTRL_HUM, [self._humidity_oversample])\n self._write(_BME680_REG_CTRL_GAS, [_BME680_RUNGAS])\n ctrl = self._read_byte(_BME680_REG_CTRL_MEAS)\n ctrl = (ctrl & 0xFC) | 0x01\n self._write(_BME680_REG_CTRL_MEAS, [ctrl])\n new_data = False\n while not new_data:\n data = self._read(_BME680_REG_MEAS_STATUS, 15)\n new_data = data[0] & 0x80 != 0\n time.sleep(0.005)\n self._last_reading = time.ticks_ms()\n self._adc_pres = _read24(data[2:5]) \/ 16\n self._adc_temp = _read24(data[5:8]) \/ 16\n self._adc_hum = struct.unpack('>H', bytes(data[8:10]))[0]\n self._adc_gas = int(struct.unpack('>H', bytes(data[13:15]))[0] \/ 64)\n self._gas_range = data[14] & 0x0F\n var1 = (self._adc_temp \/ 8) - (self._temp_calibration[0] * 2)\n var2 = (var1 * self._temp_calibration[1]) \/ 2048\n var3 = ((var1 \/ 2) * (var1 \/ 2)) \/ 4096\n var3 = (var3 * self._temp_calibration[2] * 16) \/ 16384\n self._t_fine = int(var2 + var3)\n def _read_calibration(self):\n coeff = self._read(_BME680_BME680_COEFF_ADDR1, 25)\n coeff += self._read(_BME680_BME680_COEFF_ADDR2, 16)\n coeff = list(struct.unpack('<hbBHhbBhhbbHhhBBBHbbbBbHhbb', bytes(coeff[1:39])))\n coeff = [float(i) for i in coeff]\n self._temp_calibration = [coeff[x] for x in [23, 0, 1]]\n self._pressure_calibration = [coeff[x] for x in [3, 4, 5, 7, 8, 10, 9, 12, 13, 14]]\n self._humidity_calibration = [coeff[x] for x in [17, 16, 18, 19, 20, 21, 22]]\n self._gas_calibration = [coeff[x] for x in [25, 24, 26]]\n self._humidity_calibration[1] *= 16\n self._humidity_calibration[1] += self._humidity_calibration[0] % 16\n self._humidity_calibration[0] \/= 16\n self._heat_range = (self._read_byte(0x02) & 0x30) \/ 16\n self._heat_val = self._read_byte(0x00)\n self._sw_err = (self._read_byte(0x04) & 0xF0) \/ 16\n def _read_byte(self, register):\n return self._read(register, 1)[0]\n def _read(self, register, length):\n raise NotImplementedError()\n def _write(self, register, values):\n raise NotImplementedError()\nclass BME680_I2C(Adafruit_BME680):\n def __init__(self, i2c, address=0x77, debug=False, *, refresh_rate=10):\n self._i2c = i2c\n self._address = address\n self._debug = debug\n super().__init__(refresh_rate=refresh_rate)\n def _read(self, register, length):\n result = bytearray(length)\n self._i2c.readfrom_mem_into(self._address, register & 0xff, result)\n if self._debug:\n print("\\t${:x} read ".format(register), " ".join(["{:02x}".format(i) for i in result]))\n return result\n def _write(self, register, values):\n if self._debug:\n print("\\t${:x} write".format(register), " ".join(["{:02x}".format(i) for i in values]))\n for value in values:\n self._i2c.writeto_mem(self._address, register, bytearray([value & 0xFF]))\n register += 1\n<\/code><\/pre>\n\tSchematic: ESP32 with BME680<\/h2>\n\n\n\n
![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/07\/ESP32_BME680_Wiring_Diagram_I2C.png?resize=786%2C669&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nSchematic: ESP8266 NodeMCU with BME680<\/h2>\n\n\n\n
![\"ESP8266](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/07\/ESP8266-BME680-Environmental-Sensor-Wiring-Diagram-I2C-1.png?resize=831%2C531&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nCode<\/h2>\n\n\n\n
# Complete project details at https:\/\/RandomNerdTutorials.com\/micropython-mqtt-publish-bme680-esp32-esp8266\/\n\nimport time\nfrom umqttsimple import MQTTClient\nimport ubinascii\nimport machine\nimport micropython\nimport network\nimport esp\nfrom bme680 import *\nfrom machine import Pin, I2C\n\nesp.osdebug(None)\nimport gc\ngc.collect()\n\nssid = 'REPLACE_WITH_YOUR_SSID'\npassword = 'REPLACE_WITH_YOUR_PASSWORD'\nmqtt_server = 'XXX.XXX.XXX.XXX'\n#EXAMPLE IP ADDRESS\n#mqtt_server = '192.168.1.106'\n\nclient_id = ubinascii.hexlify(machine.unique_id())\n\ntopic_pub_temp = b'esp\/bme680\/temperature'\ntopic_pub_hum = b'esp\/bme680\/humidity'\ntopic_pub_pres = b'esp\/bme680\/pressure'\ntopic_pub_gas = b'esp\/bme680\/gas'\n\nlast_message = 0\nmessage_interval = 5\n\nstation = network.WLAN(network.STA_IF)\n\nstation.active(True)\nstation.connect(ssid, password)\n\nwhile station.isconnected() == False:\n pass\n\nprint('Connection successful')\n\n# ESP32 - Pin assignment\n#i2c = I2C(scl=Pin(22), sda=Pin(21))\n# ESP8266 - Pin assignment\ni2c = I2C(scl=Pin(5), sda=Pin(4))\n\nbme = BME680_I2C(i2c=i2c)\n\ndef connect_mqtt():\n global client_id, mqtt_server\n client = MQTTClient(client_id, mqtt_server)\n #client = MQTTClient(client_id, mqtt_server, user=your_username, password=your_password)\n client.connect()\n print('Connected to %s MQTT broker' % (mqtt_server))\n return client\n\ndef restart_and_reconnect():\n print('Failed to connect to MQTT broker. Reconnecting...')\n time.sleep(10)\n machine.reset()\n\ndef read_bme_sensor():\n try:\n temp = (b'{:.2f}'.format(bme.temperature))\n #temp = (b'{0:.2f}'.format((bme.temperature) * (9\/5) + 32))\n hum = (b'{:.2f}'.format(bme.humidity))\n pres = (b'{:.2f}'.format(bme.pressure))\n gas = (b'{:.2f}'.format(bme.gas\/1000))\n \n return temp, hum, pres, gas\n #else:\n # return('Invalid sensor readings.')\n except OSError as e:\n return('Failed to read sensor.')\n\ntry:\n client = connect_mqtt()\nexcept OSError as e:\n restart_and_reconnect()\n\nwhile True:\n try:\n if (time.time() - last_message) > message_interval:\n temp, hum, pres, gas = read_bme_sensor()\n print(temp)\n print(hum)\n print(pres)\n print(gas)\n client.publish(topic_pub_temp, temp)\n client.publish(topic_pub_hum, hum) \n client.publish(topic_pub_pres, pres)\n client.publish(topic_pub_gas, gas)\n \n last_message = time.time()\n except OSError as e:\n restart_and_reconnect()\n<\/code><\/pre>\n\tHow the Code Works<\/h2>\n\n\n\n
import time\nfrom umqttsimple import MQTTClient\nimport ubinascii\nimport machine\nimport micropython\nimport network\nimport esp\nfrom bme680 import *\nfrom machine import Pin, I2C<\/code><\/pre>\n\n\n\nssid = 'REPLACE_WITH_YOUR_SSID'\npassword = 'REPLACE_WITH_YOUR_PASSWORD'\nmqtt_server = 'REPLACE_WITH_YOUR_MQTT_BROKER_IP'<\/code><\/pre>\n\n\n\nmqtt_server = '192.168.1.106'<\/code><\/pre>\n\n\n\nclient_id = ubinascii.hexlify(machine.unique_id())<\/code><\/pre>\n\n\n\ntopic_pub_temp = b'esp\/bme680\/temperature'\ntopic_pub_hum = b'esp\/bme680\/humidity'\ntopic_pub_pres = b'esp\/bme680\/pressure'\ntopic_pub_gas = b'esp\/bme680\/gas'<\/code><\/pre>\n\n\n\nlast_message = 0\nmessage_interval = 5<\/code><\/pre>\n\n\n\nstation = network.WLAN(network.STA_IF)\n\nstation.active(True)\nstation.connect(ssid, password)\n\nwhile station.isconnected() == False:\n pass\n\nprint('Connection successful')<\/code><\/pre>\n\n\n\ni2c = I2C(scl=Pin(22), sda=Pin(21))<\/code><\/pre>\n\n\n\ni2c = I2C(scl=Pin(5), sda=Pin(4))<\/code><\/pre>\n\n\n\nbme = BME680_I2C(i2c=i2c)<\/code><\/pre>\n\n\n\nConnect to MQTT Broker<\/h3>\n\n\n\n
def connect_mqtt():\n global client_id, mqtt_server\n client = MQTTClient(client_id, mqtt_server)\n #client = MQTTClient(client_id, mqtt_server, user=your_username, password=your_password)\n client.connect()\n print('Connected to %s MQTT broker' % (mqtt_server))\n return client<\/code><\/pre>\n\n\n\nclient = MQTTClient(client_id, mqtt_server, user=your_username, password=your_password)<\/code><\/pre>\n\n\n\nRestart and Reconnect<\/h3>\n\n\n\n
def restart_and_reconnect():\n print('Failed to connect to MQTT broker. Reconnecting...')\n time.sleep(10)\n machine.reset()<\/code><\/pre>\n\n\n\nRead BME680 Sensor<\/h3>\n\n\n\n
def read_bme_sensor():\n try:\n temp = (b'{:.2f}'.format(bme.temperature))\n #temp = (b'{0:.2f}'.format((bme.temperature) * (9\/5) + 32))\n hum = (b'{:.2f}'.format(bme.humidity))\n pres = (b'{:.2f}'.format(bme.pressure))\n gas = (b'{:.2f}'.format(bme.gas\/1000))\n \n return temp, hum, pres, gas\n #else:\n # return('Invalid sensor readings.')\n except OSError as e:\n return('Failed to read sensor.')<\/code><\/pre>\n\n\n\nPublishing MQTT Messages<\/h3>\n\n\n\n
if (time.time() - last_message) > message_interval:<\/code><\/pre>\n\n\n\ntemp, hum, pres, gas = read_bme_sensor()<\/code><\/pre>\n\n\n\nclient.publish(topic_pub_temp, temp)\nclient.publish(topic_pub_hum, hum)\nclient.publish(topic_pub_pres, pres)\nclient.publish(topic_pub_gas, gas)<\/code><\/pre>\n\n\n\nlast_message = time.time()<\/code><\/pre>\n\n\n\nexcept OSError as e:\n restart_and_reconnect()<\/code><\/pre>\n\n\n\nPreparing Node-RED Dashboard<\/h2>\n\n\n\n
http://raspberry-pi-ip-address:1880<\/code><\/pre>\n\n\n\n![\"Drag](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/drag-nodes-esp32-esp8266-node-red-bme680.png?resize=246%2C223&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"Edit](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/edit-mqtt-in-node-esp32-esp8266-node-red-bme680.png?resize=498%2C365&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"Edit](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/edit-gauge-node-esp32-esp8266-node-red-bme680.png?resize=499%2C567&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"Node](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/10\/node-connected-esp32-esp8266-node-red-bme680.png?resize=408%2C233&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"Deploy](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/06\/11_deploy_button.png?resize=138%2C40&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n[{"id":"3b7f947c.9759ec","type":"mqtt in","z":"254c9c97.f85b34","name":"","topic":"esp\/bme680\/temperature","qos":"1","datatype":"auto","broker":"8db3fac0.99dd48","x":470,"y":2640,"wires":[["b87b21c3.96672"]]},{"id":"b87b21c3.96672","type":"ui_gauge","z":"254c9c97.f85b34","name":"","group":"37de8fe8.46846","order":2,"width":0,"height":0,"gtype":"gage","title":"Temperature","label":"\u00baC","format":"{{value}}","min":0,"max":"40","colors":["#00b500","#f7df09","#ca3838"],"seg1":"","seg2":"","x":690,"y":2640,"wires":[]},{"id":"f92248f4.545778","type":"mqtt in","z":"254c9c97.f85b34","name":"","topic":"esp\/bme680\/humidity","qos":"1","datatype":"auto","broker":"8db3fac0.99dd48","x":460,"y":2700,"wires":[["4114a401.5ac69c"]]},{"id":"4114a401.5ac69c","type":"ui_gauge","z":"254c9c97.f85b34","name":"","group":"37de8fe8.46846","order":2,"width":0,"height":0,"gtype":"gage","title":"Humidity","label":"%","format":"{{value}}","min":"30","max":"100","colors":["#53a4e6","#1d78a9","#4e38c9"],"seg1":"","seg2":"","x":680,"y":2700,"wires":[]},{"id":"ad51f895.2c2848","type":"mqtt in","z":"254c9c97.f85b34","name":"","topic":"esp\/bme680\/pressure","qos":"1","datatype":"auto","broker":"8db3fac0.99dd48","x":460,"y":2760,"wires":[["3a95123b.66405e"]]},{"id":"c074e688.198b78","type":"mqtt in","z":"254c9c97.f85b34","name":"","topic":"esp\/bme680\/gas","qos":"1","datatype":"auto","broker":"8db3fac0.99dd48","x":440,"y":2820,"wires":[["d3539c06.00a17"]]},{"id":"3a95123b.66405e","type":"ui_text","z":"254c9c97.f85b34","group":"37de8fe8.46846","order":2,"width":0,"height":0,"name":"","label":"Pressure","format":"{{msg.payload}} hPa","layout":"row-spread","x":680,"y":2760,"wires":[]},{"id":"d3539c06.00a17","type":"ui_text","z":"254c9c97.f85b34","group":"37de8fe8.46846","order":3,"width":0,"height":0,"name":"","label":"Gas","format":"{{msg.payload}} KOhm","layout":"row-spread","x":670,"y":2820,"wires":[]},{"id":"8db3fac0.99dd48","type":"mqtt-broker","z":"","name":"","broker":"localhost","port":"1883","clientid":"","usetls":false,"compatmode":false,"keepalive":"60","cleansession":true,"birthTopic":"","birthQos":"0","birthPayload":"","closeTopic":"","closeQos":"0","closePayload":"","willTopic":"","willQos":"0","willPayload":""},{"id":"37de8fe8.46846","type":"ui_group","z":"","name":"BME680","tab":"53b8c8f9.cfbe48","order":1,"disp":true,"width":"6","collapse":false},{"id":"53b8c8f9.cfbe48","type":"ui_tab","z":"","name":"Home","icon":"dashboard","order":5,"disabled":false,"hidden":false}]\n<\/code><\/pre>\n\t