doxy

adafruit · Mar 15, 2020 · d158260 · d158260
1 parent 563b7c2
commit d158260
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/Adafruit_AHT10.cpp b/Adafruit_AHT10.cpp
@@ -101,6 +101,11 @@ bool Adafruit_AHT10::begin(TwoWire *wire, int32_t sensor_id) {
   return true;
 }
 
+/**
+ * @brief  Gets the status (first byte) from AHT10
+ *
+ * @returns 8 bits of status data, or 0xFF if failed
+ */
 uint8_t Adafruit_AHT10::getStatus(void) {
   uint8_t ret;
   if (!i2c_dev->read(&ret, 1)) {

diff --git a/Adafruit_AHT10.h b/Adafruit_AHT10.h
@@ -24,12 +24,12 @@
 #include <Adafruit_Sensor.h>
 #include <Wire.h>
 
-#define AHT10_I2CADDR_DEFAULT 0x38 ///< AHT10 default i2c address
-#define AHT10_CMD_CALIBRATE 0xE1
-#define AHT10_CMD_TRIGGER 0xAC
-#define AHT10_CMD_SOFTRESET 0xBA
-#define AHT10_STATUS_BUSY 0x80
-#define AHT10_STATUS_CALIBRATED 0x08
+#define AHT10_I2CADDR_DEFAULT 0x38   ///< AHT10 default i2c address
+#define AHT10_CMD_CALIBRATE 0xE1     ///< Calibration command
+#define AHT10_CMD_TRIGGER 0xAC       ///< Trigger reading command
+#define AHT10_CMD_SOFTRESET 0xBA     ///< Soft reset command
+#define AHT10_STATUS_BUSY 0x80       ///< Status bit for busy
+#define AHT10_STATUS_CALIBRATED 0x08 ///< Status bit for calibrated
 
 class Adafruit_AHT10;