Jordan Brack
SmartWheels self-driving race car. Designed for NXP Cup. Uses FRDM-KL25Z, area-scan camera, and simple image processing to detect and navigate any NXP spec track.
Dependencies: TSI USBDevice mbed-dev
Fork of
SmartWheels
by 
haofan Zheng
Diff: Hardwares/CamRegDefinitions.h
- Revision:
- 92:e9bd429f16b5
- Parent:
- 32:5badeff825dc
--- a/Hardwares/CamRegDefinitions.h Wed Apr 19 14:54:14 2017 +0000
+++ b/Hardwares/CamRegDefinitions.h Wed Apr 19 17:15:46 2017 +0000
@@ -1,14 +1,20 @@
+/**
+ * @file CamRegDefinitions.h
+ * @brief The header file for the common definition that used for camera SCCB control.
+ * @author Jordan Brack <jabrack@mix.wvu.edu>, Haofan Zheng <hazheng@mix.wvu.edu>
+ *
+ */
#pragma once
#ifndef CAM_REG_DEFINITIONS_H
#define CAM_REG_DEFINITIONS_H
-#define CAM_REG_WRITEWAIT 20
-#define CAM_REG_NOACK 0
-#define CAM_REG_I2CFREQ 100000
+#define CAM_REG_WRITEWAIT 20 /*!< @brief The recommanded waiting time after a SCCB write behavior. In micro-sec. */
+#define CAM_REG_NOACK 0 /*!< @brief The NOACK after a SCCB read behavior. */
+#define CAM_REG_I2CFREQ 100000 /*!< @brief The recommanded frequency for camera SCCB communication. */
-struct sensor_reg {
- uint8_t reg;
- uint8_t val;
+struct sensor_reg { /*!< @brief The struct used to store the register program. */
+ uint8_t reg; /*!< @brief The The Register Address. */
+ uint8_t val; /*!< @brief The The value that need to be written to the register in that address. */
};
#endif //CAM_REG_DEFINITIONS_H
\ No newline at end of file