my fork
Fork of mbed by
Diff: AnalogIn.h
- Revision:
- 5:62573be585e9
- Parent:
- 4:5d1359a283bc
- Child:
- 11:1c1ebd0324fa
--- a/AnalogIn.h Thu Nov 27 16:23:24 2008 +0000 +++ b/AnalogIn.h Thu Jan 22 18:32:40 2009 +0000 @@ -1,6 +1,7 @@ /* mbed Microcontroller Library - AnalogIn - * Copyright (c) 2007-2008, sford - */ + * Copyright (c) 2006-2009 ARM Limited. All rights reserved. + * sford + */ #ifndef MBED_ANALOGIN_H #define MBED_ANALOGIN_H @@ -10,63 +11,75 @@ namespace mbed { /* Class: AnalogIn - * An analog input, used for reading the voltage on a pin + * An analog input, used for reading the voltage on a pin + * + * Example: + * > // Print messages when the AnalogIn is greater than 50% + * > + * > #include "mbed.h" + * > + * > AnalogIn temperature(20); + * > + * > int main() { + * > while(1) { + * > if(temperature > 0.5) { + * > printf("Too hot! (%f)", temperature.read()); + * > } + * > } + * > } */ class AnalogIn : public Base { public: - /* Group: Configuration Methods */ - - /* Constructor: AnalogIn - * Create an AnalogIn connected to the specified pin - * - * Variables: - * pin - AnalogIn pin to connect to (15-20) - */ + /* Constructor: AnalogIn + * Create an AnalogIn, connected to the specified pin + * + * Variables: + * pin - AnalogIn pin to connect to (15 - 20) + * name - (optional) A string to identify the object + */ AnalogIn(int pin, const char *name = NULL); - /* Group: Access Methods */ - - /* Function: read - * Read the input, measured as a percentage (float) - * - * Variables: - * returns - A floating-point value representing the current input voltage, - * measured as a percentage. The returned value will lie between - * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%). - */ - float read(); - - /* Function: read_v - * Read the input, measured in volts (float) - * - * Variables: - * returns - A floating-point value representing the current input voltage, - * measured in volts. The returned value will lie between - * 0.0f (representing 0v / 0%) and 3.3f (representing 3.3v / 100%). - */ + /* Function: read + * Read the input voltage, represented as a float in the range [0.0, 1.0] + * + * Variables: + * returns - A floating-point value representing the current input voltage, + * measured as a percentage (0.0 = 0v, 1.0 = 3.3v) + */ + float read(); + + /* Function: read_u16 + * Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF] + * + * Variables: + * returns - 16-bit unsigned short representing the current input voltage, + * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v) + */ + unsigned short read_u16(); + + // functions to be removed in time... float read_v(); - - /* Function: read_mv - * Read the input, measured in milli-volts (int) - * - * Variables: - * returns - An integer value representing the current input voltage, - * measured in milli-volts. The returned value will lie between - * 0 (representing 0v / 0%) and 3300 (representing 3.3v / 100%). - */ int read_mv(); - - /* Group: Access Methods Shorthand */ /* Function: operator float - * A shorthand for <read> + * An operator shorthand for <read()> + * + * The float() operator can be used as a shorthand for <read()> to simplify common code sequences + * + * Example: + * > float x = volume.read(); + * > float x = volume; + * > + * > if(volume.read() > 0.25) { ... } + * > if(volume > 0.25) { ... } */ operator float(); - virtual const struct rpc_method *rpc_methods(); - + virtual const struct rpc_method *get_rpc_methods(); + static struct rpc_class *get_rpc_class(); + protected: int _id;