CANifier_CCI.h File Reference

#include "ctre/phoenix/cci/CCI.h"
#include "ctre/phoenix/ErrorCode.h"
#include <set>
#include <cstddef>

Go to the source code of this file.

Namespaces
namespace	CANifier_CCI

Enumerations
enum	CANifier_CCI::GeneralPin {   CANifier_CCI::QUAD_IDX = 0 , CANifier_CCI::QUAD_B = 1 , CANifier_CCI::QUAD_A = 2 , CANifier_CCI::LIMR = 3 ,   CANifier_CCI::LIMF = 4 , CANifier_CCI::SDA = 5 , CANifier_CCI::SCL = 6 , CANifier_CCI::SPI_CS = 7 ,   CANifier_CCI::SPI_MISO_PWM2P = 8 , CANifier_CCI::SPI_MOSI_PWM1P = 9 , CANifier_CCI::SPI_CLK_PWM0P = 10 }

Functions
CCIEXPORT void *	c_CANifier_Create1 (int deviceNumber)
CCIEXPORT void	c_CANifier_DestroyAll ()
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_Destroy (void *handle)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetDescription (void *handle, char *toFill, int toFillByteSz, size_t *numBytesFilled)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetLEDOutput (void *handle, uint32_t dutyCycle, uint32_t ledChannel)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetGeneralOutputs (void *handle, uint32_t outputsBits, uint32_t isOutputBits)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetGeneralOutput (void *handle, uint32_t outputPin, bool outputValue, bool outputEnable)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetPWMOutput (void *handle, uint32_t pwmChannel, uint32_t dutyCycle)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_EnablePWMOutput (void *handle, uint32_t pwmChannel, bool bEnable)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetGeneralInputs (void *handle, bool allPins[], uint32_t capacity)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetGeneralInput (void *handle, uint32_t inputPin, bool *measuredInput)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetPWMInput (void *handle, uint32_t pwmChannel, double dutyCycleAndPeriod[2])
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetLastError (void *handle)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetBusVoltage (void *handle, double *batteryVoltage)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetQuadraturePosition (void *handle, int *pos)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetQuadraturePosition (void *handle, int pos, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetQuadratureVelocity (void *handle, int *vel)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetQuadratureSensor (void *handle, int *pos, int *vel)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigVelocityMeasurementPeriod (void *handle, int period, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigVelocityMeasurementWindow (void *handle, int window, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigClearPositionOnLimitF (void *handle, bool clearPositionOnLimitF, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigClearPositionOnLimitR (void *handle, bool clearPositionOnLimitR, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigClearPositionOnQuadIdx (void *handle, bool clearPositionOnQuadIdx, int timeoutMs)
CCIEXPORT void	c_CANifier_SetLastError (void *handle, int error)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigSetParameter (void *handle, int param, double value, uint8_t subValue, int ordinal, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigGetParameter (void *handle, int param, double *value, int ordinal, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_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_CANifier_ConfigSetCustomParam (void *handle, int newValue, int paramIndex, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigGetCustomParam (void *handle, int *readValue, int paramIndex, int timoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ConfigFactoryDefault (void *handle, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetFaults (void *handle, int *param)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetStickyFaults (void *handle, int *param)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_ClearStickyFaults (void *handle, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetFirmwareVersion (void *handle, int *firmwareVers)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_HasResetOccurred (void *handle, bool *hasReset)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetStatusFramePeriod (void *handle, int frame, uint8_t periodMs, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_GetStatusFramePeriod (void *handle, int frame, int *periodMs, int timeoutMs)
CCIEXPORT ctre::phoenix::ErrorCode	c_CANifier_SetControlFramePeriod (void *handle, int frame, int periodMs)

Function Documentation

c_CANifier_ClearStickyFaults()

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

c_CANifier_ConfigClearPositionOnLimitF()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_ConfigClearPositionOnLimitF	(	void *	handle,
		bool	clearPositionOnLimitF,
		int	timeoutMs
	)

c_CANifier_ConfigClearPositionOnLimitR()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_ConfigClearPositionOnLimitR	(	void *	handle,
		bool	clearPositionOnLimitR,
		int	timeoutMs
	)

c_CANifier_ConfigClearPositionOnQuadIdx()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_ConfigClearPositionOnQuadIdx	(	void *	handle,
		bool	clearPositionOnQuadIdx,
		int	timeoutMs
	)

c_CANifier_ConfigFactoryDefault()

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

c_CANifier_ConfigGetCustomParam()

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

c_CANifier_ConfigGetParameter()

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

c_CANifier_ConfigGetParameter_6()

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

c_CANifier_ConfigSetCustomParam()

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

c_CANifier_ConfigSetParameter()

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

c_CANifier_ConfigVelocityMeasurementPeriod()

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

c_CANifier_ConfigVelocityMeasurementWindow()

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

c_CANifier_Create1()

CCIEXPORT void * c_CANifier_Create1

(

int

deviceNumber

)

c_CANifier_Destroy()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_Destroy

(

void *

handle

)

c_CANifier_DestroyAll()

CCIEXPORT void c_CANifier_DestroyAll

(

)

c_CANifier_EnablePWMOutput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_EnablePWMOutput	(	void *	handle,
		uint32_t	pwmChannel,
		bool	bEnable
	)

c_CANifier_GetBusVoltage()

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

c_CANifier_GetDescription()

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

c_CANifier_GetFaults()

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

c_CANifier_GetFirmwareVersion()

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

c_CANifier_GetGeneralInput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetGeneralInput	(	void *	handle,
		uint32_t	inputPin,
		bool *	measuredInput
	)

c_CANifier_GetGeneralInputs()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetGeneralInputs	(	void *	handle,
		bool	allPins[],
		uint32_t	capacity
	)

c_CANifier_GetLastError()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetLastError

(

void *

handle

)

c_CANifier_GetPWMInput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetPWMInput	(	void *	handle,
		uint32_t	pwmChannel,
		double	dutyCycleAndPeriod[2]
	)

c_CANifier_GetQuadraturePosition()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetQuadraturePosition	(	void *	handle,
		int *	pos
	)

c_CANifier_GetQuadratureSensor()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetQuadratureSensor	(	void *	handle,
		int *	pos,
		int *	vel
	)

c_CANifier_GetQuadratureVelocity()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_GetQuadratureVelocity	(	void *	handle,
		int *	vel
	)

c_CANifier_GetStatusFramePeriod()

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

c_CANifier_GetStickyFaults()

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

c_CANifier_HasResetOccurred()

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

c_CANifier_SetControlFramePeriod()

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

c_CANifier_SetGeneralOutput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_SetGeneralOutput	(	void *	handle,
		uint32_t	outputPin,
		bool	outputValue,
		bool	outputEnable
	)

c_CANifier_SetGeneralOutputs()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_SetGeneralOutputs	(	void *	handle,
		uint32_t	outputsBits,
		uint32_t	isOutputBits
	)

c_CANifier_SetLastError()

CCIEXPORT void c_CANifier_SetLastError	(	void *	handle,
		int	error
	)

c_CANifier_SetLEDOutput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_SetLEDOutput	(	void *	handle,
		uint32_t	dutyCycle,
		uint32_t	ledChannel
	)

c_CANifier_SetPWMOutput()

CCIEXPORT ctre::phoenix::ErrorCode c_CANifier_SetPWMOutput	(	void *	handle,
		uint32_t	pwmChannel,
		uint32_t	dutyCycle
	)

c_CANifier_SetQuadraturePosition()

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

c_CANifier_SetStatusFramePeriod()

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