BluemixでRaspberryPi2のセンサーデータを拾う (1)仕組みの理解

#<i class="fa fa-cubes" style="font-size:1em;"></i>概要
[BluemixのRaspberryPi登録レシピ](https://developer.ibm.com/recipes/tutorials/raspberry-pi-4/)に登場する[デバイス用のsampleプログラム](https://github.com/ibm-messaging/iot-raspberrypi/releases/tag/1.0.2)は、どんなにセンサーがたくさん付いていようが固定の4項目のデータのみをBluemixに送信する作りになっている。

Raspberry Pi 2にセンサーを付け加えて固定4項目以外のデータをBluemixで取得するには、[sampleプログラムのソースコード](https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/)を修正してビルドすれば良い。その方法を整理する。

整理している内に長くなってきたので、(1)Sampleプログラムの仕組みの整理と(2)どこをどのように変更すればよいのかを分けることにした。

(1)　仕組みの理解　(これ)
[(2)　センサーを付けてデータを拾う　温度センサーデジタル編](http://qiita.com/getapojim/items/0f2b5178bfaddafcde9f)
[(3)　センサーを付けてデータを拾う　温度センサーアナログ編](http://qiita.com/getapojim/items/12e5cb64a8046ab033e9)
[(4)　センサーを付けてデータを拾う　温度センサーデジタル編（リベンジ）](http://qiita.com/getapojim/items/0ea4c7369d342d5b00d5)
[(5)　センサーを付けてデータを拾う　温度・湿度・気圧まとめて採取編](http://qiita.com/getapojim/items/dfa526ece3af603b981e)
番外編 [『ムック「日経Linux ラズパイマガジン 2015年春号 」電子工作入門キット パーツセット』に入っていたもの](http://qiita.com/getapojim/items/c90edd38c0ad9d5eb379)

#<i class="fa fa-cube" style="font-size:1em;"></i>構成のイメージ
IoTという構成で考えるとこんな感じ。下段ほどより具体的に。<font color=red>(図にしたい)</font>
Things　　　　　　　　　　　　　　→　Internet
センサー　→　デバイス　　　　　　→　クラウド
センサー　→　Raspberry Pi 2(sysfs)　→　Bluemix(IoT Foundation)
　　　　　↑　　　　　　　　　　　　↑
　　　ポイント1　　　　　　　　ポイント2,3,4

#<i class="fa fa-cube" style="font-size:1em;"></i>ポイント1　要素データの取得(センサーから)
センサーから取得するデータはRaspberry Pi 2のsysfs仮想ファイルシステムを参照することで取得可能らしい。

<!--
今回は例として○○○センサーとして△△△を使う。
-->

<!--
fritzingで描いた図をここに貼りたい。
-->

一般的にLinux上でデバイスの情報を読み取るには、Sysfs仮想ファイルシステムを通じて/sys/devices配下を参照することになる。
/sys/class配下はその直下のフォルダ名がデバイスの種類を表していてより人間に分かりやすい。/sys/class配下は/sys/device配下へのシンボリックリンクになっているので使い勝手の面からこちらを参照するでもよい。

Raspberry Pi 2ではセンサーとの物理的なI/Oの手段としてGPIOなるものを使えるので、これに対応する/sys/class/gpio配下を参照することでセンサーのデータを取得できる(らしい)。

「(1) 仕組みの理解」編ではsampleプログラムが/sys/class/thermal配下からRaspberry Pi 2のCPU温度を読み取る構成であることを確認し、「(2) センサーを付けてデータを拾う」編では/sys/class/gpio配下からセンサーのデータを参照するようにしてみる。

#<i class="fa fa-cube" style="font-size:1em;"></i>ポイント2　要素データの取得(sysfsから)

[デバイス用のsampleプログラム](https://github.com/ibm-messaging/iot-raspberrypi/releases/tag/1.0.2)で取得できる固定の4つの要素データとは次の通り。

| No. | 項目            | データ・ポイント | 値                                                                |
| --: | :--             | :--            |:--                                                                |
| 1   | 名前            | d.myName	 |myPi(固定文字列)                                                         |
| 2   | CPU温度         | d.cputemp	 |実測した温度(小数)                                                  |
| 3   | ロードアベレージ | d.cpuload	 |[ロードアベレージ(小数)](https://www.google.co.jp/search?q=ロードアベレージ)|
| 4   | 正弦(サイン)値   | d.sine         |-1 ～ 1(小数)                                                            |

それぞれの値は次のように取得・生成している。

myName　：
　iot.hにべた書き。固定文字列になっている。デバイスの情報ではない。

```c:iot.h(40行目)
#define DEVICE_NAME "myPi"
```

cputemp　：
　cpustat.cのgetCPUTemp()関数内で/sys/class/thermal/thermal_zone0/tempを読んでいる。

```c:cpustat.c(24行目)
char cputemploc[255] = "/sys/class/thermal/thermal_zone0/temp";
```

```c:cpustat.c(30～46行目)
float getCPUTemp() {
	FILE * cputemp = NULL;
	char buffer [SIZE];
	long tempinmillic;
	float tempinc;

	memset(buffer, 0, sizeof(buffer));
	cputemp = fopen(cputemploc, "r");

	fgets(buffer, SIZE, cputemp);

	tempinmillic = atol(buffer);
	tempinc = tempinmillic * 1.0 / 1000.0;

	fclose(cputemp);
	return tempinc;
}
```

cpuload　：
　cpustat.cのGetCPULoad()関数内で/proc/loadavgを読んでいる。

```c:cpustat.c(25行目)
char cpuloadloc[255] = "/proc/loadavg";
```

```c:cpustat.c(48～58行目)
float GetCPULoad() {
	
	FILE *f1;
        float load1,load5,load15;

        f1 = fopen(cpuloadloc, "r");
        fscanf(f1, "%f\t%f\t%f\t", &load1, &load5, &load15 );
	fclose(f1);
        return (load1);

}
```

sine　：
　iotmain.cでサイン(正弦)値を計算して生成する。デバイスの情報ではない。

```c:iotmain.c(211～215行目)
float sineVal(float minValue, float maxValue, float duration, float count) {
	float sineValue;
	sineValue = sin(2.0 * PI * count / duration) * (maxValue - minValue) / 2.0;
	return sineValue;
}
```

#<i class="fa fa-cube" style="font-size:1em;"></i>ポイント3　JSONデータの組み立て
取得・生成した値を使ってJSONデータを組み立てる。ソースコードは[iotmain.c](https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/iotmain.c)と[jsonator.c](https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/jsonator.c)

JSONにしたい要素データを、いったんCの構造体に格納して、

```c:iot.h(22～30行目)
  struct json {
	  char myname[100];
	  float cputemp;
	  float sine;
	  float cpuload;
  };

  /* This is the short hand for json */
  typedef struct json JsonMessage;
```

```c:iotmain.c(152,153行目)
		JsonMessage json_message = { DEVICE_NAME, getCPUTemp(), sineVal(
				MIN_VALUE, MAX_VALUE, 16, count), GetCPULoad() };
```

generateJSON()メソッドを呼ぶことで、データ構造をCの構造体からJSON形式に変換している。

```c:iotmain.c(152,153行目)
		json = generateJSON(json_message);
```

```c:jsonator.c(23～55行目)
char * generateJSON(JsonMessage passedrpi ) {
	char * jsonReturned;

	// 2 braces, 4 colons, 3 commas, 10 double-quotes makes it 19
	jsonReturned = calloc(1, sizeof passedrpi + sizeof(char) * 25);

	strcat(jsonReturned, "{\"d\":");
	strcat(jsonReturned, "{");

	strcat(jsonReturned, "\"myName\":\"");
	strcat(jsonReturned, passedrpi.myname);
	strcat(jsonReturned, "\",");
	char buffer[10];

	strcat(jsonReturned, "\"cputemp\":");
	sprintf(buffer, "%.2f", passedrpi.cputemp);
	strcat(jsonReturned, buffer);
	strcat(jsonReturned, ",");

	strcat(jsonReturned, "\"cpuload\":");
	sprintf(buffer, "%.2f", passedrpi.cpuload);
	strcat(jsonReturned, buffer);
	strcat(jsonReturned, ",");

	strcat(jsonReturned, "\"sine\":");
	sprintf(buffer, "%.2f", passedrpi.sine);
	strcat(jsonReturned, buffer);

	strcat(jsonReturned, "}");
	strcat(jsonReturned, "}");

	return jsonReturned;
}
```

MQTTでデータ送信する際は、具体的にはこんな感じの電文になる。(イメージ)
`{"d":{"myName":"myPi","cputemp":46.54,"cpuload":0.00,"sine":-0.92}}`

改行を入れて見やすくするとこんな感じ。(イメージ)

```json:
{
    "d":{
        "myName":"myPi",
        "cputemp":46.54,
        "cpuload":0.00,
        "sine":-0.92
    }
}
```

#<i class="fa fa-cube" style="font-size:1em;"></i>ポイント4　MQTTプロトコルでJSONデータを送信
MQTTプロトコルでpublishする。ソースコードは[mqttPublisher.c](https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/mqttPublisher.c)

MQTTの構成要素
　MQTTブローカー　　：　Bluemixの[IoT Foundataionサービス](https://internetofthings.ibmcloud.com/)
　MQTTクライアント　：　[デバイス用のsampleプログラム](https://github.com/ibm-messaging/iot-raspberrypi/releases/tag/1.0.2)

MQTTの「トピック」は[iotmain.c](https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/iotmain.c)で次の通り指定している。
　publish用　　：　iot-2/evt/status/fmt/json
　subscribe用　：　iot-2/cmd/reboot/fmt/json

```c:iotmain.c(29,30行目)
char publishTopic[MAXBUF] = "iot-2/evt/status/fmt/json";
char subscribeTopic[MAXBUF] = "iot-2/cmd/reboot/fmt/json";
```

MQTT Publish

```c:iotmain.c(155行目)
		res = publishMQTTMessage(&client, publishTopic, json);
```

```c:mqttPublisher.c(270～299行目)
int publishMQTTMessage(MQTTAsync* client, char *topic, char *payload) {

	MQTTAsync_message pubmsg = MQTTAsync_message_initializer;
	MQTTAsync_responseOptions opts = MQTTAsync_responseOptions_initializer;
	int rc = MQTTASYNC_SUCCESS;

	opts.onSuccess = onSend;
	opts.context = *client;

	pubmsg.payload = payload;
	pubmsg.payloadlen = strlen(payload);
	pubmsg.qos = QOS;
	pubmsg.retained = 0;
	deliveredtoken = 0;

	if ((rc = MQTTAsync_sendMessage(*client, topic, &pubmsg, &opts))
			!= MQTTASYNC_SUCCESS) {
#ifdef ERROR
		syslog(LOG_ERR, "Failed to start sendMessage, return code %d\n", rc);
#endif
		return rc;
	}

#ifdef INFO
	syslog(LOG_DEBUG, "Waiting for publication of %s on topic %s\n", payload,
			topic);
#endif

	return rc;
}
```


Bluemix IoTFのダッシュボードではこんな感じで表示されるのを確認できる。
![IoTF-センサー情報.png](https://qiita-image-store.s3.amazonaws.com/0/85506/ba2e314d-2faf-212f-70e4-ec81d758fbf5.png)

#<i class="fa fa-cube" style="font-size:1em;"></i>続き
[(2)　センサーを付けてデータを拾う　温度センサーデジタル編](http://qiita.com/getapojim/items/0f2b5178bfaddafcde9f)
番外編 [『ムック「日経Linux ラズパイマガジン 2015年春号 」電子工作入門キット パーツセット』に入っていたもの](http://qiita.com/getapojim/items/c90edd38c0ad9d5eb379)

#<i class="fa fa-cube" style="font-size:1em;"></i>環境

[Raspberry Pi 2 Model B](https://www.raspberrypi.org/products/raspberry-pi-2-model-b/)
[Raspbian](https://www.raspberrypi.org/downloads/raspbian/)
[Bluemix IoT Foundation](https://internetofthings.ibmcloud.com/)

#<i class="fa fa-book" style="font-size:1em;"></i>参考
BluemixのRaspberryPi登録レシピ
https://developer.ibm.com/recipes/tutorials/raspberry-pi-4/

BluemixのRaspberryPi登録レシピに登場するデバイス用のsampleプログラム
(Linux用のdaemonになっている)
https://github.com/ibm-messaging/iot-raspberrypi/blob/master/samples/c/

sysfs仮想ファイルシステムについて
(読んでもよく分からんが。。)
https://ja.wikipedia.org/wiki/Sysfs

CPUの温度を/sys/class/thermal/thermal_zone0/tempから拾う理由は？
http://unix.stackexchange.com/questions/167207/why-does-linux-store-cpu-temperatures-on-so-many-files

/sys/class/thermal配下の構成は？
https://www.kernel.org/doc/Documentation/thermal/sysfs-api.txt