WPILibC++  unspecified
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
SerialPort.h
1 /*----------------------------------------------------------------------------*/
2 /* Copyright (c) FIRST 2008-2017. All Rights Reserved. */
3 /* Open Source Software - may be modified and shared by FRC teams. The code */
4 /* must be accompanied by the FIRST BSD license file in the root directory of */
5 /* the project. */
6 /*----------------------------------------------------------------------------*/
7 
8 #pragma once
9 
10 #include <string>
11 
12 #include "ErrorBase.h"
13 #include "llvm/StringRef.h"
14 
15 namespace frc {
16 
29 class SerialPort : public ErrorBase {
30  public:
31  enum Parity {
32  kParity_None = 0,
33  kParity_Odd = 1,
34  kParity_Even = 2,
35  kParity_Mark = 3,
36  kParity_Space = 4
37  };
38  enum StopBits {
39  kStopBits_One = 10,
40  kStopBits_OnePointFive = 15,
41  kStopBits_Two = 20
42  };
43  enum FlowControl {
44  kFlowControl_None = 0,
45  kFlowControl_XonXoff = 1,
46  kFlowControl_RtsCts = 2,
47  kFlowControl_DtrDsr = 4
48  };
49  enum WriteBufferMode { kFlushOnAccess = 1, kFlushWhenFull = 2 };
50  enum Port { kOnboard = 0, kMXP = 1, kUSB = 2, kUSB1 = 2, kUSB2 = 3 };
51 
52  SerialPort(int baudRate, Port port = kOnboard, int dataBits = 8,
53  Parity parity = kParity_None, StopBits stopBits = kStopBits_One);
54  ~SerialPort();
55 
56  SerialPort(const SerialPort&) = delete;
57  SerialPort& operator=(const SerialPort&) = delete;
58 
59  void SetFlowControl(FlowControl flowControl);
60  void EnableTermination(char terminator = '\n');
61  void DisableTermination();
62  int GetBytesReceived();
63  int Read(char* buffer, int count);
64  int Write(const char* buffer, int count);
65  int Write(llvm::StringRef buffer);
66  void SetTimeout(double timeout);
67  void SetReadBufferSize(int size);
68  void SetWriteBufferSize(int size);
69  void SetWriteBufferMode(WriteBufferMode mode);
70  void Flush();
71  void Reset();
72 
73  private:
74  int m_resourceManagerHandle = 0;
75  int m_portHandle = 0;
76  bool m_consoleModeEnabled = false;
77  int m_port;
78 };
79 
80 } // namespace frc
void SetWriteBufferSize(int size)
Specify the size of the output buffer.
Definition: SerialPort.cpp:207
void Reset()
Reset the serial port driver to a known state.
Definition: SerialPort.cpp:248
void Flush()
Force the output buffer to be written to the port.
Definition: SerialPort.cpp:237
void SetTimeout(double timeout)
Configure the timeout of the serial port.
Definition: SerialPort.cpp:174
SerialPort(int baudRate, Port port=kOnboard, int dataBits=8, Parity parity=kParity_None, StopBits stopBits=kStopBits_One)
Create an instance of a Serial Port class.
Definition: SerialPort.cpp:29
void SetFlowControl(FlowControl flowControl)
Set the type of flow control to enable on this port.
Definition: SerialPort.cpp:78
Driver for the RS-232 serial port on the roboRIO.
Definition: SerialPort.h:29
void SetReadBufferSize(int size)
Specify the size of the input buffer.
Definition: SerialPort.cpp:192
int Write(const char *buffer, int count)
Write raw bytes to the buffer.
Definition: SerialPort.cpp:145
void DisableTermination()
Disable termination behavior.
Definition: SerialPort.cpp:104
Base class for most objects.
Definition: ErrorBase.h:72
int GetBytesReceived()
Get the number of bytes currently available to read from the serial port.
Definition: SerialPort.cpp:115
~SerialPort()
Destructor.
Definition: SerialPort.cpp:67
void SetWriteBufferMode(WriteBufferMode mode)
Specify the flushing behavior of the output buffer.
Definition: SerialPort.cpp:225
void EnableTermination(char terminator= '\n')
Enable termination and specify the termination character.
Definition: SerialPort.cpp:94
int Read(char *buffer, int count)
Read raw bytes out of the buffer.
Definition: SerialPort.cpp:130