#include <device_object.h>

Inheritance diagram for DeviceObject:

Collaboration diagram for DeviceObject:

Public Member Functions
	DeviceObject ()

uint8_t *	save (uint8_t *buffer) override
	This method is called when the object should save its state to the buffer. More...

const uint8_t *	restore (const uint8_t *buffer) override
	This method is called when the object should restore its state from the buffer. More...

uint16_t	saveSize () override

uint16_t	individualAddress ()

void	individualAddress (uint16_t value)

void	individualAddressDuplication (bool value)

bool	verifyMode ()

void	verifyMode (bool value)

bool	progMode ()

void	progMode (bool value)

uint16_t	manufacturerId ()

void	manufacturerId (uint16_t value)

uint32_t	bauNumber ()

void	bauNumber (uint32_t value)

const uint8_t *	orderNumber ()

void	orderNumber (const uint8_t *value)

const uint8_t *	hardwareType ()

void	hardwareType (const uint8_t *value)

uint16_t	version ()

void	version (uint16_t value)

uint16_t	maskVersion ()

void	maskVersion (uint16_t value)

uint16_t	maxApduLength ()

void	maxApduLength (uint16_t value)

const uint8_t *	rfDomainAddress ()

void	rfDomainAddress (uint8_t *value)

uint8_t	defaultHopCount ()

Public Member Functions inherited from InterfaceObject
virtual	~InterfaceObject ()
	Destructor. More...

virtual void	readPropertyLength (PropertyID id, uint16_t &length)
	Read length of a property of the interface object. More...

virtual void	readProperty (PropertyID id, uint16_t start, uint8_t &count, uint8_t *data)
	Read a property of the interface object. More...

virtual void	writeProperty (PropertyID id, uint16_t start, uint8_t *data, uint8_t &count)
	Write property of the interface object. More...

virtual uint8_t	propertySize (PropertyID id)
	Gets the size of of property in bytes. More...

virtual void	command (PropertyID id, uint8_t data, uint8_t length, uint8_t resultData, uint8_t &resultLength)
	Call command of a function property of the interface object. More...

virtual void	state (PropertyID id, uint8_t data, uint8_t length, uint8_t resultData, uint8_t &resultLength)
	Get state of a function property of the interface object. More...

void	readPropertyDescription (uint8_t &propertyId, uint8_t &propertyIndex, bool &writeEnable, uint8_t &type, uint16_t &numberOfElements, uint8_t &access)
	Read the Description of a property of the interface object. More...

virtual void	masterReset (EraseCode eraseCode, uint8_t channel)

Property *	property (PropertyID id)
	Gets property with PropertyID id if it exists and nullptr otherwise. More...

template<typename T >
T	propertyValue (PropertyID id)

template<typename T >
void	propertyValue (PropertyID id, T value)

const uint8_t *	propertyData (PropertyID id)

const uint8_t *	propertyData (PropertyID id, uint16_t elementIndex)

const Property *	property (PropertyID id) const
	Gets const property with PropertyID id if it exists and nullptr otherwise. More...

uint8_t *	save (uint8_t *buffer) override
	This method is called when the object should save its state to the buffer. More...

const uint8_t *	restore (const uint8_t *buffer) override
	This method is called when the object should restore its state from the buffer. More...

uint16_t	saveSize () override

Public Attributes
const uint16_t	apiVersion = 1

Additional Inherited Members
Protected Member Functions inherited from InterfaceObject
virtual void	initializeProperties (size_t propertiesSize, Property **properties)
	Intializes the Property-array the the supplied values. More...

Protected Attributes inherited from InterfaceObject
Property **	_properties = nullptr

uint8_t	_propertyCount = 0

Detailed Description

Definition at line 7 of file device_object.h.

Constructor & Destructor Documentation

◆ DeviceObject()

DeviceObject::DeviceObject ( )

Definition at line 10 of file device_object.cpp.

Member Function Documentation

◆ bauNumber() [1/2]

uint32_t DeviceObject::bauNumber ( )

Definition at line 195 of file device_object.cpp.

Here is the call graph for this function:

◆ bauNumber() [2/2]

void DeviceObject::bauNumber ( uint32_t value )

Definition at line 202 of file device_object.cpp.

Here is the call graph for this function:

◆ defaultHopCount()

uint8_t DeviceObject::defaultHopCount ( )

Definition at line 288 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hardwareType() [1/2]

const uint8_t * DeviceObject::hardwareType ( )

Definition at line 222 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hardwareType() [2/2]

void DeviceObject::hardwareType ( const uint8_t * value )

Definition at line 228 of file device_object.cpp.

Here is the call graph for this function:

◆ individualAddress() [1/2]

uint16_t DeviceObject::individualAddress ( )

Definition at line 115 of file device_object.cpp.

Here is the caller graph for this function:

