SORACOM Developers

SORACOM Air for LoRaWAN

STM32L0 LoRa Discovery Kit をセットアップする

はじめに

このドキュメントでは、STMicroelectronics 社製 STM32L0 LoRa Discovery Kit(以下、Discovery Kit)のセットアップ方法を紹介します。 SORACOM Air for LoRaWAN の全体像やユーザーコンソールの使い方は SORACOM Air for LoRaWAN Getting Started を参照してください。

当ガイドの前提は以下のとおりです。

なお、当ガイドの実施にあたっては、以下が必要となります。Discovery Kit に同梱のご案内をご確認ください。

ステップ 1: Discovery Kit の受け入れをする

Discovery Kit の利用開始にあたっては、ユーザーコンソールの「発注」画面で受け取り処理が必要です。ユーザーコンソールにログインし、受け取り確認ボタンをクリックしてください。

ユーザーコンソールで受け取り確認ボタンを押すと、Discovery Kit がアカウントに登録されます。受け取り確認ボタンが押されない場合、ソラコムから発送後 3 日で自動的にご発注時のアカウントに登録されます。LoRaWAN デバイスには基本料金はありませんが、サービスの利用状況に応じて料金が発生します。 LoRaWAN デバイスをご発注時とは別のアカウントに登録することはできません。

ステップ 2: Discovery Kit の開発環境を準備する

本製品は開発環境として Keil の MDK-ARM を利用します。 ご利用開始前に事前準備としてお手持ちのPCへ必要なソフトウェアをインストールしてください。

PC 要件

※ 本資料では mbed による開発環境については割愛させていただきます。

ST-Link Utility のインストール

ST-Link Utility では、LoRa ディスカバリ・ボードに搭載された ST-LINK / V2-1 デバッガを介して Flash メモリの書込み/消去/アップロード/ダウンロードが実行できます。また ST-LINK / V2-1 デバッガに必要な Windows デバイスドライバもインストールされます。

こちらより ST-LINK Utility のインストーラをダウンロードしてインストールしてください。

上記のサイトを開き、最下部右側に「Get Software」というアイコンがありますので、そこをクリックしてダウンロードしてください。(ST.com の MyST へのログインが必要になります。)

Keil MDK-ARM のインストール

以下 URL より Keil MDK-ARM をダウンロードしてインストールを行ってください。 http://www2.keil.com/stmicroelectronics-stm32/mdk

当ガイドでは Keil MDK-ARM v5.22 以降が必要ですので、以前のバージョンの MDK-ARM を既にお持ちの場合は今回使用する MDK-ARM を別のディレクトリにインストールすることをお勧めします。

重要:上記の Keil の Web サイトに記載されている STM32F0, STM32G0, STM32L0 用の特別なシリアル番号を使用して製品をアクティブにしてください。
(未アクティブ状態ですとコンパイル可能サイズに制限があります。)
製品のシリアル番号 (PSN) は上記ダウンロードサイトの下部に表示されます。ソラコムよりデバイス購入時に同梱されていた資料に記載されていたシリアル番号の有効期限が切れていた場合も上記のサイトにアクセスして表示されたものを利用してください。

アクティベーション方法

  1. インストールした MDK-ARM のアイコン上で右クリックし、「管理者として実行」を選びます
  2. 「File」メニューから「License Management」=>「Single-User License」を選択します
  3. 「Get LIC via Internet…」を選択後、OK をクリックし、製品登録を行います。その際、「Product Serial Number」欄に、製品に同梱のご案内に記載された製品シリアル番号を入力し、連絡先情報を入力し、最後に「Submit」を選択します。
  4. 数分後にメールでライセンス ID コード(LIC)が登録したメールアドレス宛におくられてきます
  5. 「License Management」の「New License ID Code (LIC)」欄に送られてきた LIC を入力して、「Add LIC」を選択します

STM32L0

MDK-ARM デバイスパックのインストール

Keil MDK-ARM をインストール後、「Pack Installer」の実行についてポップアップが表示されます。この実行により、必要なデバイスのサポートパックがインストールされ、MDK-ARM 上で特定のデバイスファミリ向けの開発がスタートできます。

STM32L0

注意:図の右下にある青の更新パラメータ(%表記)が 100%になるのをお待ち頂いてから、該当のデバイスパックをインストールします。必ず更新パラメータが 100% まで到達しててから作業を行ってください。 100% に到達した後、画面左にある Device ベンダ一覧から STMicroelectronics を選択すると、右側の画面にインストール可能なパッケージが表示されます。

STM32L0

パックインストーラにて、以下の 3 つのデバイスパックをインストールしてください。

更新が完了しても該当の製品ファミリが表示されない場合、以下より Keil.STM32F0xxDFP と Keil.STM32L0xxDFP をダウンロードしてください。

