IoT – Giardino Familiare

M5 / プログラミング

2022年6月4日

タグ: IoT, M5Atom, プログラミング

ARGBライトでゲーミング苔

こんにちはLineaです。前回、湿度センサ […]

こんにちはLineaです。

前回、湿度センサとUSB加湿器で苔の水やりを自動化してみました。あれからシステムとしては安定して、水を2,3日おきに補充するだけになったので楽になりました。

M5Atomと100均加湿器で作る自動苔水やりシステム

しかし、なんとなく見た目が寂しいなと思っていたのですが、明かりが足りないことに気が付きました。アクアリウムではライトで照らしてやるのが基本ですから、苔にもそういったライトがあれば映えるのではないかと。

アクアリウム用のライトを買ってきても良かったのですが、折角M5Atomを使っているならライトも制御したいと考え、最近流行りのLEDテープを使って光り方を制御してみようというのが今回の趣旨です。

今回の成果としてこんな感じになりました。虹色に光らせるとゲーミング感（？）満点になったので満足です。

LEDの選定

今回、購入して使用したLEDがこちらです。

EZDIY-FAB 新しいアドレス指定可能な5V 3PIN RGB LEDストリップセット

LEDテープ類を色々調べているとゲーミングPCの装飾用の製品がおしゃれで丁度よさそうでした。シリコンカバーに覆われているため、光が拡散して線としてきれいに見えます。また、ある程度の防水性も期待できそうです。

こういったLEDテープ類で虹色など光り方を自由に変えられるタイプは軒並みNeoPixel系と呼ばれるLEDチップが使われています。LEDチップ内にICが入っていて、シリアル通信で光り方を個別に制御できるため虹色など様々な光らせ方ができます。また、制御用のライブラリも公開されているので比較的簡単に制御できます。

今回使ったのはゲーミングPC用の製品（いわゆる3ピンARGB）ですが中身は電子工作用のLEDテープと同じなのでそのままM5Atomなどで制御できました。コネクタが配線済みと考えるとむしろPC用はお得かも？

配線

PC用の3ピンARGBタイプのコネクタは次のようになっています。

5VとGNDはそれぞれM5Atomの5V出力、GNDへ接続します。データピンはシリアル通信ができるピンならどこでもいいので、今回は5V,GNDに隣接する25ピンを使用しました。

設置

今回購入した製品には設置用のステー（直線、90°）が付属していたので、利用して水槽の天板に両面テープで固定しました。

LED制御

今回使うNeoPixel系のLEDテープを制御するライブラリとしてFastLEDを使用します。FsatLEDはM5Atom内蔵のLED制御にも使われていて、既にライブラリが入っているはずなのでインストールについては割愛します。

FastLEDライブラリでLED制御する際はライブラリ内のstatic変数で競合するため、M5AtomライブラリのLED制御と同時に使うことができません。M5Atomの初期化時に本体側のLEDをオフにする必要があります（後述）。

プログラム

購入したLEDテープ用に下の制御クラスをM5AtomのLED処理を参考に作成しました。

#ifndef __LEDBar_H
#define __LEDBar_H

#include <FastLED.h>
#include "utility/Task.h"

#define NUM_LEDS_BAR 30
#define DATA_PIN_BAR 25

enum LightingMode 
{
    Static,
    Move,
    Breath,
    Rainbow,
};

class LEDBar: public Task
{
private:
    CRGB _ledbuff[NUM_LEDS_BAR];
    uint8_t _ledNumber;

    LightingMode _mode;
    CRGB _mainColor;
    CHSV _maniHSV;

    uint8_t _movePos;

    SemaphoreHandle_t _xSemaphore = NULL;

public:
    LEDBar();
    ~LEDBar();

    void begin(uint8_t LEDPin = DATA_PIN_BAR ,uint8_t LEDNumber = NUM_LEDS_BAR);
    void run(void *data);

    void setBrightness(uint8_t brightness);
    void setLightingMode(LightingMode mode, CRGB color);
    void lightOff();
};

#endif

#include "LEDBar.h"

LEDBar::LEDBar()
{

}

LEDBar::~LEDBar()
{

}

void LEDBar::begin(uint8_t LEDPin ,uint8_t LEDNumber)
{
    FastLED.addLeds<WS2812, DATA_PIN_BAR>(_ledbuff, LEDNumber);
    _xSemaphore = xSemaphoreCreateMutex();
    _ledNumber = LEDNumber;
}

void LEDBar::run(void *data)
{
    data = nullptr;

    for (int num = 0; num < NUM_LEDS_BAR; num++)
    {
        _ledbuff[num] = 0x000000;
    }
    FastLED.show();
    FastLED.setBrightness(20);

    while (1)
    {
        xSemaphoreTake(_xSemaphore, portMAX_DELAY);
        switch (_mode)
        {
            case LightingMode::Static:
                fill_solid(_ledbuff,_ledNumber,_mainColor);
                break;
            case LightingMode::Move:
                fadeLightBy(_ledbuff,_ledNumber,30);
                _movePos++;
                if(_movePos >= _ledNumber)
                {
                    _movePos = 0;
                }
                _ledbuff[_movePos] = _mainColor;
                break;
            case LightingMode::Breath:
            {
                uint8_t BeatsPerMinute = 16;
                uint8_t beat = beatsin8( BeatsPerMinute, 0, 255);
                _maniHSV.value = beat;
                fill_solid(_ledbuff,_ledNumber,CRGB(_maniHSV));
                break;
            }
            case LightingMode::Rainbow:
                fill_rainbow(_ledbuff,_ledNumber,_maniHSV.hue);
                _maniHSV.hue++;
                break;
            default:
                break;
        }
        FastLED.show();
        xSemaphoreGive(_xSemaphore);
        delay(20);
    }
}

