Seeeduino XIAOでES920LRの設定と無線通信

こんにちは、ENGかぴです。

Seeeduino XIAOの標準ライブラリであるSerial1を使用すると外部機器とシリアル通信ができます。Serial1とLoRaモジュールのES920LRをシリアル通信で接続しES920LRの初期化と電文を構成して無線通信を行う方法をまとめました。

ES920LRB（EASEL製：東京デバイセズで購入）を２台使用して親機と子機の設定を行います。ES920LRには後継機種としてES920LR2及びES920LR3があります。温湿度と気圧のデータのデータを無線通信するためにAE-BME280（秋月電子）を使用しています。

本記事ではES920LRの初期化をプロフェッサーモードで設定を行い出力データ部に自作の電文を構成して無線通信を行います。Seeeduino XIAOのシリアル通信の方法とES920LRの設定を行って無線通信する方法は以下の記事にまとめています。

Seeeduino XIAOのSerialライブラリの使い方

LoRaモジュールES920LRの設定と無線通信の確認

これらで紹介した記事を応用して無線通信を実現します。Seeeduino XIAOで動作確認したことについてリンクをまとめています。

Seeeduino XIAOで学べるソフト開発と標準ライブラリの使い方

PR：わからないを放置せず、あなたにあったスキルを身に着けるコツを教えるテックジム　「書けるが先で、理解が後」を体験しよう！

Serial1を使用する
ES920LRで無線通信する
動作確認
ソースコード全体
関連リンク

Serial1を使用する

Seeeduino XIAOでSerial1を使用すると6ピンがTX、7ピンがRXになります。Arduino UNOなどで使用するSerialはシリアルモニタ専用で使用することができます。Serial1はSerialと同じように使用することができるためシリアル通信を手軽に実装することができます。Serial1クラスのメンバー関数を使ってシリアル通信を実装します。

ライブラリの初期化

