BaosServerItems is used to get/set the server item parameters from/on the remote device. More...

#include <BaosServerItems.h>

Public Types
enum	Baudrate { Unknown = 0, B19200, B115200 }
	Possible values for server item Baudrate, id 13. More...

enum	ProgrammingMode { NotActive = 0, Active }
	Possible values for server item ProgrammingMode, id 15. More...

enum	IndicationSetting { IndicationSetting_NotActive = 0, IndicationSetting_Active }
	Possible values for server item Indication Sending, id 17. More...

Public Member Functions
	BaosServerItems (std::shared_ptr< BaosConnector > connector)
	Creates a BaosServerItems object with a specified connector. More...

	~BaosServerItems ()
	Destroys the BaosServerItems. More...

std::vector< unsigned char >	getHardwareType () const
	Gets the hardware type. More...

unsigned char	getHardwareVersion () const
	Gets the version of the ObjectServer hardware Coding Ex. More...

unsigned char	getFirmwareVersion () const
	Gets the version of ObjectServer firmware. More...

unsigned int	getManufactureCodeDevice () const
	Gets the KNX manufacturer code of the device. More...

unsigned int	getManufactureCodeApp () const
	Gets the KNX manufacturer code loaded by ETS. More...

unsigned int	getApplicationId () const
	Gets the id of application loaded by ETS. More...

unsigned char	getApplicationVersion () const
	Gets the version of application loaded by ETS. More...

std::vector< unsigned char >	getSerialNumber () const
	Gets KNX serial number of device. More...

unsigned long	getTimeSinceReset () const
	Gets the time since reset in ms. More...

bool	isBusConnected () const
	Returns true if the KNX bus is connected, otherwise false. More...

unsigned int	getMaxBufferSize () const
	Gets the maximal buffer size. More...

unsigned int	getLengthOfDescriptionString () const
	Gets the length of the description string. More...

void	setBaudrate (unsigned char baudrate)
	Sets the Baudrate Values: BaosServerItems::Unknown, BaosServerItems::BB19200, BaosServerItems::B115200. More...

unsigned char	getBaudrate () const
	Gets the baudrate. More...

void	setBufferSize (unsigned int bufferSize)
	Sets the current buffer size. More...

unsigned int	getBufferSize () const
	Gets the current buffer size. More...

void	setProgrammingMode (unsigned char programmingMode)
	Sets the programming mode Values: ProgrammingMode::NotActive ProgrammingMode::Active Server item: Programming mode, id 15. More...

unsigned char	getProgrammingMode () const
	Gets the programming mode. More...

unsigned char	getProtocolVersion () const
	Gets the version of the ObjectServer binary protocol. More...

unsigned char	getBinaryProtocolVersion () const
	Gets the version of the ObjectServer binary protocol Server item: Protocol Version (Binary), id 16. More...

void	setIndicationSetting (unsigned char indicationSetting)
	Sets the indication setting Values: IndicationSetting::IndicationSetting_NotActive IndicationSetting::IndicationSetting_Active Server item: Indication Sending, id 17. More...

unsigned char	getIndicationSetting () const
	Gets the indication setting Server item: Indication Sending, id 17. More...

unsigned char	getWebServicesProtocolVersion () const
	Gets the version of the ObjectServer web services protocol Server item: Protocol Version (WebService), id 18. More...

unsigned char	getRestServiceProtocolVersion () const
	Gets the version of the ObjectServer web services protocol Server item: Protocol Version (WebService), id 19. More...

unsigned short	getIndividualAddress () const
	Gets the KNX individual address. More...

std::vector< unsigned char >	getMacAddress () const
	Gets the MAC address. More...

bool	isTunnellingEnabled () const
	Returns true if the KNXnet/IP Tunneling service is enabled, otherwise false. More...

bool	isBaosBinaryEnabled () const
	Returns true if the BAOS Binary service is enabled, otherwise false. More...

bool	isBaosWebEnabled () const
	Returns true if the BAOS Web service is enabled, otherwise false. More...