https://www.keil.com/dd2/pack/

次図のように、Keil.STM32F0xxDFP と Keil.STM32L0xxDFP の右側のアイコンが緑色になり「Up to date」と表示されていれば無事デバイスパックがインストール完了です。

STM32L0

「Pack Installer」のポップアップを閉じても、MDK-ARM を起動後に表示される以下のアイコンにより再度「Pack Installer」を表示させることができます。

STM32L0

MDK-ARM 日本向けコンパイルオプションの追加

MDK-ARM を起動し、”Options for Target” ボタンをクリックします。

STM32L0

”C/C++” タブをクリックし、Processor Symbols → Define 部分に以下の定義を追加します。

STM32L072xx,USE_B_L072Z_LRWAN1, USE_HAL_DRIVER,REGION_AS923, REGION_AS923_JAPAN, APPKEY_USE_TRNG

※既に設定されている場合は省略してください

STM32L0

ターミナルソフトウェアのインストール

本ドキュメントでは Tera Term を利用した解説を行います。下記サイトよりダウンロードしてインストールしてください。 https://ja.osdn.net/projects/ttssh2/

ソラコム向け Discovery Kit パッケージのダウンロード

STM32L0 LoRa Discovery Kit 製品に同梱資料に記載している URL よりソラコム向け Discovery Kit のソフトウェアパッケージをダウンロードしてください。本パッケージは日本の周波数運用 (AS923) に対応した LoRa プロトコルスタックと複数のサンプルプログラムが同梱されていますので、必ずこちらをご利用ください。ダウンロードした zip ファイルを任意のフォルダに解凍しておきます。

ソラコム向け Discovery Kit パッケージのダウンロード URL は、STM32L0 LoRa Discovery Kit 製品に同梱のご案内に記載しております。

ステップ 3: Discovery Kit をセットアップする

まず、Discovery Kit の SMA コネクタに付属のアンテナ を接続します。続いてデバッグ用の USB コネクタとお手持ちの PC を USB ケーブル (micro-B) で接続します。コネクタの横の LED(LD5)が(点滅ではなく)点灯したら PC がボードを認識したことになります。以上でセットアップは完了です。

STM32L0

ステップ 4: Discovery Kit でデータを送信する

LoRa GW の準備

LoRa でデータを送信するには Gateway(以下GW) が必要です。ソラコムが提供する LoRa GW (所有 or 共有)をご準備ください。あるいは SORACOM LoRa Space もご利用可能です。

サンプルプログラム

ステップ 2 でダウンロードしたパッケージを確認すると以下のフォルダにサンプルプログラムが格納されています。 ..\Lora_soracom_rev1\Projects\Multi\Applications\LoRa

STM32L0

試しにサンプルプログラムを用いてLoRaネットワークへデータを送信してみましょう。

..\Lora_soracom_rev1\Projects\Multi\Applications\LoRa\End_Node\MDK-ARM\B-L072Z-LRWAN1

上記のフォルダに格納されている Lora.uvprojx をダブルクリックすると Keil MDK ARMが起動します。

プロジェクトのビルド

Tera Term の設定

Tera Term を使用してデバッグ出力を監視します。 次の設定を使用します。

STM32L0

以上で出力準備ができましたので、リセットボタン(黒のボタン、B2)を押して先ほど書き込んだプログラムを実行してください。

ターミナル上での出力確認

本プログラムでは LoRa ネットワークへの接続方式=OTAA になっておりますので、リセット後の最初に JOIN 処理が行われます。

下記のように JOIN REQUEST 送出後、JOINED というメッセージが表示されれば LoRa ネットワークへの接続が成功したことになります。(ネットワーク、GW の通信状況により接続までに複数回 JOIN REQUEST を送信する場合があります)

STM32L0

その後デバイスは定期的にサンプルデータを送信します。(Default では 10 秒間隔)Tx Done と表示されていてば、デバイスからは正常に LoRa パケットを送出できたことを意味します。Rx は LoRaWAN における RX1/Rx2 を意味します。特に下りのデータがない場合は Rx はそのまま満了するため rxTimeout が表示され、下りの受信 window はクローズされます。本サンプルプログラム (EndNode) ではセンサ非搭載の場合は null のセンサデータ (0x00000000000000fe) が送信されます。

STM32L0

ソラコムコンソール (Harvest) 上での受信確認

では実際に送信されたデータが GW を経由して受信できているか確認してみましょう。 予め下記を参照してグループ設定を行ってください。 https://dev.soracom.io/jp/start/lora_uc_device/

ソラコムコンソールにログインし、メニュー → LoRa デバイスのタブをクリックします。一覧から利用しているデバイスにチェックを入れ、”データの確認”をクリックします。正常に受信されていれば下記のようにコンソール上 (Harvest) にデバイスから送信されたデータが表示されます。以上でサンプルプログラムによるデータ送信確認は終了です。

