George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/PortOut.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* mbed Microcontroller Library
gkroussos 0:e8fdba0ed044 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:e8fdba0ed044 3 *
gkroussos 0:e8fdba0ed044 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:e8fdba0ed044 5 * you may not use this file except in compliance with the License.
gkroussos 0:e8fdba0ed044 6 * You may obtain a copy of the License at
gkroussos 0:e8fdba0ed044 7 *
gkroussos 0:e8fdba0ed044 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:e8fdba0ed044 9 *
gkroussos 0:e8fdba0ed044 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:e8fdba0ed044 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:e8fdba0ed044 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:e8fdba0ed044 13 * See the License for the specific language governing permissions and
gkroussos 0:e8fdba0ed044 14 * limitations under the License.
gkroussos 0:e8fdba0ed044 15 */
gkroussos 0:e8fdba0ed044 16 #ifndef MBED_PORTOUT_H
gkroussos 0:e8fdba0ed044 17 #define MBED_PORTOUT_H
gkroussos 0:e8fdba0ed044 18
gkroussos 0:e8fdba0ed044 19 #include "platform.h"
gkroussos 0:e8fdba0ed044 20
gkroussos 0:e8fdba0ed044 21 #if DEVICE_PORTOUT
gkroussos 0:e8fdba0ed044 22
gkroussos 0:e8fdba0ed044 23 #include "port_api.h"
gkroussos 0:e8fdba0ed044 24
gkroussos 0:e8fdba0ed044 25 namespace mbed {
gkroussos 0:e8fdba0ed044 26 /** A multiple pin digital out
gkroussos 0:e8fdba0ed044 27 *
gkroussos 0:e8fdba0ed044 28 * Example:
gkroussos 0:e8fdba0ed044 29 * @code
gkroussos 0:e8fdba0ed044 30 * // Toggle all four LEDs
gkroussos 0:e8fdba0ed044 31 *
gkroussos 0:e8fdba0ed044 32 * #include "mbed.h"
gkroussos 0:e8fdba0ed044 33 *
gkroussos 0:e8fdba0ed044 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
gkroussos 0:e8fdba0ed044 35 * #define LED_MASK 0x00B40000
gkroussos 0:e8fdba0ed044 36 *
gkroussos 0:e8fdba0ed044 37 * PortOut ledport(Port1, LED_MASK);
gkroussos 0:e8fdba0ed044 38 *
gkroussos 0:e8fdba0ed044 39 * int main() {
gkroussos 0:e8fdba0ed044 40 * while(1) {
gkroussos 0:e8fdba0ed044 41 * ledport = LED_MASK;
gkroussos 0:e8fdba0ed044 42 * wait(1);
gkroussos 0:e8fdba0ed044 43 * ledport = 0;
gkroussos 0:e8fdba0ed044 44 * wait(1);
gkroussos 0:e8fdba0ed044 45 * }
gkroussos 0:e8fdba0ed044 46 * }
gkroussos 0:e8fdba0ed044 47 * @endcode
gkroussos 0:e8fdba0ed044 48 */
gkroussos 0:e8fdba0ed044 49 class PortOut {
gkroussos 0:e8fdba0ed044 50 public:
gkroussos 0:e8fdba0ed044 51
gkroussos 0:e8fdba0ed044 52 /** Create an PortOut, connected to the specified port
gkroussos 0:e8fdba0ed044 53 *
gkroussos 0:e8fdba0ed044 54 * @param port Port to connect to (Port0-Port5)
gkroussos 0:e8fdba0ed044 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
gkroussos 0:e8fdba0ed044 56 */
gkroussos 0:e8fdba0ed044 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
gkroussos 0:e8fdba0ed044 58 port_init(&_port, port, mask, PIN_OUTPUT);
gkroussos 0:e8fdba0ed044 59 }
gkroussos 0:e8fdba0ed044 60
gkroussos 0:e8fdba0ed044 61 /** Write the value to the output port
gkroussos 0:e8fdba0ed044 62 *
gkroussos 0:e8fdba0ed044 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
gkroussos 0:e8fdba0ed044 64 */
gkroussos 0:e8fdba0ed044 65 void write(int value) {
gkroussos 0:e8fdba0ed044 66 port_write(&_port, value);
gkroussos 0:e8fdba0ed044 67 }
gkroussos 0:e8fdba0ed044 68
gkroussos 0:e8fdba0ed044 69 /** Read the value currently output on the port
gkroussos 0:e8fdba0ed044 70 *
gkroussos 0:e8fdba0ed044 71 * @returns
gkroussos 0:e8fdba0ed044 72 * An integer with each bit corresponding to associated PortOut pin setting
gkroussos 0:e8fdba0ed044 73 */
gkroussos 0:e8fdba0ed044 74 int read() {
gkroussos 0:e8fdba0ed044 75 return port_read(&_port);
gkroussos 0:e8fdba0ed044 76 }
gkroussos 0:e8fdba0ed044 77
gkroussos 0:e8fdba0ed044 78 /** A shorthand for write()
gkroussos 0:e8fdba0ed044 79 */
gkroussos 0:e8fdba0ed044 80 PortOut& operator= (int value) {
gkroussos 0:e8fdba0ed044 81 write(value);
gkroussos 0:e8fdba0ed044 82 return *this;
gkroussos 0:e8fdba0ed044 83 }
gkroussos 0:e8fdba0ed044 84
gkroussos 0:e8fdba0ed044 85 PortOut& operator= (PortOut& rhs) {
gkroussos 0:e8fdba0ed044 86 write(rhs.read());
gkroussos 0:e8fdba0ed044 87 return *this;
gkroussos 0:e8fdba0ed044 88 }
gkroussos 0:e8fdba0ed044 89
gkroussos 0:e8fdba0ed044 90 /** A shorthand for read()
gkroussos 0:e8fdba0ed044 91 */
gkroussos 0:e8fdba0ed044 92 operator int() {
gkroussos 0:e8fdba0ed044 93 return read();
gkroussos 0:e8fdba0ed044 94 }
gkroussos 0:e8fdba0ed044 95
gkroussos 0:e8fdba0ed044 96 private:
gkroussos 0:e8fdba0ed044 97 port_t _port;
gkroussos 0:e8fdba0ed044 98 };
gkroussos 0:e8fdba0ed044 99
gkroussos 0:e8fdba0ed044 100 } // namespace mbed
gkroussos 0:e8fdba0ed044 101
gkroussos 0:e8fdba0ed044 102 #endif
gkroussos 0:e8fdba0ed044 103
gkroussos 0:e8fdba0ed044 104 #endif