bool	isBaosRestEnabled () const
	Returns true if the BAOS Rest service is enabled, otherwise false. More...

bool	isHttpFileEnabled () const
	Returns true if the HTTP file service is enabled, otherwise false. More...

bool	isSearchRequestEnabled () const
	Returns true if the KNXnet/IP Search service is enabled, otherwise false. More...

bool	isIsStructured () const
	Returns true if the loaded application is a structured database, otherwise false. More...

unsigned char	getMaxManagementClients () const
	Gets the maximum supported management clients. More...

unsigned char	getConnectedManagementClients () const
	Gets the current connected management clients. More...

unsigned char	getMaxTunnellingClients () const
	Gets the maximum supported tunneling clients. More...

unsigned char	getConnectedTunnellingClients () const
	Gets the current connected tunneling clients. More...

unsigned char	getMaxBaosUdpClients () const
	Gets the maximum supported BAOS UDP clients. More...

unsigned char	getConnectedBaosUdpClients () const
	Gets the current connected BAOS UDP clients. More...

unsigned char	getMaxBaosTcpClients () const
	Gets the maximum supported BAOS TCP clients. More...

unsigned char	getConnectedBaosTcpClients () const
	Gets the current connected BAOS TCP clients. More...

std::string	getDeviceFriendlyName () const
	Gets the device friendly name. More...

unsigned short	getMaxDatapoints () const
	Gets the maximum supported datapoints. More...

unsigned short	getConfiguredDatapoints () const
	Gets the current configured datapoints. More...

unsigned short	getMaxParameterBytes () const
	Gets the maximum supported parameter bytes. More...

unsigned short	getDownloadCounter () const
	Gets the download counter. More...

unsigned char	getIpAssignment () const
	Gets the IP assignment method. More...

unsigned int	getIpAddress () const
	Gets the IP address. More...

unsigned int	getSubnetMask () const
	Gets the subnet mask. More...

unsigned int	getDefaultGateway () const
	Gets the IP address of the default gateway. More...

unsigned char	getTimeSinceResetUnit () const
	Gets the time since reset. More...

std::vector< unsigned char >	getSystemTime () const
	Gets the system time. More...

unsigned char	getSystemTimezoneOffset () const
	Gets the system timezone offset. More...

bool	isMenuEnabled () const
	Returns true if Menu is enabled, otherwise false. More...

bool	isSuspendEnabled () const
	Returns true if Suspend is enabled, otherwise false. More...

void	setSuspend (unsigned char suspend)
	Set new value for suspend. More...

Detailed Description

BaosServerItems is used to get/set the server item parameters from/on the remote device.

It wraps the GetServerItem and SetServerItem services, which are byte based and provides the appropriate interpretation to convert the parameters to their corresponding values.

Examples:: BaosMultiThreaded.cpp, BaosSerial.cpp, and BaosUsb.cpp.

Member Enumeration Documentation

enum kdrive::baos::BaosServerItems::Baudrate

Possible values for server item Baudrate, id 13.

Enumerator
Unknown
B19200
B115200

enum kdrive::baos::BaosServerItems::IndicationSetting

Possible values for server item Indication Sending, id 17.

Enumerator
IndicationSetting_NotActive
IndicationSetting_Active

enum kdrive::baos::BaosServerItems::ProgrammingMode

Possible values for server item ProgrammingMode, id 15.

Enumerator
NotActive
Active

Constructor & Destructor Documentation

BaosServerItems::BaosServerItems ( std::shared_ptr< BaosConnector > connector )

Creates a BaosServerItems object with a specified connector.

precondition: connector is not null

BaosServerItems::~BaosServerItems ( )

Destroys the BaosServerItems.

Member Function Documentation

unsigned int BaosServerItems::getApplicationId ( ) const

Gets the id of application loaded by ETS.

It is mapped to bytes 2 and 3 of property PID_APPLICATION_VER in the application object. Server item: application id (ETS), id 6

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getApplicationVersion ( ) const

Gets the version of application loaded by ETS.

