#include <FFBHIDMain.h>

Inheritance diagram for FFBHIDMain:

Public Member Functions
	FFBHIDMain (uint8_t axisCount)

virtual	~FFBHIDMain ()

void	setFFBEffectsCalc (std::shared_ptr< EffectsControlItf > ffb, std::shared_ptr< EffectsCalculator > effects_calc)

const ClassIdentifier	getInfo ()=0

CommandStatus	command (const ParsedCommand &cmd, std::vector< CommandReply > &replies)

void	registerCommands ()

virtual std::string	getHelpstring ()

void	setBtnTypes (uint16_t btntypes)

void	addBtnType (uint16_t id)

void	clearBtnTypes ()

void	setAinTypes (uint16_t aintypes)

void	addAinType (uint16_t id)

void	clearAinTypes ()

virtual void	usbInit ()=0

void	usbSuspend ()

void	usbResume ()

void	saveFlash ()

void	restoreFlash ()

void	Run ()

void	updateControl ()

void	emergencyStop (bool reset)

uint32_t	getRate ()

bool	getFfbActive ()

void	exti (uint16_t GPIO_Pin)

void	errorCallback (const Error &error, bool cleared)

void	systick ()

Public Member Functions inherited from FFBoardMain
const ClassType	getClassType () override
	returns the used classchooser selection id of this instance More...

	FFBoardMain ()

virtual	~FFBoardMain ()

virtual void	update ()

virtual void	cdcRcv (char Buf, uint32_t Len)

virtual void	cdcRcvReady (uint8_t itf)

Public Member Functions inherited from ChoosableClass
virtual	~ChoosableClass ()

uint16_t	getSelectionID ()

Public Member Functions inherited from CommandHandler
	CommandHandler (const char *clsname, uint16_t clsid, uint8_t instance=0)

virtual	~CommandHandler ()

virtual bool	hasCommands ()

virtual void	setCommandsEnabled (bool enable)

void	registerCommands ()

virtual CommandStatus	internalCommand (const ParsedCommand &cmd, std::vector< CommandReply > &replies)

virtual std::string	getCommandsHelpstring ()

virtual std::string	getCsvHelpstring ()

virtual uint8_t	getCommandHandlerInstance ()

void	broadcastCommandReply (CommandReply reply, uint32_t cmdId, CMDtype type)

void	sendCommandReplyAsync (CommandReply reply, uint32_t cmdId, CMDtype type, CommandInterface *interface=nullptr)

virtual uint16_t	getCommandHandlerID ()

virtual CmdHandlerInfo *	getCommandHandlerInfo ()

virtual bool	isValidCommandId (uint32_t cmdid, uint32_t ignoredFlags=0, uint32_t requiredFlag=0)

virtual CmdHandlerCommanddef *	getCommandFromName (const std::string &cmd, uint32_t ignoredFlags=0)

virtual CmdHandlerCommanddef *	getCommandFromId (const uint32_t id, uint32_t ignoredFlags=0)

template<typename ID >
void	registerCommand (const char cmd, const ID cmdid, const char help=nullptr, uint32_t flags=0)

Public Member Functions inherited from cpp_freertos::Thread
	Thread (const std::string Name, uint16_t StackDepth, UBaseType_t Priority)

	Thread (const char *Name, uint16_t StackDepth, UBaseType_t Priority)

	Thread (uint16_t StackDepth, UBaseType_t Priority)

bool	Start ()

virtual	~Thread ()

TaskHandle_t	GetHandle ()

void	Suspend ()

void	Resume ()

void	ResumeFromISR ()

void	Notify ()

void	NotifyFromISR ()

uint32_t	WaitForNotification (TickType_t Timeout=portMAX_DELAY)

UBaseType_t	GetPriority ()

UBaseType_t	GetPriorityFromISR ()

void	SetPriority (UBaseType_t NewPriority)

std::string	GetName ()

char *	GetName ()

Public Member Functions inherited from UsbHidHandler
	UsbHidHandler ()

virtual	~UsbHidHandler ()

