kdriveExpress .net SDK 23.2.0
kdrive::express::bindings::AccessPort Class Reference

This is a wrapper around the functions found in kdrive_express_access.h. More...

#include <Access.h>

Public Member Functions

 ~AccessPort ()
 Destructor cleans up unmanaged and managed resources. More...
 
int GetId ()
 
void SetKeyring (Keyring^ keyring)
 Sets the used knx keyring project. More...
 
int EnumerateUsb ()
 Scan for all KNX USB Interface devices. More...
 
void OpenUsb (int interfaceIndex)
 Opens a connection to a KNX USB Interface device interfaceIndex should be in the range 0..iface_count-1 where iface_count is > 0. More...
 
System::Collections::Generic::List< KnxNetIpDeviceDescription^> ^ EnumerateIpTunneling ()
 Scans for all KNX IP Tunneling Interface devices. More...
 
KnxNetIpDeviceDescriptionReadIpDeviceInfo (System::String^ address)
 Gets the information for one specific tunneling device.
 
KnxNetIpDeviceDescriptionReadIpDeviceInfo (System::String^ address, int port)
 Gets the information for one specific tunneling device.
 
KnxNetIpDeviceDescriptionReadIpDeviceInfo (System::String^ address, System::String^ interfaceAddress)
 Gets the information for one specific tunneling device.
 
KnxNetIpDeviceDescriptionReadIpDeviceInfo (System::String^ address, int port, System::String^ interfaceAddress)
 Gets the information for one specific tunneling device.
 
void OpenIpTunneling (System::String^ address)
 Opens a connection to a KNX IP Tunneling Interface device Default port for KNXnet/IP (3671) is used. More...
 
void OpenIpTunneling (System::String^ address, int port)
 Opens a connection to a KNX IP Tunneling Interface device on a specific network interface. More...
 
void OpenIpTunneling (System::String^ address, int port, System::String^ interfaceAddress)
 Opens a connection to a KNX IP Tunneling Interface device on a specific network interface. More...
 
void OpenIp (System::String^ address)
 
void OpenIp (System::String^ address, System::String^ interfaceAddress)
 
bool IsTunnelingPortSecure ()
 Only has works for knxnet ip tunneling ports, returns if security is used or not.
 
void SetTunnelingPortAuthenticationCode (System::String^ authenticationCode)
 Sets the optional authentication code for the KNXnet/IP tunneling connection. More...
 
void SetTunnelingPortCredentials (int userId, System::String^ password)
 Sets the user id and the security password for the KNXnet/IP tunneling connection. More...
 
void SetTunnelingPortUserId (int userId)
 Sets the security user id for the KNXnet/IP tunneling connection. More...
 
int GetTunnelingPortUserId ()
 Gets the security user id for the KNXnet/IP tunneling connection. More...
 
void SetTunnelingPortRequestedIndividualAddress (int address)
 Sets the (optional) requested individual address This function is used for KNXnet/IP v2 devices. More...
 
System::Collections::Generic::List< RoutingInfo^> ^ EnumerateIpRouting ()
 
void OpenIpRouting (System::String^ multicastAddress, System::String^ interfaceAddress, bool secured)
 
void OpenIpRouting (bool secured)
 
bool IsRoutingPortSecure ()
 Only has works for knxnet ip routing ports, returns if security is enabled or not. More...
 
void SetRoutingPortBackboneKey (System::String^ key)
 Sets the backbone key for the KNXnet/IP routing connection. More...
 
void OpenFT12 (System::String^ serialDevice)
 Opens a connection to a KNX FT1.2 serial interface. More...
 
void OpenTinySerial (System::String^ serialDevice)
 Opens a connection to the KNX Tiny Serial Interface 810. More...
 
void Close ()
 Closes the access port If the access port is not open nothing happens.
 
bool IsOpen ()
 Returns whether the access port is open. More...
 
void Send (array< unsigned char >^ telegram)
 Sends a KNX Telegram on the Access Port. More...
 
void GroupValueWrite (int address, array< unsigned char >^ data)
 Sends a GroupValue_Write Telegram. More...
 
void GroupValueWrite (int address, unsigned char data, int bits)
 Sends a GroupValue_Write Telegram. More...
 