void LEDBar::setBrightness(uint8_t brightness)
{
    xSemaphoreTake(_xSemaphore, portMAX_DELAY);
    FastLED.setBrightness(brightness);
    xSemaphoreGive(_xSemaphore);
}

void LEDBar::setLightingMode(LightingMode mode, CRGB color)
{
    xSemaphoreTake(_xSemaphore, portMAX_DELAY);
    _mode = mode;
    _mainColor = color;
    _maniHSV = rgb2hsv_approximate(color);
    xSemaphoreGive(_xSemaphore);
}

void LEDBar::lightOff()
{
    setLightingMode(LightingMode::Static,CRGB::Black);
}

FastLEDライブラリの基本的な使い方として、LEDの色情報バッファをFastLED.show()で実際にLEDに送信します。
光が動いているように見せるには定期的に色情報バッファの更新と送信を行う必要があるため、表示更新関数run()をタスクで定期実行させています。
マルチスレッドで動作するため、発光モードや色などの設定処理はセマフォで排他制御を行っています

発光のパターンについてはとりあえず4種類を定義して用意してみました。

単色
流れる
明滅
レインボー

レインボーはゲーミングの定番だけあってか、ライブラリで既に関数が用意されていて呼ぶだけなので実は1番簡単だったりします。意外と苦労したのは流れる表示の方ですね。

使い方

上のLEDBarクラスは次のように使用します

#include <M5Atom.h>
#include "LEDBar.h"

//LEDBarのインスタンス
LEDBar ledBar;

void setup() {
  //M5スタート 3つ目の引数が内蔵LED制御の有効化なのでFalseにしておく
  M5.begin(true,false,false);

  //LEDバーを初期化 第一引数 データピン、第二引数 LED個数
  ledBar.begin(25,30);
  //LEDバーの更新タスクを開始
  ledBar.setTaskName("LEDBar");
	ledBar.setTaskPriority(2);
	ledBar.start();
  delay(10);
  //LEDバーの明るさを設定
  ledBar.setBrightness(64);
  //LEDバーの発光モードと色を指定
　ledBar.setLightingMode(LightingMode::Breath,CRGB::Red);
　delay(5000);
  //虹色
  ledBar.setLightingMode(LightingMode::Rainbow,CRGB::Blue);
}

begin()関数でLEDのピンと個数を設定します。その後、タスクを開始します。タスク開始後に明るさや発光モード、色を指定して発光させることができます。
FastLEDライブラリの仕様で数値は8bit=256での指定のため、明るさは0~255、色はCRGB型で表します。色についてはFastLEDライブラリでデフォルト定義の色やRGB(0~255,0~255,0~255)で指定することができます。
ただ、LEDの種類によってはBRGの順で光る物があるようで今回購入したものもそうでした。その場合色の読み替えなどが必要になるので注意してください。

今回はここまでです。
ゲーミングPCなどでもおなじみのレインボー発光などが自分で制御して作れるということがわかって楽しかったです。
オリジナルの発光パターンも今後増やしてみたいですね。
それではまた！

M5 / プログラミング

2022年5月1日

タグ: IoT, M5Atom, ガーデニング, プログラミング

M5Atomと100均加湿器で作る自動苔水やりシステム

こんにちは、Lineaです久しぶりの更新と […]

こんにちは、Lineaです

久しぶりの更新となってしまいました。

半年ほど前から苔を育てているのですが、1日数回の霧吹きというのをつい忘れてしまいます。
そのため、水不足で何度か苔が茶色くなったり黒ずんだりしてダメにしてしまいました。

以前、M5Atomでガーデニングの水分管理を行ってみましたが、その延長で小型の加湿器を使って自動水やりができるのではないかと考えて作ってみました。

ハードウェア

水やりシステムで使用したものは以下のとおりです。M5Atomはすでに持っていたのでセンサ代と加湿器、部品代で1500円ぐらいです。

