Commit: 0986dff3d8aabbc24aa08b27447f62929eb2766b - TunnelSerialToIEEE1888 (hg)

Tunnel(Serial To IEEE1888)

Commit MetaInfo

• Revision: 0986dff3d8aabbc24aa08b27447f62929eb2766b (tree)
• Time: 2015-07-07 22:35:36
• Author: <15b05@15b0...>

Log Message

update readme, api (issue: Serialのreadが64バイトまでしかバッファがない)

Change Summary

• modified: TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.h
• modified: TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.ino
• modified: TunnelSerialToIEEE1888/core.ino
• modified: TunnelSerialToIEEE1888/tunnel_SerialReader.h
• modified: TunnelSerialToIEEE1888/tunnel_SerialReader.ino
• add: TunnelSerialToIEEE1888/readme_serial_api.txt
• delete: TunnelSerialToIEEE1888/samplecommand.txt

Incremental Difference

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.h
--- a/TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.h	Tue Jul 07 22:18:19 2015 +0900
+++ b/TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.h	Tue Jul 07 22:35:36 2015 +0900
@@ -4,6 +4,11 @@
 #include <FIAPUploadAgent.h>
 #include "tunnel_SerialReader.h"
 
+// ------------------------- グローバル変数 -------------------------
+
+// PointSet ID（PointIDのPrefix）
+extern char fiap_id_prefix[200];
+
 // ------------------------- loop関連 -------------------------
 
 // loopの間隔。

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.ino
--- a/TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.ino	Tue Jul 07 22:18:19 2015 +0900
+++ b/TunnelSerialToIEEE1888/TunnelSerialToIEEE1888.ino	Tue Jul 07 22:35:36 2015 +0900
@@ -24,8 +24,7 @@
 const int SERVER_PORT = 80;
 
 // ---------------------- Point設定 ----------------------
-// PointSet ID（PointIDのPrefix）
-const char* FIAP_ID_PREFIX = "http://j.kisarazu.ac.jp/Arduino/ANTS/0301/";
+char fiap_id_prefix[200];
 
 ///////////////////////// MainRoutine /////////////////////////
 
@@ -44,7 +43,7 @@
   }
 
   // FIAPライブラリの初期化
-  fiapUploadAgent.begin(SERVER_HOST, SERVER_PATH, SERVER_PORT, FIAP_ID_PREFIX);
+  fiapUploadAgent.begin(SERVER_HOST, SERVER_PATH, SERVER_PORT, fiap_id_prefix);
 
   // コアルーチン初期化
   initCore();
@@ -56,16 +55,25 @@
 
 tunnel::SerialReader serialReader;
 
+boolean delayCanceled = false;
+
 void loop()
 {
-  delay(waitMs);
+  if (delayCanceled) {
+    delayCanceled = false;
+  } 
+  else {
+    delay(waitMs);
+  }
 
   if (!isRunnable) {
     waitMs = 5000;
     error("initializing error!");
   }
   else {
-    serialReader.readOneOperation();
+    if (serialReader.readOneOperation()) {  
+      delayCanceled = true;
+    }
     tick();
   }
 
@@ -104,4 +112,6 @@
   Serial.println(messageBlockSentinel);
 }
 
+
+
 

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/core.ino
--- a/TunnelSerialToIEEE1888/core.ino	Tue Jul 07 22:18:19 2015 +0900
+++ b/TunnelSerialToIEEE1888/core.ino	Tue Jul 07 22:35:36 2015 +0900
@@ -8,25 +8,29 @@
   sendMessageBegin();
   Serial.println(">>>>> initialized");
   sendMessageEnd();