virtual void	hidOut (uint8_t report_id, hid_report_type_t report_type, uint8_t const *buffer, uint16_t bufsize)

virtual uint16_t	hidGet (uint8_t report_id, hid_report_type_t report_type, uint8_t *buffer, uint16_t reqlen)

void	registerHidCallback ()

void	transferComplete (uint8_t itf, uint8_t const *report, uint8_t len)

Static Public Member Functions
static bool	isCreatable ()

Static Public Member Functions inherited from FFBoardMain
static bool	isCreatable ()

Static Public Member Functions inherited from ChoosableClass
static bool	isCreatable ()

Static Public Member Functions inherited from CommandHandler
static void	logSerial (std::string string)
	Send a log formatted sequence. More...

static void	logSerialDebug (std::string string)
	Send a log formatted sequence if debug is on. More...

static bool	logsEnabled ()

static void	setLogsEnabled (bool enabled)

static uint32_t	getClassIdFromName (const char *name)

static const char *	getClassNameFromId (const uint32_t id)

static CommandHandler *	getHandlerFromHandlerId (const uint16_t cmdhandlerID)

static CommandHandler *	getHandlerFromId (const uint16_t id, const uint8_t instance=0xFF)

static CommandHandler *	getHandlerFromClassName (const char *name, const uint8_t instance=0xFF)

static std::vector< CommandHandler * >	getHandlersFromClassName (const char *name)

static std::vector< CommandHandler * >	getHandlersFromId (const uint16_t id)

static bool	isInHandlerList (CommandHandler *handler)

static std::string	getAllHelpstrings ()

static std::vector< CommandHandler * > &	getCommandHandlers ()

template<typename TVal >
static CommandStatus	handleGetSet (const ParsedCommand &cmd, std::vector< CommandReply > &replies, TVal &value)

template<typename TVal , class cls , class cls1 >
static CommandStatus	handleGetSetFunc (const ParsedCommand &cmd, std::vector< CommandReply > &replies, TVal &value, void(cls1::setfunc)(TVal), cls obj)

template<typename TVal , class cls , class cls1 , class cls2 >
static CommandStatus	handleGetFuncSetFunc (const ParsedCommand &cmd, std::vector< CommandReply > &replies, TVal(cls1::getfunc)(), void(cls2::setfunc)(TVal), cls *obj)

template<typename TVal , class cls , class cls1 >
static CommandStatus	handleGetFuncSet (const ParsedCommand &cmd, std::vector< CommandReply > &replies, TVal &value, TVal(cls1::getfunc)(), cls obj)

Static Public Member Functions inherited from cpp_freertos::Thread
static void	Yield ()

static void	StartScheduler ()

static void	EndScheduler ()

Static Public Member Functions inherited from UsbHidHandler
static void	setHidDesc (const uint8_t *desc)

static const uint8_t *	getHidDesc ()

Protected Attributes
std::shared_ptr< EffectsControlItf >	ffb

std::shared_ptr< EffectsCalculator >	effects_calc

uint8_t	axisCount =0

Protected Attributes inherited from FFBoardMain
std::unique_ptr< USBdevice >	usbdev

Protected Attributes inherited from ChoosableClass
uint16_t	selectionId
	Should only be written by ClassChooser during creation. More...

Protected Attributes inherited from CommandHandler
bool	commandsEnabled = true

std::vector< CmdHandlerCommanddef >	registeredCommands

CmdHandlerInfo	cmdHandlerInfo

Private Types
enum class	FFBWheel_commands : uint32_t { ffbactive , axes , btntypes , lsbtn , addbtn , aintypes , lsain , addain , hidrate , hidsendspd , estop , cfrate }

Private Member Functions
void	send_report ()

void	setReportRate (uint8_t rateidx)

std::string	usb_report_rates_names ()

Private Member Functions inherited from PersistentStorage
	PersistentStorage ()

virtual	~PersistentStorage ()

void	restoreFlashDelayed ()

Private Member Functions inherited from ExtiHandler
	ExtiHandler ()

virtual	~ExtiHandler ()

