|
WPILibC++
2020.3.2
|
Classes | |
| struct | HAL_CANStreamMessage |
| Storage for CAN Stream Messages. More... | |
Functions | |
| void | HAL_CAN_SendMessage (uint32_t messageID, const uint8_t *data, uint8_t dataSize, int32_t periodMs, int32_t *status) |
| Sends a CAN message. More... | |
| void | HAL_CAN_ReceiveMessage (uint32_t *messageID, uint32_t messageIDMask, uint8_t *data, uint8_t *dataSize, uint32_t *timeStamp, int32_t *status) |
| Receives a CAN message. More... | |
| void | HAL_CAN_OpenStreamSession (uint32_t *sessionHandle, uint32_t messageID, uint32_t messageIDMask, uint32_t maxMessages, int32_t *status) |
| Opens a CAN stream. More... | |
| void | HAL_CAN_CloseStreamSession (uint32_t sessionHandle) |
| Closes a CAN stream. More... | |
| void | HAL_CAN_ReadStreamSession (uint32_t sessionHandle, struct HAL_CANStreamMessage *messages, uint32_t messagesToRead, uint32_t *messagesRead, int32_t *status) |
| Reads a CAN stream message. More... | |
| void | HAL_CAN_GetCANStatus (float *percentBusUtilization, uint32_t *busOffCount, uint32_t *txFullCount, uint32_t *receiveErrorCount, uint32_t *transmitErrorCount, int32_t *status) |
| Gets CAN status information. More... | |
| void HAL_CAN_CloseStreamSession | ( | uint32_t | sessionHandle | ) |
Closes a CAN stream.
| sessionHandle | the session to close |
| void HAL_CAN_GetCANStatus | ( | float * | percentBusUtilization, |
| uint32_t * | busOffCount, | ||
| uint32_t * | txFullCount, | ||
| uint32_t * | receiveErrorCount, | ||
| uint32_t * | transmitErrorCount, | ||
| int32_t * | status | ||
| ) |
Gets CAN status information.
| percentBusUtilization | the bus utilization |
| busOffCount | the number of bus off errors |
| txFullCount | the number of tx full errors |
| receiveErrorCount | the number of receive errors |
| transmitErrorCount | the number of transmit errors |
| void HAL_CAN_OpenStreamSession | ( | uint32_t * | sessionHandle, |
| uint32_t | messageID, | ||
| uint32_t | messageIDMask, | ||
| uint32_t | maxMessages, | ||
| int32_t * | status | ||
| ) |
Opens a CAN stream.
| sessionHandle | output for the session handle |
| messageID | the message ID to read |
| messageIDMask | the mssage ID mask |
| maxMessages | the maximum number of messages to stream |
| void HAL_CAN_ReadStreamSession | ( | uint32_t | sessionHandle, |
| struct HAL_CANStreamMessage * | messages, | ||
| uint32_t | messagesToRead, | ||
| uint32_t * | messagesRead, | ||
| int32_t * | status | ||
| ) |
Reads a CAN stream message.
| sessionHandle | the session handle |
| messages | array of messages |
| messagesToRead | the max number of messages to read |
| messageRead | the number of messages actually read |
| void HAL_CAN_ReceiveMessage | ( | uint32_t * | messageID, |
| uint32_t | messageIDMask, | ||
| uint8_t * | data, | ||
| uint8_t * | dataSize, | ||
| uint32_t * | timeStamp, | ||
| int32_t * | status | ||
| ) |
Receives a CAN message.
| messageID | store for the received message ID |
| messageIDMask | the message ID mask to look for |
| data | data output (8 bytes) |
| dataSize | data length (0-8 bytes) |
| timeStamp | the packet received timestamp (based off of CLOCK_MONOTONIC) |
| void HAL_CAN_SendMessage | ( | uint32_t | messageID, |
| const uint8_t * | data, | ||
| uint8_t | dataSize, | ||
| int32_t | periodMs, | ||
| int32_t * | status | ||
| ) |
Sends a CAN message.
| messageID | the CAN ID to send |
| data | the data to send (0-8 bytes) |
| dataSize | the size of the data to send (0-8 bytes) |
| periodMs | the period to repeat the packet at. Use HAL_CAN_SEND_PERIOD_NO_REPEAT to not repeat. |