Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

RawSerial.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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