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@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
19:e6be4cd80aad
Child:
43:aff670d0d510
New Libraries 11.11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - DigitalIn
emilmont 27:7110ebee3484 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 5:62573be585e9 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_DIGITALIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_DIGITALIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
rolf.meyer@arm.com 11:1c1ebd0324fa 8 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 11 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12
simon.ford@mbed.co.uk 0:82220227f4fa 13 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 14
simon.ford@mbed.co.uk 0:82220227f4fa 15 /* Class: DigitalIn
simon.ford@mbed.co.uk 0:82220227f4fa 16 * A digital input, used for reading the state of a pin
simon.ford@mbed.co.uk 5:62573be585e9 17 *
simon.ford@mbed.co.uk 5:62573be585e9 18 * Example:
simon.ford@mbed.co.uk 5:62573be585e9 19 * > // Flash an LED while a DigitalIn is true
simon.ford@mbed.co.uk 5:62573be585e9 20 * >
simon.ford@mbed.co.uk 5:62573be585e9 21 * > #include "mbed.h"
simon.ford@mbed.co.uk 5:62573be585e9 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > DigitalIn enable(p5);
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > DigitalOut led(LED1);
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(enable) {
simon.ford@mbed.co.uk 5:62573be585e9 29 * > led = !led;
simon.ford@mbed.co.uk 5:62573be585e9 30 * > }
simon.ford@mbed.co.uk 5:62573be585e9 31 * > wait(0.25);
simon.ford@mbed.co.uk 5:62573be585e9 32 * > }
simon.ford@mbed.co.uk 5:62573be585e9 33 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 34 */
simon.ford@mbed.co.uk 0:82220227f4fa 35 class DigitalIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 36
simon.ford@mbed.co.uk 0:82220227f4fa 37 public:
simon.ford@mbed.co.uk 0:82220227f4fa 38
rolf.meyer@arm.com 11:1c1ebd0324fa 39 /* Constructor: DigitalIn
rolf.meyer@arm.com 11:1c1ebd0324fa 40 * Create a DigitalIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 41 *
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 43 * pin - DigitalIn pin to connect to
simon.ford@mbed.co.uk 5:62573be585e9 44 * name - (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 45 */
rolf.meyer@arm.com 11:1c1ebd0324fa 46 DigitalIn(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 47
rolf.meyer@arm.com 11:1c1ebd0324fa 48 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 49 * Read the input, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 50 *
simon.ford@mbed.co.uk 5:62573be585e9 51 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * returns - An integer representing the state of the input pin,
rolf.meyer@arm.com 11:1c1ebd0324fa 53 * 0 for logical 0 and 1 for logical 1
simon.ford@mbed.co.uk 5:62573be585e9 54 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 int read() {
emilmont 27:7110ebee3484 56 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 return ((_gpio->FIOPIN & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 58 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 59 return ((LPC_GPIO->PIN[_index] & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 60 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62
simon.ford@mbed.co.uk 0:82220227f4fa 63
rolf.meyer@arm.com 11:1c1ebd0324fa 64 /* Function: mode
rolf.meyer@arm.com 11:1c1ebd0324fa 65 * Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 66 *
simon.ford@mbed.co.uk 5:62573be585e9 67 * Variables:
simon 19:e6be4cd80aad 68 * mode - PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 5:62573be585e9 69 */
rolf.meyer@arm.com 11:1c1ebd0324fa 70 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 #ifdef MBED_OPERATORS
simon.ford@mbed.co.uk 0:82220227f4fa 73 /* Function: operator int()
simon.ford@mbed.co.uk 5:62573be585e9 74 * An operator shorthand for <read()>
simon.ford@mbed.co.uk 0:82220227f4fa 75 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 77 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79
rolf.meyer@arm.com 11:1c1ebd0324fa 80 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 81
rolf.meyer@arm.com 11:1c1ebd0324fa 82 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 83 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 84 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 85 #endif
simon.ford@mbed.co.uk 5:62573be585e9 86
simon.ford@mbed.co.uk 0:82220227f4fa 87 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 88
simon.ford@mbed.co.uk 18:b3c9f16cbb96 89 PinName _pin;
emilmont 27:7110ebee3484 90 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 91 LPC_GPIO_TypeDef *_gpio;
emilmont 27:7110ebee3484 92 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 93 int _index;
emilmont 27:7110ebee3484 94 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 95 uint32_t _mask;
simon.ford@mbed.co.uk 0:82220227f4fa 96
simon.ford@mbed.co.uk 0:82220227f4fa 97 };
simon.ford@mbed.co.uk 0:82220227f4fa 98
rolf.meyer@arm.com 11:1c1ebd0324fa 99 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 100
simon.ford@mbed.co.uk 1:6b7f447ca868 101 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 102