void GroupValueRead (int address)
 Sends a GroupValue_Read Telegram on the Access Port This function does not wait for a GroupValue_Response telegram. More...
 
void GroupValueResponse (int address, array< unsigned char >^ data)
 Sends a GroupValue_Response Telegram. More...
 
void GroupValueResponse (int address, unsigned char data, int bits)
 Sends a GroupValue_Response Telegram. More...
 
array< unsigned char > ^ ReadGroupObject (int address, int timeout)
 Sends a GroupValue_Read Telegram on the Access Port and waits for a GroupValue_Response indication telegram (with a matching Group Address). More...
 
void EnableQueue (bool enabled)
 Enables/Disables the receive queue for the access port. More...
 
array< unsigned char > ^ Receive (int timeout)
 Waits for an inbound KNX telegram. More...
 
int GetAccessPortIndividualAddress ()
 Gets the Individual Address of the Local Device (KNX Interface Device) More...
 
void SetAccessPortIndividualAddress (int address)
 Sets the Individual Address of the Local Device (KNX Interface Device) More...
 
array< unsigned char > ^ GetAccessPortRfDomainAddress ()
 Gets the Domain Address of the Local Device (KNX Interface Device) More...
 
void SetAccessPortRfDomainAddress (array< unsigned char >^ domainAddress)
 Sets the Domain Address of the Local Device (KNX Interface Device) More...
 
array< unsigned char > ^ GetAccessPortSerialNumber ()
 Gets the Serial Number of the Local Device (KNX Interface Device) More...
 
void SetAccessPortSerialNumber (array< unsigned char >^ serialNumber)
 Sets the Serial Number of the Local Device (KNX Interface Device) More...
 
int GetAccessPortTunnelIndividualAddress ()
 Gets the used Individual Address of the tunnel connection (KNX Interface Device). More...
 
void SetAccessPortTunnelIndividualAddress (int address)
 Sets the used Individual Address of the tunnel connection (KNX Interface Device). More...
 
array< int > ^ GetAccessPortAdditionalIndividualAddresses ()
 Gets the Additional Individual Addresses of the Local Device (KNX Interface Device) More...
 
void SetAccessPortAdditionalIndividualAddresses (array< int >^ addresses)
 Sets the Additional Individual Addresses of the Local Device (KNX Interface Device) More...
 
int GetAccessPortMaxApduLength ()
 Gets the maximum supported apdu length of the Local Device (KNX Interface Device)
 
void ConnectPacketTrace ()
 Starts the Packet Trace, write Rx and Tx packets to the logger (level: information)
 
void DisconnectPacketTrace ()
 Stops the Packet Trace.
 
delegate void TelegramEventHandler (Object^ sender, array< unsigned char >^ telegram)
 
delegate void NotificationEventHandler (Object^ sender, AccessPortEvent e)
 

Static Public Member Functions

static int GetDestAddress (array< unsigned char >^ telegram)
 Extracts the Destination Address from the Telegram. More...
 
static int GetSrcAddress (array< unsigned char >^ telegram)
 Extracts the Source Address from the Telegram. More...
 
static int GetApci (array< unsigned char >^ telegram)
 Extracts the APCI from the Telegram. More...
 
static int GetMessageCode (array< unsigned char >^ telegram)
 Extracts the Message Code from the Telegram. More...
 
static array< unsigned char > ^ GetSerialNumber (array< unsigned char >^ telegram)
 Extracts the Serial Number from the Telegram This is extracted from the Additional Info field i.e. More...
 
static bool IsGroup (array< unsigned char >^ telegram)
 Determines if the specified telegram is a GroupValue telegram This is, one of GroupValue_Read, GroupValue_Write or GroupValue_Response. More...
 
static bool IsGroupWrite (array< unsigned char >^ telegram)
 Determines if the specified telegram is a GroupValue_Write telegram. More...
 
static bool IsGroupRead (array< unsigned char >^ telegram)
 Determines if the specified telegram is a GroupValue_Read telegram. More...
 
static bool IsGroupResponse (array< unsigned char >^ telegram)
 Determines if the specified telegram is a GroupValue_Response telegram. More...
 
static array< unsigned char > ^ GetGroupData (array< unsigned char >^ telegram)
 Extracts the Group Value data from the KNX telegram. More...
 

