George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/RawSerial.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_RAW_SERIAL_H
gkroussos 0:dd0fea342ad2 17 #define MBED_RAW_SERIAL_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "platform.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 #if DEVICE_SERIAL
gkroussos 0:dd0fea342ad2 22
gkroussos 0:dd0fea342ad2 23 #include "SerialBase.h"
gkroussos 0:dd0fea342ad2 24 #include "serial_api.h"
gkroussos 0:dd0fea342ad2 25
gkroussos 0:dd0fea342ad2 26 namespace mbed {
gkroussos 0:dd0fea342ad2 27
gkroussos 0:dd0fea342ad2 28 /** A serial port (UART) for communication with other serial devices
gkroussos 0:dd0fea342ad2 29 * This is a variation of the Serial class that doesn't use streams,
gkroussos 0:dd0fea342ad2 30 * thus making it safe to use in interrupt handlers with the RTOS.
gkroussos 0:dd0fea342ad2 31 *
gkroussos 0:dd0fea342ad2 32 * Can be used for Full Duplex communication, or Simplex by specifying
gkroussos 0:dd0fea342ad2 33 * one pin as NC (Not Connected)
gkroussos 0:dd0fea342ad2 34 *
gkroussos 0:dd0fea342ad2 35 * Example:
gkroussos 0:dd0fea342ad2 36 * @code
gkroussos 0:dd0fea342ad2 37 * // Send a char to the PC
gkroussos 0:dd0fea342ad2 38 *
gkroussos 0:dd0fea342ad2 39 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 40 *
gkroussos 0:dd0fea342ad2 41 * RawSerial pc(USBTX, USBRX);
gkroussos 0:dd0fea342ad2 42 *
gkroussos 0:dd0fea342ad2 43 * int main() {
gkroussos 0:dd0fea342ad2 44 * pc.putc('A');
gkroussos 0:dd0fea342ad2 45 * }
gkroussos 0:dd0fea342ad2 46 * @endcode
gkroussos 0:dd0fea342ad2 47 */
gkroussos 0:dd0fea342ad2 48 class RawSerial: public SerialBase {
gkroussos 0:dd0fea342ad2 49
gkroussos 0:dd0fea342ad2 50 public:
gkroussos 0:dd0fea342ad2 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
gkroussos 0:dd0fea342ad2 52 *
gkroussos 0:dd0fea342ad2 53 * @param tx Transmit pin
gkroussos 0:dd0fea342ad2 54 * @param rx Receive pin
gkroussos 0:dd0fea342ad2 55 *
gkroussos 0:dd0fea342ad2 56 * @note
gkroussos 0:dd0fea342ad2 57 * Either tx or rx may be specified as NC if unused
gkroussos 0:dd0fea342ad2 58 */
gkroussos 0:dd0fea342ad2 59 RawSerial(PinName tx, PinName rx);
gkroussos 0:dd0fea342ad2 60
gkroussos 0:dd0fea342ad2 61 /** Write a char to the serial port
gkroussos 0:dd0fea342ad2 62 *
gkroussos 0:dd0fea342ad2 63 * @param c The char to write
gkroussos 0:dd0fea342ad2 64 *
gkroussos 0:dd0fea342ad2 65 * @returns The written char or -1 if an error occured
gkroussos 0:dd0fea342ad2 66 */
gkroussos 0:dd0fea342ad2 67 int putc(int c);
gkroussos 0:dd0fea342ad2 68
gkroussos 0:dd0fea342ad2 69 /** Read a char from the serial port
gkroussos 0:dd0fea342ad2 70 *
gkroussos 0:dd0fea342ad2 71 * @returns The char read from the serial port
gkroussos 0:dd0fea342ad2 72 */
gkroussos 0:dd0fea342ad2 73 int getc();
gkroussos 0:dd0fea342ad2 74
gkroussos 0:dd0fea342ad2 75 /** Write a string to the serial port
gkroussos 0:dd0fea342ad2 76 *
gkroussos 0:dd0fea342ad2 77 * @param str The string to write
gkroussos 0:dd0fea342ad2 78 *
gkroussos 0:dd0fea342ad2 79 * @returns 0 if the write succeeds, EOF for error
gkroussos 0:dd0fea342ad2 80 */
gkroussos 0:dd0fea342ad2 81 int puts(const char *str);
gkroussos 0:dd0fea342ad2 82
gkroussos 0:dd0fea342ad2 83 int printf(const char *format, ...);
gkroussos 0:dd0fea342ad2 84 };
gkroussos 0:dd0fea342ad2 85
gkroussos 0:dd0fea342ad2 86 } // namespace mbed
gkroussos 0:dd0fea342ad2 87
gkroussos 0:dd0fea342ad2 88 #endif
gkroussos 0:dd0fea342ad2 89
gkroussos 0:dd0fea342ad2 90 #endif