+  
+  strcpy(fiap_id_prefix, "http://j.kisarazu.ac.jp/Arduino/ANTS/0301/");
 }
 
 void tick()
 {
-
   //sendMessageBegin();
   //Serial.print(">>>>> ");
   //Serial.println(tickPeriod);
   //sendMessageEnd();
 
-  waitMs = 100;
+  waitMs = 1000;
 }
 
 AntsElement antsElement;
 
 void tunnel::invokeCommand(SerialReader* serialReader)
 {
-  if (strcmp(serialReader->argumentsString[0], "SetTime") == 0) {
-    
+  if (strcmp(serialReader->argumentsString[0], "ShowTime") == 0) {
+
+    // 操作
+
+    // print
     sendMessageBegin();
     {
       char buf[50];
@@ -40,19 +44,35 @@
       Serial.println(buf);
     }
     sendMessageEnd();
-    
+
     return;
   }
-  if (strcmp(serialReader->argumentsString[0], "FlushIEEE1888") == 0) {
-  
-    antsElement.flush();
-    
-    Serial.println("[Message]:flush");
-    
+  if (strcmp(serialReader->argumentsString[0], "SetIdPrefix") == 0) {
+
+    // 操作
+    strcpy(fiap_id_prefix, serialReader->argumentsString[1]);
+
+    // print
+    sendMessageBegin();
+    Serial.print("Set Id Prefix: ");
+    Serial.println(fiap_id_prefix);
+    sendMessageEnd();
+
     return;
   }
-  if (strcmp(serialReader->argumentsString[0], "SendIEEE1888") == 0) {
+  if (strcmp(serialReader->argumentsString[0], "FlushFiapPacket") == 0) {
 
+    // 操作
+    antsElement.flush();
+
+    // ptint
+    Serial.println("[Message]:flush");
+
+    return;
+  }
+  if (strcmp(serialReader->argumentsString[0], "PushFiapPacket") == 0) {
+
+    // 操作
     {
       DateTime dateTime;
       dateTime.year = serialReader->argumentsInt[0];
@@ -61,14 +81,16 @@
       dateTime.hour = serialReader->argumentsInt[3];
       dateTime.minute = serialReader->argumentsInt[4];
       dateTime.second = serialReader->argumentsInt[5];
+
       antsElement.acceptElement(
       serialReader->argumentsString[1],
       serialReader->argumentsString[2],
       dateTime);
     }
 
+    // print
     sendMessageBegin();
-    Serial.println("Send IEEE1888");
+    Serial.println("Push Fiap Packet");
     Serial.println(serialReader->argumentsString[1]);
     Serial.println(serialReader->argumentsString[2]);
     {
@@ -87,6 +109,7 @@
     return;
   }
 
+  // print
   sendMessageBegin();
   Serial.print("Command: ");
   Serial.println(serialReader->argumentsString[0]);
@@ -103,7 +126,12 @@
     Serial.println(serialReader->argumentsString[i]);
   }
   sendMessageEnd();
+
 }
 
 
+
+
+
+
 

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/readme_serial_api.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/TunnelSerialToIEEE1888/readme_serial_api.txt	Tue Jul 07 22:35:36 2015 +0900
@@ -0,0 +1,70 @@
+
+■サンプルコマンド文
+
+C;SSetIdPrefix;Shttp://j.kisarazu.ac.jp/Arduino/ANTS/0630/;M;C;SPushFiapPacket;I2015;I6;I23;I14;I11;I34;STemperature;S801.3;M;C;SFlushFiapPacket;M;
+
+C;SSetIdPrefix;Shttp://j.kisarazu.ac.jp/Arduino/ANTS/0630/;M;
+C;SPushFiapPacket;I2015;I6;I23;I14;I11;I34;STemperature;S801.3;M;
+C;SFlushFiapPacket;M;
+
+C;
+SPushFiapPacket;
+I2015;
+I6;
+I23;
+I14;
+I11;
+I34;
+STemperature;
+S801.3;
+M;
+
+
+■命令
+
+命令は英大文字で始まって区切り文字で終わる。
+
+命令区切り文字：　';', '\n'
+命令種類：
+	'C': 与えた全引数の削除
+	'I': 整数型引数のpush　最大100個
+	'D': 浮動小数型引数のpush　最大10個
+	'S': 文字列型引数のpush（区切り文字は含められない）
+		'\\'ですべての文字はエスケープ可能。
+		最大4個、99文字
+	'M': コマンドの実行（引数は維持）
+
+※コマンド実行命令'M'のコマンド名は最初に与えた文字列型引数
+※区切り文字は連続して挿入すると無視される
+※Arduinoの都合上の問題で、一度に受信バッファに64バイトまでしか格納しておけない。
+
+■コマンド一覧
+
+コマンド名：　SetFiapIdPrefix
+引数：
+	S　IDのPrefix　例："http://example.com/Test/Sample/"
+説明：
+	IDのPrefixを設定する。
+	後続のAPIに影響する。
+
+コマンド名：　FlushFiapPackets
+引数：　なし
+説明：
+	すべてのpushされたパケットを送信する。
+	なぜか1個しかパケットがないと
+	送信時にタイムアウトするまで
+	ライブラリ内の処理が終わらない。
+
+コマンド名：　PushFiapPacket
+引数：
+	I　年
+	I　月
+	I　日
+	I　時
+	I　分
+	I　秒
+	S　cid　例："Temperature"
+	S　value
+説明：
+	FIAPパケットを1個pushする。
+	送信されるかどうかは不明。

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/samplecommand.txt
--- a/TunnelSerialToIEEE1888/samplecommand.txt	Tue Jul 07 22:18:19 2015 +0900
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +0,0 @@
-C;SSendIEEE1888;I2015;I6;I23;I14;I11;I34;STemperature;S801.3;M;
-C;SFlushIEEE1888;M;

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/tunnel_SerialReader.h
--- a/TunnelSerialToIEEE1888/tunnel_SerialReader.h	Tue Jul 07 22:18:19 2015 +0900
+++ b/TunnelSerialToIEEE1888/tunnel_SerialReader.h	Tue Jul 07 22:35:36 2015 +0900
@@ -51,7 +51,7 @@
     // 指定キャラクタまで読み込んでbufferに入れる
     // @return 正常終了してbufferが更新された場合にtrue
     // @param containStopper 指定キャラクタをバッファに含めるかどうか
-    boolean readUntil(char stopper1, char stopper2, boolean containStopper);
+    boolean readUntil(char stopper1, char stopper2, char escape);
 
   };
 

diff -r fd01534372df -r 0986dff3d8aa TunnelSerialToIEEE1888/tunnel_SerialReader.ino
--- a/TunnelSerialToIEEE1888/tunnel_SerialReader.ino	Tue Jul 07 22:18:19 2015 +0900
+++ b/TunnelSerialToIEEE1888/tunnel_SerialReader.ino	Tue Jul 07 22:35:36 2015 +0900
@@ -30,42 +30,97 @@
   argumentsStringLength++;
 }
 
-boolean tunnel::SerialReader::readUntil(char stopper1, char stopper2, boolean containStopper)
+boolean tunnel::SerialReader::readUntil(
+char stopper1, 
+char stopper2,
+char escape)
 {
   if (!Serial.available()) return false;
 
+  // 既に受け取った'\0'を含めない文字列長＝これから代入すべき添え字。
+  // 実際のバッファサイズも超える。
   bufferLength = 0;
 
+  // この文字はエスケープ済みである
+  boolean escaped = false;
+
   while (true) {
     int c = Serial.read();
 
+    // 謎エラー
     if (c == -1) {
       Serial.println("[Warning]:readUntil -1");
+      continue;
+    } 
+
+    // ストッパーやエスケープ文字が着たか否か
+    boolean isStopper = (c == stopper1) || (c == stopper2);
+    boolean isEscape = c == escape;
+
+    // この文字が特殊文字として処理されないべきか否か
+    boolean appendable;
+
+    // この文字自体がエスケープ済みなら、
+    if (escaped) {
+      escaped = false;
+
+      // 特殊文字ではない。
+      appendable = true;
     } 
     else {
+      // エスケープ済みではなくて、
 
-      // bufferLength: これから代入すべき添え字
-      if (!(c == stopper1 || c == stopper2) || containStopper) {
-        if (bufferLength <= BUFFER_MAX_LENGTH - 1 - 1) {
-          buffer[bufferLength] = c;
-        }
+      // ストッパーやエスケープ文字なら、
+      if (isStopper || isEscape) {
+        // 特殊文字として処理されるべき。
+        appendable = false;
+      } 
+      else {
+        // そうでなければ通常文字として処理されるべき。
+        appendable = true;   
+      }
+    }
 
-        bufferLength++;
+    /////////////////////////////////////////// メイン処理
+
+    // この文字が通常文字として処理されるべきならば、
+    if (appendable) {
+
+      // バッファがあふれていなければ、
+      if (bufferLength <= BUFFER_MAX_LENGTH - 1 - 1) {
+        // バッファに追加。
+        buffer[bufferLength] = c;
       }
 
-      // bufferLength: 文字列長
-      if (c == stopper1 || c == stopper2) {
-        if (bufferLength <= BUFFER_MAX_LENGTH - 1) {
-          buffer[bufferLength] = '\0';
-        } 
-        else {
-          buffer[BUFFER_MAX_LENGTH - 1] = '\0';
-        }
+      // どちらにしろ既に受け取った文字列長を増やす。
+      bufferLength++;
+      continue;
+    }
 
-        break;
+    // エスケープ文字が来た場合、
+    if (isEscape) {
+
+      // 次の文字をエスケープ済みに指定
+      escaped = true;
+
+      continue;
+    }
+
+    // 区切り文字が来た場合、
+    if (isStopper) {
+      // バッファがあふれていなければ、
+      if (bufferLength <= BUFFER_MAX_LENGTH - 1) {
+        // 終端文字を追加。
+        buffer[bufferLength] = '\0';
+      } 
+      else {
+        // あふれていても追加。
+        buffer[BUFFER_MAX_LENGTH - 1] = '\0';
       }
 
+      break;
     }
+
   }
 
   // bufferLength: 文字列長
@@ -87,55 +142,64 @@
   int c = Serial.read();
   if (c == -1) {
     Serial.println("[Warning]:readOneOperation -1");
+    return false;
   } 
   else if (c == 'I') {
-    if (readUntil('\n', ';', false)) {
+    if (readUntil('\n', ';', '\\')) {
       int value = atoi(buffer);
       pushInt(value);
       Serial.print("[Message]:(int) ");
       Serial.print(value);
       Serial.println("");
+      return true;
     }
-  } 
+  }
   else if (c == 'D') {
-    if (readUntil('\n', ';', false)) {
+    if (readUntil('\n', ';', '\\')) {
       double value = atof(buffer);
       pushDouble(value);
       Serial.print("[Message]:(double) ");
       Serial.print(value);
       Serial.println("");
+      return true;
     }
-  } 
+  }
   else if (c == 'S') {
-    if (readUntil('\n', ';', false)) {
+    if (readUntil('\n', ';', '\\')) {
       pushString(buffer);
       Serial.print("[Message]:(string) ");
       Serial.print(buffer);
       Serial.println("");
+      return true;
     }
   } 
   else if (c == 'M') {
-    readUntil('\n', ';', false);
+    readUntil('\n', ';', '\\');
     invokeCommand(this);
+    return true;
   }
   else if (c == 'C') {
-    readUntil('\n', ';', false);
+    readUntil('\n', ';', '\\');
     argumentsIntLength = 0;
     argumentsDoubleLength = 0;
     argumentsStringLength = 0;
-    Serial.println("[Message]:clear");
+    Serial.println("[Message]:clear operator");
+    return true;
   }
   else if (c == '\n') {
-    Serial.println("[Message]:blank");
+    Serial.println("[Message]:blank operator");
+    return true;
   }
   else if (c == ';') {
-    Serial.println("[Message]:blank");
+    Serial.println("[Message]:blank operator");
+    return true;
   }
   else {
-    readUntil('\n', ';', false);
+    readUntil('\n', ';', '\\');
     Serial.print("[Warning]: unknown operator: ");
     Serial.print((char) c);
     Serial.println("");
+    return false;
   }
 
   return false;