Protected Member Functions

 !AccessPort ()
 Finalizer (non-deterministic destructor) cleans up unmanaged resources. More...
 

Events

TelegramEventHandler^ TelegramEvent
 
NotificationEventHandler^ NotificationEvent
 

Detailed Description

This is a wrapper around the functions found in kdrive_express_access.h.

Note
It's high recommended that you release the unmanaged resources with Dispose if you do not more need it.
// C# sample
AccessPort accessPort = null;
try
{
accessPort = new AccessPort();
accessPort.EnumerateUsb();
accessPort.OpenUsb(0);
// ...
accessPort.Close();
}
catch (kdrive.KdriveException exception)
{
Console.WriteLine(exception.Message);
}
finally
{
if (accessPort != null)
{
accessPort.Dispose();
}
}

Alternative with C# using:

// C# sample
using (AccessPort accessPort = new AccessPort())
{
Console.WriteLine("Found " + accessPort.EnumerateUsb() + " KNX USB Interfaces");
accessPort.Close();
}

Constructor & Destructor Documentation

◆ ~AccessPort()

kdrive::express::bindings::AccessPort::~AccessPort ( )
inline

Destructor cleans up unmanaged and managed resources.

Note
It's high recommended to call dispose to release the unmanaged resources

◆ !AccessPort()

kdrive::express::bindings::AccessPort::!AccessPort ( )
inlineprotected

Finalizer (non-deterministic destructor) cleans up unmanaged resources.

(converted into "virtual void Finalize()" by the compiler)

Member Function Documentation

◆ EnableQueue()

void kdrive::express::bindings::AccessPort::EnableQueue ( bool  enabled)
inline

Enables/Disables the receive queue for the access port.

Parameters
[in]enabledtrue enables the receive queue false disables the queue

◆ EnumerateIpRouting()

System::Collections::Generic::List<RoutingInfo^> ^ kdrive::express::bindings::AccessPort::EnumerateIpRouting ( )
inline
Scans for all KNX IP Routing devices
Note
Only available in the Commercial Access kdriveExpress SDK
Returns
list with the found routing devices

◆ EnumerateIpTunneling()

System::Collections::Generic::List<KnxNetIpDeviceDescription^> ^ kdrive::express::bindings::AccessPort::EnumerateIpTunneling ( )
inline

Scans for all KNX IP Tunneling Interface devices.

Returns
list with the found tunneling devices

◆ EnumerateUsb()

int kdrive::express::bindings::AccessPort::EnumerateUsb ( )
inline

Scan for all KNX USB Interface devices.

Returns
count of successfully enumerated interface devices

◆ GetAccessPortAdditionalIndividualAddresses()

array<int> ^ kdrive::express::bindings::AccessPort::GetAccessPortAdditionalIndividualAddresses ( )
inline

Gets the Additional Individual Addresses of the Local Device (KNX Interface Device)

Note
This function is only for tunneling access ports
Returns
the array of additional individual addresses

◆ GetAccessPortIndividualAddress()

int kdrive::express::bindings::AccessPort::GetAccessPortIndividualAddress ( )
inline

Gets the Individual Address of the Local Device (KNX Interface Device)

Returns
The individual address of the local device

◆ GetAccessPortRfDomainAddress()

array<unsigned char> ^ kdrive::express::bindings::AccessPort::GetAccessPortRfDomainAddress ( )
inline

Gets the Domain Address of the Local Device (KNX Interface Device)

Returns
The domain address of the local device

◆ GetAccessPortSerialNumber()

array<unsigned char> ^ kdrive::express::bindings::AccessPort::GetAccessPortSerialNumber ( )
inline

Gets the Serial Number of the Local Device (KNX Interface Device)

Returns
The serial number of the local device

◆ GetAccessPortTunnelIndividualAddress()

int kdrive::express::bindings::AccessPort::GetAccessPortTunnelIndividualAddress ( )
inline

Gets the used Individual Address of the tunnel connection (KNX Interface Device).

This address is the device address PID_KNX_INDIVIDUAL_ADDRESS or a additional individual address PID_ADDITIONAL_INDIVIDUAL_ADDRESSES (normal case). The interface communicates it at the connecting procedure. So if somebody changed the additional individual addresses than this value is not up to data!

