Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/RawSerial.h@5:7e5c566b1760, 2017-10-07 (annotated)

Committer:
Pokitto
Date:
Sat Oct 07 21:31:12 2017 +0000
Revision:
5:7e5c566b1760
mbed-pokitto integrated

Who changed what in which revision?

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