ctre::phoenix::platform::can Namespace Reference

Classes
struct	canframe_t
	"plain old data" container for holding a CAN Frame Event. More...
struct	canbus_status_t
	Information about the status of a CAN bus. More...

Enumerations
enum class	can_state_t : int {   ERROR_ACTIVE = 0 , ERROR_WARNING , ERROR_PASSIVE , BUS_OFF ,   STOPPED , SLEEPING }

Functions
CTREXPORT int32_t	RegisterCANbus (char const *canbus, bool printErr=true)
CTREXPORT std::string	GetCANivoreDevName (char const *canbus)
CTREXPORT std::vector< std::string >	GetCANbusList (void)
CTREXPORT int32_t	CANbus_GetStatus (canbus_status_t &status, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANbus_SendFrame (uint32_t messageID, uint8_t const *data, uint8_t dataSize, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_SendMessage (uint32_t messageID, uint8_t const *data, uint8_t dataSize, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_SendPeriodicMessage (uint32_t messageID, uint8_t const *data, uint8_t dataSize, int32_t periodMs, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_StopPeriodicMessage (uint32_t messageID, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_ReceiveMessage (uint32_t messageID, canframe_t &frame, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_WaitForMessages (std::unordered_set< uint32_t > const &messageIDs, uint16_t timeoutMs, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_OpenStreamSession (uint32_t *sessionHandle, uint32_t messageID, uint32_t messageIDMask, uint32_t maxMessages, char const *canbus, bool printErr=true)
CTREXPORT void	CANComm_CloseStreamSession (uint32_t sessionHandle, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_ReadStreamSession (uint32_t sessionHandle, canframe_t *messages, uint32_t messagesToRead, uint32_t *messagesRead, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_GetTxSchedulerStatus (char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_SetRxSchedPriority (int priority, bool useRoundRobin, char const *canbus, bool printErr=true)
CTREXPORT int32_t	CANComm_SetTxSchedPriority (int priority, bool useRoundRobin, char const *canbus, bool printErr=true)
CTREXPORT StatusCode	Network_GetLastTx (char const *canbus, uint32_t arbId, canframe_t &frame)
CTREXPORT bool	Network_ChangeTxPeriod (char const *canbus, uint32_t arbId, int32_t periodMs)
CTREXPORT StatusCode	Network_SendTxFrame (char const *canbus, canframe_t const &frame)
CTREXPORT StatusCode	Network_SendPeriodicTxFrame (char const *canbus, canframe_t const &frame, int32_t periodMs)
CTREXPORT StatusCode	Network_UpdatePeriodicTxFrame (char const *canbus, canframe_t const &frame)
CTREXPORT StatusCode	Network_StopPeriodicTxFrame (char const *canbus, uint32_t arbId)
CTREXPORT StatusCode	Network_GetRxFrame (char const *canbus, uint32_t arbId, canframe_t &frame, uint32_t timeoutMs)
CTREXPORT StatusCode	Network_WaitForRxFrames (char const *canbus, std::unordered_set< uint32_t > const &arbIds, uint16_t timeoutMs)
CTREXPORT StatusCode	Network_SetEnableSignalSchedPriority (int priority, bool useRoundRobin)

Enumeration Type Documentation

can_state_t

enum class ctre::phoenix::platform::can::can_state_t : int

strong

Enumerator
ERROR_ACTIVE
ERROR_WARNING
ERROR_PASSIVE
BUS_OFF
STOPPED
SLEEPING

Function Documentation

CANbus_GetStatus()

CTREXPORT int32_t ctre::phoenix::platform::can::CANbus_GetStatus	(	canbus_status_t &	status,
		char const *	canbus,
		bool	printErr = true )

CANbus_SendFrame()

CTREXPORT int32_t ctre::phoenix::platform::can::CANbus_SendFrame	(	uint32_t	messageID,
		uint8_t const *	data,
		uint8_t	dataSize,
		char const *	canbus,
		bool	printErr = true )

CANComm_CloseStreamSession()

CTREXPORT void ctre::phoenix::platform::can::CANComm_CloseStreamSession	(	uint32_t	sessionHandle,
		char const *	canbus,
		bool	printErr = true )

CANComm_GetTxSchedulerStatus()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_GetTxSchedulerStatus	(	char const *	canbus,
		bool	printErr = true )

CANComm_OpenStreamSession()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_OpenStreamSession	(	uint32_t *	sessionHandle,
		uint32_t	messageID,
		uint32_t	messageIDMask,
		uint32_t	maxMessages,
		char const *	canbus,
		bool	printErr = true )

CANComm_ReadStreamSession()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_ReadStreamSession	(	uint32_t	sessionHandle,
		canframe_t *	messages,
		uint32_t	messagesToRead,
		uint32_t *	messagesRead,
		char const *	canbus,
		bool	printErr = true )

CANComm_ReceiveMessage()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_ReceiveMessage	(	uint32_t	messageID,
		canframe_t &	frame,
		char const *	canbus,
		bool	printErr = true )

CANComm_SendMessage()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_SendMessage	(	uint32_t	messageID,
		uint8_t const *	data,
		uint8_t	dataSize,
		char const *	canbus,
		bool	printErr = true )

CANComm_SendPeriodicMessage()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_SendPeriodicMessage	(	uint32_t	messageID,
		uint8_t const *	data,
		uint8_t	dataSize,
		int32_t	periodMs,
		char const *	canbus,
		bool	printErr = true )

CANComm_SetRxSchedPriority()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_SetRxSchedPriority	(	int	priority,
		bool	useRoundRobin,
		char const *	canbus,
		bool	printErr = true )

CANComm_SetTxSchedPriority()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_SetTxSchedPriority	(	int	priority,
		bool	useRoundRobin,
		char const *	canbus,
		bool	printErr = true )

CANComm_StopPeriodicMessage()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_StopPeriodicMessage	(	uint32_t	messageID,
		char const *	canbus,
		bool	printErr = true )

CANComm_WaitForMessages()

CTREXPORT int32_t ctre::phoenix::platform::can::CANComm_WaitForMessages	(	std::unordered_set< uint32_t > const &	messageIDs,
		uint16_t	timeoutMs,
		char const *	canbus,
		bool	printErr = true )

GetCANbusList()

CTREXPORT std::vector< std::string > ctre::phoenix::platform::can::GetCANbusList

(

void

)

GetCANivoreDevName()

CTREXPORT std::string ctre::phoenix::platform::can::GetCANivoreDevName

(

char const *

canbus

)

Network_ChangeTxPeriod()

CTREXPORT bool ctre::phoenix::platform::can::Network_ChangeTxPeriod	(	char const *	canbus,
		uint32_t	arbId,
		int32_t	periodMs )

Network_GetLastTx()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_GetLastTx	(	char const *	canbus,
		uint32_t	arbId,
		canframe_t &	frame )

Network_GetRxFrame()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_GetRxFrame	(	char const *	canbus,
		uint32_t	arbId,
		canframe_t &	frame,
		uint32_t	timeoutMs )

Network_SendPeriodicTxFrame()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_SendPeriodicTxFrame	(	char const *	canbus,
		canframe_t const &	frame,
		int32_t	periodMs )

Network_SendTxFrame()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_SendTxFrame	(	char const *	canbus,
		canframe_t const &	frame )

Network_SetEnableSignalSchedPriority()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_SetEnableSignalSchedPriority	(	int	priority,
		bool	useRoundRobin )

Network_StopPeriodicTxFrame()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_StopPeriodicTxFrame	(	char const *	canbus,
		uint32_t	arbId )

Network_UpdatePeriodicTxFrame()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_UpdatePeriodicTxFrame	(	char const *	canbus,
		canframe_t const &	frame )

Network_WaitForRxFrames()

CTREXPORT StatusCode ctre::phoenix::platform::can::Network_WaitForRxFrames	(	char const *	canbus,
		std::unordered_set< uint32_t > const &	arbIds,
		uint16_t	timeoutMs )

RegisterCANbus()

CTREXPORT int32_t ctre::phoenix::platform::can::RegisterCANbus	(	char const *	canbus,
		bool	printErr = true )