Note
This function is only for tunneling access ports.
Returns
The used individual address for the tunnel

◆ GetApci()

static int kdrive::express::bindings::AccessPort::GetApci ( array< unsigned char >^  telegram)
inlinestatic

Extracts the APCI from the Telegram.

Parameters
[in]telegramthe KNX telegram
Returns
APCI

◆ GetDestAddress()

static int kdrive::express::bindings::AccessPort::GetDestAddress ( array< unsigned char >^  telegram)
inlinestatic

Extracts the Destination Address from the Telegram.

Parameters
[in]telegramthe KNX telegram
Returns
the destination address

◆ GetGroupData()

static array<unsigned char> ^ kdrive::express::bindings::AccessPort::GetGroupData ( array< unsigned char >^  telegram)
inlinestatic

Extracts the Group Value data from the KNX telegram.

If the telegram is not a GroupValue_Write or GroupValue_Response telegram an Invalid Telegram error is returned. The data buffer should be large enough to hold the data from the telegram. This length is checked against the length held in the telegram and if insufficient an Access Port Error is returned (Buffer Overflow).

Parameters
[in]telegramthe KNX Telegram (Group Value Telegram)
Returns
The data buffer

◆ GetMessageCode()

static int kdrive::express::bindings::AccessPort::GetMessageCode ( array< unsigned char >^  telegram)
inlinestatic

Extracts the Message Code from the Telegram.

See also
CEmiCodes
Parameters
[in]telegramthe KNX telegram
Returns
Message Code

◆ GetSerialNumber()

static array<unsigned char> ^ kdrive::express::bindings::AccessPort::GetSerialNumber ( array< unsigned char >^  telegram)
inlinestatic

Extracts the Serial Number from the Telegram This is extracted from the Additional Info field i.e.

for KNX-RF telegrams

Parameters
[in]telegramthe KNX telegram
Returns
Serial Number

◆ GetSrcAddress()

static int kdrive::express::bindings::AccessPort::GetSrcAddress ( array< unsigned char >^  telegram)
inlinestatic

Extracts the Source Address from the Telegram.

Parameters
[in]telegramthe KNX telegram
Returns
the source address

◆ GetTunnelingPortUserId()

int kdrive::express::bindings::AccessPort::GetTunnelingPortUserId ( )
inline

Gets the security user id for the KNXnet/IP tunneling connection.

Returns
The security user id of the local device
See also
SetAccessPortCredentials

◆ GroupValueRead()

void kdrive::express::bindings::AccessPort::GroupValueRead ( int  address)
inline

Sends a GroupValue_Read Telegram on the Access Port This function does not wait for a GroupValue_Response telegram.

Parameters
addressis the Group Address (destination)

◆ GroupValueResponse() [1/2]

void kdrive::express::bindings::AccessPort::GroupValueResponse ( int  address,
array< unsigned char >^  data 
)
inline

Sends a GroupValue_Response Telegram.

See also
kdriveGroupValueWrite
Parameters
[in]addressis the Group Address (destination)
[in]datais the datapoint value to be sent

◆ GroupValueResponse() [2/2]

void kdrive::express::bindings::AccessPort::GroupValueResponse ( int  address,
unsigned char  data,
int  bits 
)
inline

Sends a GroupValue_Response Telegram.

See also
kdriveGroupValueWrite
Parameters
[in]addressis the Group Address (destination)
[in]datais the datapoint value to be sent
[in]bitsrepresents the length of the datapoint value, in bits

◆ GroupValueWrite() [1/2]

void kdrive::express::bindings::AccessPort::GroupValueWrite ( int  address,
array< unsigned char >^  data 
)
inline

Sends a GroupValue_Write Telegram.

Parameters
[in]addressis the Group Address (destination)
[in]datais the datapoint value to be sent

◆ GroupValueWrite() [2/2]

void kdrive::express::bindings::AccessPort::GroupValueWrite ( int  address,
unsigned char  data,
int  bits 
)
inline

Sends a GroupValue_Write Telegram.

Parameters
[in]addressis the Group Address (destination)
[in]datais the datapoint value to be sent
[in]bitsrespresents the length of the datapoint value, in bits

◆ IsGroup()

