差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

--- max3xx_tips:upload_di_state_to_harvest:start [2023/06/22 17:57]
admin
+++ max3xx_tips:upload_di_state_to_harvest:start [2023/06/23 08:56] (現在)
admin [アプリケーションの構成]
@@ ライン 13: / ライン 13: @@
 このサンプルは、下記により構成されています。
-  * MA-X3xx 内部の MQTT Broker(Mosquitto)
+  * MA-X3xx 内部の MQTT Broker(mosquitto)
-  * DI の状態を監視し、DI 状態変化時に MQTT Broker に DI の状態を Publish するアプリケーション(di_mqtt)
+  * DI の状態を監視((libgpiod を使用しています))し、DI 状態変化時に MQTT Broker に DI の状態を Publish するアプリケーション(di_mqtt)
   * MQTT Broker を Subscibe し、DI の状態を受け取ったら SORACOM Harvest Data にアップロードするアプリケーション(mqtt_harvest)
 \\
-===== アプリケーションの動作 =====
+===== アプリケーションの起動 =====
 ==== DI to MQTT ====
@@ ライン 46: / ライン 46: @@
 </file>
-上記の設定ファイルを指定して、コマンドを実行します。
+上記のような設定ファイルを指定して、コマンドを実行します。
 <code>
@@ ライン 54: / ライン 54: @@
 \\