M5 Atom
湿度センサ（ENVⅢ ユニット）
100均 USB 加湿器(ダイソー）
ブレッドボード
USBコネクタ
トランジスタ(2N2222)
抵抗(2.2kΩ,10kΩ)

システムの配線は下の図のとおりです

湿度センサとM5はGroveで接続し、計測した湿度値に応じてUSBコネクタの5Vラインを簡単なトランジスタ回路でスイッチングして加湿器への電力のON/OFFを制御します。

湿度センサにはM5シリーズ向けのセンサユニットを使用しています。画像では以前買ったM5StickC用のHATタイプをAtomに接続したものを本体ごと水槽に入れていますが、流石に湿度でAtom本体が逝きそうなので後で替えています。ユニット化されてGroveケーブルで回路本体と分離できるので、もし壊れてもセンサユニットの替えがきくので安心です。

加湿器にはダイソーの300円USB加湿器を使用しました。ここで重要なのがスイッチやタイマー機能がついておらず、USB端子に電流が流れるだけで動作する単純なものを使用することでした。M5から加湿器に対して制御できるのが電流のON/OFFだけなので、余計な機能がついていると制御できない可能性があるからです。
最近の100均製品も進化していてスイッチやタイマーがついているものが多く、意外と単純なものを探すのに苦労しました。作り始めたのが4月頭だったので加湿器のシーズンが終わっていたこともあって1週間ほど100均めぐりをしてやっと見つけたのがダイソーの300円加湿器でしたので、同じこと考えている人はご参考ください。

加湿器への電流のオンオフはM5のピンから直接流すのは流石に怖かったので簡単なスイッチング回路を組んでいます。抵抗計算はいい加減ですがUSB端子に150mAぐらい流せるように計算してみました。とりあえず加湿器は元気に動いてくれているので大丈夫そうです。

プログラム

プログラムは以前つくった水分計測システムを元にしています。
動作としては5分おきに湿度測定、加湿器の動作決定、ディープスリープを繰り返します。湿度値などはデータベースサービスのAmbientへ送信しています

#include <M5Atom.h>
#include <WiFi.h>
#include <Ambient.h>
#include "driver/rtc_io.h"
#include "SHT3X.h"
#include "key.h"

//define
#define SLEEP_MIN(min) min*60000000ULL
//GRB?
#define LED_PINK 0x55FFAA
#define LED_GREEN 0xFF0022
#define LED_BLUE 0x0022FF
#define LED_YELLOW 0xAAAA00
#define LED_RED 0x00FF22
#define LED_OFF 0x000000
//明るさ
const uint8_t kLEDBright = 15;
//pin定義
const gpio_num_t kPowerPin = GPIO_NUM_33; //電力供給
//スリープ時間
const uint64_t sleepMin = 5;

//加湿稼働閾値
const float minHumidity = 70;
const float targetHumidity = 90;
//static変数
WiFiClient client;
Ambient ambient;

//温湿度センサ
const uint8_t kI2CSclPin = 32;
const uint8_t kI2CSdaPin = 26;
SHT3X sht3x = SHT3X(kI2CSclPin,kI2CSdaPin);

//保存変数
RTC_DATA_ATTR bool humidifierActive = false;
RTC_DATA_ATTR float humidityInteglal = 0;

//functions

//加湿ONOFF
void sethHumidifier(bool sw)
{
  humidifierActive = sw;
  rtc_gpio_set_level(kPowerPin, sw ? HIGH:LOW);
}

//測定
void measure(){

  //温湿度計測
  if(sht3x.get() ==0){
    //ambient セット
    float humidity = sht3x.humidity;
    ambient.set(7,sht3x.cTemp);
    ambient.set(8,humidity);
    Serial.printf("temp:%.2f \n",sht3x.cTemp);
    Serial.printf("humidty:%.2f \n",humidity);

    //湿度によってLED色変える
    CRGB col = LED_GREEN;
    #ifdef false
    //カラー無段階変化
    fract8 frac = humidity / 100.f * UINT8_MAX;
    col = col.lerp8(CRGB::Red,frac);
    Serial.printf("humid color R:%d, G:%d, B:%d\n",col.r,col.g,col.b);
    #else
    //段階カラー
    if(humidity < targetHumidity){
      col = LED_YELLOW;
      if(humidity < minHumidity)
      {
        col = LED_RED;
      }
    }
    #endif

    M5.dis.fillpix(col);

    //加湿器稼働
    humidityInteglal = min(max((humidityInteglal + (targetHumidity - humidity))*0.5f,-10.f),10.f);
    sethHumidifier(humidityInteglal > 0);
    ambient.set(6,humidifierActive);
    Serial.printf("humidifier:%d \n",humidifierActive);
  }

  //Ambient送信
  ambient.send();  
}

//Wifi接続
void connectNet()
{
  // WiFi接続
  Serial.printf("Connecting to %s ", wifi_ssid);
  WiFi.begin(wifi_ssid, wifi_key);
  while (WiFi.status() != WL_CONNECTED) {
    M5.dis.fillpix(LED_BLUE);
    delay(250);
    M5.dis.fillpix(LED_OFF);
    delay(250);
    Serial.print(".");
  }
  Serial.println("CONNECTED");

  //Ambient setup
  ambient.begin(channelId, writeKey, &client); // チャネルIDとライトキーを指定してAmbientの初期化
}

//カウントダウン
void countDown(const char *dispTxt,const int sec)
{
  int count = sec;
  while (count >= 0)
  {
    count--;
    M5.dis.fillpix(LED_PINK);
    //1秒待つ
    delay(500);
    M5.dis.fillpix(LED_OFF);
    delay(500);
  }
}

void setup() {
  Serial.println("Setup");

  //M5スタート
  M5.begin(true,false,true);

  //ピンをセットアップ
  rtc_gpio_init(kPowerPin);
  rtc_gpio_set_direction(kPowerPin,RTC_GPIO_MODE_OUTPUT_ONLY);
  //rtc_gpio_set_level(kPowerPin,LOW);

  M5.dis.setBrightness(kLEDBright);

  //Wifi接続はクロック上げたほうがいいらしい？CPUクロックを戻す
  setCpuFrequencyMhz(160);

  //ネットワーク系初期化
  connectNet();

  //CPUクロックを下げる 80より下はWifi使えないらしい
  setCpuFrequencyMhz(80);
}

void loop() {
  //計測カウントダウン
  countDown("measure",3);

  //計測
  measure();
  
  //wait
  delay(100);

  //wifiオフ
  WiFi.disconnect();
  //pinもオフにする
  //pinMode(kPowerPin,DISABLED);

  //スリープカウントダウン
  //countDown("sleep",3);
  //LED停止
  //M5.dis.stop();

  //スリープ
  Serial.println("Enter sleep");
  Serial.printf("sleep time: %ld \n",SLEEP_MIN(sleepMin));

  esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH,ESP_PD_OPTION_ON);
  esp_sleep_enable_timer_wakeup(SLEEP_MIN(sleepMin));
  esp_deep_sleep_start();
}