void setup() {

  Serial1.begin(115200); //外部機器との通信用
  //while(!Serial ){ } //ポートを開くまでの待ち
｝

begin()関数でシリアル通信を開始します。引数にシリアル通信のボーレートを入力します。ES920LRのボーレートのデフォルトに合わせて115200bpsを指定しています。

begin()を発行した後シリアル通信ポートが開始する（初期設定待ち）までループさせて確実に設定が完了するまで待機させることもありますが、初期化時に意図して遅延させている場合やbegin()関数のコールからすぐにシリアル通信をしない場合は実装する必要はありません。

ボーレート以外の設定は特に指定しない場合はデータ長は8ビット・パリティなしの条件で動作します。

Arduino IDEやVSCodeで選択できるボーレートから選択すると多くの場合問題になりませんが、ボーレートを早くしすぎると配線の長さや周辺回路の部品などの影響で通信できなくなることがあるので外部機器のクロックを含めて検討する必要があります。

データを受信する

while(Serial1.available()){
  SeeedRcv.buf[SeeedRcv.wp] = Serial1.read(); //データをリード

  if( ++SeeedRcv.wp >= sizeof(SeeedRcv.buf)){ //次に保管する位置を更新
    SeeedRcv.wp = 0;
  }
}

受信データの有無を確認するためavailable()関数を使用します。受信データが存在する場合はavailabale()関数の戻り値が1以上になります。データが存在する場合はread()関数でデータを読み込みます。

例では受信データをSeeedRcv[]の配列に保存先を更新しながら一時保管しています。一時保管したデータはデータチェックに使用します。

While()で受信データを確認しているのはメイン処理に来るたびに受信データ分だけ確実に取得するためです。受信タイミングにもよりますがif()で確認するよりもデータの一時保管が早くなることがあります。

データを送信する

//COM_TXモードで送信                
Serial1.write(&Txdata.buf[0], Txdata.sz);

データの送信はwrite()関数を使用します。write()関数は４通りの指定方法がありますが、例では第1引数に送信するデータのポインタ、第2引数に送信するデータ数を指定する方法を使用しています。Txdata.buf[0]からTxdata.szで指定したサイズのデータを送信します。

print()関数やprintln()関数を使用するとテキストデータの文字列を送信することができますがバイナリデータを送信するためにwrite()を使用します。

シリアル通信の管理する

void Serialmain(bool init){

  switch(ComMode){
    case COM_RX_WAIT:
      //受信待ちで一時保管したデータのチェックを行う
      //ヘッダーとSUMで電文の整合性チェックをチェック
      break;
    case COM_RCVDATA: 
      //受け入れた電文に対して処理を行う
      break;
    case COM_TX:
      //返信電文を送信する
      break;        
    }
}

自作の関数のSerialmain()関数でシリアル通信の管理を行います。引数はES920LRの初期化の場合と通常の電文で処理を切り替えるために使用します。初期化する場合は引数にtrueを指定します。

受信と送信をモードによる切り替え処理で管理します。以下のように3つのモードを実装します。

モード	説明
COM_RX_WAIT	一時保管したデータをヘッダーやデータ長から電文を判断する。データのチェックサムによって問題なければ電文受け入れる。
COM_RCVDATA	受け付けた電文を解析して処理を行う。
COM_TX	データを送信する。

送受信を管理するモードの説明

COM_RX_WAITで受信したデータの確認を行いチェックサムの条件を満足すると電文を受け入れてモードをCOM_RCVDATAに遷移します。

COM_RCVDATAで電文を解析して処理を行います。データを返信する場合は送信用のデータをセットしてモードをCOM_TXに遷移します。返信しない場合はモードをCOM_RCVDATAに戻して受信待ちにします。

モードを切り替えて処理するため受信データのチェックと送信の処理が同時に発生することはありません。

ES920LRで無線通信する

ES920LRの初期設定をプロフェッサーモードで行います。Seeeduino XIAOのシリアル通信を使ってES920LRの初期設定を行い、自作の電文を構成して無線通信を行います。

ES920LRの初期設定

プロフェッサーモードはショートコマンドを使用してES920LRの設定する方法です。設定方法の詳細はEASEL社のHPに公開されているデータシート（ES920LRコマンド仕様ソフトウェア説明書_v121）で確認することができます。

EASEL社ー920MHz帯LoRaモジュール　ES920LR

ES920LRの設定は以下の手順で行います。半角のスペースを␣改行コードをCRLF(0x0D 0x0A)と表記します。

ES920LRの初期化の例

手順1
プロフェッサーモードに遷移

電源ONから３秒後に[Select Mode]が表示されるのを待って
2CRLFでプロフェッサーモードに遷移します。
手順2
ノードの選択

親機/子機で動作するかを設定します。
親機：a␣1 CRLF、子機：a␣2 CRLF
手順3
ノードのPAMIDの設定

親機/子機で共通のPANIDを設定します。
e␣12AB CRLF（12ABは16進数）
手順4
自局のアドレスの設定

親機/子機の自局のアドレスを設定します。
親機：f␣0000 CRLF、子機：f␣0001 CRLF
手順5
送信先（宛先）のアドレスの設定

送信相手のアドレスを設定します。
親機：g␣0001 CRLF、子機：g␣0000 CRLF
手順6
ペイロードのフォーマットの設定

※バイナリデータで送信に変更
A␣2 CRLF
手順7
RSSIの追加

電文にRSSIのデータを付加します。
p␣1 CRLF
手順8
起動時のモードの設定（本記事では未実装）

電源ONした後のモードを設定する。オペレーションモードで起動
q␣2 CRLF
手順9
設定の保存（本記事では未実装）

手順6までに設定した項目を保存する。
手順10
オペレーションモードスタート

オペレーションモードに遷移します。
z CRLF

ES920LRは電源をONして3秒（bootモードに遷移するまでの時限）ほどコマンドを受け付けることができません。そのためプロフェッサーモードに遷移させるコマンドを３秒経過してから送信するようにします。

上位互換のES920LR2やES920LR3は起動時の仕組みが改善されているため３秒のウェイトを置く必要はないようです。

本記事では未実装ですが起動時に親機と子機の役割が明確な場合は手順8による起動時のモードの設定と手順9の設定の保存を行うことで次回起動時に初期化処理をせずに無線通信ができます。

switch(initmode){
  case INIT_WAIT: //3秒以上のウェイト
    if(timInitWait == TIME_UP ){
      timInitWait = TIME_OFF;
      initmode = INIT_SEL;
    }
    break;
  case INIT_SEL: //プロフェッサーモードを選択
    if( IntTxDataSet((uint8_t*)&select,1)){ //2CRLFを送信
      initmode = INIT_SEL_WAIT; //OKが返信されるのを待つモード
    }            
    break;
  case INIT_NODE: //ノードの設定
    if(selParent){ //親機の場合
      if( IntTxDataSet((uint8_t*)&node1,3)){ //a␣1 CRLFを送信
        initmode = INIT_NODE_WAIT; //OKが返信されるのを待つモード
      }                   
    }
    else{ //子機の場合
      if( IntTxDataSet((uint8_t*)&node2,3)){ //a␣2 CRLFを送信
        initmode = INIT_NODE_WAIT; //OKが返信されるのを待つモード
      }                     
    }
    break;
}

初期化処理はモード切替で行います。ES920LRの初期化の例の手順に従うようにモードを遷移させていきます。INIT_SELモードでは「2CRLF」を送信し、INIT_SEL_WAITモードで返信を待ちます。

プロフェッサーモードではコマンドを受け付けると「OK」を返信します。「OK」が確認できれば次のモードであるINIT_NODEに遷移します。このように送信と返信待ちを繰り返しながら各種設定を行っていきます。

使用環境によってはシリアル通信がうまくいかずNGが返信されたりOKが掴めなかったりして処理が停滞してしまうことがあります。対策として失敗したときのリトライ処理（本記事では未実装）を実装すると安定性が良くなります。

送受信に使用する電文の構成

引用：EASEL社-ES920LRコマンド仕様ソフトウェア説明書_v121.pdf

ES920LRの初期設定の時に通信方式をPayloadモードに変更しています。Payloadモードでは先頭に全体の入力長を1バイトで指定し２バイト目からRSSIなどの付加情報が続き出力データ（最大50バイト）の順に構成されます。

アスキーコードは受信時にモニター表示するとデータを確認しやすいメリットがありますが、バイナリデータに置き換えると2バイト必要になるため送信バイト数が増えてしまうデメリットがあります。

例）バイナリデータの「0x31」を送信する場合はアスキー文字では0x33 0x31と2バイト分のデータとなります。

LoRa通信などLPWAでは低消費電力を実現するために可能な限り送信するバイト数を減らすことが必要です。対策としてバイナリデータで送信バイト数を減らす方法が有効です。

Payloadモードのフォーマットに従って電文は出力データ部に構成します。

１バイト目には全体の入力長を指定します。２バイト目は電文を判別するためのヘッダーとして「L」を指定します。コマンドに番号を指定しデータ1からデータ4はコマンドの番号に対する処理の内容を指定します。SUMはコマンドからデータ4までを加算した値の下位1バイトを付加します。

１バイト目の入力長は送信時に使用します。受信時はRSSIの前に全体の入力長が付加されるため出力データ部分はヘッダーからになります。コマンドは子機がボタンを押したときにBME280モジュールの温度、湿度、気圧のデータを切り替えて送信するために使用します。

PR：わからないを放置せず、あなたにあった最低限のスキルを身に着けるコツを教えるテックジム　「書けるが先で、理解が後」を体験しよう！

送信データの生成

bool TxDataSet(bool boo, uint8_t cmd){
  bool ret = false;
  uint8_t i=0;
  uint32_t data;
    
  if( ComMode == COM_RX_WAIT ){ //データが送信中でない
    Txdata.buf[i++] = 7;//sz
    Txdata.buf[i++] = HEADER;//5; //cmd+4byte
    Txdata.buf[i++] = cmd;
    data = (uint32_t)(bme280data[cmd] * 100);
    Txdata.buf[i++] = ( data >> 24 );
    Txdata.buf[i++] = ( data >> 16 );
    Txdata.buf[i++] = ( data >> 8 );
    Txdata.buf[i++] = ( data & 0xFF );
    Txdata.buf[i++] = CalcSum(&Txdata.buf[2], 5);
    Txdata.sz = i;
    ComMode = COM_TX;
    timTxWait = TIM_TX_WAIT;
    ret = true;
  }
  return ret;
}

TxData.buf[]配列に送信データを格納します。データの受信と送信をモードで管理しているためデータが受信待ち（送信中でない）でなければ送信データをセットします。

最初に全体のデータ長をセットし、次にヘッダをセットします。

コマンド(cmd)は0：気温、1：気圧、2：湿度を切り替えに使用します。続けてcmdに対応したBME280モジュールのデータをセットします。BME280モジュールのデータは4バイトデータなのでビットシフトを使用して1バイトデータに分割してセットしています。受信側（親機）でデータを再構成した際に小数点以下の精度を保つために100倍値を分割して送信します。

コマンドからBME280モジュールのデータまでのSUM値を計算して電文の最後尾に付加します。送信データをセットした後は、送信モードに遷移させてデータを送信します。

受信データのチェック

  if( rxsz >= 6 ){ //データ長分だけ獲得しているか
    for( i = 0; i < 6; i++){//データサイズ算出のため仮おき
      dat[i] = SeeedRcv.buf[ rp ];
      if(++rp >= sizeof(SeeedRcv.buf) ) rp = 0;
    }
                          
    if( dat[5] == HEADER){
       allsz = dat[0] + 1; //全データ数
       datsz = dat[0] - OFFSET_RSSI - 2; //headerとsumを除外
                    
       if( rxsz >= allsz){ //確定したサイズ以上か
         timRxWait = TIME_OFF;

         for(i=0; i < sizeof(Rcvdata); i++){
           Rcvdata[i] = 0; //バッファのクリア
         }

         for( i=0; i < allsz; i++ ){
           Rcvdata[i] = SeeedRcv.buf[SeeedRcv.rp]; //一時保管したデータを移す
           ReadPointerAdd(); //読み込み位置の更新
         }

         sumchk = CalcSum(&Rcvdata[6], datsz); //チェックサムの計算
         if( sumchk == Rcvdata[allsz-1]){ //チェックサムの確認
           ComMode = COM_RCVDATA; //モードを遷移
         }
       }    
     }
    else{
      ReadPointerAdd(); 
    }
  }

一時保存した受信データが電文の構成と一致するかをCOM_RX_WAITモードでチェックします。受信データにはRSSIが付加されているので受信データの先頭から6バイト目がヘッダになります。

ヘッダが一致すると受信データを電文保管用のバッファ(Rcvdata[])に移し替えてRcvdata[]の7バイト目から5バイト分のチェックサム（SUM）を計算します。

電文のチェックサム値と計算したチェックサム値が一致すると正常な電文と判断してCOM_RCVDATAモードに遷移します。COM_RCVDATAモードでは電文から温度、気圧、湿度のデータを解析します。

 rssi = (strtol((char*)&Rcvdata[1],NULL,16));
 Serial.print("rssi:");  
 Serial.println(rssi);

RSSIのデータは仕様上アスキーコードで受信するため符号付のバイナリデータに変換する必要があります。strtol()でアスキーコードを16進数のバイナリデータに変換しています。strtol()関数は文字列の区切り(0や変換不能な文字)までをバイナリデータに変換します。RSSIデータの後ろにはヘッダー（L）があるため変換できずにRSSIの4バイト分がバイナリデータに変換されます。

float data;

data = ( Rcvdata[7] << 24 )
     + ( Rcvdata[8] << 16 )
     + ( Rcvdata[9] << 8 )
     + ( Rcvdata[10] );
data /= 100;
Serial.print("Temperature = ");
Serial.print(data );
Serial.println(" °C");

子機で4バイトデータを1バイトに分割したので4バイトデータに戻します。ビットシフトを使ってデータを構成しますが、子機で100倍値の値をセットしたので100で割ってデータを戻しています。100で割ることで小数点以下2桁を表示しています。