STM32L0

送信間隔の変更

先ほど Build したProjectのmain.cを開いてみましょう。 87 行目の #define APP_TX_DUTYCYCLE 10000 は送信間隔が 1000ms(10s) であることを意味しています。それでは間隔を 15s に変更するため、 #define APP_TX_DUTYCYCLE 15000 に変更して再度 Builld → Download → リセットしてみましょう。今度は送信間隔が 15s 間隔に変更されている事が確認できます。

ステップ 5: Discovery Kit でデータを受信する

データの受信については以下のガイドを参照して、コンソール上(あるいは API)でダウンリンクデータの設定を行ってください。

応用編3:ダウンリンク通信機能を使ってデバイスでデータを受信する

コンソール上でダウンリンクデータの設定を行うと、設定されたデータはソラコム Network Server 内にセットされ、次の Uplink 通信が来るのを待ちます。以下のように Rx window にてソラコムコンソールから送信したデータを受信できていれば成功です。

STM32L0

応用編: カスタマイズ

LoRaWAN に関連するパラメータの変更方法を紹介します。 Build された Project 内に格納されている Comissioning.h, hw_conf.h, RegionAS923.h を修正することで各種設定の変更が可能です。

各ファイルの変更は MDK-ARM 上で行うことを強くお勧めいたします。(MDK-ARM での再読み込み操作や、文法チェックといった手間とミスを軽減するためです)

ファイル名 MDK-ARM 上のパス
Comissioning.h Project: Lora → mlm32l07x01 → Projects/End_Node等 → main.c
hw_conf.h Project: Lora → mlm32l07x01 → Projects/End_Node等 → main.c
RegionAS923.h Project: Lora → mlm32l07x01 → Middlewares/Lora/Mac/Regions

※下記のように main.c 等から Comissioning.h がツリーとして構成されていない場合は、一度「Project → Build」を行い、依存関係を解決するようにしてください。

STM32L0 STM32L0

パラメータの内容は以下の通りです。

STM32L0 STM32L0

※ Commisioning.h 内の DevEUI/AppEUI/Appkey のコードについては一切の修正を加えないでください。別の値に書き換えてしまうと二度とソラコム LoRaWAN ネットワークに JOIN 出来なくなります。その他パラメータについても EIRP や LBT など、変更内容によっては電波法違反になる可能性がありますので無線有識者以外のパラメータ変更はご注意下さい。 ※ ST-Link Utility 他による「Erase Chip」といった初期化処理は行わないでください。当社より出荷した製品には先の注意書きにも記載した DevEUI 等のパラメータがすでに書き込まれた状態で出荷されており、初期化処理などで消去してしまうとソラコム LoRaWAN ネットワークに JOIN するための情報が失われてしまうためです。(ダウンロード等の転送処理で消去されることはありませんので、通常の利用においては問題とはなりえませんのでご安心してお使いください。) ※本作業によるいかなる不具合、生じる不利益について弊社では一切の責任を負いません。

トラブルシュート

「ダウンロード」で失敗する

コンパイル後、バイナリをボードへ転送する「ダウンロード」を実行した際に、下記のように失敗する場合があります。

ダウンロードに失敗

※ 表示が若干違うかもしれませんが、ダウンロードに失敗している事には変わりありません

対策

これはダウンロードに使用するツールが違っているために発生します。ダウンロードには ST-Link Debugger を使用するに指定します。

手順は以下の通りです。

MDK-ARM の “Options for Target” ボタンで表示される設定画面から「Debug」タブの「Use」で ST-Link Debugger を選択し、その後「Settings」ボタンをクリックします。

Options for Target

次の画面では「Debug Adapter」が ST-LINK/V2-1 になっている事と、「SW Device」の SWDIO に何かしらのデバイス名が表示されていれば正常です。認識できていない場合は “No ST-LINK detected” と表示されます。

Options for Target

STM32L0 LoRa Discovery Kit を接続しているのに “No ST-LINK detected” と表示されてしまう場合は「Target Com」を SW から JTAG に変更し、再度 SW に戻して再認識させてみてください。

以上の手順で、SWDIO にデバイスが表示されれば成功していますので、OK ボタンを押して設定画面を閉じ、改めてダウンロードを行ってください。

Getting Started

SORACOM Air for セルラー

SORACOM Air for LoRaWAN

SORACOM Air for Sigfox

SORACOM Beam

SORACOM Canal/Direct/Door

SORACOM Endorse

SORACOM Funnel

SORACOM Funk

SORACOM Gate

SORACOM Harvest

SORACOM Inventory

SORACOM Junction

SORACOM Krypton

SORACOM Lagoon

SORACOM Napter

Gadgets

Device

サービス機能詳細

Developer Tools

pagetop