Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

AnalogIn.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
5:62573be585e9
Child:
27:7110ebee3484
A shiny new version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - AnalogIn
simon.ford@mbed.co.uk 5:62573be585e9 2 * Copyright (c) 2006-2009 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 5:62573be585e9 3 * sford
simon.ford@mbed.co.uk 5:62573be585e9 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_ANALOGIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_ANALOGIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 13
simon.ford@mbed.co.uk 0:82220227f4fa 14 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 15
simon.ford@mbed.co.uk 0:82220227f4fa 16 /* Class: AnalogIn
simon.ford@mbed.co.uk 5:62573be585e9 17 * An analog input, used for reading the voltage on a pin
simon.ford@mbed.co.uk 5:62573be585e9 18 *
simon.ford@mbed.co.uk 5:62573be585e9 19 * Example:
simon.ford@mbed.co.uk 5:62573be585e9 20 * > // Print messages when the AnalogIn is greater than 50%
simon.ford@mbed.co.uk 5:62573be585e9 21 * >
simon.ford@mbed.co.uk 5:62573be585e9 22 * > #include "mbed.h"
simon.ford@mbed.co.uk 5:62573be585e9 23 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > AnalogIn temperature(p20);
simon.ford@mbed.co.uk 5:62573be585e9 25 * >
simon.ford@mbed.co.uk 5:62573be585e9 26 * > int main() {
simon.ford@mbed.co.uk 5:62573be585e9 27 * > while(1) {
simon.ford@mbed.co.uk 5:62573be585e9 28 * > if(temperature > 0.5) {
simon.ford@mbed.co.uk 5:62573be585e9 29 * > printf("Too hot! (%f)", temperature.read());
simon.ford@mbed.co.uk 5:62573be585e9 30 * > }
simon.ford@mbed.co.uk 5:62573be585e9 31 * > }
simon.ford@mbed.co.uk 5:62573be585e9 32 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 33 */
simon.ford@mbed.co.uk 0:82220227f4fa 34 class AnalogIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 35
simon.ford@mbed.co.uk 0:82220227f4fa 36 public:
simon.ford@mbed.co.uk 0:82220227f4fa 37
simon.ford@mbed.co.uk 5:62573be585e9 38 /* Constructor: AnalogIn
simon.ford@mbed.co.uk 5:62573be585e9 39 * Create an AnalogIn, connected to the specified pin
simon.ford@mbed.co.uk 5:62573be585e9 40 *
simon.ford@mbed.co.uk 5:62573be585e9 41 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * pin - AnalogIn pin to connect to
simon.ford@mbed.co.uk 5:62573be585e9 43 * name - (optional) A string to identify the object
simon.ford@mbed.co.uk 5:62573be585e9 44 */
rolf.meyer@arm.com 11:1c1ebd0324fa 45 AnalogIn(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 46
simon.ford@mbed.co.uk 5:62573be585e9 47 /* Function: read
simon.ford@mbed.co.uk 5:62573be585e9 48 * Read the input voltage, represented as a float in the range [0.0, 1.0]
simon.ford@mbed.co.uk 5:62573be585e9 49 *
simon.ford@mbed.co.uk 5:62573be585e9 50 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 51 * returns - A floating-point value representing the current input voltage,
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * measured as a percentage
simon.ford@mbed.co.uk 5:62573be585e9 53 */
simon.ford@mbed.co.uk 5:62573be585e9 54 float read();
simon.ford@mbed.co.uk 5:62573be585e9 55
simon.ford@mbed.co.uk 5:62573be585e9 56 /* Function: read_u16
simon.ford@mbed.co.uk 5:62573be585e9 57 * Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
simon.ford@mbed.co.uk 5:62573be585e9 58 *
simon.ford@mbed.co.uk 5:62573be585e9 59 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 60 * returns - 16-bit unsigned short representing the current input voltage,
rolf.meyer@arm.com 11:1c1ebd0324fa 61 * normalised to a 16-bit value
simon.ford@mbed.co.uk 5:62573be585e9 62 */
simon.ford@mbed.co.uk 5:62573be585e9 63 unsigned short read_u16();
simon.ford@mbed.co.uk 5:62573be585e9 64
rolf.meyer@arm.com 11:1c1ebd0324fa 65 #ifdef MBED_OPERATORS
simon.ford@mbed.co.uk 0:82220227f4fa 66 /* Function: operator float
simon.ford@mbed.co.uk 5:62573be585e9 67 * An operator shorthand for <read()>
simon.ford@mbed.co.uk 5:62573be585e9 68 *
simon.ford@mbed.co.uk 5:62573be585e9 69 * The float() operator can be used as a shorthand for <read()> to simplify common code sequences
simon.ford@mbed.co.uk 5:62573be585e9 70 *
simon.ford@mbed.co.uk 5:62573be585e9 71 * Example:
simon.ford@mbed.co.uk 5:62573be585e9 72 * > float x = volume.read();
simon.ford@mbed.co.uk 5:62573be585e9 73 * > float x = volume;
simon.ford@mbed.co.uk 5:62573be585e9 74 * >
simon.ford@mbed.co.uk 5:62573be585e9 75 * > if(volume.read() > 0.25) { ... }
simon.ford@mbed.co.uk 5:62573be585e9 76 * > if(volume > 0.25) { ... }
simon.ford@mbed.co.uk 0:82220227f4fa 77 */
rolf.meyer@arm.com 11:1c1ebd0324fa 78 operator float();
rolf.meyer@arm.com 11:1c1ebd0324fa 79 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 80
rolf.meyer@arm.com 11:1c1ebd0324fa 81 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 82 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 83 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 84 #endif
simon.ford@mbed.co.uk 5:62573be585e9 85
simon.ford@mbed.co.uk 0:82220227f4fa 86 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 87
rolf.meyer@arm.com 11:1c1ebd0324fa 88 ADCName _adc;
rolf.meyer@arm.com 11:1c1ebd0324fa 89
simon.ford@mbed.co.uk 0:82220227f4fa 90 };
simon.ford@mbed.co.uk 0:82220227f4fa 91
rolf.meyer@arm.com 11:1c1ebd0324fa 92 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 93
simon.ford@mbed.co.uk 1:6b7f447ca868 94 #endif