Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

AnalogIn.h@5:62573be585e9, 2009-01-22 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Jan 22 18:32:40 2009 +0000
Revision:
5:62573be585e9
Parent:
4:5d1359a283bc
Child:
11:1c1ebd0324fa
* Added initial RPC release

 * Added RTC and helper functions

 * Added read_u16()/write_u16() to AnalogIn/Out

 * Ticker/Timeout timing fixed!

 * mbedinfo() helper added

 * error() and printf() added to replace DEBUG() and ERROR()

 * DigitalIn supports methods on rise/fall

 * SPI and Serial support NC

 * LED1-4 also map to 1-4

 * Timer object reset fixed

 * SPI uses single mode

 * SPI3 added

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
simon.ford@mbed.co.uk 0:82220227f4fa 9 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 10
simon.ford@mbed.co.uk 0:82220227f4fa 11 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 12
simon.ford@mbed.co.uk 0:82220227f4fa 13 /* Class: AnalogIn
simon.ford@mbed.co.uk 5:62573be585e9 14 * An analog input, used for reading the voltage on a pin
simon.ford@mbed.co.uk 5:62573be585e9 15 *
simon.ford@mbed.co.uk 5:62573be585e9 16 * Example:
simon.ford@mbed.co.uk 5:62573be585e9 17 * > // Print messages when the AnalogIn is greater than 50%
simon.ford@mbed.co.uk 5:62573be585e9 18 * >
simon.ford@mbed.co.uk 5:62573be585e9 19 * > #include "mbed.h"
simon.ford@mbed.co.uk 5:62573be585e9 20 * >
simon.ford@mbed.co.uk 5:62573be585e9 21 * > AnalogIn temperature(20);
simon.ford@mbed.co.uk 5:62573be585e9 22 * >
simon.ford@mbed.co.uk 5:62573be585e9 23 * > int main() {
simon.ford@mbed.co.uk 5:62573be585e9 24 * > while(1) {
simon.ford@mbed.co.uk 5:62573be585e9 25 * > if(temperature > 0.5) {
simon.ford@mbed.co.uk 5:62573be585e9 26 * > printf("Too hot! (%f)", temperature.read());
simon.ford@mbed.co.uk 5:62573be585e9 27 * > }
simon.ford@mbed.co.uk 5:62573be585e9 28 * > }
simon.ford@mbed.co.uk 5:62573be585e9 29 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 30 */
simon.ford@mbed.co.uk 0:82220227f4fa 31 class AnalogIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 32
simon.ford@mbed.co.uk 0:82220227f4fa 33 public:
simon.ford@mbed.co.uk 0:82220227f4fa 34
simon.ford@mbed.co.uk 5:62573be585e9 35 /* Constructor: AnalogIn
simon.ford@mbed.co.uk 5:62573be585e9 36 * Create an AnalogIn, connected to the specified pin
simon.ford@mbed.co.uk 5:62573be585e9 37 *
simon.ford@mbed.co.uk 5:62573be585e9 38 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 39 * pin - AnalogIn pin to connect to (15 - 20)
simon.ford@mbed.co.uk 5:62573be585e9 40 * name - (optional) A string to identify the object
simon.ford@mbed.co.uk 5:62573be585e9 41 */
simon.ford@mbed.co.uk 4:5d1359a283bc 42 AnalogIn(int pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 43
simon.ford@mbed.co.uk 5:62573be585e9 44 /* Function: read
simon.ford@mbed.co.uk 5:62573be585e9 45 * Read the input voltage, represented as a float in the range [0.0, 1.0]
simon.ford@mbed.co.uk 5:62573be585e9 46 *
simon.ford@mbed.co.uk 5:62573be585e9 47 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 48 * returns - A floating-point value representing the current input voltage,
simon.ford@mbed.co.uk 5:62573be585e9 49 * measured as a percentage (0.0 = 0v, 1.0 = 3.3v)
simon.ford@mbed.co.uk 5:62573be585e9 50 */
simon.ford@mbed.co.uk 5:62573be585e9 51 float read();
simon.ford@mbed.co.uk 5:62573be585e9 52
simon.ford@mbed.co.uk 5:62573be585e9 53 /* Function: read_u16
simon.ford@mbed.co.uk 5:62573be585e9 54 * Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
simon.ford@mbed.co.uk 5:62573be585e9 55 *
simon.ford@mbed.co.uk 5:62573be585e9 56 * Variables:
simon.ford@mbed.co.uk 5:62573be585e9 57 * returns - 16-bit unsigned short representing the current input voltage,
simon.ford@mbed.co.uk 5:62573be585e9 58 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
simon.ford@mbed.co.uk 5:62573be585e9 59 */
simon.ford@mbed.co.uk 5:62573be585e9 60 unsigned short read_u16();
simon.ford@mbed.co.uk 5:62573be585e9 61
simon.ford@mbed.co.uk 5:62573be585e9 62 // functions to be removed in time...
simon.ford@mbed.co.uk 0:82220227f4fa 63 float read_v();
simon.ford@mbed.co.uk 0:82220227f4fa 64 int read_mv();
simon.ford@mbed.co.uk 0:82220227f4fa 65
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 */
simon.ford@mbed.co.uk 0:82220227f4fa 78 operator float();
simon.ford@mbed.co.uk 4:5d1359a283bc 79
simon.ford@mbed.co.uk 5:62573be585e9 80 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 81 static struct rpc_class *get_rpc_class();
simon.ford@mbed.co.uk 5:62573be585e9 82
simon.ford@mbed.co.uk 0:82220227f4fa 83 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 84
simon.ford@mbed.co.uk 0:82220227f4fa 85 int _id;
simon.ford@mbed.co.uk 0:82220227f4fa 86
simon.ford@mbed.co.uk 0:82220227f4fa 87 };
simon.ford@mbed.co.uk 0:82220227f4fa 88
simon.ford@mbed.co.uk 0:82220227f4fa 89 }
simon.ford@mbed.co.uk 0:82220227f4fa 90
simon.ford@mbed.co.uk 1:6b7f447ca868 91 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 92