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

DigitalIn.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:
18:b3c9f16cbb96
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 - DigitalIn
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_DIGITALIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_DIGITALIN_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: DigitalIn
simon.ford@mbed.co.uk 0:82220227f4fa 17 * A digital input, used for reading the state of 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 * > // Flash an LED while a DigitalIn is true
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 * > DigitalIn enable(p5);
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > DigitalOut led(LED1);
simon.ford@mbed.co.uk 5:62573be585e9 26 * >
simon.ford@mbed.co.uk 5:62573be585e9 27 * > int main() {
simon.ford@mbed.co.uk 5:62573be585e9 28 * > while(1) {
simon.ford@mbed.co.uk 5:62573be585e9 29 * > if(enable) {
simon.ford@mbed.co.uk 5:62573be585e9 30 * > led = !led;
simon.ford@mbed.co.uk 5:62573be585e9 31 * > }
simon.ford@mbed.co.uk 5:62573be585e9 32 * > wait(0.25);
simon.ford@mbed.co.uk 5:62573be585e9 33 * > }
simon.ford@mbed.co.uk 5:62573be585e9 34 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 35 */
simon.ford@mbed.co.uk 0:82220227f4fa 36 class DigitalIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 37
simon.ford@mbed.co.uk 0:82220227f4fa 38 public:
simon.ford@mbed.co.uk 0:82220227f4fa 39
rolf.meyer@arm.com 11:1c1ebd0324fa 40 /* Constructor: DigitalIn
rolf.meyer@arm.com 11:1c1ebd0324fa 41 * Create a DigitalIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 42 *
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 44 * pin - DigitalIn pin to connect to
simon.ford@mbed.co.uk 5:62573be585e9 45 * name - (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 46 */
rolf.meyer@arm.com 11:1c1ebd0324fa 47 DigitalIn(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 48
rolf.meyer@arm.com 11:1c1ebd0324fa 49 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 50 * Read the input, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 51 *
simon.ford@mbed.co.uk 5:62573be585e9 52 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 53 * returns - An integer representing the state of the input pin,
rolf.meyer@arm.com 11:1c1ebd0324fa 54 * 0 for logical 0 and 1 for logical 1
simon.ford@mbed.co.uk 5:62573be585e9 55 */
rolf.meyer@arm.com 11:1c1ebd0324fa 56 int read();
simon.ford@mbed.co.uk 0:82220227f4fa 57
rolf.meyer@arm.com 11:1c1ebd0324fa 58 /* Function: mode
rolf.meyer@arm.com 11:1c1ebd0324fa 59 * Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 60 *
simon.ford@mbed.co.uk 5:62573be585e9 61 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 62 * mode - PullUp, PullDown, PullNone
simon.ford@mbed.co.uk 5:62573be585e9 63 */
rolf.meyer@arm.com 11:1c1ebd0324fa 64 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 65
rolf.meyer@arm.com 11:1c1ebd0324fa 66 #ifdef MBED_OPERATORS
simon.ford@mbed.co.uk 0:82220227f4fa 67 /* Function: operator int()
simon.ford@mbed.co.uk 5:62573be585e9 68 * An operator shorthand for <read()>
simon.ford@mbed.co.uk 0:82220227f4fa 69 */
rolf.meyer@arm.com 11:1c1ebd0324fa 70 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 71 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 72
rolf.meyer@arm.com 11:1c1ebd0324fa 73 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 74 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 75 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 76 #endif
simon.ford@mbed.co.uk 5:62573be585e9 77
simon.ford@mbed.co.uk 0:82220227f4fa 78 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 79
rolf.meyer@arm.com 11:1c1ebd0324fa 80 PinName _pin;
simon.ford@mbed.co.uk 0:82220227f4fa 81
simon.ford@mbed.co.uk 0:82220227f4fa 82 };
simon.ford@mbed.co.uk 0:82220227f4fa 83
rolf.meyer@arm.com 11:1c1ebd0324fa 84 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 85
simon.ford@mbed.co.uk 1:6b7f447ca868 86 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 87