It is mapped to byte 4 of property PID_APPLICATION_VER in application object. Server item: application version (ETS), id 7

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getBaudrate ( ) const

Gets the baudrate.

Server item: Baudrate, id 13

See also: Baudrate

unsigned char BaosServerItems::getBinaryProtocolVersion ( ) const

Gets the version of the ObjectServer binary protocol Server item: Protocol Version (Binary), id 16.

unsigned int BaosServerItems::getBufferSize ( ) const

Gets the current buffer size.

Server item: Current buffer size, id 14

See also: Baudrate

Examples:: BaosMultiThreaded.cpp.

unsigned short BaosServerItems::getConfiguredDatapoints ( ) const

Gets the current configured datapoints.

unsigned char BaosServerItems::getConnectedBaosTcpClients ( ) const

Gets the current connected BAOS TCP clients.

unsigned char BaosServerItems::getConnectedBaosUdpClients ( ) const

Gets the current connected BAOS UDP clients.

unsigned char BaosServerItems::getConnectedManagementClients ( ) const

Gets the current connected management clients.

unsigned char BaosServerItems::getConnectedTunnellingClients ( ) const

Gets the current connected tunneling clients.

unsigned int BaosServerItems::getDefaultGateway ( ) const

Gets the IP address of the default gateway.

std::string BaosServerItems::getDeviceFriendlyName ( ) const

Gets the device friendly name.

unsigned short BaosServerItems::getDownloadCounter ( ) const

Gets the download counter.

unsigned char BaosServerItems::getFirmwareVersion ( ) const

Gets the version of ObjectServer firmware.

Version of the ObjectServer firmware Coding Ex.: 0x10 = Version 1.0 Server item: firmware version, id 3

Examples:: BaosMultiThreaded.cpp.

std::vector< unsigned char > BaosServerItems::getHardwareType ( ) const

Gets the hardware type.

Can be used to identify the hardware type. Coding is manufacturer specific. It is mapped to property PID_HARDWARE_TYPE in the device object. Server item: hardware type, id 1

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getHardwareVersion ( ) const

Gets the version of the ObjectServer hardware Coding Ex.

: 0x10 = Version 1.0 Server item: hardware version, id 2

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getIndicationSetting ( ) const

Gets the indication setting Server item: Indication Sending, id 17.

unsigned short BaosServerItems::getIndividualAddress ( ) const

Gets the KNX individual address.

unsigned int BaosServerItems::getIpAddress ( ) const

Gets the IP address.

unsigned char BaosServerItems::getIpAssignment ( ) const

Gets the IP assignment method.

unsigned int BaosServerItems::getLengthOfDescriptionString ( ) const

Gets the length of the description string.

Server item: Length of description string, id 12

Examples:: BaosMultiThreaded.cpp.

std::vector< unsigned char > BaosServerItems::getMacAddress ( ) const

Gets the MAC address.

unsigned int BaosServerItems::getManufactureCodeApp ( ) const

Gets the KNX manufacturer code loaded by ETS.

It is mapped to bytes 0 and 1 of property PID_APPLICATION_VER in the application object. Server item: KNX manufacture code APP, id 5

Examples:: BaosMultiThreaded.cpp.

unsigned int BaosServerItems::getManufactureCodeDevice ( ) const

Gets the KNX manufacturer code of the device.

Not modified by ETS. It is mapped to property PID_MANUFACTURER_ID in the device object. Server item: KNX manufacture code DEV, id 4

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getMaxBaosTcpClients ( ) const

Gets the maximum supported BAOS TCP clients.

unsigned char BaosServerItems::getMaxBaosUdpClients ( ) const

Gets the maximum supported BAOS UDP clients.

unsigned int BaosServerItems::getMaxBufferSize ( ) const

Gets the maximal buffer size.

Server item: Maximal buffer size, id 11

Examples:: BaosMultiThreaded.cpp.

unsigned short BaosServerItems::getMaxDatapoints ( ) const

Gets the maximum supported datapoints.

unsigned char BaosServerItems::getMaxManagementClients ( ) const

Gets the maximum supported management clients.

