#include <SPIButtons.h>

Inheritance diagram for SPI_Buttons:

Public Member Functions
virtual	~SPI_Buttons ()

uint8_t	readButtons (uint64_t *buf)

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

void	registerCommands ()

virtual std::string	getHelpstring ()

void	saveFlash ()

void	restoreFlash ()

std::string	printModes (const std::vector< std::string > &names)

void	setMode (SPI_BtnMode mode)

void	initSPI ()

const ClassType	getClassType () override
	returns the used classchooser selection id of this instance More...

void	setSpiSpeed (uint8_t speedPreset)

Public Member Functions inherited from ButtonSource
	ButtonSource ()

virtual	~ButtonSource ()

virtual uint16_t	getBtnNum ()

virtual const ClassIdentifier	getInfo ()=0

Public Member Functions inherited from ChoosableClass
virtual	~ChoosableClass ()

uint16_t	getSelectionID ()

Public Member Functions inherited from PersistentStorage
	PersistentStorage ()

virtual	~PersistentStorage ()

void	restoreFlashDelayed ()

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 const ClassIdentifier	getInfo ()=0
	Command handlers always have class infos. Works well with ChoosableClass. More...

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 SPIDevice
	SPIDevice (SPIPort &port, OutputPin csPin)

	SPIDevice (SPIPort &port, SPIConfig &spiConfig)

virtual	~SPIDevice ()

void	assertChipSelect ()

void	clearChipSelect ()

virtual bool	updateCSPin (OutputPin &csPin)

virtual void	spiTxCompleted (SPIPort *port)

virtual void	spiRxCompleted (SPIPort *port)

virtual void	spiTxRxCompleted (SPIPort *port)

virtual void	spiRequestError (SPIPort *port)

virtual void	beginSpiTransfer (SPIPort *port)

virtual void	endSpiTransfer (SPIPort *port)

virtual SPIConfig *	getSpiConfig ()

Public Attributes
const uint8_t	maxButtons = 64

Static Public Attributes
static const std::vector< std::string >	mode_names = {"Thrustmaster/HEF4021BT","74xx165"}

static const std::vector< std::string >	speed_names = {"Fast","Medium","Slow"}

Static Public Attributes inherited from ButtonSource
static ClassIdentifier	info

static const std::vector< class_entry< ButtonSource > >	all_buttonsources

Static Public Attributes inherited from ChoosableClass
static ClassIdentifier	info

Static Public Attributes inherited from CommandHandler
static bool	logEnabled = true

Protected Member Functions
	SPI_Buttons (uint16_t configuration_address, uint16_t configuration_address_2)

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

virtual void	addCommandHandler ()

virtual void	removeCommandHandler ()

Protected Member Functions inherited from SPIDevice
virtual void	setSpiConfig (SPIConfig config)

Private Types
enum class	SPIButtons_commands : uint32_t { mode , btncut , btnpol , btnnum , cs , spispeed }

Private Member Functions
void	setConfig (ButtonSourceConfig config)

virtual ButtonSourceConfig *	getConfig ()

void	process (uint64_t *buf)

Private Attributes
uint16_t	configuration_address

uint16_t	configuration_address_2

bool	ready = false

uint8_t	bytes = 4

uint64_t	mask = 0xff

uint8_t	offset = 0

ButtonSourceConfig	conf

uint8_t	spi_buf [4] = {0}

Static Private Attributes
static constexpr std::array< uint32_t, 3 >	speedPresets = {SPI_BAUDRATEPRESCALER_16,SPI_BAUDRATEPRESCALER_32,SPI_BAUDRATEPRESCALER_64}

Additional Inherited Members
Static Public Member Functions inherited from ButtonSource
static bool	isCreatable ()

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

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

static void	restoreFlashStartupCb ()

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 Protected Member Functions inherited from CommandHandler
static std::vector< uint16_t > &	getCommandHandlerIds ()

Protected Attributes inherited from ButtonSource
uint16_t	btnnum = 0

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

Protected Attributes inherited from PersistentStorage
bool	restoreDelayedFlag = false

Protected Attributes inherited from CommandHandler
bool	commandsEnabled = true

std::vector< CmdHandlerCommanddef >	registeredCommands

CmdHandlerInfo	cmdHandlerInfo

Protected Attributes inherited from SPIDevice
SPIPort &	spiPort

SPIConfig	spiConfig

Static Protected Attributes inherited from PersistentStorage
static bool	startupComplete = false

Detailed Description

Definition at line 35 of file SPIButtons.h.

Member Enumeration Documentation

◆ SPIButtons_commands

enum class SPI_Buttons::SPIButtons_commands : uint32_t

strongprivate

Enumerator
mode
btncut
btnpol
btnnum
cs
spispeed

Definition at line 37 of file SPIButtons.h.

Constructor & Destructor Documentation

◆ ~SPI_Buttons()

SPI_Buttons::~SPI_Buttons ( )

virtual

Definition at line 74 of file SPIButtons.cpp.

◆ SPI_Buttons()

SPI_Buttons::SPI_Buttons	(	uint16_t	configuration_address,
		uint16_t	configuration_address_2
	)

protected

Definition at line 47 of file SPIButtons.cpp.

Member Function Documentation

◆ command()

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