Wifiやデータベース（Ambient）へのアクセス情報はmainに書くとGit管理などでうっかり上げてしまいそうなので、別途”key.h”と別ヘッダに置くようにしました。

#ifndef __key_H
#define __key_H

//wifi情報
const char wifi_ssid[32]="SSID";
const char wifi_key[64]="Wifi_Pass";
//ambient情報
const unsigned int channelId = 00000; // AmbientのチャネルID
const char* writeKey = "Write_Key"; // ライトキー

#endif

温湿度センサで使用しているライブラリ「SHT3X」については過去記事で導入の解説をしているので参考にしてください

M5AtomでENVⅡHatを使う

要所解説

湿度計測

//温湿度センサ定義
const uint8_t kI2CSclPin = 32;
const uint8_t kI2CSdaPin = 26;
SHT3X sht3x = SHT3X(kI2CSclPin,kI2CSdaPin);

//温湿度計測
void measure(){
  if(sht3x.get() ==0){
    //計測完了時の動作
    float humidity = sht3x.humidity;
    }
}

湿度センサの使い方は過去記事とほぼ同様です。今回はSHT3Xのオブジェクトを作成時にGroveのデータピン32,26を指定します。計測はSHT3X::get()を呼び出します。このとき返り値0であれば成功ですのでif文などで分岐して計測時の動作を記述します。測定値はオブジェクト内に保存されているので必要な値を取り出します。

加湿器の動作

//加湿稼働閾値
const float targetHumidity = 90;

//加湿器稼働
    humidityInteglal = min(max((humidityInteglal + (targetHumidity - humidity))*0.5f,-10.f),10.f);
    sethHumidifier(humidityInteglal > 0);
    ambient.set(6,humidifierActive);
    Serial.printf("humidifier:%d \n",humidifierActive);

加湿器の稼働の判断は目標の湿度値との差分をもとにオンオフの判定を行っています。単純にその時の湿度値で判定すると値の変化に過敏になりすぎるので前回の計算値との移動平均の値で判定をしてみています。後述する結果でもわかりますが、それでもオンオフを交互に繰り返すような結果なので計算方法は今後も考えていきたいです。

//保存変数
RTC_DATA_ATTR bool humidifierActive = false;
RTC_DATA_ATTR float humidityInteglal = 0;

//加湿ONOFF
void sethHumidifier(bool sw)
{
  humidifierActive = sw;
  rtc_gpio_set_level(kPowerPin, sw ? HIGH:LOW);
}

void setup() {
  //ピンをセットアップ
  rtc_gpio_init(kPowerPin);
  rtc_gpio_set_direction(kPowerPin,RTC_GPIO_MODE_OUTPUT_ONLY);

  //スリープ時にピン出力し続ける設定
  esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH,ESP_PD_OPTION_ON);
}

ディープスリープを使用しているので、加湿器の稼働判定用の変数や出力ピンの動作をスリープ中でも継続する必要があります。
スリープ中に変数を保存するには変数の定義の先頭にRTC_DATA_ATTRを設定することで保存されます。
ピンについては通常のピン入出力関数ではなく、rtc_gpio_で始まる関数を使用する必要があります。
esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH,ESP_PD_OPTION_ON)を呼ぶことでスリープ時にrtc_gpio_~で設定したピンの動作が継続できるようになります。

結果

結果はAmbientへ送信しているので、現在IoTの部屋でグラフとして確認することができます。

IoTの部屋

上は4/30の結果ですが、目標の90%を行ったり来たりしています。もうちょっとなだらかな結果を期待していたのですが、半開きのテラリウム水槽だと5分加湿器を止めるだけで結構水分が逃げていくみたいですね。
16時頃から加湿器用の水が切れたみたいで湿度が下がりっぱなしですが、稼働しないとこれだけ下がるということで効果はしっかりありそうです。

ゆくゆくは加湿器を単純にオンオフではなく、PWM的に間欠動作させて加湿量をコントロールしてよりフラットなグラフを目指すのも考えています。
でもその前に苔ルームに照明が欲しくなってきたのでそっちですかね

それではまた！

M5 / プログラミング

2021年10月9日

タグ: IoT, M5Atom, プログラミング

M5AtomでENVⅡHatを使う

こんにちは、Lineaです　前回で水分監視 […]

こんにちは、Lineaです　

前回で水分監視システムの制御をM5Atomに替えました。
今回は測定できるものが水分量だけなのも寂しいので、余っていたENVⅡHatを追加して気温や湿度の計測を追加しました。
ENVⅡHATはそもそもM5StickC用のセンサーモジュールなのですが、アダプターを使うことでM5Atomでも使用することができます。今回は使ったアダプターやM5Atomで使用するポイントも解説したいと思います。

ENVⅡHAT

ENVⅡHATはM5StickCに直接接続できる環境センサーモジュールです。内部には温湿度、地磁気、気圧センサーの3つのセンサーが内蔵されています。それぞれのセンサーはI2C接続でまとまっていますが、センサー自体は別々なので個別に制御する必要があります。

ENVⅡHAT
https://www.switch-science.com/catalog/6559/

写真のようにM5StickCのピンソケットに直接挿さるようになっているのでM5Atomには直接接続することはできません。M5Atomでてっとり早く接続するには以下に含まれるアダプターを使います。

Atom Mate
https://www.switch-science.com/catalog/6532/

