From a84419e321a56ff9237788ca5edf75e8774927b5 Mon Sep 17 00:00:00 2001 From: PeterKietzmann Date: Mon, 8 Dec 2014 13:26:38 +0100 Subject: [PATCH] doc: fix drivers/srf08 documentation --- drivers/include/srf08-ultrasonic-sensor.h | 42 +++++++++++++++++------ 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/drivers/include/srf08-ultrasonic-sensor.h b/drivers/include/srf08-ultrasonic-sensor.h index b7e37bbc57..2a89370092 100644 --- a/drivers/include/srf08-ultrasonic-sensor.h +++ b/drivers/include/srf08-ultrasonic-sensor.h @@ -31,23 +31,45 @@ extern "C" { #endif -/* define the SRF02 registers*/ +/** @brief The sensors default I2C address */ #define SRF08_DEFAULT_ADDR 112 + + +/** @brief The sensors command register (write) */ #define SRF08_COMMAND_REG 0x0 -#define SRF08_RANGE_HIGH_BYTE 0x2 -#define SRF08_RANGE_LOW_BYTE 0x3 -#define SRF08_REAL_RANGING_MODE_CM 0x51 -#define SRF08_RANGE_REG 0x2 + +/** @brief Max. gain register (write) */ #define SRF08_GAIN_REG 0x1 +/** @brief The sensors range register (write) */ +#define SRF08_RANGE_REG 0x2 + +/** @brief The upper measurement byte (read) */ +#define SRF08_RANGE_HIGH_BYTE 0x2 + +/** @brief The lower measurement byte (read)*/ +#define SRF08_RANGE_LOW_BYTE 0x3 + + +/** @brief Measure in inch mode */ +#define SRF08_REAL_RANGING_MODE_CM 0x50 + +/** @brief Measure in cm mode */ +#define SRF08_REAL_RANGING_MODE_CM 0x51 + +/** @brief Measure in micro-seconds mode */ +#define SRF08_REAL_RANGING_MODE_CM 0x52 + + +/** @brief Number of highest register */ #define SRF08_MAX_REGISTER_NUMBER 35 + +/** @brief Maximum number of echos from more distant objects */ #define SRF08_MAX_ECHO_NUMBER 17 -/* Define the used I2C Interface */ -//#define I2C_INTERFACE I2C0 // P0.27 SDA0, P0.28 SCL0 -//#define I2C_INTERFACE I2C1_0 // P0.0 SDA1, P0.1 SCL1 -//#define I2C_INTERFACE I2C1_1 // P0.19 SDA1, P0.20 SCL1 -#define SRF08_I2C_INTERFACE I2C2 // P0.10 SDA2, P0.11 SCL2 + +/** @brief Define the used I2C Interface */ +#define SRF08_I2C_INTERFACE I2C2 /* P0.10 SDA2, P0.11 SCL2 */ /**