overridevirtual

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 CommandHandler.

Definition at line 202 of file SPIButtons.cpp.

◆ getClassType()

const ClassType SPI_Buttons::getClassType ( )

inlineoverridevirtual

returns the used classchooser selection id of this instance

Type of this class. Mainclass, motordriver... Should be implemented by the parent class so it is not in the info struct

Reimplemented from ButtonSource.

Definition at line 61 of file SPIButtons.h.

◆ getConfig()

ButtonSourceConfig * SPI_Buttons::getConfig ( )

privatevirtual

Definition at line 142 of file SPIButtons.cpp.

◆ getHelpstring()

virtual std::string SPI_Buttons::getHelpstring ( )

inlinevirtual

Returns a description of this class

Reimplemented from CommandHandler.

Definition at line 51 of file SPIButtons.h.

◆ initSPI()

void SPI_Buttons::initSPI ( )

Definition at line 68 of file SPIButtons.cpp.

◆ printModes()

std::string SPI_Buttons::printModes ( const std::vector< std::string > & names )

Definition at line 194 of file SPIButtons.cpp.

◆ process()

void SPI_Buttons::process ( uint64_t * buf )

private

Definition at line 167 of file SPIButtons.cpp.

◆ readButtons()

uint8_t SPI_Buttons::readButtons ( uint64_t * buf )

virtual

Return a bit field without offset of pressed buttons in the supplied buffer. Returns amount of button read.

Implements ButtonSource.

◆ registerCommands()

void SPI_Buttons::registerCommands ( )

Definition at line 79 of file SPIButtons.cpp.

◆ restoreFlash()

void SPI_Buttons::restoreFlash ( )

virtual

Should be implemented to restore settings. This is not automatically called and should be called when appropriate.

Reimplemented from PersistentStorage.

Definition at line 160 of file SPIButtons.cpp.

◆ saveFlash()

void SPI_Buttons::saveFlash ( )

virtual

Called when the user uses the "save" command and presses the save button in the configurator Automatically called by the command parser thread for every class that inherits from PersistentStorage

Reimplemented from PersistentStorage.

Definition at line 153 of file SPIButtons.cpp.

◆ setConfig()

void SPI_Buttons::setConfig ( ButtonSourceConfig config )

private

Definition at line 97 of file SPIButtons.cpp.

◆ setMode()

void SPI_Buttons::setMode ( SPI_BtnMode mode )

Called on preset change

Definition at line 92 of file SPIButtons.cpp.

◆ setSpiSpeed()

void SPI_Buttons::setSpiSpeed ( uint8_t speedPreset )

Definition at line 146 of file SPIButtons.cpp.

Member Data Documentation

◆ bytes

uint8_t SPI_Buttons::bytes = 4

private

Definition at line 75 of file SPIButtons.h.

◆ conf

ButtonSourceConfig SPI_Buttons::conf

private

Definition at line 79 of file SPIButtons.h.

◆ configuration_address

uint16_t SPI_Buttons::configuration_address

private

Definition at line 69 of file SPIButtons.h.

◆ configuration_address_2

uint16_t SPI_Buttons::configuration_address_2

private

Definition at line 70 of file SPIButtons.h.

◆ mask

uint64_t SPI_Buttons::mask = 0xff

private

Definition at line 76 of file SPIButtons.h.

◆ maxButtons

const uint8_t SPI_Buttons::maxButtons = 64

Definition at line 56 of file SPIButtons.h.

◆ mode_names

const std::vector< std::string > SPI_Buttons::mode_names = {"Thrustmaster/HEF4021BT","74xx165"}

static

Definition at line 42 of file SPIButtons.h.

◆ offset

uint8_t SPI_Buttons::offset = 0

private

Definition at line 77 of file SPIButtons.h.

◆ ready

bool SPI_Buttons::ready = false

private

Definition at line 71 of file SPIButtons.h.

◆ speed_names

const std::vector< std::string > SPI_Buttons::speed_names = {"Fast","Medium","Slow"}

static

Definition at line 43 of file SPIButtons.h.

◆ speedPresets

constexpr std::array<uint32_t,3> SPI_Buttons::speedPresets = {SPI_BAUDRATEPRESCALER_16,SPI_BAUDRATEPRESCALER_32,SPI_BAUDRATEPRESCALER_64}

staticconstexprprivate

Definition at line 83 of file SPIButtons.h.

◆ spi_buf

uint8_t SPI_Buttons::spi_buf[4] = {0}

private

Definition at line 81 of file SPIButtons.h.

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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SPIButtons_commands

Constructor & Destructor Documentation

◆ ~SPI_Buttons()

◆ SPI_Buttons()

Member Function Documentation

◆ command()

◆ getClassType()

◆ getConfig()

◆ getHelpstring()

◆ initSPI()

◆ printModes()

◆ process()

◆ readButtons()

◆ registerCommands()

◆ restoreFlash()

◆ saveFlash()

◆ setConfig()

◆ setMode()

◆ setSpiSpeed()

Member Data Documentation

◆ bytes

◆ conf

◆ configuration_address

◆ configuration_address_2

◆ mask

◆ maxButtons

◆ mode_names

◆ offset

◆ ready

◆ speed_names

◆ speedPresets

◆ spi_buf