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@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

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
screamer 43:aff670d0d510 15 /** A digital input, used for reading the state of a pin
simon.ford@mbed.co.uk 5:62573be585e9 16 *
simon.ford@mbed.co.uk 5:62573be585e9 17 * Example:
screamer 43:aff670d0d510 18 * @code
screamer 43:aff670d0d510 19 * // Flash an LED while a DigitalIn is true
screamer 43:aff670d0d510 20 *
screamer 43:aff670d0d510 21 * #include "mbed.h"
screamer 43:aff670d0d510 22 *
screamer 43:aff670d0d510 23 * DigitalIn enable(p5);
screamer 43:aff670d0d510 24 * DigitalOut led(LED1);
screamer 43:aff670d0d510 25 *
screamer 43:aff670d0d510 26 * int main() {
screamer 43:aff670d0d510 27 * while(1) {
screamer 43:aff670d0d510 28 * if(enable) {
screamer 43:aff670d0d510 29 * led = !led;
screamer 43:aff670d0d510 30 * }
screamer 43:aff670d0d510 31 * wait(0.25);
screamer 43:aff670d0d510 32 * }
screamer 43:aff670d0d510 33 * }
screamer 43:aff670d0d510 34 * @endcode
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
screamer 43:aff670d0d510 40 /** Create a DigitalIn connected to the specified pin
rolf.meyer@arm.com 11:1c1ebd0324fa 41 *
screamer 43:aff670d0d510 42 * @param pin DigitalIn pin to connect to
screamer 43:aff670d0d510 43 * @param name (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 44 */
rolf.meyer@arm.com 11:1c1ebd0324fa 45 DigitalIn(PinName pin, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 46
screamer 43:aff670d0d510 47 /** Read the input, represented as 0 or 1 (int)
rolf.meyer@arm.com 11:1c1ebd0324fa 48 *
screamer 43:aff670d0d510 49 * @returns
screamer 43:aff670d0d510 50 * An integer representing the state of the input pin,
screamer 43:aff670d0d510 51 * 0 for logical 0, 1 for logical 1
simon.ford@mbed.co.uk 5:62573be585e9 52 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 int read() {
emilmont 27:7110ebee3484 54 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 return ((_gpio->FIOPIN & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 56 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 57 return ((LPC_GPIO->PIN[_index] & _mask) ? 1 : 0);
emilmont 27:7110ebee3484 58 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60
simon.ford@mbed.co.uk 0:82220227f4fa 61
screamer 43:aff670d0d510 62 /** Set the input pin mode
rolf.meyer@arm.com 11:1c1ebd0324fa 63 *
screamer 43:aff670d0d510 64 * @param mode PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 5:62573be585e9 65 */
rolf.meyer@arm.com 11:1c1ebd0324fa 66 void mode(PinMode pull);
rolf.meyer@arm.com 11:1c1ebd0324fa 67
rolf.meyer@arm.com 11:1c1ebd0324fa 68 #ifdef MBED_OPERATORS
screamer 43:aff670d0d510 69 /** An operator shorthand for read()
simon.ford@mbed.co.uk 0:82220227f4fa 70 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74
rolf.meyer@arm.com 11:1c1ebd0324fa 75 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 76
rolf.meyer@arm.com 11:1c1ebd0324fa 77 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 78 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 79 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 80 #endif
simon.ford@mbed.co.uk 5:62573be585e9 81
simon.ford@mbed.co.uk 0:82220227f4fa 82 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 83
simon.ford@mbed.co.uk 18:b3c9f16cbb96 84 PinName _pin;
emilmont 27:7110ebee3484 85 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 86 LPC_GPIO_TypeDef *_gpio;
emilmont 27:7110ebee3484 87 #elif defined(TARGET_LPC11U24)
emilmont 27:7110ebee3484 88 int _index;
emilmont 27:7110ebee3484 89 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 90 uint32_t _mask;
simon.ford@mbed.co.uk 0:82220227f4fa 91
simon.ford@mbed.co.uk 0:82220227f4fa 92 };
simon.ford@mbed.co.uk 0:82220227f4fa 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 95
simon.ford@mbed.co.uk 1:6b7f447ca868 96 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 97