static bool kdrive::express::bindings::AccessPort::IsGroup ( array< unsigned char >^  telegram)
inlinestatic

Determines if the specified telegram is a GroupValue telegram This is, one of GroupValue_Read, GroupValue_Write or GroupValue_Response.

Parameters
[in]telegramthe KNX telegram
Returns
true if a Group Telegram false otherwise

◆ IsGroupRead()

static bool kdrive::express::bindings::AccessPort::IsGroupRead ( array< unsigned char >^  telegram)
inlinestatic

Determines if the specified telegram is a GroupValue_Read telegram.

Parameters
[in]telegramthe KNX telegram
Returns
true if a GroupValue_Read telegram false otherwise

◆ IsGroupResponse()

static bool kdrive::express::bindings::AccessPort::IsGroupResponse ( array< unsigned char >^  telegram)
inlinestatic

Determines if the specified telegram is a GroupValue_Response telegram.

Parameters
[in]telegramthe KNX telegram
Returns
true if a GroupValue_Response telegram false otherwise

◆ IsGroupWrite()

static bool kdrive::express::bindings::AccessPort::IsGroupWrite ( array< unsigned char >^  telegram)
inlinestatic

Determines if the specified telegram is a GroupValue_Write telegram.

Parameters
[in]telegramthe KNX telegram
Returns
true if a GroupValue_Write telegram false otherwise

◆ IsOpen()

bool kdrive::express::bindings::AccessPort::IsOpen ( )
inline

Returns whether the access port is open.

Returns
true if the access port is open, false otherwise

◆ IsRoutingPortSecure()

bool kdrive::express::bindings::AccessPort::IsRoutingPortSecure ( )
inline

Only has works for knxnet ip routing ports, returns if security is enabled or not.

Note
Only available in the Commercial Access kdriveExpress SDK

◆ OpenFT12()

void kdrive::express::bindings::AccessPort::OpenFT12 ( System::String^  serialDevice)
inline

Opens a connection to a KNX FT1.2 serial interface.

Interfaces which supports this protocol: all KNX conform FT1.2 serial interfaces e.g. Weinzierl KNX Serial BAOS 870 e.g. Weinzierl KNX BAOS Module 820/822/830/838

Parameters
[in]serialDeviceis the device where the interface is attached, i.e. COM1 or /dev/ttyS0 etc

◆ OpenIp() [1/2]

void kdrive::express::bindings::AccessPort::OpenIp ( System::String^  address)
inline
Deprecated:
Was renamed to OpenIpTunneling

Opens a connection to a KNX IP Tunneling Interface device

See also
OpenIpTunneling
Parameters
[in]addressThe IP Address and (optional) the port which is separated by a colon. When the port is not set then the default port for KNXnet/IP (3671) is used e.g. "192.168.1.47" "192.168.1.47:3671"

◆ OpenIp() [2/2]

void kdrive::express::bindings::AccessPort::OpenIp ( System::String^  address,
System::String^  interfaceAddress 
)
inline
Deprecated:
Was renamed to OpenIpTunneling

Opens a connection to a KNX IP Tunneling Interface device on a specific network interface

See also
OpenIpTunneling
Parameters
[in]addressThe IP Address and (optional) the port which is separated by a colon. When the port is not set then the default port for KNXnet/IP (3671) is used e.g. "192.168.1.47" "192.168.1.47:3671"
[in]interfaceAddressThe Interface Adaptor IP Address

◆ OpenIpRouting() [1/2]

void kdrive::express::bindings::AccessPort::OpenIpRouting ( bool  secured)
inline
Creates an KNXnet/IP Routing access port
the default KNXnet/IP multicast address (224.0.23.12) and
network interface adaptor are used

When is_secure is true then backbone key must set before open.

See also
SetRoutingPortBackboneKey
or via keyring file
\sa SetKeyring

\note Only available in the Commercial Access kdriveExpress SDK
\param [in] secured with (1) or without encrypted communication (0)

◆ OpenIpRouting() [2/2]

void kdrive::express::bindings::AccessPort::OpenIpRouting ( System::String^  multicastAddress,
System::String^  interfaceAddress,
bool  secured 
)
inline
Creates an KNXnet/IP Routing access port.

When is_secure is true then backbone key must set before open.

See also
SetRoutingPortBackboneKey
or via keyring file
\sa SetKeyring