M5Atom底部のピンソケットからM5StickCのピンソケットと同じ配置に変換します。製品ページの注意にも書いてありますが、M5Atom自体がM5StickCとピン番号が異なるのでプログラム側でピン番号は置き換えて使う必要があります。
アダプターの裏にピン配置が書かれているのでそれを元にピンを指定します。HATのサンプルコードなどWebにあるコードはM5StickCのピンになっていることがほとんどなので参考にする場合は注意しましょう。

このようなM5StickC用の拡張センサはHatシリーズとして他にも色々用意されています。接続できればM5Atomで使えるのは同じようなのでアダプタを持っておくと使い回せて便利ですね。

温湿度センサーのプログラム

ENVⅡHATは内部に温湿度、地磁気、気圧の3つのセンサーがありますが、今回は温湿度センサーのみを使います。
温湿度センサーからの情報取得はこちらの公式のサンプルの一部を参考にしています。

公式サンプルコード（GitHub）
https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/ENVII_HAT

この中のSHT3X.h/cppに温湿度センサーの情報取得が書かれていますが、そのままだとM5Atomのピンが設定できないので少し変更しました。
以下のようにI2C接続で使用するピンを設定できるコンストラクタを追加しています。

class SHT3X{
public:
  SHT3X(uint8_t address=0x44); //元のコンストラクタ
  SHT3X(uint8_t scl, uint8_t sda,uint8_t address=0x44);//追加コンストラクタ
//略
}

//元のコンストラクタ
SHT3X::SHT3X(uint8_t address)
{
  Wire.begin();
  _address=address;
}
//追加コンストラクタ
SHT3X::SHT3X(uint8_t scl, uint8_t sda,uint8_t address)
{
  Wire.begin(sda,scl);
  _address=address;
}

メインの計測プログラムでセンサーの値の取得には上記で変更したSHT3X.h/.cppをインクルードします。
計測のコードは以下のようになります。

#include "SHT3X.h"
//I2cピン
const uint8_t kI2CSclPin = 22; 
const uint8_t kI2CSdaPin = 19;
//センサーオブジェクト
SHT3X sht3x = SHT3X(kI2CSclPin,kI2CSdaPin); 

//計測関数
void measure(){
  //温湿度計測 get()で取得　成功すると0が返る
  if(sht3x.get() == 0){
    //オブジェクトに書き込まれているので読み取る
    Serial.printf("temp:%.2f \n",sht3x.cTemp);
    Serial.printf("humidty:%.2f \n",sht3x.humidity);
  }
}

SHT3X型のオブジェクトを作成し、get関数で値を取得します。取得した値はオブジェクトの変数に書き込まれます。
あとは変数の値を読んで表示やデータ送信などデータ処理に使うだけです。
注意点としてはピンの設定を忘れないことです。I2CにはSCL,SDAの2ピンを使いますが22,19ピンが対応しています。

おまけ

アダプターにピン拡張基板がついてきたのですが、足の長いピンソケットと組み合わせてアダプターと同時に使えるようにしてみました。アダプターだけだとAtom本体のピンソケットが幾つか使えなくなってしまうのですが、これで全部のピンを生かせます。

問題は厚みがすごいことになって要塞のようになってしまうことですwww。Atomとは言えませんねこれはw

M5 / プログラミング

2021年9月18日

タグ: IoT, M5Atom, プログラミング

M5Atomを買ってみた

こんにちはLineaです。　また日が空いてし […]

こんにちはLineaです。　
また日が空いてしまいました。書くネタは溜まってるんですが書く一歩が中々重い、これが筆不精ってやつでしょうか。

今回のネタはM5シリーズの一つM5Atomを買って使ってみた話になります。

M5Atomは以前紹介したM5StickCよりも更に小型で安価なマイコンボードです。メインのチップはM5StickCと同じなので基礎性能は同じなのですが液晶ディスプレイなど内蔵デバイスが省かれていてよりIoTデバイスに特化しています。

今回は水分監視システムの制御をM5StickCからM5Atomで置き換えました。定期的にデータを計測して送信することがメインなのでディスプレイは必要ないですのでM5Atom向きですからね

それでは解説していきます。

M5Atomについて

M5Atomは先程述べたとおりM5シリーズの一つでIoTデバイス向けのマイコンボードです。
特徴としては、表示やボタンといった人が操作する部分は必要最小限になっている分、小型で安価なところです。
内蔵するチップはESP32と他のM5シリーズと同じチップを搭載しているため、処理性能やWifi,Bluetoothといったネットワーク接続が可能な点は同じです。GROVE互換の端子や接続ピンを持っているのも共通です。
M5Atomには搭載するフルカラーLEDが一つのLite版と、5＊5のマトリックスLEDになっているMatrixの2種類があります。自分が購入したのはLite版ですが、1300円ほどで販売されています。

M5Atom Lite
https://ssci.to/6262

他のM5シリーズと同様に開発はUIFlowやArduinoIDEといった開発環境が使えます。チップも同じなのでライブラリやピン配置は変える必要がありますがコードもある程度使い回すことができます。

M5StickCと並べてみました。半分ぐらいのサイズですね。
裏にはピン配置が書かれています。M5StickCのものと見比べるとGROVEのピンが結構異なるのでちゃんと確認してプログラムを書く必要がありますね。
M5Atomは汎用端子が裏面に出ているのでジャンパピンなどを刺してやればそのままブレッドボードに挿すこともできます。

水分監視システムのプログラム：M5Atom版

それでは以前M5StickC向けにC++で作ったプログラムをM5Atomで動くように書き換えます。

