George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/PortOut.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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