#include <arduino_platform.h>

Inheritance diagram for ArduinoPlatform:

Collaboration diagram for ArduinoPlatform:

Public Member Functions
	ArduinoPlatform ()

	ArduinoPlatform (HardwareSerial *knxSerial)

void	fatalError ()

virtual void	knxUart (HardwareSerial *serial)

virtual HardwareSerial *	knxUart ()

virtual void	setupUart ()

virtual void	closeUart ()

virtual int	uartAvailable ()

virtual size_t	writeUart (const uint8_t data)

virtual size_t	writeUart (const uint8_t *buffer, size_t size)

virtual int	readUart ()

virtual size_t	readBytesUart (uint8_t *buffer, size_t length)

virtual void	flushUart ()

void	setupSpi () override

void	closeSpi () override

int	readWriteSpi (uint8_t *data, size_t len) override

Public Member Functions inherited from Platform
virtual	~Platform ()

virtual uint32_t	currentIpAddress ()

virtual uint32_t	currentSubnetMask ()

virtual uint32_t	currentDefaultGateway ()

virtual void	macAddress (uint8_t *data)

virtual uint32_t	uniqueSerialNumber ()

virtual void	restart ()=0

virtual void	setupMultiCast (uint32_t addr, uint16_t port)

virtual void	closeMultiCast ()

virtual bool	sendBytesMultiCast (uint8_t *buffer, uint16_t len)

virtual int	readBytesMultiCast (uint8_t *buffer, uint16_t maxLen)

virtual int	readBytesMultiCast (uint8_t *buffer, uint16_t maxLen, uint32_t &src_addr, uint16_t &src_port)

virtual bool	sendBytesUniCast (uint32_t addr, uint16_t port, uint8_t *buffer, uint16_t len)

virtual bool	overflowUart ()

virtual uint8_t *	getEepromBuffer (uint32_t size)

virtual void	commitToEeprom ()

virtual uint8_t *	getNonVolatileMemoryStart ()

virtual size_t	getNonVolatileMemorySize ()

virtual void	commitNonVolatileMemory ()

virtual uint32_t	writeNonVolatileMemory (uint32_t relativeAddress, uint8_t *buffer, size_t size)

virtual uint32_t	readNonVolatileMemory (uint32_t relativeAddress, uint8_t *buffer, size_t size)

virtual uint32_t	writeNonVolatileMemory (uint32_t relativeAddress, uint8_t value, size_t repeat)

NvMemoryType	NonVolatileMemoryType ()

void	NonVolatileMemoryType (NvMemoryType type)

virtual size_t	flashPageSize ()

void	registerFlashCallbacks (FlashCallbackSize callbackFlashSize, FlashCallbackRead callbackFlashRead, FlashCallbackWrite callbackFlashWrite, FlashCallbackCommit callbackFlashCommit)

FlashCallbackSize	callbackFlashSize ()

FlashCallbackRead	callbackFlashRead ()

FlashCallbackWrite	callbackFlashWrite ()

FlashCallbackCommit	callbackFlashCommit ()

Static Public Attributes
static Stream *	SerialDebug = &KNX_DEBUG_SERIAL

Protected Attributes
HardwareSerial *	_knxSerial

Protected Attributes inherited from Platform
NvMemoryType	_memoryType = Eeprom

uint8_t *	_eraseblockBuffer = nullptr

int32_t	_bufferedEraseblockNumber = -1

bool	_bufferedEraseblockDirty = false

FlashCallbackSize	_callbackFlashSize = nullptr

FlashCallbackRead	_callbackFlashRead = nullptr

FlashCallbackWrite	_callbackFlashWrite = nullptr

FlashCallbackCommit	_callbackFlashCommit = nullptr

Additional Inherited Members
Protected Member Functions inherited from Platform
virtual size_t	flashEraseBlockSize ()

virtual uint8_t *	userFlashStart ()

virtual size_t	userFlashSizeEraseBlocks ()

virtual void	flashErase (uint16_t eraseBlockNum)

virtual void	flashWritePage (uint16_t pageNumber, uint8_t *data)

void	loadEraseblockContaining (uint32_t relativeAddress)

