|
ClearCore Library
|
ClearCore XBee Interface. More...
#include <XBeeDriver.h>
Inheritance diagram for ClearCore::XBeeDriver: Collaboration diagram for ClearCore::XBeeDriver:Additional Inherited Members | |
| Public Types inherited from ClearCore::SerialBase | |
| enum | DataOrders { COM_MSB_FIRST = 0, COM_LSB_FIRST = 1 } |
| enum | PortModes { UART, SPI } |
| enum | SpiClockPolarities { SCK_LOW = 0, SCK_HIGH } |
| enum | SpiClockPhases { LEAD_SAMPLE = 0, LEAD_CHANGE } |
| enum | CtrlLineModes { LINE_OFF, LINE_ON, LINE_HW } |
| Public Types inherited from ClearCore::ISerial | |
| enum | _Parities { PARITY_E = 0, PARITY_O, PARITY_N } |
| typedef enum ClearCore::ISerial::_Parities | Parities |
| Public Member Functions inherited from ClearCore::SerialBase | |
| bool | PortMode (PortModes newMode) |
| Setup the port mode. More... | |
| void | Flush () override |
| void | FlushInput () override |
| virtual void | PortOpen () override |
| virtual void | PortClose () override |
| virtual bool | Speed (uint32_t bitsPerSecond) override |
| Change the baud rate for the port. More... | |
| virtual uint32_t | Speed () override |
| Gets the baud rate of the port. More... | |
| int16_t | CharGet () override |
| Attempt to read the next character from serial channel. More... | |
| int16_t | CharPeek () override |
| Attempt to get the next character from the serial channel without pulling the character out of the buffer. More... | |
| bool | SendChar (uint8_t charToSend) override |
| Send an ascii character on the serial channel. More... | |
| int32_t | AvailableForRead () override |
| int32_t | AvailableForWrite () override |
| Determines the number of characters available in the transmit buffer. More... | |
| void | WaitForTransmitIdle () override |
| bool | PortIsOpen () override |
| Return whether or not the port is open. More... | |
| void | FlowControl (bool useFlowControl) |
| Set UART CTS/RTS flow control. More... | |
| bool | FlowControl () |
| Return whether UART CTS/RTS flow control is enabled. More... | |
| bool | RtsMode (CtrlLineModes mode) |
| Change the serial RTS mode. More... | |
| bool | CtsState () |
| Read the serial CTS state. More... | |
| void | SerialBreak (bool enable) |
| Initiate a Serial Break. More... | |
| bool | Parity (Parities newParity) override |
| Set UART transmission parity format. More... | |
| Parities | Parity () override |
| Return current port UART transmission format. More... | |
| bool | StopBits (uint8_t bits) override |
| bool | CharSize (uint8_t size) override |
| Change the number of bits in a character. More... | |
| void | SpiClock (SpiClockPolarities polarity, SpiClockPhases phase) |
| Change the polarity and phase for the SPI clock. More... | |
| bool | SpiSsMode (CtrlLineModes mode) |
| Change the SPI Slave Select mode. More... | |
| uint8_t | SpiTransferData (uint8_t data) |
| int32_t | SpiTransferData (uint8_t const *writeBuf, uint8_t *readBuf, int32_t len) |
| SPI's multi-byte transmit and receive function. More... | |
| bool | SpiTransferDataAsync (uint8_t const *writeBuf, uint8_t *readBuf, int32_t len) |
| SPI's asynchronous multi-byte transmit and receive function. More... | |
| bool | SpiAsyncWaitComplete () |
| Block until asynchronous transfers are completed. More... | |
| void | DataOrder (DataOrders newOrder) |
| Change the data order for the port. More... | |
| void | HandleFrameError () |
| void | HandleParityError () |
| void | HandleOverflow () |
| SerialErrorStatusRegister | ErrorStatusAccum (SerialErrorStatusRegister mask=UINT32_MAX) |
| Accumulating clear on read accessor for any error status bits that were asserted sometime since the previous invocation of this function. More... | |
| Public Member Functions inherited from ClearCore::ISerial | |
| bool | SendLine () |
| Send carriage return and newline characters. More... | |
| bool | Send (const char *buffer, size_t bufferSize) |
| Send the array of characters out the port. More... | |
| bool | SendLine (const char *buffer, size_t bufferSize) |
| Send the array of characters out the port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (const char *nullTermStr) |
| Send a string of characters out the port. More... | |
| bool | SendLine (const char *nullTermStr) |
| Send a string of characters out the port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (char theChar) |
| Send a character to be printed to the serial port. More... | |
| bool | SendLine (char theChar) |
| Send a character to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (double number, uint8_t precision=2) |
| Send a floating point number to the serial port. More... | |
| bool | SendLine (double number, uint8_t precision=2) |
| Send a floating point number to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (int8_t number, uint8_t radix=10) |
| Send an 8-bit signed number to be printed to the serial port. More... | |
| bool | SendLine (int8_t number, uint8_t radix=10) |
| Send an 8-bit signed number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (uint8_t number, uint8_t radix=10) |
| Send an 8-bit unsigned number to be printed to the serial port. More... | |
| bool | SendLine (uint8_t number, uint8_t radix=10) |
| Send an 8-bit unsigned number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (int16_t number, uint8_t radix=10) |
| Send a 16-bit signed number to be printed to the serial port. More... | |
| bool | SendLine (int16_t number, uint8_t radix=10) |
| Send a 16-bit signed number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (uint16_t number, uint8_t radix=10) |
| Send a 16-bit unsigned number to be printed to the serial port. More... | |
| bool | SendLine (uint16_t number, uint8_t radix=10) |
| Send a 16-bit unsigned number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (int32_t number, uint8_t radix=10) |
| Send a 32-bit signed number to be printed to the serial port. More... | |
| bool | SendLine (int32_t number, uint8_t radix=10) |
| Send a 32-bit signed number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (uint32_t number, uint8_t radix=10) |
| Send a 32-bit unsigned number to be printed to the serial port. More... | |
| bool | SendLine (uint32_t number, uint8_t radix=10) |
| Send a 32-bit unsigned number to be printed to the serial port. Terminate the line with carriage return and newline characters. More... | |
| bool | Send (int number, uint8_t radix=10) |
| Send an integer to be printed to the serial port. More... | |
| bool | SendLine (int number, uint8_t radix=10) |
| Send an integer to be printed to the serial port. More... | |
| virtual | operator bool ()=0 |
| Static Public Attributes inherited from ClearCore::SerialBase | |
| static const int16_t | BREAK_DETECTED = int16_t(0xBDBD) |
| static const int16_t | EOB = -1 |
1.8.11
