CANCoder_CCI.h File Reference

#include "ctre/phoenix/cci/CCI.h"
#include "ctre/phoenix/ErrorCode.h"
#include "ctre/phoenix/sensors/AbsoluteSensorRange.h"
#include "ctre/phoenix/sensors/CANCoderStatusFrame.h"
#include "ctre/phoenix/sensors/CANCoderStickyFaults.h"
#include "ctre/phoenix/sensors/CANCoderFaults.h"
#include "ctre/phoenix/sensors/SensorVelocityMeasPeriod.h"
#include "ctre/phoenix/sensors/SensorInitializationStrategy.h"
#include "ctre/phoenix/sensors/MagnetFieldStrength.h"
#include "ctre/phoenix/sensors/SensorTimeBase.h"
#include <set>
#include <cstddef>

Go to the source code of this file.

Functions
CCIEXPORT void *	c_CANCoder_Create1 (int deviceNumber, const char *canbus)
CCIEXPORT void	c_CANCoder_DestroyAll ()
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_Destroy (void *handle)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetDescription (void *handle, char *toFill, int toFillByteSz, size_t *numBytesFilled)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetLastError (void *handle)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetLastUnitString (void *handle, char *toFill, int toFillByteSz, int *numBytesFilled)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetLastTimestamp (void *handle, double *timestamp)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetBusVoltage (void *handle, double *batteryVoltage)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetMagnetFieldStrength (void *handle, ctre::phoenix::sensors::MagnetFieldStrength *magnetFieldStrength)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetPosition (void *handle, double *pos)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_SetPosition (void *handle, double pos, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_SetPositionToAbsolute (void *handle, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigSensorDirection (void *handle, int bDirection, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetVelocity (void *handle, double *vel)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetAbsolutePosition (void *handle, double *pos)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigVelocityMeasurementPeriod (void *handle, int period, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigVelocityMeasurementWindow (void *handle, int window, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigAbsoluteSensorRange (void *handle, ctre::phoenix::sensors::AbsoluteSensorRange absoluteSensorRange, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigMagnetOffset (void *handle, double offsetDegrees, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigSensorInitializationStrategy (void *handle, ctre::phoenix::sensors::SensorInitializationStrategy initializationStrategy, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigFeedbackCoefficient (void *handle, double sensorCoefficient, const char *unitString, ctre::phoenix::sensors::SensorTimeBase sensortimeBase, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigSetParameter (void *handle, int param, double value, uint8_t subValue, int ordinal, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetParameter (void *handle, int param, double *value, int ordinal, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetParameter_6 (void *handle, int32_t param, int32_t valueToSend, int32_t *valueRecieved, uint8_t *subValue, int32_t ordinal, int32_t timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigSetCustomParam (void *handle, int newValue, int paramIndex, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetCustomParam (void *handle, int *readValue, int paramIndex, int timoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigFactoryDefault (void *handle, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetFaults (void *handle, int *param)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetStickyFaults (void *handle, int *param)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ClearStickyFaults (void *handle, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetFirmwareVersion (void *handle, int *firmwareVers)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_HasResetOccurred (void *handle, bool *hasReset)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_SetStatusFramePeriod (void *handle, int frame, uint8_t periodMs, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_GetStatusFramePeriod (void *handle, int frame, int *periodMs, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetVelocityMeasurementPeriod (void *handle, ctre::phoenix::sensors::SensorVelocityMeasPeriod *period, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetVelocityMeasurementWindow (void *handle, int *window, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetAbsoluteSensorRange (void *handle, ctre::phoenix::sensors::AbsoluteSensorRange *absoluteSensorRange, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetMagnetOffset (void *handle, double *offsetDegrees, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetSensorDirection (void *handle, int *bDirection, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetSensorInitializationStrategy (void *handle, ctre::phoenix::sensors::SensorInitializationStrategy *initializationStrategy, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetFeedbackCoefficient (void *handle, double *sensorCoefficient, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetFeedbackUnitString (void *handle, char *unitStringToFill, int toFillByteSz, int *numBytesFilled, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANCoder_ConfigGetFeedbackTimeBase (void *handle, ctre::phoenix::sensors::SensorTimeBase *sensortimeBase, int timeoutMs)

Function Documentation

c_CANCoder_ClearStickyFaults()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ClearStickyFaults	(	void *	handle,
		int	timeoutMs )

c_CANCoder_ConfigAbsoluteSensorRange()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigAbsoluteSensorRange	(	void *	handle,
		ctre::phoenix::sensors::AbsoluteSensorRange	absoluteSensorRange,
		int	timeoutMs )

c_CANCoder_ConfigFactoryDefault()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigFactoryDefault	(	void *	handle,
		int	timeoutMs )

c_CANCoder_ConfigFeedbackCoefficient()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigFeedbackCoefficient	(	void *	handle,
		double	sensorCoefficient,
		const char *	unitString,
		ctre::phoenix::sensors::SensorTimeBase	sensortimeBase,
		int	timeoutMs )

c_CANCoder_ConfigGetAbsoluteSensorRange()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetAbsoluteSensorRange	(	void *	handle,
		ctre::phoenix::sensors::AbsoluteSensorRange *	absoluteSensorRange,
		int	timeoutMs )

c_CANCoder_ConfigGetCustomParam()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetCustomParam	(	void *	handle,
		int *	readValue,
		int	paramIndex,
		int	timoutMs )

c_CANCoder_ConfigGetFeedbackCoefficient()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetFeedbackCoefficient	(	void *	handle,
		double *	sensorCoefficient,
		int	timeoutMs )

c_CANCoder_ConfigGetFeedbackTimeBase()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetFeedbackTimeBase	(	void *	handle,
		ctre::phoenix::sensors::SensorTimeBase *	sensortimeBase,
		int	timeoutMs )

c_CANCoder_ConfigGetFeedbackUnitString()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetFeedbackUnitString	(	void *	handle,
		char *	unitStringToFill,
		int	toFillByteSz,
		int *	numBytesFilled,
		int	timeoutMs )

c_CANCoder_ConfigGetMagnetOffset()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetMagnetOffset	(	void *	handle,
		double *	offsetDegrees,
		int	timeoutMs )

c_CANCoder_ConfigGetParameter()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetParameter	(	void *	handle,
		int	param,
		double *	value,
		int	ordinal,
		int	timeoutMs )

c_CANCoder_ConfigGetParameter_6()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetParameter_6	(	void *	handle,
		int32_t	param,
		int32_t	valueToSend,
		int32_t *	valueRecieved,
		uint8_t *	subValue,
		int32_t	ordinal,
		int32_t	timeoutMs )

c_CANCoder_ConfigGetSensorDirection()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetSensorDirection	(	void *	handle,
		int *	bDirection,
		int	timeoutMs )

c_CANCoder_ConfigGetSensorInitializationStrategy()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetSensorInitializationStrategy	(	void *	handle,
		ctre::phoenix::sensors::SensorInitializationStrategy *	initializationStrategy,
		int	timeoutMs )

c_CANCoder_ConfigGetVelocityMeasurementPeriod()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetVelocityMeasurementPeriod	(	void *	handle,
		ctre::phoenix::sensors::SensorVelocityMeasPeriod *	period,
		int	timeoutMs )

c_CANCoder_ConfigGetVelocityMeasurementWindow()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigGetVelocityMeasurementWindow	(	void *	handle,
		int *	window,
		int	timeoutMs )

c_CANCoder_ConfigMagnetOffset()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigMagnetOffset	(	void *	handle,
		double	offsetDegrees,
		int	timeoutMs )

c_CANCoder_ConfigSensorDirection()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigSensorDirection	(	void *	handle,
		int	bDirection,
		int	timeoutMs )

c_CANCoder_ConfigSensorInitializationStrategy()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigSensorInitializationStrategy	(	void *	handle,
		ctre::phoenix::sensors::SensorInitializationStrategy	initializationStrategy,
		int	timeoutMs )

c_CANCoder_ConfigSetCustomParam()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigSetCustomParam	(	void *	handle,
		int	newValue,
		int	paramIndex,
		int	timeoutMs )

c_CANCoder_ConfigSetParameter()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigSetParameter	(	void *	handle,
		int	param,
		double	value,
		uint8_t	subValue,
		int	ordinal,
		int	timeoutMs )

c_CANCoder_ConfigVelocityMeasurementPeriod()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigVelocityMeasurementPeriod	(	void *	handle,
		int	period,
		int	timeoutMs )

c_CANCoder_ConfigVelocityMeasurementWindow()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_ConfigVelocityMeasurementWindow	(	void *	handle,
		int	window,
		int	timeoutMs )

c_CANCoder_Create1()

CCIEXPORT void * c_CANCoder_Create1	(	int	deviceNumber,
		const char *	canbus )

c_CANCoder_Destroy()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_Destroy

(

void *

handle

)

c_CANCoder_DestroyAll()

CCIEXPORT void c_CANCoder_DestroyAll

(

)

c_CANCoder_GetAbsolutePosition()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetAbsolutePosition	(	void *	handle,
		double *	pos )

c_CANCoder_GetBusVoltage()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetBusVoltage	(	void *	handle,
		double *	batteryVoltage )

c_CANCoder_GetDescription()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetDescription	(	void *	handle,
		char *	toFill,
		int	toFillByteSz,
		size_t *	numBytesFilled )

c_CANCoder_GetFaults()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetFaults	(	void *	handle,
		int *	param )

c_CANCoder_GetFirmwareVersion()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetFirmwareVersion	(	void *	handle,
		int *	firmwareVers )

c_CANCoder_GetLastError()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetLastError

(

void *

handle

)

c_CANCoder_GetLastTimestamp()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetLastTimestamp	(	void *	handle,
		double *	timestamp )

c_CANCoder_GetLastUnitString()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetLastUnitString	(	void *	handle,
		char *	toFill,
		int	toFillByteSz,
		int *	numBytesFilled )

c_CANCoder_GetMagnetFieldStrength()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetMagnetFieldStrength	(	void *	handle,
		ctre::phoenix::sensors::MagnetFieldStrength *	magnetFieldStrength )

c_CANCoder_GetPosition()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetPosition	(	void *	handle,
		double *	pos )

c_CANCoder_GetStatusFramePeriod()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetStatusFramePeriod	(	void *	handle,
		int	frame,
		int *	periodMs,
		int	timeoutMs )

c_CANCoder_GetStickyFaults()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetStickyFaults	(	void *	handle,
		int *	param )

c_CANCoder_GetVelocity()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_GetVelocity	(	void *	handle,
		double *	vel )

c_CANCoder_HasResetOccurred()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_HasResetOccurred	(	void *	handle,
		bool *	hasReset )

c_CANCoder_SetPosition()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_SetPosition	(	void *	handle,
		double	pos,
		int	timeoutMs )

c_CANCoder_SetPositionToAbsolute()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_SetPositionToAbsolute	(	void *	handle,
		int	timeoutMs )

c_CANCoder_SetStatusFramePeriod()

CCIEXPORT ctre::phoenix::ErrorCode c_CANCoder_SetStatusFramePeriod	(	void *	handle,
		int	frame,
		uint8_t	periodMs,
		int	timeoutMs )