kdrive::baos::FT12Connector Class Reference

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

#include <FT12Connector.h>

Inheritance diagram for kdrive::baos::FT12Connector:

Public Types
typedef std::shared_ptr< FT12Connector >	Ptr
Public Types inherited from kdrive::baos::BaosConnector
typedef std::shared_ptr< BaosConnector >	Ptr

Public Member Functions
	FT12Connector ()
	Creates a default (disconnected) FT 1.2 baos connector. More...
virtual	~FT12Connector ()
	Closes the connections and destroys the connector. More...
void	open (const std::string &serialDeviceName)
	Opens a connection with the local device. More...
std::string	getDescription () override
	Returns a formatted port description. More...
std::string	getSerialDeviceName () const
	Returns the serial device name used to open the serial port. More...
Public Member Functions inherited from kdrive::baos::BaosConnector
	BaosConnector ()=delete
virtual	~BaosConnector ()
	Destroys the BaosConnector. More...
unsigned int	getConnectorId () const
	Returns the connector id. More...
void	setVersion (unsigned char version)
	Sets the protocol version. More...
unsigned char	getVersion () const
	Returns the protocol version. More...
virtual bool	isConnected () const
	Indicates whether the rx thread is still running, which means that the connector is connected. More...

Static Public Attributes
static const std::string	ConnectorTypeLabel
static const std::string	SerialDeviceName
	Property key for the serial device name e.g. More...
Static Public Attributes inherited from kdrive::baos::BaosConnector
static const std::string	ConnectorId = "baos.connector_id"
	Property Key for the connector id, set in the constructor. More...
static const std::string	Version = "baos.version"
	Property Key for version, set by the connector type or enumeration. More...
static const std::string	RouteTransportPacket = "baos.route_transport_packet"

Additional Inherited Members
Protected Member Functions inherited from kdrive::baos::BaosConnector
	BaosConnector (unsigned char version)
	Property Key for enable/disable routing of Transport Packets. More...
void	resetPropertiesImpl () override
	Calls resetPropertiesImpl from base class and readded own properties. More...

Detailed Description

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

This class supports BAOS protocol version 1.0 and 2.0.

Devices with protocol version 1:

• KNX BAOS Module 820
• KNX BAOS Module 822
• KNX Serial BAOS 870

Devices with protocol version 2:

• KNX BAOS Module 830

Member Typedef Documentation

typedef std::shared_ptr<FT12Connector> kdrive::baos::FT12Connector::Ptr

Constructor & Destructor Documentation

kdrive::baos::FT12Connector::FT12Connector

(

)

Creates a default (disconnected) FT 1.2 baos connector.

virtual kdrive::baos::FT12Connector::~FT12Connector ( )

virtual

Closes the connections and destroys the connector.

Member Function Documentation

std::string kdrive::baos::FT12Connector::getDescription ( )

override

Returns a formatted port description.

Format: <SerialDeviceName> e.g. COM1

std::string kdrive::baos::FT12Connector::getSerialDeviceName

(

)

const

Returns the serial device name used to open the serial port.

void kdrive::baos::FT12Connector::open

(

const std::string &

serialDeviceName

)

Opens a connection with the local device.

Parameters

serialDeviceName

is the platform specific device name, e.g. COM1 or /dev/ttyS0

Member Data Documentation

const std::string kdrive::baos::FT12Connector::ConnectorTypeLabel

static

const std::string kdrive::baos::FT12Connector::SerialDeviceName

static

Property key for the serial device name e.g.

COM1

---

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

• FT12Connector.h