Private Member Functions inherited from ErrorHandler
	ErrorHandler ()

virtual	~ErrorHandler ()

Private Attributes
volatile Control_t	control

const bool	allowEstopReset = true

const Error	estopError = Error(ErrorCode::emergencyStop, ErrorType::critical, "Emergency stop button triggered")

uint8_t	usb_report_rate = HID_BINTERVAL

uint8_t	usb_report_rate_idx = 0

const uint8_t	usb_report_rates [4] = {1,2,4,8}

uint8_t	report_rate_cnt = 0

std::unique_ptr< AxesManager >	axes_manager

std::vector< std::unique_ptr< ButtonSource > >	btns

std::vector< std::unique_ptr< AnalogSource > >	analog_inputs

reportHID_t	reportHID

reportHID_t	lastReportHID

uint8_t	reportSendCounter = 0

const uint8_t	analogAxisCount = 8

uint16_t	btnsources = 0

uint16_t	ainsources = 0

ClassChooser< ButtonSource >	btn_chooser

ClassChooser< AnalogSource >	analog_chooser

std::unique_ptr< HID_CommandInterface >	hidCommands = std::make_unique<HID_CommandInterface>()

uint32_t	lastUsbReportTick = 0

cpp_freertos::BinarySemaphore	sourcesSem = cpp_freertos::BinarySemaphore(true)

volatile uint32_t	lastEstop = 0

Private Attributes inherited from PersistentStorage
bool	restoreDelayedFlag = false

Additional Inherited Members
Public Attributes inherited from FFBoardMain
std::unique_ptr< FFBoardMainCommandThread >	commandThread

std::unique_ptr< CDC_CommandInterface >	cdcCmdInterface = std::make_unique<CDC_CommandInterface>()

ErrorPrinter	errorPrinter

SystemCommands	systemCommands
	System command handler. More...

std::unique_ptr< UART_CommandInterface >	uartCmdInterface = std::make_unique<UART_CommandInterface>(115200)

Static Public Attributes inherited from FFBoardMain
static ClassIdentifier	info ={.name = "Basic (Failsafe)" ,.id=0}

Static Public Attributes inherited from ChoosableClass
static ClassIdentifier	info

Static Public Attributes inherited from CommandHandler
static bool	logEnabled = true

Static Public Attributes inherited from UsbHidHandler
static UsbHidHandler *	globalHidHandler = nullptr

static uint8_t *	hid_desc = nullptr

Protected Member Functions inherited from CommandHandler
void	setInstance (uint8_t instance)

virtual void	addCommandHandler ()

virtual void	removeCommandHandler ()

Protected Member Functions inherited from cpp_freertos::Thread
virtual void	Cleanup ()

void	Delay (const TickType_t Delay)

void	DelayUntil (const TickType_t Period)

void	ResetDelayUntil ()

bool	Wait (ConditionVariable &Cv, Mutex &CvLock, TickType_t Timeout=portMAX_DELAY)

Static Protected Member Functions inherited from CommandHandler
static std::vector< uint16_t > &	getCommandHandlerIds ()

Static Protected Attributes inherited from FFBoardMain
static char	cdcbuf []

Static Private Member Functions inherited from PersistentStorage
static std::vector< PersistentStorage * > &	getFlashHandlers ()

static void	restoreFlashStartupCb ()

Static Private Member Functions inherited from ErrorHandler
static void	addError (const Error &error)

static void	clearError (const Error &error)

static void	clearError (ErrorCode errorcode)

static void	clearTemp ()

static void	clearAll ()

static std::span< Error >	getErrors ()

static void	sortErrors ()

Static Private Attributes inherited from PersistentStorage
static bool	startupComplete = false

Static Private Attributes inherited from ExtiHandler
static std::vector< ExtiHandler * >	extiHandlers

Static Private Attributes inherited from ErrorHandler
static std::vector< ErrorHandler * >	errorHandlers

static std::array< Error, ERRORHANDLER_MAXERRORS >	errors

Detailed Description

Definition at line 36 of file FFBHIDMain.h.

Member Enumeration Documentation

