Inheritance diagram for Mrm_8x8a:

Public Member Functions
	Mrm_8x8a (Robot *robot=NULL, uint8_t maxDevices=1)

void	activeCheckIfStartedSet (bool value)

ActionBase *	actionCheck ()

void	actionSet (ActionBase *action, uint8_t switchNumber, uint8_t deviceNumber=0)

void	add (char deviceName=(char )"")

void	bitmapDisplay (uint8_t bitmapId, uint8_t deviceNumber=0)

void	bitmapCustomDisplay (uint8_t red[], uint8_t green[], uint8_t deviceNumber=0)

void	bitmapCustomStore (uint8_t red[], uint8_t green[], uint8_t address, uint8_t deviceNumber=0)

void	bitmapCustomStoredDisplay (uint8_t address, uint8_t deviceNumber=0)

bool	messageDecode (uint32_t canId, uint8_t data[8])

bool	progressBar (uint32_t period, uint32_t current, bool reset=false)

void	rotationSet (enum LED8x8Rotation rotation=LED_8X8_BY_0_DEGREES, uint8_t deviceNumber=0)

bool	switchRead (uint8_t switchNumber, uint8_t deviceNumber=0)

void	text (char content[], uint8_t deviceNumber=0)

void	test ()

Public Member Functions inherited from SensorBoard
	SensorBoard (Robot robot, uint8_t devicesOnABoard, const char boardName, uint8_t maxNumberOfBoards, BoardId id)

void	continuousReadingCalculatedDataStart (uint8_t deviceNumber=0xFF)

Public Member Functions inherited from Board
	Board (Robot robot, uint8_t maxNumberOfBoards, uint8_t devicesOnABoard, const char boardName, BoardType boardType, BoardId id)

void	add (char *deviceName, uint16_t canIn, uint16_t canOut)

bool	alive (uint8_t deviceNumber=0, bool checkAgainIfDead=false, bool errorIfNotAfterCheckingAgain=false)

uint8_t	count ()

void	aliveSet (bool yesOrNo, uint8_t deviceNumber=0)

BoardType	boardType ()

uint8_t	deadOrAliveCount ()

uint8_t	devicesOnASingleBoard ()

uint8_t	devicesMaximumNumberInAllBoards ()

uint8_t	devicesScan (bool verbose=true, uint16_t mask=0xFFFF)

uint8_t	errorCodeLast ()

uint8_t	errorWasInDeviceNumber ()

void	firmwareRequest (uint8_t deviceNumber=0xFF)

uint16_t	fps (uint8_t deviceNumber=0)

void	fpsDisplay ()

void	fpsRequest (uint8_t deviceNumber=0xFF)

BoardId	id ()

void	idChange (uint16_t newDeviceNumber, uint8_t deviceNumber=0)

void	info (uint8_t deviceNumber=0xFF)

bool	isForMe (uint32_t canIdOut, uint8_t deviceNumber)

bool	isFromMe (uint32_t canIdOut, uint8_t deviceNumber)

uint32_t	lastMessageMs (uint8_t deviceNumber=0)

bool	messagePrint (uint32_t msgId, uint8_t dlc, uint8_t *data, bool outbound)
	‍** Prints a frame More...

void	messageSend (uint8_t *data, uint8_t dlc, uint8_t deviceNumber=0)

char *	name (uint8_t deviceNumber)

char *	name ()

void	notificationRequest (uint8_t commandRequestingNotification, uint8_t deviceNumber)

void	oscillatorTest (uint8_t deviceNumber=0xFF)

void	reset (uint8_t deviceNumber=0xFF)

void	start (uint8_t deviceNumber=0xFF, uint8_t measuringModeNow=0, uint16_t refreshMs=0)

void	swap (uint8_t deviceNumber1, uint8_t deviceNumber2)

void	stop (uint8_t deviceNumber=0xFF)

virtual void	test (uint8_t deviceNumber=0xFF, uint16_t betweenTestsMs=0)

Additional Inherited Members
Protected Member Functions inherited from Board
bool	messageDecodeCommon (uint32_t canId, uint8_t data[8], uint8_t deviceNumber=0)

Protected Attributes inherited from Board
uint32_t	_alive

bool	_aliveReport = false

char	_boardsName [12]

BoardType	_boardType

uint8_t	canData [8]

uint8_t	devicesOnABoard

uint8_t	errorCode = 0

uint8_t	errorInDeviceNumber = 0

std::vector< uint16_t > *	fpsLast

BoardId	_id

std::vector< uint32_t > *	idIn

std::vector< uint32_t > *	idOut

std::vector< uint32_t > *	lastMessageReceivedMs

std::vector< uint32_t > *	_lastReadingMs

uint8_t	maximumNumberOfBoards

uint8_t	measuringMode = 0

uint8_t	measuringModeLimit = 0

uint8_t	_message [29]

std::vector< char[10]> *	_name

int	nextFree

Robot *	robotContainer

