Classes
class	BaosConnection
	The BaosConnection is responsible for creating a TCP/IP stream or a FT 1.2 connection with the baos server. More...

class	BaosConnector
	The BaosConnector is a QueueConnector which means it is possible to use the queue to obtain the Rx packet notifications. More...

class	BaosDatapoint
	The Baos Datapoint class is used to get and set a datapoint value. More...

struct	BaosDatapointCommands

class	BaosDatapointDescription
	A BaosDatapointDescription contains information about a Datapoint Value. More...

class	BaosDatapointDescriptions
	Reads the datapoint descriptions from the baos server and stores the datapoint descriptions internally. More...

struct	BaosDatapointTypes
	BAOS datapoint types (DPT) More...

struct	BaosDeviceAttr

struct	BaosErrorCodes
	Error codes from the kdriveRPC_baos lib The range for the baos error codes begins with 0x00010000 and ends with 0x00011FFF. More...

class	BaosEvent
	BaosEvent connects to the rx packet signals from the BaosConnector and filters the received packets to forward the datapoint value indications and the datapoint get value responses to a single handler. More...

class	BaosHeartbeat
	BaosHeartbeat sends periodically a heartbeat. More...

class	BaosIpEnumerator
	Finds all available IP BAOS devices on the network. More...

class	BaosPacketFactory
	A connector has a PacketFactory which converts a raw byte stream into a known packet type. More...

struct	BaosServerErrorCodes
	BAOS server error codes. More...

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

class	BaosTimers
	BaosTimers is used to get/set the timer parameters from/on the remote device. More...

struct	BaosTimerTypes

class	BaosUsbEnumerator
	Finds all available USB BAOS devices. More...

struct	DataIndication

class	DataPacket

class	DatapointDescriptionHolder
	Cache for Baos Datapoint Descriptions Holds BaosDatapointDescriptions so we don't have to continually read them from the remote device. More...

struct	DatapointValueIndication

struct	DataRequest

struct	DataRequestFactory
	DataRequestFactory. More...

struct	DataResponse

struct	ErrorResponse

class	FT12Connector
	The FT12Connector is responsible for creating a Serial FT 1.2 connection with the baos server. More...

class	GetDatapointDescription

class	GetDatapointValue

class	GetDescriptionString

class	GetParameterByte

class	GetServerItem

class	GetTimer

struct	HeaderPolicy
	DataPacketHeaderPolicy. More...

struct	HeaderPolicy12
	HeaderPolicy12. More...

struct	HeaderPolicy2x
	HeaderPolicy20. More...

struct	IndicationFunctions

class	KnxUsbPort

struct	MulticastProtocolConstants

class	PacketFactory12
	PacketFactory12. More...

class	PacketFactory2x
	PacketFactory20. More...

struct	Protocol12

struct	Protocol2x

struct	ProtocolConstants

class	ProtocolDecoder
	A utility class to decode the communication between the client and the remote baos device. More...

struct	ProtocolFormatter
	ProtocolFormatter. More...

struct	ProtocolFormatter12
	ProtocolFormatter12. More...

struct	ProtocolFormatter2x
	ProtocolFormatter2x. More...

struct	ProtocolVersions
	BAOS protocol versions. More...

struct	RequestFunctions

struct	ResponseFunctions

class	ScopedBaosConnection
	Auto-connect and disconnect of the StreamConnection. More...

class	ScopedBaosHeartbeat
	Auto starts and stops the Heartbeat class using RAII. More...

class	ScopedSerialBaosConnection
	Auto-connect and disconnect of the StreamConnection. More...

class	ServerFunction

struct	ServerItem

struct	ServerItemIndication

struct	ServerItemProperties
	BAOS server items. More...

class	ServiceRunner

class	SetDatapointHistoryCommand

class	SetDatapointValue

class	SetServerItem

class	SetTimer

class	StreamConnection
	The StreamConnection is responsible for creating a TCP/IP stream connection with the baos server. More...

class	StreamConnector
	The StreamConnector is responsible for creating a TCP/IP stream connection with the baos server. More...

class	StreamConnector12
	The StreamConnector is responsible for creating a TCP/IP stream connection with the baos server with version 1.2. More...

class	StreamConnector2x
	The StreamConnector is responsible for creating a TCP/IP stream connection with the baos server with version 2x. More...

struct	StreamConnectorFactory
	StreamConnectorFactory. More...

struct	StreamProtocolConstants

struct	Timer

class	UsbConnector
	The UsbConnector is responsible for creating a SUB connection with the baos server. More...