◆ FFBWheel_commands

enum class FFBHIDMain::FFBWheel_commands : uint32_t

strongprivate

Enumerator
ffbactive
axes
btntypes
lsbtn
addbtn
aintypes
lsain
addain
hidrate
hidsendspd
estop
cfrate

Definition at line 37 of file FFBHIDMain.h.

Constructor & Destructor Documentation

◆ FFBHIDMain()

FFBHIDMain::FFBHIDMain ( uint8_t axisCount )

setFFBEffectsCalc must be called in constructor of derived class to finish the setup

Definition at line 23 of file FFBHIDMain.cpp.

◆ ~FFBHIDMain()

FFBHIDMain::~FFBHIDMain ( )

virtual

Definition at line 47 of file FFBHIDMain.cpp.

Member Function Documentation

◆ addAinType()

void FFBHIDMain::addAinType ( uint16_t id )

Definition at line 190 of file FFBHIDMain.cpp.

◆ addBtnType()

void FFBHIDMain::addBtnType ( uint16_t id )

Definition at line 158 of file FFBHIDMain.cpp.

◆ clearAinTypes()

void FFBHIDMain::clearAinTypes ( )

Definition at line 170 of file FFBHIDMain.cpp.

◆ clearBtnTypes()

void FFBHIDMain::clearBtnTypes ( )

Definition at line 137 of file FFBHIDMain.cpp.

◆ command()

CommandStatus FFBHIDMain::command	(	const ParsedCommand &	cmd,
		std::vector< CommandReply > &	replies
	)

virtual

Parameters

[in]	cmd	The parsed command to be executed.
[out]	replies	A vector to return one or multiple reply objects into. Replies to the interface will be generated based on the reply objects. A string reply may not contain start, end and separation markers: [,],\| Other characters are allowed.

Reimplemented from FFBoardMain.

Definition at line 32 of file FFBHIDMain_commmands.cpp.

◆ emergencyStop()

void FFBHIDMain::emergencyStop ( bool reset )

Definition at line 296 of file FFBHIDMain.cpp.

◆ errorCallback()

void FFBHIDMain::errorCallback	(	const Error &	error,
		bool	cleared
	)

virtual

Reimplemented from ErrorHandler.

Definition at line 362 of file FFBHIDMain.cpp.

◆ exti()

void FFBHIDMain::exti ( uint16_t GPIO_Pin )

virtual

Reimplemented from ExtiHandler.

Definition at line 334 of file FFBHIDMain.cpp.

◆ getFfbActive()

bool FFBHIDMain::getFfbActive ( )

Definition at line 205 of file FFBHIDMain.cpp.

◆ getHelpstring()

virtual std::string FFBHIDMain::getHelpstring ( )

inlinevirtual

Returns a description of this class

Reimplemented from FFBoardMain.

Definition at line 52 of file FFBHIDMain.h.

◆ getInfo()

const ClassIdentifier FFBHIDMain::getInfo ( )

pure virtual

Reimplemented from FFBoardMain.

Implemented in FFBHIDExt, FFBJoystick, and FFBWheel.

◆ getRate()

uint32_t FFBHIDMain::getRate ( )

Definition at line 201 of file FFBHIDMain.cpp.

◆ isCreatable()

static bool FFBHIDMain::isCreatable ( )

inlinestatic

Definition at line 48 of file FFBHIDMain.h.

◆ registerCommands()

void FFBHIDMain::registerCommands ( )

Definition at line 11 of file FFBHIDMain_commmands.cpp.

◆ restoreFlash()

void FFBHIDMain::restoreFlash ( )

virtual

Read parameters from flash and restore settings

Reimplemented from PersistentStorage.

Definition at line 54 of file FFBHIDMain.cpp.

◆ Run()

void FFBHIDMain::Run ( )

virtual

Implementation of your actual thread code. You must override this function.

Note: If INCLUDE_vTaskDelete is defined, then you may return from your Run method. This will cause the task to be deleted from FreeRTOS, however you are still responsible to delete the task object. If this is not defined, then retuning from your Run() method will result in an assert.

