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

BusIn.h@4:5d1359a283bc, 2008-11-27 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Nov 27 16:23:24 2008 +0000
Revision:
4:5d1359a283bc
Parent:
1:6b7f447ca868
Child:
5:62573be585e9
New version of framework: vectors, environment, platform, base and file system

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - BusIn
simon.ford@mbed.co.uk 0:82220227f4fa 2 * Copyright (c) 2007-2008, sford
simon.ford@mbed.co.uk 0:82220227f4fa 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
simon.ford@mbed.co.uk 0:82220227f4fa 8 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 9 #include "DigitalIn.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: BusIn
simon.ford@mbed.co.uk 0:82220227f4fa 14 * A digital input bus, used for reading the state of a collection of pins
simon.ford@mbed.co.uk 0:82220227f4fa 15 */
simon.ford@mbed.co.uk 0:82220227f4fa 16 class BusIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 17
simon.ford@mbed.co.uk 0:82220227f4fa 18 public:
simon.ford@mbed.co.uk 0:82220227f4fa 19
simon.ford@mbed.co.uk 0:82220227f4fa 20 /* Group: Configuration Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 21
simon.ford@mbed.co.uk 0:82220227f4fa 22 /* Constructor: BusIn
simon.ford@mbed.co.uk 0:82220227f4fa 23 * Create an BusIn, connected to the specified pins
simon.ford@mbed.co.uk 0:82220227f4fa 24 *
simon.ford@mbed.co.uk 0:82220227f4fa 25 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 26 * p<n> - DigitalIn pin to connect to bus bit <n> (5-30, NOT_CONNECTED)
simon.ford@mbed.co.uk 0:82220227f4fa 27 *
simon.ford@mbed.co.uk 0:82220227f4fa 28 * Note:
simon.ford@mbed.co.uk 0:82220227f4fa 29 * It is only required to specify as many pin variables as is required
simon.ford@mbed.co.uk 0:82220227f4fa 30 * for the bus; the rest will default to NOT_CONNECTED
simon.ford@mbed.co.uk 0:82220227f4fa 31 */
simon.ford@mbed.co.uk 4:5d1359a283bc 32 BusIn(int p0, int p1 = NOT_CONNECTED, int p2 = NOT_CONNECTED, int p3 = NOT_CONNECTED,
simon.ford@mbed.co.uk 4:5d1359a283bc 33 int p4 = NOT_CONNECTED, int p5 = NOT_CONNECTED, int p6 = NOT_CONNECTED, int p7 = NOT_CONNECTED,
simon.ford@mbed.co.uk 4:5d1359a283bc 34 int p8 = NOT_CONNECTED, int p9 = NOT_CONNECTED, int p10 = NOT_CONNECTED, int p11 = NOT_CONNECTED,
simon.ford@mbed.co.uk 4:5d1359a283bc 35 int p12 = NOT_CONNECTED, int p13 = NOT_CONNECTED, int p14 = NOT_CONNECTED, int p15 = NOT_CONNECTED,
simon.ford@mbed.co.uk 4:5d1359a283bc 36 const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 37
simon.ford@mbed.co.uk 0:82220227f4fa 38 virtual ~BusIn();
simon.ford@mbed.co.uk 0:82220227f4fa 39
simon.ford@mbed.co.uk 0:82220227f4fa 40 /* Group: Access Methods */
simon.ford@mbed.co.uk 0:82220227f4fa 41
simon.ford@mbed.co.uk 0:82220227f4fa 42 /* Function: read
simon.ford@mbed.co.uk 0:82220227f4fa 43 * Read the value of the input bus
simon.ford@mbed.co.uk 0:82220227f4fa 44 *
simon.ford@mbed.co.uk 0:82220227f4fa 45 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 46 * returns - An integer with each bit corresponding to the value read from the associated DigitalIn pin
simon.ford@mbed.co.uk 0:82220227f4fa 47 */
simon.ford@mbed.co.uk 0:82220227f4fa 48 int read();
simon.ford@mbed.co.uk 0:82220227f4fa 49
simon.ford@mbed.co.uk 0:82220227f4fa 50 /* Group: Access Method Shorthand */
simon.ford@mbed.co.uk 0:82220227f4fa 51
simon.ford@mbed.co.uk 0:82220227f4fa 52 /* Function: operator int()
simon.ford@mbed.co.uk 0:82220227f4fa 53 * A shorthand for <read>
simon.ford@mbed.co.uk 0:82220227f4fa 54 */
simon.ford@mbed.co.uk 0:82220227f4fa 55 operator int();
simon.ford@mbed.co.uk 4:5d1359a283bc 56
simon.ford@mbed.co.uk 4:5d1359a283bc 57 virtual const struct rpc_method *rpc_methods();
simon.ford@mbed.co.uk 0:82220227f4fa 58
simon.ford@mbed.co.uk 0:82220227f4fa 59 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 60
simon.ford@mbed.co.uk 0:82220227f4fa 61 DigitalIn* _pin[16];
simon.ford@mbed.co.uk 0:82220227f4fa 62
simon.ford@mbed.co.uk 0:82220227f4fa 63 };
simon.ford@mbed.co.uk 0:82220227f4fa 64
simon.ford@mbed.co.uk 0:82220227f4fa 65 }
simon.ford@mbed.co.uk 0:82220227f4fa 66
simon.ford@mbed.co.uk 1:6b7f447ca868 67 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 68