Diff: PQADXL375.h

Revision:

1:7fdf6d2e8a9b

Parent:

0:83a20280ea3a

Child:

2:b5fd8584fd83

diff -r 83a20280ea3a -r 7fdf6d2e8a9b PQADXL375.h
--- a/PQADXL375.h	Tue Dec 17 09:10:21 2019 +0000
+++ b/PQADXL375.h	Tue Dec 17 13:14:53 2019 +0000
@@ -10,6 +10,33 @@
 #define ADXL375_DATAX0 0x32
 #define ADXL375_LSB 0.049
 
+/**
+ * 3軸高加速度センサADXL375のライブラリ
+ * @code
+#include "mbed.h"
+#include "PQADXL375.h"
+
+Serial pc(USBTX, USBRX, 115200);
+I2C i2c(p9, p10);
+
+ADXL375 adxl(i2c, ADXL375::ALT_ADDRESS_HIGH);
+
+float high_accel_offset[] = {0, 0, 0};
+float high_accel[3];
+
+int main() {
+    adxl.begin();
+    adxl.offset(high_accel);
+    if(adxl.test()){
+        adxl.read(high_accel);
+        pc.printf("%f\t%f\t%f\r\n", high_accel[0], high_accel[1], high_accel[2]);
+    }
+    else{
+        pc.printf("[  FAIL  ] ADXL375 cannot be reached.\r\n");
+    }
+}
+ * @endcode
+ */
 class ADXL375
 {
 public:
@@ -17,17 +44,43 @@
         ALT_ADDRESS_HIGH = ADXL375_ADDR_HIGH,
         ALT_ADDRESS_LOW = ADXL375_ADDR_LOW
     } ALT_ADDRESS_t;
+    
 private:
     I2C *_i2c;
     int _addr;
     char cmd[2];
     char buff[6];
     float high_accel_offset[3];
+    
 public:   
+    /**
+     * @param i2c I2Cのインスタンスへの参照
+     * @param ALT_ADDRESS_t ALT_ADDRESSピンのH/Lレベル
+     */
     ADXL375(I2C &i2c, ALT_ADDRESS_t ALT_ADDRESS);
+    
+    /**
+     * センサ動作開始
+     */
     void begin();
+    
+    /**
+     * センサ通信テスト
+     * @retval true 通信成功
+     * @retval false 通信失敗
+     */
     bool test();
+    
+    /**
+     * ゼロ点補正
+     * @param high_accel 高加速度のオフセット配列
+     */
     void offset(float *high_accel);
+    
+    /**
+     * 測定値の読み取り
+     * @param high_accel 高加速度を格納する配列
+     */
     void read(float *high_accel);
 };