Implements cpp_freertos::Thread.

Definition at line 84 of file FFBHIDMain.cpp.

◆ saveFlash()

void FFBHIDMain::saveFlash ( )

virtual

Save parameters to flash

Reimplemented from PersistentStorage.

Definition at line 72 of file FFBHIDMain.cpp.

◆ send_report()

void FFBHIDMain::send_report ( )

private

Sends periodic gamepad reports of buttons and analog axes

Definition at line 212 of file FFBHIDMain.cpp.

◆ setAinTypes()

void FFBHIDMain::setAinTypes ( uint16_t aintypes )

Definition at line 176 of file FFBHIDMain.cpp.

◆ setBtnTypes()

void FFBHIDMain::setBtnTypes ( uint16_t btntypes )

Definition at line 143 of file FFBHIDMain.cpp.

◆ setFFBEffectsCalc()

void FFBHIDMain::setFFBEffectsCalc	(	std::shared_ptr< EffectsControlItf >	ffb,
		std::shared_ptr< EffectsCalculator >	effects_calc
	)

MUST be called in the constructor of the derived class. This finishes the construction because the constructor of this class will be called before the ffb and effects calc objects are created in the derived class.

Definition at line 38 of file FFBHIDMain.cpp.

◆ setReportRate()

void FFBHIDMain::setReportRate ( uint8_t rateidx )

private

Changes the hid report rate based on the index for usb_report_rates

Definition at line 277 of file FFBHIDMain.cpp.

◆ systick()

void FFBHIDMain::systick ( )

◆ updateControl()

void FFBHIDMain::updateControl ( )

Main update loop

Definition at line 102 of file FFBHIDMain.cpp.

◆ usb_report_rates_names()

std::string FFBHIDMain::usb_report_rates_names ( )

private

Generates the speed strings to display to the user

Definition at line 286 of file FFBHIDMain.cpp.

◆ usbInit()

virtual void FFBHIDMain::usbInit ( )

pure virtual

Called during the startup Should initialize a USBdevice and call registerUsb()

Reimplemented from FFBoardMain.

Implemented in FFBHIDExt, FFBJoystick, and FFBWheel.

◆ usbResume()

void FFBHIDMain::usbResume ( )

virtual

USB plugged in

Reimplemented from FFBoardMain.

Definition at line 322 of file FFBHIDMain.cpp.

◆ usbSuspend()

void FFBHIDMain::usbSuspend ( )

virtual

USB unplugged Deactivates FFB

Reimplemented from FFBoardMain.

Definition at line 310 of file FFBHIDMain.cpp.

Member Data Documentation

◆ ainsources

uint16_t FFBHIDMain::ainsources = 0

private

Definition at line 121 of file FFBHIDMain.h.

◆ allowEstopReset

const bool FFBHIDMain::allowEstopReset = true

private

Definition at line 93 of file FFBHIDMain.h.

◆ analog_chooser

ClassChooser<AnalogSource> FFBHIDMain::analog_chooser

private

Definition at line 125 of file FFBHIDMain.h.

◆ analog_inputs

std::vector<std::unique_ptr<AnalogSource> > FFBHIDMain::analog_inputs

private

Definition at line 113 of file FFBHIDMain.h.

◆ analogAxisCount

const uint8_t FFBHIDMain::analogAxisCount = 8

private

Definition at line 119 of file FFBHIDMain.h.

◆ axes_manager

std::unique_ptr<AxesManager> FFBHIDMain::axes_manager

private

Definition at line 109 of file FFBHIDMain.h.

◆ axisCount

uint8_t FFBHIDMain::axisCount =0

protected

Definition at line 88 of file FFBHIDMain.h.

◆ btn_chooser

ClassChooser<ButtonSource> FFBHIDMain::btn_chooser

private

Definition at line 124 of file FFBHIDMain.h.

◆ btns

std::vector<std::unique_ptr<ButtonSource> > FFBHIDMain::btns

private

Definition at line 112 of file FFBHIDMain.h.

◆ btnsources

uint16_t FFBHIDMain::btnsources = 0

