Enumerations
enum	Message : uint8_t { kPositionOutput = 0x1F , kVelocityOutput = 0x1E , kRawPositionOutput = 0x1D , kSettingCommand = 0x2 , kSetSetting = 0x3 , kReportSetting = 0x4 , kClearStickyFaults = 0x5 , kStatus = 0x6 , kPartyMode = 0x7 }

enum	Setting : uint8_t { kZeroOffset = 0xFF , kVelocityWindow = 0xFE , kPositionFramePeriod = 0xFD , kVelocityFramePeriod = 0xFC , kRawPositionFramePeriod = 0xFB , kInvertDirection = 0xFA , kRelativePosition = 0xF9 , kDisableZeroButton = 0xF8 , kStatusFramePeriod = 0x4 }

enum	SettingCommand : uint8_t { kFetchSettings = 0x0 , kResetFactoryDefault = 0x1 , kFetchSettingValue = 0x2 , kResetFactoryDefaultKeepZero = 0xFF }

Variables
const std::vector< uint8_t >	VDEP_SETTINGS

Detailed Description

Namespace for Canandmag-specific constants and details not generally needed by end users

Enumeration Type Documentation

◆ Message

enum redux::sensors::canandmag::details::Message : uint8_t

Canandmag-specific CAN message IDs

Enumerator
kPositionOutput	Message id for Position frame
kVelocityOutput	Message id for Velocity frame
kRawPositionOutput	Message id for Raw position frame
kSettingCommand	Message id for setting control command
kSetSetting	Message id for update setting on device
kReportSetting	Message id for setting value report from device
kClearStickyFaults	Message id for clear device sticky faults
kStatus	Message id for status frames
kPartyMode	Message id for party mode

◆ Setting

enum redux::sensors::canandmag::details::Setting : uint8_t

Setting IDs valid for Canandmag

Enumerator
kZeroOffset	Setting msg id for Encoder zero offset
kVelocityWindow	Setting msg id for Velocity window width (value*250us)
kPositionFramePeriod	Setting msg id for Position frame period (ms)
kVelocityFramePeriod	Setting msg id for Velocity frame period (ms)
kRawPositionFramePeriod	Setting msg id for Raw position frame period (ms)
kInvertDirection	Setting msg id for Invert direction (use cw instead of ccw)
kRelativePosition	Setting msg id for Relative position value
kDisableZeroButton	Setting msg id for Disable the zero button
kStatusFramePeriod	Setting msg id for status frame period (ms)

◆ SettingCommand

enum redux::sensors::canandmag::details::SettingCommand : uint8_t

Canandmag-specific setting command IDs

Enumerator
kFetchSettings	Setting command id for Fetch all settings from device
kResetFactoryDefault	Setting command id for Reset everything to factory default
kFetchSettingValue	setting command for Fetch individual setting
kResetFactoryDefaultKeepZero	Setting command id for Factory defaults, but keep the encoder zero offset

Variable Documentation

◆ VDEP_SETTINGS

const std::vector<uint8_t> redux::sensors::canandmag::details::VDEP_SETTINGS

Initial value:

= { 
  Setting::kStatusFramePeriod,
  Setting::kZeroOffset,
  Setting::kVelocityWindow,
  Setting::kPositionFramePeriod,
  Setting::kVelocityFramePeriod,
  Setting::kInvertDirection,
  Setting::kDisableZeroButton
}

std::vector of relevant settings IDS for the vendordep

Enumerations