前提として、M5Atomには専用のライブラリがあるのでそちらを使用します。ここらへんは内蔵しているデバイスが違うので他機種で使い回せないのは仕方ないですね。ライブラリのリンクは以下ですが、ArduinoIDEなど各エディタで「M5Atom」ライブラリで検索したほうが早いと思います。

M5Atomライブラリー
https://github.com/m5stack/M5Atom

また、上記のM5Atomのライブラリでは内蔵LEDの制御にFastLEDというライブラリを使用しています。そのため、動作にはFastLEDライブラリもインストールする必要があります。

FastLEDライブラリー
https://github.com/FastLED/FastLED

作成したプログラムが以下になります。

#include <M5Atom.h>
#include <WiFi.h>
#include <Ambient.h>

//define
//スリープ時間計算マクロ関数
#define SLEEP_MIN(min) min*60000000ULL
//色定義　GRBの順番に注意
#define LED_PINK 0x55FFAA
#define LED_GREEN 0xFF0022
#define LED_BLUE 0x0022FF
#define LED_OFF 0x000000
//pin定義
const uint8_t kEarthPin = 32;
//スリープ時間
const uint sleepMin = 30; //30分
//wifi情報
const char wifi_ssid[32]="SSID";
const char wifi_key[64]="アクセスポイントのキー";
//ambient情報
const unsigned int channelId = 0; // AmbientのチャネルID
const char* writeKey = "ライトキー";
//static変数
WiFiClient client;
Ambient ambient;

//functions
//測定
void measureEarth(){

  //5回計測した平均を送る
  uint16_t earthVal = 0;
  int measureNum = 5;
  for(int i=0; i<measureNum; i++)
  {
    M5.dis.fillpix(LED_GREEN);    //LED点灯
    delay(200);
    //水分センサは濡れているほうが値が低くなるので反転させる
    earthVal += 1024 - analogRead(kEarthPin);
    M5.dis.fillpix(LED_OFF);    //LEDオフ
    delay(300);
  }
  earthVal/= measureNum;
  ambient.set(1,earthVal);

  //Ambient送信
  ambient.send();
  
}

//カウントダウン
void countDown(const char *dispTxt,const int sec)
{
  int count = sec;
  while (count >= 0)
  {
    count--;
    M5.dis.fillpix(LED_PINK);    //LEDオン
    //1秒待つ
    delay(500);
    M5.dis.fillpix(LED_OFF);    //LEDオフ
    delay(500);
  }
}

//setup関数　ディープスリープ復帰時もここから再開する
void setup() {
  //M5スタート
  M5.begin();

  //水分センサのピンをセットアップ
  pinMode(kEarthPin,ANALOG);

  //アナログ値の解像度を1024段階に設定
  analogSetWidth(10); //10bit(1024)

  // WiFi接続
  Serial.printf("Connecting to %s ", wifi_ssid);
  WiFi.begin(wifi_ssid, wifi_key);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("CONNECTED");

  //Ambient setup
  ambient.begin(channelId, writeKey, &client); // チャネルIDとライトキーを指定してAmbientの初期化
}

void loop() {
  //計測カウントダウン
  countDown("measure",5);

  //計測
  measureEarth();
  
  //wait
  delay(5000);

  //スリープカウントダウン
  countDown("sleep",5);

  //スリープ
  Serial.println("Enter sleep");
  esp_sleep_enable_timer_wakeup(SLEEP_MIN(sleepMin));
  esp_deep_sleep_start();
}

主な変更点は液晶ディスプレイの表示をLEDの点灯に切り替えた点です。LEDはフルカラーLEDですのでfillpix()関数で色を指定して変更することができます。このとき色の指定は16進数で指定しますが、色の並びがGRBになっているので注意が必要です。

水分センサはM5AtomのGROVE端子に接続する想定ですが、M5StickCとピンが異なるので書き換えるひつようがありました。

その他のWifi接続や計測、Ambientへの送信についてはM5StickC用のコードから変えていません。スリープの開始関数もESP32の関数を呼んでいるので共通して使えます。

終わり

動作自体は大して変わらないので割愛します。
M5Atom自体が小型なおかげでケース内での取り回しが良くなりました。ステータス表示ぐらいはLEDの色で表現できるのでIoTデバイスを作るにはこちらのほうが確かに向いていますね。
お役目が余ったM5StickCの方でまた別でお役立ちデバイス？を作ったのでそのうち紹介したいと思います。

それではまた！

M5 / プログラミング

2021年8月29日

タグ: IoT, 電子工作

土壌水分センサをアップグレードした話

こんにちはLineaです。　今回は溜まって […]

M5 / プログラミング

2021年8月8日

タグ: IoT, M5 StickC, プログラミング

M5StickCでガーデニングの水やりセンサを作る ~その3 【スリープで長時間稼働】

こんにちは、Lineaです　前回は計測した […]

こんにちは、Lineaです　

前回は計測した水分量データをAmbientというIoTログサービスに送信してデータの可視化まで行いました。ですが、課題としてM5StickCの内蔵バッテリーで常時ネットワーク接続して稼働させ続けると1時間弱しか保ちませんでした。
今回はM5StickCのスリープ機能を使って解決してみようと思います。計測してデータ送信⇒15分スリープ⇒計測してデータ送信…と繰り返す動作を作っていきます。
スリープ機能はUIFlowでは使用できなかったので、今回からArduino環境（C/C++)でつくっていきます

前回の記事はこちらです

M5StickCでガーデニングの水やりセンサを作る ~その2 【Ambientでデータ保存編】