\note Only available in the Commercial Access kdriveExpress SDK
\param [in] multicastAddress (optional) The Multicast IP Address
            When the multicast_address = 0 (null pointer) then the default KNXnet/IP multicast address is used (224.0.23.12)
\param [in] interfaceAddress The Interface Adaptor IP Address
\param [in] secured with (1) or without encrypted communication (0)

◆ OpenIpTunneling() [1/3]

void kdrive::express::bindings::AccessPort::OpenIpTunneling ( System::String^  address)
inline

Opens a connection to a KNX IP Tunneling Interface device Default port for KNXnet/IP (3671) is used.

See also
OpenIpTunneling
Parameters
[in]addressThe IP Address

◆ OpenIpTunneling() [2/3]

void kdrive::express::bindings::AccessPort::OpenIpTunneling ( System::String^  address,
int  port 
)
inline

Opens a connection to a KNX IP Tunneling Interface device on a specific network interface.

Parameters
[in]addressThe IP Address
[in]portthe port When the port is set to 0 then the default port for KNXnet/IP (3671) is used
[in]interfaceAddressThe Interface Adaptor IP Address

◆ OpenIpTunneling() [3/3]

void kdrive::express::bindings::AccessPort::OpenIpTunneling ( System::String^  address,
int  port,
System::String^  interfaceAddress 
)
inline

Opens a connection to a KNX IP Tunneling Interface device on a specific network interface.

Interfaces which supports this protocol: all KNX conform KNXnet/IP Tunneling interfaces e.g. Weinzierl KNX IP Interface 730/731/732 e.g. Weinzierl KNX IP Interface 740 Wireless e.g. Weinzierl KNX IP Router 750/751/752 e.g. Weinzierl KNX IP LineMaster 760/762 e.g. Weinzierl KNX IP BAOS 770/771/772/773/774/777

When a secure KNX IP Tunneling device is used then password, user id (optional) and authentication code (optional) must set before open.

See also
SetAccessPortAuthenticationCode
SetAccessPortPassword
SetAccessPortUserId

or via keyring file

See also
SetKeyring
Parameters
[in]addressThe IP Address
[in]portthe port When the port is set to 0 then the default port for KNXnet/IP (3671) is used
[in]interfaceAddressThe Interface Adaptor IP Address

◆ OpenTinySerial()

void kdrive::express::bindings::AccessPort::OpenTinySerial ( System::String^  serialDevice)
inline

Opens a connection to the KNX Tiny Serial Interface 810.

This is a modified TP-UART Protocol without real-time requirements to the host

Interfaces which supports this protocol: Weinzierl KNX Tiny Serial Interface 810

Parameters
[in]serialDeviceis the device where the interface is attached, i.e. COM1 or /dev/ttyS0 etc

◆ OpenUsb()

void kdrive::express::bindings::AccessPort::OpenUsb ( int  interfaceIndex)
inline

Opens a connection to a KNX USB Interface device interfaceIndex should be in the range 0..iface_count-1 where iface_count is > 0.

Interfaces which supports this protocol: all KNX conform USB interfaces e.g. Weinzierl KNX USB Interface 310/311/320/330

Parameters
interfaceIndexthe interface device enumeration index

◆ ReadGroupObject()

array<unsigned char> ^ kdrive::express::bindings::AccessPort::ReadGroupObject ( int  address,
int  timeout 
)
inline

Sends a GroupValue_Read Telegram on the Access Port and waits for a GroupValue_Response indication telegram (with a matching Group Address).

If the response telegram has been received you can use GetGroupData to get the response data. This function waits until either a telegram is received or the timeout elapses. If the timeout elapses a KdriveException will thrown.

Parameters
[in]addressis the Group Address (destination)
[in]timeoutThe time period to wait in milliseconds for the response to arrive

◆ Receive()

array<unsigned char> ^ kdrive::express::bindings::AccessPort::Receive ( int  timeout)
inline

Waits for an inbound KNX telegram.

This function waits until either a telegram is received or the timeout elapses. If the timeout elapses a KdriveException will thrown.

Parameters
[in]timeoutThe time period to wait in milliseconds for a telegram to arrive
Returns
The received KNX telegram

◆ Send()

