Helper Class Reference  1.3
HomeGenie - Automation Programs' Engine API
Public Member Functions | List of all members
KnxClientHelper Class Reference

KNX client helper. Class instance accessor: KnxClient More...

Public Member Functions

KnxClientHelper EndPoint (string host, int port)
 Set the endpoint to connect to. More...
 
KnxClientHelper EndPoint (string host)
 Set the endpoint to connect to. More...
 
KnxClientHelper EndPoint (int port)
 Set the endpoint to connect to. More...
 
KnxClientHelper EndPoint (string localIp, int localPort, string remoteIp, int remotePort)
 Set the endpoint to connect to using tunneling. More...
 
KnxClientHelper Connect ()
 Connect to the remote host using the specified port. More...
 
KnxClientHelper Disconnect ()
 Disconnects from the remote host. More...
 
KnxClientHelper Action (string address, bool data)
 Send action data to the specified address. More...
 
KnxClientHelper Action (string address, int data)
 Send action data to the specified address. More...
 
KnxClientHelper Action (string address, byte data)
 Send action data to the specified address. More...
 
KnxClientHelper Action (string address, byte[] data)
 Send action data to the specified address. More...
 
KnxClientHelper Action (string address, string data)
 Send action data to the specified address. More...
 
KnxClientHelper Action (string address, object data)
 Send action data to the specified address. More...
 
KnxClientHelper RequestStatus (string address)
 Requests the status. More...
 
byte[] ConvertToDpt (string type, object data)
 Converts to KNX Data Point Type. More...
 
object ConvertFromDpt (string type, object data)
 Converts from KNX Data Point Type. More...
 
KnxClientHelper OnStatusChanged (Action< bool > statusChangeAction)
 Sets the function to call when the status of the connection changes. More...
 
KnxClientHelper OnEventReceived (Action< string, string > eventAction)
 Sets the function to call when a new event is received. More...
 
KnxClientHelper OnStatusReceived (Action< string, string > statusAction)
 Sets the function to call when a new status is received. More...
 

Detailed Description

KNX client helper. Class instance accessor: KnxClient

Member Function Documentation

◆ EndPoint() [1/4]

KnxClientHelper EndPoint ( string  host,
int  port 
)

Set the endpoint to connect to.

Parameters
hostEndpoint address.
portEndpoint port.

◆ EndPoint() [2/4]

KnxClientHelper EndPoint ( string  host)

Set the endpoint to connect to.

Parameters
hostEndpoint address.

◆ EndPoint() [3/4]

KnxClientHelper EndPoint ( int  port)

Set the endpoint to connect to.

Parameters
portEndpoint port.

◆ EndPoint() [4/4]

KnxClientHelper EndPoint ( string  localIp,
int  localPort,
string  remoteIp,
int  remotePort 
)

Set the endpoint to connect to using tunneling.

Parameters
localIpLocal IP.
localPortLocal port.
remoteIpRemote IP.
remotePortRemote port.

◆ Connect()

KnxClientHelper Connect ( )

Connect to the remote host using the specified port.

◆ Disconnect()

KnxClientHelper Disconnect ( )

Disconnects from the remote host.

◆ Action() [1/6]

KnxClientHelper Action ( string  address,
bool  data 
)

Send action data to the specified address.

Parameters
addressAddress.
databoolean action value.

◆ Action() [2/6]

KnxClientHelper Action ( string  address,
int  data 
)

Send action data to the specified address.

Parameters
addressAddress.
dataint action value.

◆ Action() [3/6]

KnxClientHelper Action ( string  address,
byte  data 
)

Send action data to the specified address.

Parameters
addressAddress.
databyte action value.

◆ Action() [4/6]

KnxClientHelper Action ( string  address,
byte[]  data 
)

Send action data to the specified address.

Parameters
addressAddress.
databyte array action value.

◆ Action() [5/6]

KnxClientHelper Action ( string  address,
string  data 
)

Send action data to the specified address.

Parameters
addressAddress.
datastring action value.

◆ Action() [6/6]

KnxClientHelper Action ( string  address,
object  data 
)

Send action data to the specified address.

Parameters
addressAddress.
datageneric object action value.

◆ RequestStatus()

KnxClientHelper RequestStatus ( string  address)

Requests the status.

Parameters
addressAddress.

◆ ConvertToDpt()

byte [] ConvertToDpt ( string  type,
object  data 
)

Converts to KNX Data Point Type.

Returns
KNX Data Point Type byte array.
Parameters
typeType
dataData

◆ ConvertFromDpt()

object ConvertFromDpt ( string  type,
object  data 
)

Converts from KNX Data Point Type.

Returns
Converted object from KNX Data Point Type.
Parameters
typeType.
dataData.

◆ OnStatusChanged()

KnxClientHelper OnStatusChanged ( Action< bool >  statusChangeAction)

Sets the function to call when the status of the connection changes.

Parameters
statusChangeActionFunction or inline delegate.

◆ OnEventReceived()

KnxClientHelper OnEventReceived ( Action< string, string >  eventAction)

Sets the function to call when a new event is received.

Parameters
eventActionFunction or inline delegate.

◆ OnStatusReceived()

KnxClientHelper OnStatusReceived ( Action< string, string >  statusAction)

Sets the function to call when a new status is received.

Parameters
statusActionFunction or inline delegate.

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