M5StickCのスリープ機能

M5StickC（に内蔵されるマイコン）には2段階のスリープがあります。

ディープスリープ
ライトスリープ

どちらも復帰にはタイマーやボタンの入力が使えます。一定時間後やボタンが押されたらといった条件で復帰させることができます。
2つのスリープの差は電力以外に復帰時の挙動に大きな違いがあります。

ディープスリープ

名前の通り機能をほぼ停止させることで電力消費を大きく抑えます。
復帰時にはプログラムを最初から実行し直すことになります。また、データもスローメモリという特殊領域に保存しておかないと維持されないです。スリープから復帰したかどうかを判別する事はできるのでプログラムの先頭でスリープ復帰時に処理を切り替える事はできます。

ライトスリープ

ディープスリープより色々停止しないので消費電力は少し大きくなります。その代わりスリープの復帰時に継続してプログラムが動作します。変数なども普通に維持された状態で復帰します。どちらかというとこっちの方が「スリープ」っぽい動作ですね。

今回は実行する機能としては数十分おきに測って送信するだけなので、状態を維持する必要がないのでディープスリープを使います。

プログラミング

最初にも書きましたがUIFlowではスリープが使えないのでC言語でプログラミングします。
M5StickCはArduino環境でC言語でプログラミングできます。ArduinoIDEでもプログラミングできますが、自分はVSCode+PlatformIOを使用しています。そのうちPlatformIOでのスタート手順も書かないとですね。

今回作成したプログラムがこちらです。

#include <M5StickCPlus.h>
#include <WiFi.h>
#include <Ambient.h>

//define
//pin定義
const uint8_t kEarthPin = 33;
const uint8_t kEarthDigiPin = 32;
//スリープ時間
const uint sleepMin = 15; //15分
//wifi情報
const char wifi_ssid[32]="SSID";
const char wifi_key[64]="アクセスポイントのキー";
//ambient情報
const unsigned int channelId = 0; // AmbientのチャネルID
const char* writeKey = "ライトキー"
//static変数
WiFiClient client;
Ambient ambient;

//functions
//測定
void measureEarth(){
  //濡れているほうが値が低くなるので反転させる
  uint16_t earthVal = 1024 - analogRead(kEarthPin);
  int earthDigi = digitalRead(kEarthDigiPin);

  //表示
  M5.lcd.fillScreen(BLACK);//クリア
  M5.Lcd.setTextColor(WHITE, BLACK);
  int32_t drawX=4 ,drawY = 16;
  char valStr[32];
  M5.lcd.drawString("Earth Sensor",drawX,drawY);
  drawY += 24;
  sprintf(valStr,"value : %d",earthVal);
  M5.lcd.drawString(valStr,drawX,drawY);
  drawY += 24;
  M5.lcd.fillRect(drawX,drawY,(earthVal/1024.0)*(M5.Lcd.width()-32),16,BLUE);
  drawY += 24;
  sprintf(valStr,"wet? : %d",earthDigi);
  M5.lcd.drawString(valStr,drawX,drawY);
  drawY += 24;
  sprintf(valStr,"wifi? : %d",WiFi.status());
  M5.lcd.drawString(valStr,drawX,drawY);

  //Ambient送信
  ambient.set(1,earthVal);
  ambient.set(2,earthDigi);
  ambient.send();
  
}

//カウントダウン
void countDown(const char *dispTxt,const int sec)
{
  int count = sec;
  char countStr[16];
  M5.Lcd.setTextColor(WHITE, GREEN);
  M5.Lcd.fillRect(24,24,M5.Lcd.width()-48,M5.Lcd.height()-48,GREEN);
  while (count >= 0)
  {
    sprintf(countStr,"%s %ds...",dispTxt,count);
    M5.lcd.drawCentreString(countStr,M5.Lcd.width()/2,M5.Lcd.height()/2,2);
    count--;
    //1秒待つ
    delay(1000);
  }
}

//setup関数　ディープスリープ復帰時もここから再開する
void setup() {
  //M5スタート
  M5.begin();
  M5.Lcd.setRotation(1);
  // 画面をつける（スリープ復帰用）
  M5.Axp.ScreenBreath(10);

  //水分センサのピンをセットアップ
  pinMode(kEarthPin,ANALOG);
  pinMode(kEarthDigiPin,INPUT);

  //アナログ値の解像度を1024段階に設定
  analogSetWidth(10); //10bit(1024)

  //文字サイズを少し大きくしておく
  M5.lcd.setTextFont(2);

  // WiFi接続
  Serial.printf("Connecting to %s ", wifi_ssid);
  WiFi.begin(wifi_ssid, wifi_key);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("CONNECTED");

  //Ambient setup
  ambient.begin(channelId, writeKey, &client); // チャネルIDとライトキーを指定してAmbientの初期化
}

void loop() {
  //計測カウントダウン
  countDown("measure",5);

  //計測
  measureEarth();
  
  //wait
  delay(5000);

  //スリープカウントダウン
  countDown("sleep",5);

  //スリープ
  Serial.println("Enter sleep");
  // 画面を消す
  M5.Axp.ScreenBreath(0);
  esp_sleep_enable_timer_wakeup(SLEEP_MIN(sleepMin));
  esp_deep_sleep_start();
}

重要なところをいくつか解説します

スリープ処理

//スリープ時間
const uint sleepMin = 15; //15分

//setup関数　ディープスリープ復帰時もここから再開する
void setup() {
  //中略...
  // 画面をつける（スリープ復帰用）
  M5.Axp.ScreenBreath(10);
}

