Yihui Xiong / BLE_NODE_TEST

Test code for Grove Node BLE

Dependencies:   BLE_API nRF51822

Fork of BLE_LoopbackUART by Bluetooth Low Energy

mbed-src/api/RawSerial.h@10:22480ac31879, 2014-11-27 (annotated)

Committer:
yihui
Date:
Thu Nov 27 09:30:36 2014 +0000
Revision:
10:22480ac31879
Parent:
9:05f0b5a3a70a 
change to new revision hardware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yihui 9:05f0b5a3a70a 1 /* mbed Microcontroller Library
yihui 9:05f0b5a3a70a 2 * Copyright (c) 2006-2013 ARM Limited
yihui 9:05f0b5a3a70a 3 *
yihui 9:05f0b5a3a70a 4 * Licensed under the Apache License, Version 2.0 (the "License");
yihui 9:05f0b5a3a70a 5 * you may not use this file except in compliance with the License.
yihui 9:05f0b5a3a70a 6 * You may obtain a copy of the License at
yihui 9:05f0b5a3a70a 7 *
yihui 9:05f0b5a3a70a 8 * http://www.apache.org/licenses/LICENSE-2.0
yihui 9:05f0b5a3a70a 9 *
yihui 9:05f0b5a3a70a 10 * Unless required by applicable law or agreed to in writing, software
yihui 9:05f0b5a3a70a 11 * distributed under the License is distributed on an "AS IS" BASIS,
yihui 9:05f0b5a3a70a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
yihui 9:05f0b5a3a70a 13 * See the License for the specific language governing permissions and
yihui 9:05f0b5a3a70a 14 * limitations under the License.
yihui 9:05f0b5a3a70a 15 */
yihui 9:05f0b5a3a70a 16 #ifndef MBED_RAW_SERIAL_H
yihui 9:05f0b5a3a70a 17 #define MBED_RAW_SERIAL_H
yihui 9:05f0b5a3a70a 18
yihui 9:05f0b5a3a70a 19 #include "platform.h"
yihui 9:05f0b5a3a70a 20
yihui 9:05f0b5a3a70a 21 #if DEVICE_SERIAL
yihui 9:05f0b5a3a70a 22
yihui 9:05f0b5a3a70a 23 #include "SerialBase.h"
yihui 9:05f0b5a3a70a 24 #include "serial_api.h"
yihui 9:05f0b5a3a70a 25
yihui 9:05f0b5a3a70a 26 namespace mbed {
yihui 9:05f0b5a3a70a 27
yihui 9:05f0b5a3a70a 28 /** A serial port (UART) for communication with other serial devices
yihui 9:05f0b5a3a70a 29 * This is a variation of the Serial class that doesn't use streams,
yihui 9:05f0b5a3a70a 30 * thus making it safe to use in interrupt handlers with the RTOS.
yihui 9:05f0b5a3a70a 31 *
yihui 9:05f0b5a3a70a 32 * Can be used for Full Duplex communication, or Simplex by specifying
yihui 9:05f0b5a3a70a 33 * one pin as NC (Not Connected)
yihui 9:05f0b5a3a70a 34 *
yihui 9:05f0b5a3a70a 35 * Example:
yihui 9:05f0b5a3a70a 36 * @code
yihui 9:05f0b5a3a70a 37 * // Send a char to the PC
yihui 9:05f0b5a3a70a 38 *
yihui 9:05f0b5a3a70a 39 * #include "mbed.h"
yihui 9:05f0b5a3a70a 40 *
yihui 9:05f0b5a3a70a 41 * RawSerial pc(USBTX, USBRX);
yihui 9:05f0b5a3a70a 42 *
yihui 9:05f0b5a3a70a 43 * int main() {
yihui 9:05f0b5a3a70a 44 * pc.putc('A');
yihui 9:05f0b5a3a70a 45 * }
yihui 9:05f0b5a3a70a 46 * @endcode
yihui 9:05f0b5a3a70a 47 */
yihui 9:05f0b5a3a70a 48 class RawSerial: public SerialBase {
yihui 9:05f0b5a3a70a 49
yihui 9:05f0b5a3a70a 50 public:
yihui 9:05f0b5a3a70a 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
yihui 9:05f0b5a3a70a 52 *
yihui 9:05f0b5a3a70a 53 * @param tx Transmit pin
yihui 9:05f0b5a3a70a 54 * @param rx Receive pin
yihui 9:05f0b5a3a70a 55 *
yihui 9:05f0b5a3a70a 56 * @note
yihui 9:05f0b5a3a70a 57 * Either tx or rx may be specified as NC if unused
yihui 9:05f0b5a3a70a 58 */
yihui 9:05f0b5a3a70a 59 RawSerial(PinName tx, PinName rx);
yihui 9:05f0b5a3a70a 60
yihui 9:05f0b5a3a70a 61 /** Write a char to the serial port
yihui 9:05f0b5a3a70a 62 *
yihui 9:05f0b5a3a70a 63 * @param c The char to write
yihui 9:05f0b5a3a70a 64 *
yihui 9:05f0b5a3a70a 65 * @returns The written char or -1 if an error occured
yihui 9:05f0b5a3a70a 66 */
yihui 9:05f0b5a3a70a 67 int putc(int c);
yihui 9:05f0b5a3a70a 68
yihui 9:05f0b5a3a70a 69 /** Read a char from the serial port
yihui 9:05f0b5a3a70a 70 *
yihui 9:05f0b5a3a70a 71 * @returns The char read from the serial port
yihui 9:05f0b5a3a70a 72 */
yihui 9:05f0b5a3a70a 73 int getc();
yihui 9:05f0b5a3a70a 74
yihui 9:05f0b5a3a70a 75 /** Write a string to the serial port
yihui 9:05f0b5a3a70a 76 *
yihui 9:05f0b5a3a70a 77 * @param str The string to write
yihui 9:05f0b5a3a70a 78 *
yihui 9:05f0b5a3a70a 79 * @returns 0 if the write succeeds, EOF for error
yihui 9:05f0b5a3a70a 80 */
yihui 9:05f0b5a3a70a 81 int puts(const char *str);
yihui 9:05f0b5a3a70a 82
yihui 9:05f0b5a3a70a 83 int printf(const char *format, ...);
yihui 9:05f0b5a3a70a 84 };
yihui 9:05f0b5a3a70a 85
yihui 9:05f0b5a3a70a 86 } // namespace mbed
yihui 9:05f0b5a3a70a 87
yihui 9:05f0b5a3a70a 88 #endif
yihui 9:05f0b5a3a70a 89
yihui 9:05f0b5a3a70a 90 #endif