Typedefs
typedef BaosIpEnumerator	BaosEnumerator
	Deprecated Renamed BaosEnumerator to BaosIpEnumerator. More...

typedef BaosDeviceAttr::Device	BaosDevice

typedef BaosDeviceAttr::Devices	BaosDevices

using	DataPacketBase = connector::Packet

typedef ScopedBaosConnection	ScopedStreamConnection

Functions
kdriveRPC_baos_API unsigned char	readParameter (std::shared_ptr< BaosConnector > connector, unsigned short offset)
	Reads a parameter byte from the BAOS device. More...

kdriveRPC_baos_API void	readParameters (std::shared_ptr< BaosConnector > connector, std::vector< unsigned char > &data, unsigned short offset, unsigned short count)
	Reads multiple contiguous parameter bytes from the BAOS device. More...

kdriveRPC_baos_API std::string	lookupErrorCode (std::exception &exception)
	given a std::exception will try to extract the error code embedded in Poco::Exception otherwise will return exception.what() use this if you are not compiling against the poco library More...

kdriveRPC_baos_API unsigned int	lookupErrorCodeValue (std::exception &exception, unsigned int defaultCode=0)
	given a std::exception will try to extract the error code embedded in Poco::Exception otherwise will return defaultCode More...

kdriveRPC_baos_API void	throwBaosServerException (unsigned int baosServerErrorCode)
	Throws the baos server exception in dependency from the BAOS server error code. More...

template<class Packet >
Packet::Response::Ptr	rpc (BaosConnector::Ptr connector, typename Packet::Request::Ptr request, unsigned long timeout=ProtocolConstants::Timeout)

std::string	extract (const unsigned char *ptr, int bufferLength)

template<class DataPacketType , class HeaderPolicyType >
DataPacketType::Ptr	dataPacketFactory (unsigned char version)
	DataPacketFactory. More...

void kdriveRPC_baos_API	enumerateBaosUsbDevices (std::vector< kdrive::utility::PropertyCollection > &devices)

Typedef Documentation

typedef BaosDeviceAttr::Device kdrive::baos::BaosDevice

typedef BaosDeviceAttr::Devices kdrive::baos::BaosDevices

typedef BaosIpEnumerator kdrive::baos::BaosEnumerator

Deprecated Renamed BaosEnumerator to BaosIpEnumerator.

using kdrive::baos::DataPacketBase = typedef connector::Packet

typedef ScopedBaosConnection kdrive::baos::ScopedStreamConnection

Function Documentation

template<class DataPacketType , class HeaderPolicyType >

DataPacketType::Ptr kdrive::baos::dataPacketFactory ( unsigned char version )

DataPacketFactory.

void kdrive::baos::enumerateBaosUsbDevices ( std::vector< kdrive::utility::PropertyCollection > & devices )

std::string kdrive::baos::extract	(	const unsigned char *	ptr,
		int	bufferLength
	)

std::string kdrive::baos::lookupErrorCode ( std::exception & exception )

given a std::exception will try to extract the error code embedded in Poco::Exception otherwise will return exception.what() use this if you are not compiling against the poco library

unsigned int kdrive::baos::lookupErrorCodeValue	(	std::exception &	exception,
		unsigned int	defaultCode = `0`
	)

given a std::exception will try to extract the error code embedded in Poco::Exception otherwise will return defaultCode

kdriveRPC_baos_API unsigned char kdrive::baos::readParameter	(	std::shared_ptr< BaosConnector >	connector,
		unsigned short	offset
	)

Reads a parameter byte from the BAOS device.

This parameter byte should be configured with the ETS application

Examples:: BaosLightSwitcher.cpp.

kdriveRPC_baos_API void kdrive::baos::readParameters	(	std::shared_ptr< BaosConnector >	connector,
		std::vector< unsigned char > &	data,
		unsigned short	offset,
		unsigned short	count
	)

Reads multiple contiguous parameter bytes from the BAOS device.

This parameter byte should be configured with the ETS application

template<class Packet >

Packet::Response::Ptr kdrive::baos::rpc	(	BaosConnector::Ptr	connector,
		typename Packet::Request::Ptr	request,
		unsigned long	timeout = `ProtocolConstants::Timeout`
	)

void kdrive::baos::throwBaosServerException ( unsigned int baosServerErrorCode )

Throws the baos server exception in dependency from the BAOS server error code.

Parameters

baosServerErrorCode see BaosServerErrorCodes

Note: param baosServerErrorCode is not a BaosErrorCodes!

Classes

Typedefs

Functions

Typedef Documentation

Function Documentation