unsigned short BaosServerItems::getMaxParameterBytes ( ) const

Gets the maximum supported parameter bytes.

unsigned char BaosServerItems::getMaxTunnellingClients ( ) const

Gets the maximum supported tunneling clients.

unsigned char BaosServerItems::getProgrammingMode ( ) const

Gets the programming mode.

Server item: Programming mode, id 15

See also: ProgrammingMode

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getProtocolVersion ( ) const

Gets the version of the ObjectServer binary protocol.

Deprecated:: use getBinaryProtocolVersion instead

unsigned char BaosServerItems::getRestServiceProtocolVersion ( ) const

Gets the version of the ObjectServer web services protocol Server item: Protocol Version (WebService), id 19.

std::vector< unsigned char > BaosServerItems::getSerialNumber ( ) const

Gets KNX serial number of device.

It is mapped to property PID_SERIAL_NUMBER in the device object. Server item: serial number, id 8

Examples:: BaosMultiThreaded.cpp, BaosSerial.cpp, and BaosUsb.cpp.

unsigned int BaosServerItems::getSubnetMask ( ) const

Gets the subnet mask.

std::vector< unsigned char > BaosServerItems::getSystemTime ( ) const

Gets the system time.

unsigned char BaosServerItems::getSystemTimezoneOffset ( ) const

Gets the system timezone offset.

unsigned long BaosServerItems::getTimeSinceReset ( ) const

Gets the time since reset in ms.

Server item: time since reset, id 9

Examples:: BaosMultiThreaded.cpp.

unsigned char BaosServerItems::getTimeSinceResetUnit ( ) const

Gets the time since reset.

unsigned char BaosServerItems::getWebServicesProtocolVersion ( ) const

Gets the version of the ObjectServer web services protocol Server item: Protocol Version (WebService), id 18.

bool BaosServerItems::isBaosBinaryEnabled ( ) const

Returns true if the BAOS Binary service is enabled, otherwise false.

bool BaosServerItems::isBaosRestEnabled ( ) const

Returns true if the BAOS Rest service is enabled, otherwise false.

bool BaosServerItems::isBaosWebEnabled ( ) const

Returns true if the BAOS Web service is enabled, otherwise false.

bool BaosServerItems::isBusConnected ( ) const

Returns true if the KNX bus is connected, otherwise false.

Server item: bus connection state, id 10

Examples:: BaosMultiThreaded.cpp.

bool BaosServerItems::isHttpFileEnabled ( ) const

Returns true if the HTTP file service is enabled, otherwise false.

bool BaosServerItems::isIsStructured ( ) const

Returns true if the loaded application is a structured database, otherwise false.

bool BaosServerItems::isMenuEnabled ( ) const

Returns true if Menu is enabled, otherwise false.

bool BaosServerItems::isSearchRequestEnabled ( ) const

Returns true if the KNXnet/IP Search service is enabled, otherwise false.

bool BaosServerItems::isSuspendEnabled ( ) const

Returns true if Suspend is enabled, otherwise false.

bool BaosServerItems::isTunnellingEnabled ( ) const

Returns true if the KNXnet/IP Tunneling service is enabled, otherwise false.

void BaosServerItems::setBaudrate ( unsigned char baudrate )

Sets the Baudrate Values: BaosServerItems::Unknown, BaosServerItems::BB19200, BaosServerItems::B115200.

void BaosServerItems::setBufferSize ( unsigned int bufferSize )

Sets the current buffer size.

Server item: Current buffer size, id 14

void BaosServerItems::setIndicationSetting ( unsigned char indicationSetting )

Sets the indication setting Values: IndicationSetting::IndicationSetting_NotActive IndicationSetting::IndicationSetting_Active Server item: Indication Sending, id 17.

void BaosServerItems::setProgrammingMode ( unsigned char programmingMode )

Sets the programming mode Values: ProgrammingMode::NotActive ProgrammingMode::Active Server item: Programming mode, id 15.

void BaosServerItems::setSuspend ( unsigned char suspend )

Set new value for suspend.

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation