BME280 sample in MicroPython

This project was coded in MicroPython.
And the code is sample for using BME280.

このプロジェクトは、MicroPython でコーディングしました。
BME280 を使うサンプル実装です。

Overview 概要

This project is MicroPython and is created by introducing PyMakr into Visual Studio Code.
And the platform is ESP32 board, OLED SSD1306 for using to display the acquired informations, and other measuring device used are BME280.

このプロジェクトは MycroPython で Visual Studio Code に PyMakr を導入して作成しています。
プラットフォームは ESP32 ボードで、取得したデータ表示に SSD1306 を使用し、その他の計測デバイスは BME280 です。

• Reference 参考
  • [備忘録]ESP32-VSCode-microPythonでの開発環境の構築 - Qiita (Japanese)

Hardware ハードウェア

ESP32 board with OLED SSD1306

• Reference 参考
  • SSD1306 | Solomon Systech Limited (OFFICIAL English)

OLED SSD1306 is OLED driver IC from SOLOMON SYSTECH.
For this time used OLED is connected with I2C interface to the ESP32 board.
The resolution is 128 x 64 and it is used as the display destination of the acquired informations.

OLED SSD1306 は SOLOMON SYSTECH 社が提供する OLED ドライバです。
今回の OLED は ESP32 ボードに I2C インターフェースで接続している ESP32 ボードです。
また解像度が 128 x 64 で、取得した情報の表示先として使用しています。

BME280

• Reference 参考
  • Humidity Sensor BME280 | Bosch Sensortec (OFFICIAL English)
  • BME280 – スイッチサイエンス (Japanese)

BME280 is a multi-function sensor from BOSCH that can measure temperature, humidity and atmospheric pressure.
And it is connected with I2C interface.

BME280 は BOSCH 社が提供する多機能センサーで 温度・湿度・大気圧 を計測できるマルチセンサーです。
I2C インターフェースで接続しています。

Installation 導入方法

This time, we will use esptool to the following steps.

ここでは、esptool と ampy を使った導入手順を例示します。

• Reference 参考
  • Getting started with MicroPython on the ESP32 — MicroPython 1.13 documentation (OFFICIAL English)
  • ESP32 での MicroPython の始め方 — MicroPython 1.13 ドキュメント (Japanese)
  • GitHub - espressif/esptool: Espressif SoC serial bootloader utility (English)
  • GitHub - scientifichackers/ampy: Adafruit MicroPython Tool - Utility to interact with a MicroPython board over a serial connection. (English)
  • ESP32でesptool.pyの使い方 – Lang-ship (Japanese)
  • ampy: MicroPythonマイコンとPCとのファイル転送ツール – Ambient (Japanese)

(steps in English)

1. Connect the ESP32 board and each devices.
   Refer to following figure, you connect the devices according to the pin definition on the ESP32 board.
   

   If the pin definition is different, you need to change the program "main.py".

2. Install the firmware of MicroPython to the ESP32 board

   1. At first, you connect the ESP32 board and your PC with a MicroUSB Cable, and it is start to the following works.

   2. Next, you download the firmware from MicroPython official download site.
      MicroPython - Python for microcontrollers

   3. Next, you erase the flash memory on the ESP32 board.
      Change connection port name and baud rate according to your environment.

      esptool.py --chip esp32 --port COM3 --baud 921600 erase_flash

   4. Next, you put on the firmware of MicroPython to the ESP32 board.
      This time, I used the firmware of ESP-IDF v3.x, 20191220 released.

      esptool.py --chip esp32 --port COM3 --baud 921600 write_flash 0x001000 esp32-idf3-20191220-v1.12.bin

3. Install this project files to the ESP32 board

   1. At first, you download this project files from GitHub repository.

      git clone https://github.com/ks-tec/mpy-BME280.git

   2. Next, you put on the download files to the ESP32 board.

      cd sample-BME280
      ampy --port COM3 put bme280.py
      ampy --port COM3 put ssd1306.py
      ampy --port COM3 put main.py

   3. Next, you run program on the ESP32 board.

      ampy --port COM3 run main.py

(steps in Japanese)

1. ESP32 ボードと各デバイスを配線します。
   下図を参考に、ESP32 ボードのピン定義に合わせて接続してください。
   

   ESP32 ボードのピン定義が異なる場合は、プログラム main.py の変更が必要になります。

2. MicroPython を導入します。

   1. ESP32 ボードと PC を MicroUSB ケーブルで繋いだら、作業を開始します。

   2. MicroPython 公式サイトからファームウェアをダウンロードします。
      MicroPython - Python for microcontrollers

   3. ESP32 ボード上のフラッシュを消去します。
      接続されているポート番号やボーレートは、環境に合わせて変更してください。

      esptool.py --chip esp32 --port COM3 --baud 921600 erase_flash

   4. ESP32 ボードに MicroPython のファームウェアを書き込みます。
      今回は ESP-IDF v3.x の 20191220 版のファームウェアを使いました。

      esptool.py --chip esp32 --port COM3 --baud 921600 write_flash 0x001000 esp32-idf3-20191220-v1.12.bin

3. このプロジェクトを導入します。

   1. GitHub からダウンロードします。

      git clone https://github.com/ks-tec/mpy-BME280.git

   2. ESP32 ボードに このプロジェクトを書き込みます。

      cd sample-BME280
      ampy --port COM3 put bme280.py
      ampy --port COM3 put ssd1306.py
      ampy --port COM3 put main.py

   3. ESP32 ボード上でプロジェクトを実行します。

      ampy --port COM3 run main.py

Usage 使用方法

When you connect the ESP32 board to the power supply, the measurement starts automatically.
Or, When you want restart, you rerun the program already placed on the ESP32 board.

ESP32 ボードと電源を繋ぐと、自動的に計測が始まります。
または、再起動したい場合は、ESP32 ボード上に配置済みのプログラムを再実行します。

Change connection port name according to your environment.

接続されているポート番号は、環境に合わせて変更してください。

ampy --port COM3 run main.py

Note 注意事項

The contents of this project may be updated without notice. Please be aware.

このプロジェクトの内容は、予告なく更新される場合があります。 ご承知おきください。

Change log 更新履歴

(1.0.0)
First released.

最初のリリースです。

License ライセンス

This project is under MIT license.
Copyright (c) 2020, ks-tec.