private

Definition at line 120 of file FFBHIDMain.h.

◆ control

volatile Control_t FFBHIDMain::control

private

Definition at line 91 of file FFBHIDMain.h.

◆ effects_calc

std::shared_ptr<EffectsCalculator> FFBHIDMain::effects_calc

protected

Definition at line 87 of file FFBHIDMain.h.

◆ estopError

const Error FFBHIDMain::estopError = Error(ErrorCode::emergencyStop, ErrorType::critical, "Emergency stop button triggered")

private

Definition at line 95 of file FFBHIDMain.h.

◆ ffb

std::shared_ptr<EffectsControlItf> FFBHIDMain::ffb

protected

Definition at line 86 of file FFBHIDMain.h.

◆ hidCommands

std::unique_ptr<HID_CommandInterface> FFBHIDMain::hidCommands = std::make_unique<HID_CommandInterface>()

private

Definition at line 128 of file FFBHIDMain.h.

◆ lastEstop

volatile uint32_t FFBHIDMain::lastEstop = 0

private

Definition at line 133 of file FFBHIDMain.h.

◆ lastReportHID

reportHID_t FFBHIDMain::lastReportHID

private

Definition at line 116 of file FFBHIDMain.h.

◆ lastUsbReportTick

uint32_t FFBHIDMain::lastUsbReportTick = 0

private

Definition at line 130 of file FFBHIDMain.h.

◆ report_rate_cnt

uint8_t FFBHIDMain::report_rate_cnt = 0

private

Definition at line 107 of file FFBHIDMain.h.

◆ reportHID

reportHID_t FFBHIDMain::reportHID

private

Definition at line 115 of file FFBHIDMain.h.

◆ reportSendCounter

uint8_t FFBHIDMain::reportSendCounter = 0

private

Definition at line 117 of file FFBHIDMain.h.

◆ sourcesSem

cpp_freertos::BinarySemaphore FFBHIDMain::sourcesSem = cpp_freertos::BinarySemaphore(true)

private

Definition at line 131 of file FFBHIDMain.h.

◆ usb_report_rate

uint8_t FFBHIDMain::usb_report_rate = HID_BINTERVAL

private

Definition at line 101 of file FFBHIDMain.h.

◆ usb_report_rate_idx

uint8_t FFBHIDMain::usb_report_rate_idx = 0

private

Definition at line 102 of file FFBHIDMain.h.

◆ usb_report_rates

const uint8_t FFBHIDMain::usb_report_rates[4] = {1,2,4,8}

private

Definition at line 103 of file FFBHIDMain.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FFBWheel_commands

Constructor & Destructor Documentation

◆ FFBHIDMain()

◆ ~FFBHIDMain()

Member Function Documentation

◆ addAinType()

◆ addBtnType()

◆ clearAinTypes()

◆ clearBtnTypes()

◆ command()

◆ emergencyStop()

◆ errorCallback()

◆ exti()

◆ getFfbActive()

◆ getHelpstring()

◆ getInfo()

◆ getRate()

◆ isCreatable()

◆ registerCommands()

◆ restoreFlash()

◆ Run()

◆ saveFlash()

◆ send_report()

◆ setAinTypes()

◆ setBtnTypes()

◆ setFFBEffectsCalc()

◆ setReportRate()

◆ systick()

◆ updateControl()

◆ usb_report_rates_names()

◆ usbInit()

◆ usbResume()

◆ usbSuspend()

Member Data Documentation

◆ ainsources

◆ allowEstopReset

◆ analog_chooser

◆ analog_inputs

◆ analogAxisCount

◆ axes_manager

◆ axisCount

◆ btn_chooser

◆ btns

◆ btnsources

◆ control

◆ effects_calc

◆ estopError

◆ ffb

◆ hidCommands

◆ lastEstop

◆ lastReportHID

◆ lastUsbReportTick

◆ report_rate_cnt

◆ reportHID

◆ reportSendCounter

◆ sourcesSem

◆ usb_report_rate

◆ usb_report_rate_idx

◆ usb_report_rates