#include <DetachedEncoderLowLevel.h>

Inherited by rev::detached::DetachedEncoder.

Classes
struct	FirmwareVersion

struct	PeriodicStatus0

struct	PeriodicStatus1

struct	PeriodicStatus2

struct	PeriodicStatus3

struct	PeriodicStatus4

Public Types
enum class	EncoderModel { kUnknown = 0 , kMAXSplineEncoder = 1 }

Public Member Functions
virtual	~DetachedEncoderLowLevel ()

int	GetBusId () const

int	GetDeviceId () const

EncoderModel	GetEncoderModel () const

FirmwareVersion	GetFirmwareVersion () const

PeriodicStatus0	GetPeriodicStatus0 () const

rev::util::Signal< PeriodicStatus1 >	GetPeriodicStatus1 () const

rev::util::Signal< PeriodicStatus2 >	GetPeriodicStatus2 () const

rev::util::Signal< PeriodicStatus3 >	GetPeriodicStatus3 () const

rev::util::Signal< PeriodicStatus4 >	GetPeriodicStatus4 () const

void	CreateSimFaultManager ()

Protected Member Functions
	DetachedEncoderLowLevel (int busId, int deviceID, EncoderModel model)

Protected Attributes
void *	m_detachedEncoderHandle {nullptr}

Member Enumeration Documentation

◆ EncoderModel

enum class rev::detached::DetachedEncoderLowLevel::EncoderModel

strong

Enumerator
kUnknown
kMAXSplineEncoder

Constructor & Destructor Documentation

◆ ~DetachedEncoderLowLevel()

DetachedEncoderLowLevel::~DetachedEncoderLowLevel ( )

virtual

Closes the Detached Encoder

◆ DetachedEncoderLowLevel()

DetachedEncoderLowLevel::DetachedEncoderLowLevel	(	int	busId,
		int	deviceID,
		EncoderModel	model
	)

protected

Member Function Documentation

◆ GetBusId()

int DetachedEncoderLowLevel::GetBusId ( ) const

Get the configured CAN Bus ID of the Detached Encoder.

Returns: int CAN bus ID

◆ GetDeviceId()

int DetachedEncoderLowLevel::GetDeviceId ( ) const

Get the configured Device ID of the Detached encoder.

Returns: int device ID

◆ GetEncoderModel()

DetachedEncoderLowLevel::EncoderModel DetachedEncoderLowLevel::GetEncoderModel ( ) const

Get the Model of this Detached Encoder Device. Useful for determining if this is a MAXSpline, or other device

Returns: the model of this encoder

◆ GetFirmwareVersion()

DetachedEncoderLowLevel::FirmwareVersion DetachedEncoderLowLevel::GetFirmwareVersion ( ) const

Get the firmware version of the detached encoder.

Returns: Firmware version object

◆ GetPeriodicStatus0()

DetachedEncoderLowLevel::PeriodicStatus0 DetachedEncoderLowLevel::GetPeriodicStatus0 ( ) const

Get Periodic Status 0 for the Detached Encoder.

Returns: PeriodicStatus0 Periodic status 0

◆ GetPeriodicStatus1()

Signal< DetachedEncoderLowLevel::PeriodicStatus1 > DetachedEncoderLowLevel::GetPeriodicStatus1 ( ) const

Get Periodic Status 1 Signal for the Detached Encoder.

Returns: Signal containing Periodic status 1

◆ GetPeriodicStatus2()

Signal< DetachedEncoderLowLevel::PeriodicStatus2 > DetachedEncoderLowLevel::GetPeriodicStatus2 ( ) const

Get Periodic Status 2 Signal for the Detached Encoder.

Returns: Signal containing Periodic status 2

◆ GetPeriodicStatus3()

Signal< DetachedEncoderLowLevel::PeriodicStatus3 > DetachedEncoderLowLevel::GetPeriodicStatus3 ( ) const

Get Periodic Status 3 Signal for the Detached Encoder.

Returns: Signal containing Periodic status 3

◆ GetPeriodicStatus4()

Signal< DetachedEncoderLowLevel::PeriodicStatus4 > DetachedEncoderLowLevel::GetPeriodicStatus4 ( ) const

Get Periodic Status 4 Signal for the Detached Encoder.

Returns: Signal containing Periodic status 4

◆ CreateSimFaultManager()

void DetachedEncoderLowLevel::CreateSimFaultManager ( )

Create the sim gui Fault Manager for this Detached Encoder device

Member Data Documentation

◆ m_detachedEncoderHandle

void* rev::detached::DetachedEncoderLowLevel::m_detachedEncoderHandle {nullptr}