Constructor & Destructor Documentation

◆ Mrm_8x8a()

Mrm_8x8a::Mrm_8x8a	(	Robot *	robot = `NULL`,
		uint8_t	maxNumberOfBoards = `1`
	)

Constructor

Parameters

robot	- robot containing this board
esp32CANBusSingleton	- a single instance of CAN Bus common library for all CAN Bus peripherals.
hardwareSerial	- Serial, Serial1, Serial2,... - an optional serial port, for example for Bluetooth communication

Constructor

Parameters

robot	- robot containing this board
esp32CANBusSingleton	- a single instance of CAN Bus common library for all CAN Bus peripherals.
hardwareSerial	- Serial, Serial1, Serial2,... - an optional serial port, for example for Bluetooth communication
maxNumberOfBoards	- maximum number of boards

Member Function Documentation

◆ activeCheckIfStartedSet()

void Mrm_8x8a::activeCheckIfStartedSet ( bool value )

inline

Contacting mrm_8x8a periodically to check. Normally true:

◆ add()

void Mrm_8x8a::add ( char * deviceName = (char*)"" )

Add a mrm-8x8a board

Parameters

deviceName - device's name

◆ bitmapCustomDisplay()

void Mrm_8x8a::bitmapCustomDisplay	(	uint8_t	red[],
		uint8_t	green[],
		uint8_t	deviceNumber = `0`
	)

Display custom bitmap

Parameters

red	- 8-byte array for red
green	- 8-byte array for green
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

◆ bitmapCustomStore()

void Mrm_8x8a::bitmapCustomStore	(	uint8_t	red[],
		uint8_t	green[],
		uint8_t	address,
		uint8_t	deviceNumber = `0`
	)

Store custom bitmap

Parameters

red	- 8-byte array for red
green	- 8-byte array for green
addres	- address in display's RAM. 0 - 99.
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

◆ bitmapCustomStoredDisplay()

void Mrm_8x8a::bitmapCustomStoredDisplay	(	uint8_t	address,
		uint8_t	deviceNumber = `0`
	)

Display custom custom bitmap

Parameters

addres	- address in display's RAM. 0 - 99.
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

Display custom stored bitmap

Parameters

addres	- address in display's RAM. 0 - 99.
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

◆ bitmapDisplay()

void Mrm_8x8a::bitmapDisplay	(	uint8_t	bitmapId,
		uint8_t	deviceNumber = `0`
	)

Display stored (in sensor, read-only) bitmap

Parameters

bitmapId	- bitmap's id
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

◆ messageDecode()

bool Mrm_8x8a::messageDecode	(	uint32_t	canId,
		uint8_t	data[8]
	)

virtual

Read CAN Bus message into local variables

Parameters

canId	- CAN Bus id
data	- 8 bytes from CAN Bus message.

Returns: - true if canId for this class

Reimplemented from SensorBoard.

◆ progressBar()

bool Mrm_8x8a::progressBar	(	uint32_t	period,
		uint32_t	current,
		bool	reset = `false`
	)

Displays 8-row progress bar. Useful for visual feedback of a long process.

Parameters

period	- total count (100%)
current	- current count (current percentage)
reset	- reset to start (no bar)

Returns: - display changed

◆ rotationSet()

void Mrm_8x8a::rotationSet	(	enum LED8x8Rotation	rotation = `LED_8X8_BY_0_DEGREES`,
		uint8_t	deviceNumber = `0`
	)

Set rotation from now on

Parameters

rotation	- 0, 90, or 270 degrees counterclockwise
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

◆ switchRead()

bool Mrm_8x8a::switchRead	(	uint8_t	switchNumber,
		uint8_t	deviceNumber = `0`
	)

Read switch

Parameters

switchNumber - 0 - 3 @deviceNumber - Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

Returns: - true if pressed, false otherwise

Read switch

Parameters

switchNumber @deviceNumber - Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

Returns: - true if pressed, false otherwise

◆ test()

void Mrm_8x8a::test ( )

Test

◆ text()

void Mrm_8x8a::text	(	char	content[],
		uint8_t	deviceNumber = `0`
	)

Display text

Parameters

content	- text
deviceNumber	- Displays's ordinal number. Each call of function add() assigns a increasing number to the device, starting with 0.

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

C:/Users/priba/Documents/PlatformIO/Projects/MRMS/lib/mrm-8x8a/src/mrm-8x8a.h
C:/Users/priba/Documents/PlatformIO/Projects/MRMS/lib/mrm-8x8a/src/mrm-8x8a.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Mrm_8x8a()

Member Function Documentation

◆ activeCheckIfStartedSet()

◆ add()

◆ bitmapCustomDisplay()

◆ bitmapCustomStore()

◆ bitmapCustomStoredDisplay()

◆ bitmapDisplay()

◆ messageDecode()

◆ progressBar()

◆ rotationSet()

◆ switchRead()

◆ test()

◆ text()