IoT program by MicroPython

ESP32 開発ボードを利用して、様々なセンサーの値をサーバーに送信するためのプログラム群です。送信方法は MQTT になります。

構成

micropython-iot
    +-- app.py # 実行ファイル
    +-- config.py # 環境別設定ファイル（config.default.py をリネーム）
    +-- main.py # ボードが実行するファイル
    +-- ulib # ライブラリ群
        +-- button.py # ボタンのライブラリ
        +-- cds.py # 光センサーのライブラリ
        +-- env.py # 環境センサーのライブラリ
        +-- led.py # LEDのライブラリ

環境ごとの設定は config.py で行います。
app.py の main メソッドにボードで動かしたいプログラムを記述します。

MicroPython インストール

使用するボードは ESP32 を想定しています。手順は公式ドキュメントのとおりです。

ESP32 での MicroPython の始め方
https://micropython-docs-ja.readthedocs.io/ja/latest/esp32/tutorial/intro.html

仮想環境

Python の仮想環境を作成します。

% python3 -V
Python 3.9.1
% python3 -m venv venv
% source venv/bin/activate

仮想環境を抜ける場合

(venv) % deactivate

必要なユーティリティ

ボードを扱うために必要なユーティリティをインストールします。

esptool

ESP8266 または ESP32 のROMブートローダと通信するためのユーティリティ
https://github.com/espressif/esptool

pip install esptool

ampy

シリアル接続を介して CircuitPython または MicroPython ボードと対話するためのユーティリティ
https://github.com/scientifichackers/ampy

pip install adafruit-ampy

ファームウェアのダウンロード

ESP32用のファームウェア
https://micropython.org/download/esp32/

最新の安定版をダウンロードします。

v1.17 (20210902) .bin

ボードの確認

接続しているボードを確認します。

ls -al /dev/tty.*
・・・
crw-rw-rw-  1 root  wheel   18,   4  3 23 13:48 /dev/tty.SLAB_USBtoUART
・・・

表示されたシリアルポートは環境によって変わります。
以降の操作で頻繁に使用しますので環境変数に格納します。

export SERIALPORT="/dev/tty.SLAB_USBtoUART"

ボードの情報を確認する

次のコマンドを実行すると、ボードの情報が表示されます。

esptool.py --port $SERIALPORT flash_id

実行結果

esptool.py v3.0
Serial port /dev/tty.SLAB_USBtoUART
Connecting........_
Detecting chip type... ESP32
Chip is ESP32-D0WDQ6 (revision 1)
Features: WiFi, BT, Dual Core, 160MHz, VRef calibration in efuse, Coding Scheme None
Crystal is 40MHz
MAC: xx:xx:xx:xx:xx:xx
Uploading stub...
Running stub...
Stub running...
Manufacturer: 20
Device: 4016
Detected flash size: 4MB
Hard resetting via RTS pin...

ボードの初期化

次のコマンドを実行して、ボードのフラッシュを消去します。

esptool.py --port $SERIALPORT erase_flash

ファームウェアの書き込み

ダウンロードしたファームウェアを指定してボードに書き込みます。

esptool.py --chip esp32 --port $SERIALPORT write_flash 0x1000 esp32-20210902-v1.17.bin

コマンドオプションについて

• --chip : ボード（チップ）の種類
• --port : ボードが接続されたシリアルポート
• --baud : 転送速度

0x1000 はコマンドに渡される数値の指定です。（16進数）

動作確認

REPLプロンプトを利用して実行します。

screen -L $SERIALPORT 115200

help() と入力して enter を押すと次のように表示されます。

Welcome to MicroPython on the ESP32!

For generic online docs please visit http://docs.micropython.org/

For access to the hardware use the 'machine' module:

ctrl + a + k で終了確認のプロンプトが表示されるので y を入力して終了します。

コマンドオプションについて

• -L : ログファイルに出力

MicroPython の実行

ESP32では、起動時に boot.py が実行され、その後存在すれば main.py を実行します。自身のプログラムは main.py を作成して転送することになります。

ファイルの転送

ampy ユーティリティを使ってファイルの転送を行います。コマンドは次のとおりです。

• get: ボードからパソコンにファイルを転送する
• ls: ボード内の一覧を表示する
• mkdir: ボード上でディレクトリを作成する
• put: パソコンからボードにファイルを転送する
• reset: ボード上でソフトリセットとブートを実行する
• rm: ボード上でファイルを削除する
• rmdir: ボード上でディレクトリを削除する
• run: ボード上でプログラムファイルを実行する

例：転送済みのファイルを確認する

ampy -p $SERIALPORT --baud 115200 ls
/boot.py

サンプルコードの作成

Lチカのコードを作成してボード上で実行してみます。

import machine
import time

p13 = machine.Pin(13, machine.Pin.OUT)

while True:
  p13.on()
  time.sleep(1)
  p13.off()
  time.sleep(1)

つづいて main.py を転送します。

ampy -p $SERIALPORT --baud 115200 put main.py

D13ピンにLEDを接続すると、1秒間隔で点滅します。

プログラムの使い方

このプログラム群では、main.py の中で app.py を実行しています。使い方のながれは次のとおりです。

1. micropython-iot 直下の config.default.py をコピーして config.py を作成
2. 環境に合わせて config.py を修正して転送
3. micropython-iot 直下の app.py を修正して転送
4. ulib 内の必要なファイルを転送
5. micropython-iot 直下の main.py を転送

転送コマンドの例

ampy -p $SERIALPORT put config.py
ampy -p $SERIALPORT put app.py
ampy -p $SERIALPORT put ulib
ampy -p $SERIALPORT put main.py

プログラムを止めたい場合

ボード上の main.py を削除することでプログラムが止まります。

ampy -p $SERIALPORT rm main.py

サンプルプログラム

ボタン

ボタンを押したら True を送信する

def main():
    from ulib.button import Button
    button = Button(config.BUTTON_PIN)

    while True:
        value = button.isPressed()
        if (value):
            data = {
                "deviceid": config.DEVICE_ID,
                "devicename": config.DEVICE_NAME,
                "value": value
            }
            payload = ujson.dumps(data)

            try:
                do_publish(config.MQTT_TOPIC, payload)
            except:
                pass

光センサー

一定の時間ごとに光センサーで取得した値を送信する

def main():
    from ulib.cds import CdS
    cds = CdS(config.CDS_PIN)

    while True:
        value = cds.read()
        data = {
            "deviceid": config.DEVICE_ID,
            "devicename": config.DEVICE_NAME,
            "value": value
        }
        payload = ujson.dumps(data)

        try:
            do_publish(config.MQTT_TOPIC, payload)
        except:
            pass

        time.sleep(publish_interval)

スレッドを使う

import _thread

def th_light():
    """光センサーの処理など"""

def th_button():
    """ボタンの処理など"""

def main():
    _thread.start_new_thread(th_light, ())
    _thread.start_new_thread(th_button, ())