int32_t	getEraseBlockNumberOf (uint32_t relativeAddress)

virtual void	writeBufferedEraseBlock ()

void	bufferEraseBlock (int32_t eraseBlockNumber)

Detailed Description

Definition at line 13 of file arduino_platform.h.

Constructor & Destructor Documentation

◆ ArduinoPlatform() [1/2]

ArduinoPlatform::ArduinoPlatform ( )

Definition at line 15 of file arduino_platform.cpp.

◆ ArduinoPlatform() [2/2]

ArduinoPlatform::ArduinoPlatform ( HardwareSerial * knxSerial )

Definition at line 19 of file arduino_platform.cpp.

Member Function Documentation

◆ closeSpi()

void ArduinoPlatform::closeSpi ( )

overridevirtual

Reimplemented from Platform.

Definition at line 125 of file arduino_platform.cpp.

◆ closeUart()

void ArduinoPlatform::closeUart ( )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 62 of file arduino_platform.cpp.

Here is the caller graph for this function:

◆ fatalError()

void ArduinoPlatform::fatalError ( )

virtual

Implements Platform.

Definition at line 23 of file arduino_platform.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flushUart()

void ArduinoPlatform::flushUart ( )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 113 of file arduino_platform.cpp.

◆ knxUart() [1/2]

HardwareSerial * ArduinoPlatform::knxUart ( )

virtual

Reimplemented in RP2040ArduinoPlatform.

Definition at line 48 of file arduino_platform.cpp.

◆ knxUart() [2/2]

void ArduinoPlatform::knxUart ( HardwareSerial * serial )

virtual

Reimplemented in RP2040ArduinoPlatform.

Definition at line 39 of file arduino_platform.cpp.

Here is the call graph for this function:

◆ readBytesUart()

size_t ArduinoPlatform::readBytesUart	(	uint8_t *	buffer,
		size_t	length
	)

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 97 of file arduino_platform.cpp.

◆ readUart()

int ArduinoPlatform::readUart ( )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 88 of file arduino_platform.cpp.

◆ readWriteSpi()

int ArduinoPlatform::readWriteSpi	(	uint8_t *	data,
		size_t	len
	)

overridevirtual

Reimplemented from Platform.

Definition at line 131 of file arduino_platform.cpp.

◆ setupSpi()

void ArduinoPlatform::setupSpi ( )

overridevirtual

Reimplemented from Platform.

Definition at line 119 of file arduino_platform.cpp.

◆ setupUart()

void ArduinoPlatform::setupUart ( )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform, and Esp32Platform.

Definition at line 53 of file arduino_platform.cpp.

Here is the caller graph for this function:

◆ uartAvailable()

int ArduinoPlatform::uartAvailable ( )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 68 of file arduino_platform.cpp.

◆ writeUart() [1/2]

size_t ArduinoPlatform::writeUart	(	const uint8_t *	buffer,
		size_t	size
	)

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 81 of file arduino_platform.cpp.

◆ writeUart() [2/2]

size_t ArduinoPlatform::writeUart ( const uint8_t data )

virtual

Reimplemented from Platform.

Reimplemented in RP2040ArduinoPlatform.

Definition at line 74 of file arduino_platform.cpp.

Member Data Documentation

◆ _knxSerial

HardwareSerial* ArduinoPlatform::_knxSerial

protected

Definition at line 45 of file arduino_platform.h.

◆ SerialDebug

Stream * ArduinoPlatform::SerialDebug = &KNX_DEBUG_SERIAL

static

Definition at line 41 of file arduino_platform.h.

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

src/arduino_platform.h
src/arduino_platform.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArduinoPlatform() [1/2]

◆ ArduinoPlatform() [2/2]

Member Function Documentation

◆ closeSpi()

◆ closeUart()

◆ fatalError()

◆ flushUart()

◆ knxUart() [1/2]

◆ knxUart() [2/2]

◆ readBytesUart()

◆ readUart()

◆ readWriteSpi()

◆ setupSpi()

◆ setupUart()

◆ uartAvailable()

◆ writeUart() [1/2]

◆ writeUart() [2/2]

Member Data Documentation

◆ _knxSerial

◆ SerialDebug