|
WPILibC++
2020.3.2
|
Functions | |
| HAL_ENUM (HAL_SerialPort) | |
| HAL_SerialPortHandle | HAL_InitializeSerialPort (HAL_SerialPort port, int32_t *status) |
| Initializes a serial port. More... | |
| HAL_SerialPortHandle | HAL_InitializeSerialPortDirect (HAL_SerialPort port, const char *portName, int32_t *status) |
| Initializes a serial port with a direct name. More... | |
| int | HAL_GetSerialFD (HAL_SerialPortHandle handle, int32_t *status) |
| Gets the raw serial port file descriptor from a handle. More... | |
| void | HAL_SetSerialBaudRate (HAL_SerialPortHandle handle, int32_t baud, int32_t *status) |
| Sets the baud rate of a serial port. More... | |
| void | HAL_SetSerialDataBits (HAL_SerialPortHandle handle, int32_t bits, int32_t *status) |
| Sets the number of data bits on a serial port. More... | |
| void | HAL_SetSerialParity (HAL_SerialPortHandle handle, int32_t parity, int32_t *status) |
| Sets the number of parity bits on a serial port. More... | |
| void | HAL_SetSerialStopBits (HAL_SerialPortHandle handle, int32_t stopBits, int32_t *status) |
| Sets the number of stop bits on a serial port. More... | |
| void | HAL_SetSerialWriteMode (HAL_SerialPortHandle handle, int32_t mode, int32_t *status) |
| Sets the write mode on a serial port. More... | |
| void | HAL_SetSerialFlowControl (HAL_SerialPortHandle handle, int32_t flow, int32_t *status) |
| Sets the flow control mode of a serial port. More... | |
| void | HAL_SetSerialTimeout (HAL_SerialPortHandle handle, double timeout, int32_t *status) |
| Sets the minimum serial read timeout of a port. More... | |
| void | HAL_EnableSerialTermination (HAL_SerialPortHandle handle, char terminator, int32_t *status) |
| Sets the termination character that terminates a read. More... | |
| void | HAL_DisableSerialTermination (HAL_SerialPortHandle handle, int32_t *status) |
| Disables a termination character for reads. More... | |
| void | HAL_SetSerialReadBufferSize (HAL_SerialPortHandle handle, int32_t size, int32_t *status) |
| Sets the size of the read buffer. More... | |
| void | HAL_SetSerialWriteBufferSize (HAL_SerialPortHandle handle, int32_t size, int32_t *status) |
| Sets the size of the write buffer. More... | |
| int32_t | HAL_GetSerialBytesReceived (HAL_SerialPortHandle handle, int32_t *status) |
| Gets the number of bytes currently in the read buffer. More... | |
| int32_t | HAL_ReadSerial (HAL_SerialPortHandle handle, char *buffer, int32_t count, int32_t *status) |
| Reads data from the serial port. More... | |
| int32_t | HAL_WriteSerial (HAL_SerialPortHandle handle, const char *buffer, int32_t count, int32_t *status) |
| Writes data to the serial port. More... | |
| void | HAL_FlushSerial (HAL_SerialPortHandle handle, int32_t *status) |
| Flushes the serial write buffer out to the port. More... | |
| void | HAL_ClearSerial (HAL_SerialPortHandle handle, int32_t *status) |
| Clears the receive buffer of the serial port. More... | |
| void | HAL_CloseSerial (HAL_SerialPortHandle handle, int32_t *status) |
| Closes a serial port. More... | |
| void HAL_ClearSerial | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Clears the receive buffer of the serial port.
| handle | the serial port handle |
| void HAL_CloseSerial | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Closes a serial port.
| handle | the serial port handle to close |
| void HAL_DisableSerialTermination | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Disables a termination character for reads.
| handle | the serial port handle |
| void HAL_EnableSerialTermination | ( | HAL_SerialPortHandle | handle, |
| char | terminator, | ||
| int32_t * | status | ||
| ) |
Sets the termination character that terminates a read.
By default this is disabled.
| handle | the serial port handle |
| terminator | the termination character to set |
| void HAL_FlushSerial | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Flushes the serial write buffer out to the port.
| handle | the serial port handle |
| int32_t HAL_GetSerialBytesReceived | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Gets the number of bytes currently in the read buffer.
| handle | the serial port handle |
| int HAL_GetSerialFD | ( | HAL_SerialPortHandle | handle, |
| int32_t * | status | ||
| ) |
Gets the raw serial port file descriptor from a handle.
| handle | the serial port handle |
| HAL_SerialPortHandle HAL_InitializeSerialPort | ( | HAL_SerialPort | port, |
| int32_t * | status | ||
| ) |
Initializes a serial port.
The channels are either the onboard RS232, the mxp uart, or 2 USB ports. The top port is USB1, the bottom port is USB2.
| port | the serial port to initialize |
| HAL_SerialPortHandle HAL_InitializeSerialPortDirect | ( | HAL_SerialPort | port, |
| const char * | portName, | ||
| int32_t * | status | ||
| ) |
Initializes a serial port with a direct name.
This name is the /dev name for a specific port. Note these are not always consistent between roboRIO reboots.
| port | the serial port to initialize |
| portName | the dev port name |
| int32_t HAL_ReadSerial | ( | HAL_SerialPortHandle | handle, |
| char * | buffer, | ||
| int32_t | count, | ||
| int32_t * | status | ||
| ) |
Reads data from the serial port.
Will wait for either timeout (if set), the termination char (if set), or the count to be full. Whichever one comes first.
| handle | the serial port handle |
| count | the number of bytes maximum to read |
| void HAL_SetSerialBaudRate | ( | HAL_SerialPortHandle | handle, |
| int32_t | baud, | ||
| int32_t * | status | ||
| ) |
Sets the baud rate of a serial port.
Any value between 0 and 0xFFFFFFFF may be used. Default is 9600.
| handle | the serial port handle |
| baud | the baud rate to set |
| void HAL_SetSerialDataBits | ( | HAL_SerialPortHandle | handle, |
| int32_t | bits, | ||
| int32_t * | status | ||
| ) |
Sets the number of data bits on a serial port.
Defaults to 8.
| handle | the serial port handle |
| bits | the number of data bits (5-8) |
| void HAL_SetSerialFlowControl | ( | HAL_SerialPortHandle | handle, |
| int32_t | flow, | ||
| int32_t * | status | ||
| ) |
Sets the flow control mode of a serial port.
Valid values are: 0: None (default) 1: XON-XOFF 2: RTS-CTS 3: DTR-DSR
| handle | the serial port handle |
| flow | the mode to set (see remarks for valid values) |
| void HAL_SetSerialParity | ( | HAL_SerialPortHandle | handle, |
| int32_t | parity, | ||
| int32_t * | status | ||
| ) |
Sets the number of parity bits on a serial port.
Valid values are: 0: None (default) 1: Odd 2: Even 3: Mark - Means exists and always 1 4: Space - Means exists and always 0
| handle | the serial port handle |
| parity | the parity bit mode (see remarks for valid values) |
| void HAL_SetSerialReadBufferSize | ( | HAL_SerialPortHandle | handle, |
| int32_t | size, | ||
| int32_t * | status | ||
| ) |
Sets the size of the read buffer.
| handle | the serial port handle |
| size | the read buffer size |
| void HAL_SetSerialStopBits | ( | HAL_SerialPortHandle | handle, |
| int32_t | stopBits, | ||
| int32_t * | status | ||
| ) |
Sets the number of stop bits on a serial port.
Valid values are: 10: One stop bit (default) 15: One and a half stop bits 20: Two stop bits
| handle | the serial port handle |
| stopBits | the stop bit value (see remarks for valid values) |
| void HAL_SetSerialTimeout | ( | HAL_SerialPortHandle | handle, |
| double | timeout, | ||
| int32_t * | status | ||
| ) |
Sets the minimum serial read timeout of a port.
| handle | the serial port handle |
| timeout | the timeout in milliseconds |
| void HAL_SetSerialWriteBufferSize | ( | HAL_SerialPortHandle | handle, |
| int32_t | size, | ||
| int32_t * | status | ||
| ) |
Sets the size of the write buffer.
| handle | the serial port handle |
| size | the write buffer size |
| void HAL_SetSerialWriteMode | ( | HAL_SerialPortHandle | handle, |
| int32_t | mode, | ||
| int32_t * | status | ||
| ) |
Sets the write mode on a serial port.
Valid values are: 1: Flush on access 2: Flush when full (default)
| handle | the serial port handle |
| mode | the mode to set (see remarks for valid values) |
| int32_t HAL_WriteSerial | ( | HAL_SerialPortHandle | handle, |
| const char * | buffer, | ||
| int32_t | count, | ||
| int32_t * | status | ||
| ) |
Writes data to the serial port.
| handle | the serial port handle |
| buffer | the buffer to write |
| count | the number of bytes to write from the buffer |