Diff: controller.h

Revision:

1:a8f5f13b0840

Parent:

0:9ea2a0d8b9d9

Child:

2:e97f32749217

diff -r 9ea2a0d8b9d9 -r a8f5f13b0840 controller.h
--- a/controller.h	Sat Oct 16 05:24:37 2021 +0000
+++ b/controller.h	Sat Oct 16 13:41:01 2021 +0000
@@ -1,6 +1,6 @@
 /**
  *  @file   controller.h
- *  @brief  2021Bcon受信用ﾗｲﾌﾞﾗﾘ
+ *  @brief  2021Bcon受信用ライブラリ
  *  @author 安澤瑠
  *  @date   21/10/16
  */
@@ -15,6 +15,11 @@
 /**
  *  @class con 
  *  @brief class for receiving 2021Bcon data
+ *    0       4
+ *  1   3   5   7
+ *    2       6
+ *
+ *   0        1
  *  @note  mbed-os 6 では使えません。  Not compatible with mbed-os 6
  */
 class Bcon : public RawSerial {
@@ -22,7 +27,7 @@
     /** constructor
      *  @param tx   FEPと接続するSerialTX pin
      *  @param rx   FEPと接続するSerialRX pin
-     *  @param addr 通信相手のアドレス
+     *  @param addr コントローラーについてるFEPのアドレス
      *  @param baud 通信速度(デフォルト115200)
      */
     Bcon(PinName tx, PinName rx, uint8_t addr_, int baud=115200);
@@ -64,8 +69,8 @@
     uint8_t bufindex;     //! buffer の添え字変数
     uint8_t retindex;     //! retdata の添え字変数
     uint8_t timeout;      //! 0.1秒間通信が成功していないと1増える
-    uint8_t sum;
-    uint8_t stick[4];
+    uint8_t sum;          //! BusInの値を格納
+    uint8_t stick[4];     //! スティックの値を格納
 };
 
 #endif
\ No newline at end of file