void kdrive::express::bindings::AccessPort::Send ( array< unsigned char >^  telegram)
inline

Sends a KNX Telegram on the Access Port.

Parameters
[in]telegramis the EMIC encoded KNX Telegram

◆ SetAccessPortAdditionalIndividualAddresses()

void kdrive::express::bindings::AccessPort::SetAccessPortAdditionalIndividualAddresses ( array< int >^  addresses)
inline

Sets the Additional Individual Addresses of the Local Device (KNX Interface Device)

Note
This function is only for tunneling access ports
Parameters
[in]apthe access port descriptor of a tunneling access port
[in]addressesthe array of additional individual addresses

◆ SetAccessPortIndividualAddress()

void kdrive::express::bindings::AccessPort::SetAccessPortIndividualAddress ( int  address)
inline

Sets the Individual Address of the Local Device (KNX Interface Device)

Parameters
addressthe individual address of the local device

◆ SetAccessPortRfDomainAddress()

void kdrive::express::bindings::AccessPort::SetAccessPortRfDomainAddress ( array< unsigned char >^  domainAddress)
inline

Sets the Domain Address of the Local Device (KNX Interface Device)

Parameters
[in]domainAddressthe new domain address of the local device

◆ SetAccessPortSerialNumber()

void kdrive::express::bindings::AccessPort::SetAccessPortSerialNumber ( array< unsigned char >^  serialNumber)
inline

Sets the Serial Number of the Local Device (KNX Interface Device)

Parameters
[in]serialNumberthe new serial number of the local device

◆ SetAccessPortTunnelIndividualAddress()

void kdrive::express::bindings::AccessPort::SetAccessPortTunnelIndividualAddress ( int  address)
inline

Sets the used Individual Address of the tunnel connection (KNX Interface Device).

Returns an error, if it can not changed because for the tunnel address is the device individual address used.

Note
This function is only for tunneling access ports
Parameters
[in]addressthe individual address of the tunnel

◆ SetKeyring()

void kdrive::express::bindings::AccessPort::SetKeyring ( Keyring keyring)
inline

Sets the used knx keyring project.

Use 0 when you want remove it

◆ SetRoutingPortBackboneKey()

void kdrive::express::bindings::AccessPort::SetRoutingPortBackboneKey ( System::String^  key)
inline

Sets the backbone key for the KNXnet/IP routing connection.

Note
Only available in the Commercial Access kdriveExpress SDK
Parameters
[in]keythe backbone key of the local device as hex string

◆ SetTunnelingPortAuthenticationCode()

void kdrive::express::bindings::AccessPort::SetTunnelingPortAuthenticationCode ( System::String^  authenticationCode)
inline

Sets the optional authentication code for the KNXnet/IP tunneling connection.

This function is used for secure KNXnet/IP devices. Call this before open the connection. The default value is a empty string.

Note
This function is only for closed tunneling access ports
Parameters
[in]authenticationCodethe authentication code of the local device

◆ SetTunnelingPortCredentials()

void kdrive::express::bindings::AccessPort::SetTunnelingPortCredentials ( int  userId,
System::String^  password 
)
inline

Sets the user id and the security password for the KNXnet/IP tunneling connection.

This function is used for secure KNXnet/IP devices. Call this before open the connection.

Note
This function is only for closed tunneling access ports
Parameters
[in]userIdthe security user id of the local device
[in]passwordthe security password of the local device

◆ SetTunnelingPortRequestedIndividualAddress()

void kdrive::express::bindings::AccessPort::SetTunnelingPortRequestedIndividualAddress ( int  address)
inline

Sets the (optional) requested individual address This function is used for KNXnet/IP v2 devices.

The default value is 0 ( = considered any). Call this before open the connection.

Note
This function is only for closed tunneling access ports
Parameters
[in]passwordthe security password of the local device

◆ SetTunnelingPortUserId()

void kdrive::express::bindings::AccessPort::SetTunnelingPortUserId ( int  userId)
inline

Sets the security user id for the KNXnet/IP tunneling connection.

This function is used for secure KNXnet/IP devices. Call this before opening the connection. The default value is 1.

Note
This function is only for closed tunneling access ports
Parameters
[in]userIdthe security user id of the local device
See also
SetAccessPortCredentials

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