Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/BusIn.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yihui 0:700cadd8b708 1 /* mbed Microcontroller Library
yihui 0:700cadd8b708 2 * Copyright (c) 2006-2013 ARM Limited
yihui 0:700cadd8b708 3 *
yihui 0:700cadd8b708 4 * Licensed under the Apache License, Version 2.0 (the "License");
yihui 0:700cadd8b708 5 * you may not use this file except in compliance with the License.
yihui 0:700cadd8b708 6 * You may obtain a copy of the License at
yihui 0:700cadd8b708 7 *
yihui 0:700cadd8b708 8 * http://www.apache.org/licenses/LICENSE-2.0
yihui 0:700cadd8b708 9 *
yihui 0:700cadd8b708 10 * Unless required by applicable law or agreed to in writing, software
yihui 0:700cadd8b708 11 * distributed under the License is distributed on an "AS IS" BASIS,
yihui 0:700cadd8b708 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
yihui 0:700cadd8b708 13 * See the License for the specific language governing permissions and
yihui 0:700cadd8b708 14 * limitations under the License.
yihui 0:700cadd8b708 15 */
yihui 0:700cadd8b708 16 #ifndef MBED_BUSIN_H
yihui 0:700cadd8b708 17 #define MBED_BUSIN_H
yihui 0:700cadd8b708 18
yihui 0:700cadd8b708 19 #include "platform.h"
yihui 0:700cadd8b708 20 #include "DigitalIn.h"
yihui 0:700cadd8b708 21
yihui 0:700cadd8b708 22 namespace mbed {
yihui 0:700cadd8b708 23
yihui 0:700cadd8b708 24 /** A digital input bus, used for reading the state of a collection of pins
yihui 0:700cadd8b708 25 */
yihui 0:700cadd8b708 26 class BusIn {
yihui 0:700cadd8b708 27
yihui 0:700cadd8b708 28 public:
yihui 0:700cadd8b708 29 /* Group: Configuration Methods */
yihui 0:700cadd8b708 30
yihui 0:700cadd8b708 31 /** Create an BusIn, connected to the specified pins
yihui 0:700cadd8b708 32 *
yihui 0:700cadd8b708 33 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
yihui 0:700cadd8b708 34 *
yihui 0:700cadd8b708 35 * @note
yihui 0:700cadd8b708 36 * It is only required to specify as many pin variables as is required
yihui 0:700cadd8b708 37 * for the bus; the rest will default to NC (not connected)
yihui 0:700cadd8b708 38 */
yihui 0:700cadd8b708 39 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
yihui 0:700cadd8b708 40 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
yihui 0:700cadd8b708 41 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
yihui 0:700cadd8b708 42 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
yihui 0:700cadd8b708 43
yihui 0:700cadd8b708 44 BusIn(PinName pins[16]);
yihui 0:700cadd8b708 45
yihui 0:700cadd8b708 46 virtual ~BusIn();
yihui 0:700cadd8b708 47
yihui 0:700cadd8b708 48 /** Read the value of the input bus
yihui 0:700cadd8b708 49 *
yihui 0:700cadd8b708 50 * @returns
yihui 0:700cadd8b708 51 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
yihui 0:700cadd8b708 52 */
yihui 0:700cadd8b708 53 int read();
yihui 0:700cadd8b708 54
yihui 0:700cadd8b708 55 /** Set the input pin mode
yihui 0:700cadd8b708 56 *
yihui 0:700cadd8b708 57 * @param mode PullUp, PullDown, PullNone
yihui 0:700cadd8b708 58 */
yihui 0:700cadd8b708 59 void mode(PinMode pull);
yihui 0:700cadd8b708 60
yihui 0:700cadd8b708 61 #ifdef MBED_OPERATORS
yihui 0:700cadd8b708 62 /** A shorthand for read()
yihui 0:700cadd8b708 63 */
yihui 0:700cadd8b708 64 operator int();
yihui 0:700cadd8b708 65 #endif
yihui 0:700cadd8b708 66
yihui 0:700cadd8b708 67 protected:
yihui 0:700cadd8b708 68 DigitalIn* _pin[16];
yihui 0:700cadd8b708 69
yihui 0:700cadd8b708 70 /* disallow copy constructor and assignment operators */
yihui 0:700cadd8b708 71 private:
yihui 0:700cadd8b708 72 BusIn(const BusIn&);
yihui 0:700cadd8b708 73 BusIn & operator = (const BusIn&);
yihui 0:700cadd8b708 74 };
yihui 0:700cadd8b708 75
yihui 0:700cadd8b708 76 } // namespace mbed
yihui 0:700cadd8b708 77
yihui 0:700cadd8b708 78 #endif