void loop() {
  //計測
  measureEarth();
　//中略...

  //スリープ
  Serial.println("Enter sleep");
  // 画面を消す　スリープに入るだけでは画面は点いたままになる
  M5.Axp.ScreenBreath(0);
  //スリープ復帰方法を設定　タイマー版
  esp_sleep_enable_timer_wakeup(SLEEP_MIN(sleepMin));
　//スリープ開始
  esp_deep_sleep_start();
}

スリープはesp_sleep_enable_xxx_wakeup()で復帰方法を指定後にesp_deep_sleep_start()で開始します。xxxの部分は復帰方法毎に関数が分かれています。今回は復帰方法にタイマーを使用します。タイマーの時間はマイクロ秒で指定するので注意が必要です。SLEEP_MIN()など変換マクロ関数が用意されているのでこちらを使うと指定が楽です。

ディープスリープからの復帰はsetup()からやり直されることになるのでこの中に復帰した際の処理はここに書く必要があります。

スリープでは液晶画面のオンオフは管理されないので、スリープ突入時に画面をオフにする場合はM5.Axp.ScreenBreath()で画面の明るさを0にして消す必要があります。また、スリープからの復帰時には再度ScreenBreath()で明るさを設定してオンにする必要がありますのでsetup()に書いてあります。

Wifi & Ambient

//ヘッダ
#include <WiFi.h>
#include <Ambient.h>
//wifi情報
const char wifi_ssid[32]="SSID";
const char wifi_key[64]="アクセスポイントのキー";
//ambient情報
const unsigned int channelId = 0; // AmbientのチャネルID
const char* writeKey = "ライトキー"
//static変数
WiFiClient client; //Ambientで使うので必要
Ambient ambient;

void setup() {
  // WiFi接続
  WiFi.begin(wifi_ssid, wifi_key);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
  }
  //Ambient setup
  ambient.begin(channelId, writeKey, &client); // チャネルIDとライトキーを指定してAmbientの初期化
}

Ambientに送信するにはWifi接続も必要なので合わせて解説します。Ambientを使うにはライブラリをインストールする必要があります。ArduinoIDEやPlatformIOのライブラリ検索で「Ambient ESP32 ESP8266 lib」を検索してインストールします。インストールできたらWifi.hとAmbient.hをインクルードしておきます。

ENVⅡHAT
https://www.switch-science.com/catalog/6559/

WiFi.begin()の引数にSSIDとパスワードを渡して呼ぶことで接続します。接続には時間がかかるので、すぐに次の処理を始めてしまうとエラーの原因になります。WiFi.status()で状態を取得して、接続状態WL_CONNECTEDになるまでループして接続できるまで待機します。

AmbientはAmbient型のクラスから制御します。static変数などでインスタンスを作っておき、Ambient::begin()にチャネルIDとライトキーを渡して初期化します。 Ambient::begin() にはWifiClientのポインタも渡す必要がありますのでWifi接続後に呼ぶ必要があります。

測定 & データ送信

//pin定義
const uint8_t kEarthPin = 33; //アナログ値ピン
const uint8_t kEarthDigiPin = 32;　//デジタル値ピン

void setup() {
  //水分センサのピンをセットアップ
  pinMode(kEarthPin,ANALOG);
  pinMode(kEarthDigiPin,INPUT);
  //アナログ値の解像度を1024段階に設定
  analogSetWidth(10); //10bit(1024)
}

void measureEarth(){
　//計測
  //濡れているほうが値が低くなるので反転させる
  uint16_t earthVal = 1024 - analogRead(kEarthPin); //アナログ値
  int earthDigi = digitalRead(kEarthDigiPin);　//デジタル値

  //Ambient送信
  ambient.set(1,earthVal); //データスロット1
  ambient.set(2,earthDigi); //データスロット2
  ambient.send();
  
}

水分センサの値は接続しているピンの値を直接読み取ります。32,33ピンが対応するピンです。32はデジタル値で一定値を境に0-1で取得できます。33はアナログ値で細かい数値が取得できます。基本的には細かく取れる33ピンの方を使用すると思います。pinMode()でピンとモードを適したものに設定します。
アナログ値はanalogSetWidth()でAD変換の解像度を設定することで値の範囲を変更できます。デフォルトでは0-4096になっていますが、UIFlowでは0-1024だったのでそれに合わせて変更しています。

センサからの値の取得はanalogRead(),digitalRead()でそれぞれ設定したピンから取得します。
Ambientへのデータ送信はAmbient::set()にデータのスロットと値を渡してセットします。Ambient::send()でセットした値を送信します。

動作

動かしてみたところをGif動画にしてみました。

Wifiの接続完了後に計測までのカウントダウンが表示されます。Wifi接続までは数秒かかります。接続中の表示を足しても良かったかもしれないです。
測定後にカウントダウンしてスリープに入ります。画面もオフにしているので見た目では電源が切れているのと差がわからないのが難点ですね。運用上はプランターに挿して放置するので目視確認することもないので気にしない方針。

さて、肝心の稼働時間です。Ambientのデータにどれだけデータ送信が続けられたかで確認します。

満充電で17:30ごろから動かして24:30ごろまでデータが送信されていました。内蔵バッテリーだけで約7時間ほど稼働できました。前回の1時間に比べれば7倍ですのでかなり伸ばすことができました！！
これならモバイルバッテリーを接続することで数日は動かし続けられそうです。計測の間隔を伸ばせば実行時間が減るので更に稼働時間を増やせるかもしれないですね。