◆ individualAddress() [2/2]

void DeviceObject::individualAddress ( uint16_t value )

Definition at line 120 of file device_object.cpp.

◆ individualAddressDuplication()

void DeviceObject::individualAddressDuplication ( bool value )

Definition at line 131 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manufacturerId() [1/2]

uint16_t DeviceObject::manufacturerId ( )

Definition at line 180 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manufacturerId() [2/2]

void DeviceObject::manufacturerId ( uint16_t value )

Definition at line 187 of file device_object.cpp.

Here is the call graph for this function:

◆ maskVersion() [1/2]

uint16_t DeviceObject::maskVersion ( )

Definition at line 248 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maskVersion() [2/2]

void DeviceObject::maskVersion ( uint16_t value )

Definition at line 256 of file device_object.cpp.

Here is the call graph for this function:

◆ maxApduLength() [1/2]

uint16_t DeviceObject::maxApduLength ( )

Definition at line 262 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxApduLength() [2/2]

void DeviceObject::maxApduLength ( uint16_t value )

Definition at line 270 of file device_object.cpp.

Here is the call graph for this function:

◆ orderNumber() [1/2]

const uint8_t * DeviceObject::orderNumber ( )

Definition at line 210 of file device_object.cpp.

Here is the call graph for this function:

◆ orderNumber() [2/2]

void DeviceObject::orderNumber ( const uint8_t * value )

Definition at line 216 of file device_object.cpp.

Here is the call graph for this function:

◆ progMode() [1/2]

bool DeviceObject::progMode ( )

Definition at line 167 of file device_object.cpp.

Here is the caller graph for this function:

◆ progMode() [2/2]

void DeviceObject::progMode ( bool value )

Definition at line 172 of file device_object.cpp.

◆ restore()

const uint8_t * DeviceObject::restore ( const uint8_t * buffer )

overridevirtual

This method is called when the object should restore its state from the buffer.

Parameters

buffer The buffer the object should restore its state from.

Returns: The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented from SaveRestore.

Definition at line 104 of file device_object.cpp.

Here is the call graph for this function:

◆ rfDomainAddress() [1/2]

const uint8_t * DeviceObject::rfDomainAddress ( )

Definition at line 276 of file device_object.cpp.

Here is the call graph for this function:

◆ rfDomainAddress() [2/2]

void DeviceObject::rfDomainAddress ( uint8_t * value )

Definition at line 282 of file device_object.cpp.

Here is the call graph for this function:

◆ save()

uint8_t * DeviceObject::save ( uint8_t * buffer )

overridevirtual

This method is called when the object should save its state to the buffer.

Parameters

buffer The buffer the object should save its state to.

Returns: The buffer plus the size of the object state. The next object will use this value as the start of its buffer.

Reimplemented from SaveRestore.

Definition at line 98 of file device_object.cpp.

Here is the call graph for this function:

◆ saveSize()

uint16_t DeviceObject::saveSize ( )

overridevirtual

Returns: The maximum number of bytes the object needs to save its state.

Reimplemented from SaveRestore.

Definition at line 110 of file device_object.cpp.

Here is the call graph for this function:

◆ verifyMode() [1/2]

bool DeviceObject::verifyMode ( )

Definition at line 145 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ verifyMode() [2/2]

void DeviceObject::verifyMode ( bool value )

Definition at line 153 of file device_object.cpp.

Here is the call graph for this function:

◆ version() [1/2]

uint16_t DeviceObject::version ( )

Definition at line 234 of file device_object.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ version() [2/2]

void DeviceObject::version ( uint16_t value )

Definition at line 242 of file device_object.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ apiVersion

const uint16_t DeviceObject::apiVersion = 1

Definition at line 12 of file device_object.h.

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

src/knx/device_object.h
src/knx/device_object.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeviceObject()

Member Function Documentation

◆ bauNumber() [1/2]

◆ bauNumber() [2/2]

◆ defaultHopCount()

◆ hardwareType() [1/2]

◆ hardwareType() [2/2]

◆ individualAddress() [1/2]

◆ individualAddress() [2/2]

◆ individualAddressDuplication()

◆ manufacturerId() [1/2]

◆ manufacturerId() [2/2]

◆ maskVersion() [1/2]

◆ maskVersion() [2/2]

◆ maxApduLength() [1/2]

◆ maxApduLength() [2/2]

◆ orderNumber() [1/2]

◆ orderNumber() [2/2]

◆ progMode() [1/2]

◆ progMode() [2/2]

◆ restore()

◆ rfDomainAddress() [1/2]

◆ rfDomainAddress() [2/2]

◆ save()

◆ saveSize()

◆ verifyMode() [1/2]

◆ verifyMode() [2/2]

◆ version() [1/2]

◆ version() [2/2]

Member Data Documentation

◆ apiVersion