+==== MQTT to SORACOM Harvest ====
+DI を監視するコマンドと同じ設定ファイルを指定して、コマンドを実行します。
+<code>
+root@metis:/tmp# ./mqtt_soracom -c di_mqtt.conf
+</code>
+\\
+==== MQTT テスト (確認用) ====
+MQTT で publish されるデータを確認することもできます。
+<code>
+user1@metis:~$ nmqtt_sub -p 51883 -t DI
+</code>
+\\
+===== 動作例 =====
+つのコマンドを実行している状態で DI の状態を変化させると、MQTT Broker に DI の状態が publish され、それを MQTT Broker 経由で受け取ったプログラムが SORACOM Harvest Data にアップロードします。
+MQTT 確認用で subscribe しているプログラムの出力
+<code>
+user1@metis:~$ nmqtt_sub -p 51883 -t DI
+DI: {"timestamp":1687424585957,"state":{"DI_10":0,"DI_3":0,"DI_8":0,"DI_0":0,"DI_5":0,"DI_4":0,"DI_6":0,"DI_9":0,"DI_11":0,"DI_7":0,"DI_1":0,"DI_2":0}}
+</code>
+\\
+syslog に SORACOM Harvest Data へアップロードした、というログも記録されます。
+<code>
+Jun 22 18:03:06 metis mqtt_soracom[8021]: upload: timestamp: 1687424585957
+Jun 22 18:03:06 metis mqtt_soracom[8021]: upload: payload: {"DI_10":0,"DI_3":0,"DI_8":0,"DI_0":0,"DI_5":0,"DI_4":0,"DI_6":0,"DI_9":0,"DI_11":0,"DI_7":0,"DI_1":0,"DI_2":0}
+Jun 22 18:03:06 metis mqtt_soracom[8021]: upload: response code: 201 Created
+</code>
+※ **"timestamp"** は、SORACOM Harvest Data の timestamp に設定するため、データから抜き出して HTTP Header **"X-Soracom-timestamp"** にセットするようになっています。
+\\
+==== SORACOM コンソールで確認 ====
+アップロードされたデータを SORACOM コンソール で確認してみます。
+{{:max3xx_tips:upload_di_state_to_harvest:soracom_harvest_data_00.png|}}
+\\
+きちんとアップロードされていることが確認できました。
+\\
+===== ソースコード =====
+サンプルアプリのコードです。
+^  File  ^  Stat  ^  SHA1SUM  ^  Info  |
+|{{ :max3xx_tips:upload_di_state_to_harvest:di_mqtt.tar.xz |}}|2023/06/22 19:23 8.5 KB|f6d915c19bfcac942885c36ebe635e8cb455ae04|DI to MQTT/MQTT to SORACOM Harvest|
+|{{ :max3xx_tips:upload_di_state_to_harvest:nim_gpiod.tar.xz |}}|2023/06/22 19:23 3.1 KB|97eb2b65b748f4bd049a9a7e60ff157a88aa5127|libgpiod wrapper library|
+\\
+===== How to Build =====
+アプリケーションのビルド方法です。
+\\
+==== 必要なソフトウェアのインストール ====
+=== C Compiler (build-essential) ===
+[[max3xx_devel:build_firmware:start|]] でも必要なのでインストールしておきます。
+参照: [[max3xx_devel:setup_crossdev:start|]]
+\\
+=== Nim Compiler ===
+[[https://nim-lang.org/|Nim 言語]] で記述しているので、[[https://nim-lang.org/install_unix.html|Nim Compiler をインストール]] します。
+<code>
+user1@max3xx-devel:~$ curl https://nim-lang.org/choosenim/init.sh -sSf | sh
+choosenim-init: Downloading choosenim-0.8.4_linux_amd64
+    Prompt: Can choosenim record and send anonymised telemetry data? [y/n]
+        ... Anonymous aggregate user analytics allow us to prioritise
+        ... fixes and features based on how, where and when people use Nim.
+        ... For more details see: https://goo.gl/NzUEPf.
+    Answer: n
+Downloading Nim 1.6.12 from nim-lang.org
+[##################################################] 100.0% 0kb/s
+ Extracting nim-1.6.12-linux_x64.tar.xz
+ Extracting nim-1.6.12-linux_x64.tar
+   Building Nim 1.6.12
+  Compiler: Already built
+  Installed component 'nim'
+  Installed component 'nimble'
+  Installed component 'nimgrep'
+  Installed component 'nimpretty'
+  Installed component 'nimsuggest'
+  Installed component 'testament'
+  Installed component 'nim-gdb'
+   Switched to Nim 1.6.12
+choosenim-init: ChooseNim installed in /home/user1/.nimble/bin
+choosenim-init: You must now ensure that the Nimble bin dir is in your PATH.
+choosenim-init: Place the following line in the ~/.profile or ~/.bashrc file.
+choosenim-init:     export PATH=/home/user1/.nimble/bin:$PATH
+user1@max3xx-devel:~$
+</code>
+最後の部分で指示されているように、PATH を設定しておきます。
+<code>
+user1@max3xx-devel:~$ nano -w .bashrc
+</code>
+{{:max3xx_tips:upload_di_state_to_harvest:add_nim_path_to_bashrc.png|}}
+※ 最後の行に追加しておきます。
+\\
+実行できるように .bashrc を読み直し、実行の確認をしてみます。
+<code>
+user1@max3xx-devel:~$ source .bashrc
+user1@max3xx-devel:~$ nim -v
+Nim Compiler Version 1.6.12 [Linux: amd64]
+Compiled at 2023-03-10
+Copyright (c) 2006-2023 by Andreas Rumpf
+git hash: 1aa9273640c0c51486cf3a7b67282fe58f360e91
+active boot switches: -d:release
+user1@max3xx-devel:~$
+</code>
+きちんとインストールされて実行できることが確認できました。
+\\
+=== Nim Package List 更新 ===
+Nim のパッケージリストを更新しておきます。
+<code>
+user1@max3xx-devel:~$ nimble refresh
+Downloading Official package list
+    Success Package list downloaded.
+user1@max3xx-devel:~$
+</code>
+\\
+=== libgpiod 開発用(-dev)パッケージの追加 ===
+apt で追加しておきます。
+<code>
+user1@max3xx-devel:~$ sudo apt install libgpiod-dev
+[sudo] password for user1:
+Reading package lists... Done
+Building dependency tree... Done
+Reading state information... Done
+The following additional packages will be installed:
+  libgpiod2
+Suggested packages:
+  libgpiod-doc
+The following NEW packages will be installed:
+  libgpiod-dev libgpiod2
+upgraded, 2 newly installed, 0 to remove and 0 not upgraded.
+Need to get 103 kB of archives.
+After this operation, 492 kB of additional disk space will be used.
+Do you want to continue? [Y/n]
+Get:1 http://archive.ubuntu.com/ubuntu jammy/universe amd64 libgpiod2 amd64 1.6.3-1build1 [42.2 kB]
+Get:2 http://archive.ubuntu.com/ubuntu jammy/universe amd64 libgpiod-dev amd64 1.6.3-1build1 [61.1 kB]
+Fetched 103 kB in 2s (52.0 kB/s)
+Selecting previously unselected package libgpiod2:amd64.
+(Reading database ... 33935 files and directories currently installed.)
+Preparing to unpack .../libgpiod2_1.6.3-1build1_amd64.deb ...
+Unpacking libgpiod2:amd64 (1.6.3-1build1) ...
+Selecting previously unselected package libgpiod-dev:amd64.
+Preparing to unpack .../libgpiod-dev_1.6.3-1build1_amd64.deb ...
+Unpacking libgpiod-dev:amd64 (1.6.3-1build1) ...
+Setting up libgpiod2:amd64 (1.6.3-1build1) ...
+Setting up libgpiod-dev:amd64 (1.6.3-1build1) ...
+Processing triggers for libc-bin (2.35-0ubuntu3.1) ...
+user1@max3xx-devel:~$
+</code>
+\\
+==== ソースコードの展開 ====
+適当なディレクトリ以下に、2 つのソースのアーカイブを展開します。
+<code>
+user1@max3xx-devel:~$ cd src/
+user1@max3xx-devel:~/src$
+</code>
+<code>
+user1@max3xx-devel:~/src$ tar axf ../nim_gpiod.tar.xz
+user1@max3xx-devel:~/src$ tar axf ../di_mqtt.tar.xz
+user1@max3xx-devel:~/src$ ls -l
+total 12
+drwxrwxr-x  3 user1 user1 4096 Jun 22 19:22 di_mqtt   <----
+drwxrwxr-x 27 user1 user1 4096 Apr 13 13:50 linux-kernel
+drwxrwxr-x  3 user1 user1 4096 Jun 22 19:22 nim_gpiod <----
+user1@max3xx-devel:~/src$
+</code>
+\\
+==== ソースのビルド ====
+=== nim_gpiod のインストール ===
+di_mqtt のソースをビルドするために必要なので、nim_gpiod((libgpiod の Nim 用ラッパーライブラリ)) をインストールします。
+<code>
+user1@max3xx-devel:~$ cd src/nim_gpiod/
+user1@max3xx-devel:~/src/nim_gpiod$ nimble install --cpu:arm64
+  Verifying dependencies for nim_gpiod@0.2.0
+ Installing nim_gpiod@0.2.0
+   Building nim_gpiod/nim_gpiod using c backend
+   Success: nim_gpiod installed successfully.
+user1@max3xx-devel:~/src/nim_gpiod$
+</code>
+\\
+=== di_mqtt のビルド ===
+ビルドする準備ができたので、di_mqtt をビルドします。
+<code>
+user1@max3xx-devel:~/src/nim_gpiod$ cd ../di_mqtt/
+user1@max3xx-devel:~/src/di_mqtt$ nimble build -d:release --cpu:arm64
+  Verifying dependencies for di_mqtt@0.2.0
+ Installing argparse@0.10.1
+Downloading https://github.com/iffy/nim-argparse using git
+  Verifying dependencies for argparse@0.10.1
+ Installing argparse@0.10.1
+   Success: argparse installed successfully.
+ Installing nmqtt@>= 1.0.5
+Downloading https://github.com/zevv/nmqtt using git
+  Verifying dependencies for nmqtt@1.0.5
+ Installing cligen@>= 0.9.45
+Downloading https://github.com/c-blake/cligen.git using git
+  Verifying dependencies for cligen@1.6.6
+ Installing cligen@1.6.6
+   Success: cligen installed successfully.
+ Installing bcrypt@>= 0.2.1
+Downloading https://github.com/ithkuil/bcryptnim using git
+  Verifying dependencies for bcrypt@0.2.1
+ Installing bcrypt@0.2.1
+   Success: bcrypt installed successfully.
+ Installing nmqtt@1.0.5
+   Building nmqtt/nmqtt/nmqtt_password using c backend
+   Building nmqtt/nmqtt/nmqtt using c backend
+/tmp/nimble_22433/githubcom_zevvnmqtt_1.0.5/nmqtt.nim(285, 54) template/generic instantiation of `async` from here
+/tmp/nimble_22433/githubcom_zevvnmqtt_1.0.5/nmqtt.nim(292, 5) Warning: The bare except clause is deprecated; use `except CatchableError:` instead [BareExcept]
+/tmp/nimble_22433/githubcom_zevvnmqtt_1.0.5/nmqtt.nim(285, 54) template/generic instantiation of `async` from here
+/home/user1/.choosenim/toolchains/nim-1.6.12/lib/pure/asyncmacro.nim(42, 5) Warning: The bare except clause is deprecated; use `except CatchableError:` instead [BareExcept]
+... 中略 ...
+/home/user1/.choosenim/toolchains/nim-1.6.12/lib/pure/asyncmacro.nim(42, 5) Warning: The bare except clause is deprecated; use `except CatchableError:` instead [BareExcept]
+/tmp/nimble_22433/githubcom_zevvnmqtt_1.0.5/nmqtt/nmqtt_sub.nim(20, 222) template/generic instantiation of `async` from here
+/home/user1/.choosenim/toolchains/nim-1.6.12/lib/pure/asyncmacro.nim(42, 5) Warning: The bare except clause is deprecated; use `except CatchableError:` instead [BareExcept]
+   Success: nmqtt installed successfully.
+      Info: Dependency on nim_gpiod@>= 0.2.0 already satisfied
+  Verifying dependencies for nim_gpiod@0.2.0
+ Installing jsony@>= 1.1.5
+Downloading https://github.com/treeform/jsony using git
+  Verifying dependencies for jsony@1.1.5
+ Installing jsony@1.1.5
+   Success: jsony installed successfully.
+   Building di_mqtt/di_mqtt using c backend
+   Building di_mqtt/mqtt_soracom using c backend
+user1@max3xx-devel:~/src/di_mqtt$
+</code>
+必要なライブラリが芋づる式に追加され、di_mqtt のビルドが完了しました。
+\\
+できあがったバイナリを確認してみます。
+<code>
+user1@max3xx-devel:~/src/di_mqtt$ ls -l bin/
+total 1272
+-rwxrwxr-x 1 user1 user1 563040 Jun 22 19:33 di_mqtt
+-rwxrwxr-x 1 user1 user1 733408 Jun 22 19:33 mqtt_soracom
+user1@max3xx-devel:~/src/di_mqtt$
+</code>
+strip によりシンボルを除去してバイナリを小さくすることもできます。
+<code>
+user1@max3xx-devel:~/src/di_mqtt$ aarch64-linux-gnu-strip bin/*
+user1@max3xx-devel:~/src/di_mqtt$ ls -l bin/
+total 952
+-rwxrwxr-x 1 user1 user1 423936 Jun 22 19:35 di_mqtt
+-rwxrwxr-x 1 user1 user1 546816 Jun 22 19:35 mqtt_soracom
+user1@max3xx-devel:~/src/di_mqtt$
+</code>

MA-X/MA-S/MA-E/IP-K Developers' WiKi

ユーザ用ツール

サイト用ツール

差分

ページ用ツール