kdriveExpress SDK 23.2.0
kdrive_express_tunnel_ind_addr.c
//
// Copyright (c) 2002-2023 WEINZIERL ENGINEERING GmbH
// All rights reserved.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
//
#include <stdio.h>
#include <stdlib.h>
#include <kdrive_express.h>
#define ERROR_MESSAGE_LEN (128)
/*******************************
** Private Functions
********************************/
static void read_additional_individual_addresses(int32_t ap);
static uint16_t read_tunn_ind_addr(int32_t ap);
static void write_tunn_ind_addr(int32_t ap, uint16_t address);
static void error_callback(error_t e, void* user_data);
static void event_callback(int32_t ap, uint32_t e, void* user_data);
/*******************************
** Main
********************************/
int main(int argc, char* argv[])
{
uint16_t tunnel_address = 0xFF12;
int32_t ap = 0;
/*
Configure the logging level and console logger
*/
/*
We register an error callback as a convenience logger function to
print out the error message when an error occurs.
*/
kdrive_register_error_callback(&error_callback, NULL);
/*
We create a Access Port descriptor. This descriptor is then used for
all calls to that specific access port.
*/
/*
We check that we were able to allocate a new descriptor
This should always happen, unless a bad_alloc exception is internally thrown
which means the memory couldn't be allocated.
*/
{
printf("Unable to create access port. This is a terminal failure\n");
while (1)
{
;
}
}
/*
We register an event callback to notify of the Access Port Events
For example: KDRIVE_EVENT_TERMINATED
*/
kdrive_set_event_callback(ap, &event_callback, NULL);
/*
Open a Tunneling connection with a specific IP Interface,
you will probably have to change the IP address
*/
if (kdrive_ap_open_ip_tunn(ap, "192.168.1.45", 0, 0) == KDRIVE_ERROR_NONE)
{
/*
Read all additional individual addresses
*/
read_additional_individual_addresses(ap);
/*
Read the tunnel individual address
*/
tunnel_address = read_tunn_ind_addr(ap);
/*
Write the tunnel individual address
*/
write_tunn_ind_addr(ap, 0xFF12);
read_tunn_ind_addr(ap);
write_tunn_ind_addr(ap, tunnel_address);
read_tunn_ind_addr(ap);
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Press [Enter] to exit the application ...");
getchar();
/* close the access port */
}
/* releases the access port */
return 0;
}
/*******************************
** Private Functions
********************************/
void read_additional_individual_addresses(int32_t ap)
{
uint32_t index = 0;
uint16_t addresses[10];
uint32_t addresses_len = 10;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Read all additional individual addresses");
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "========================================");
if (kdrive_ap_get_additional_ind_addr(ap, addresses, &addresses_len) == KDRIVE_ERROR_NONE)
{
for (index = 0; index < addresses_len; ++index)
{
kdrive_logger_ex(KDRIVE_LOGGER_INFORMATION, "- 0x%04X", addresses[index]);
}
}
}
uint16_t read_tunn_ind_addr(int32_t ap)
{
uint16_t address = 0;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Read the tunnel individual address");
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "==================================");
{
kdrive_logger_ex(KDRIVE_LOGGER_INFORMATION, "Tunnel address 0x%04X", address);
}
return address;
}
void write_tunn_ind_addr(int32_t ap, uint16_t address)
{
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Write the tunnel individual address");
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "===================================");
}
void error_callback(error_t e, void* user_data)
{
{
static char error_message[ERROR_MESSAGE_LEN];
kdrive_get_error_message(e, error_message, ERROR_MESSAGE_LEN);
kdrive_logger_ex(KDRIVE_LOGGER_ERROR, "kdrive error: %s", error_message);
}
}
void event_callback(int32_t ap, uint32_t e, void* user_data)
{
switch (e)
{
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Access Port Opening");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Access Port Opened");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Access Port Closed");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Access Port Closing");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Access Port Terminated");
break;
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "KNX Bus Disconnected");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Local Device Reset");
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Telegram Indication");
break;
break;
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Telegram Confirm Timeout");
break;
break;
default:
kdrive_logger(KDRIVE_LOGGER_INFORMATION, "Unknown kdrive event");
break;
}
}
kdriveExpress_API bool_t kdrive_ap_release(int32_t ap)
Releases the AccessPort interface.
kdriveExpress_API int32_t kdrive_ap_create(void)
Creates an internal AccessPort interface This should be the first function called when working with t...
kdriveExpress_API error_t kdrive_ap_close(int32_t ap)
Closes the access port If the access port is not open nothing happens.
kdriveExpress_API error_t kdrive_ap_open_ip_tunn(int32_t ap, const char *ip_address, uint16_t port, const char *iface_address)
Opens a connection to a KNX IP Tunneling Interface device on a specific network interface or default ...
kdriveExpress_API error_t kdrive_ap_get_additional_ind_addr(int32_t ap, uint16_t addresses[], uint32_t *addresses_len)
Gets the Additional Individual Addresses of the Local Device (KNX Interface Device)
kdriveExpress_API error_t kdrive_ap_set_tunnel_ind_addr(int32_t ap, uint16_t address)
Sets the used Individual Address of the tunnel connection (KNX Interface Device).
kdriveExpress_API error_t kdrive_ap_get_tunnel_ind_addr(int32_t ap, uint16_t *address)
Gets the used Individual Address of the tunnel connection (KNX Interface Device).
kdriveExpress_API void kdrive_logger(uint8_t level, const char *message)
Writes to the kdrive express logger.
kdriveExpress_API void kdrive_logger_console(void)
Sets the logger to write to the console.
kdriveExpress_API void kdrive_logger_ex(uint8_t level, const char *fmt,...)
Writes to the kdrive express logger.
kdriveExpress_API void kdrive_logger_set_level(uint8_t level)
Sets the root logger level This is once of:
unsigned short uint16_t
16 bit unsigned char
Definition: kdrive_express_config.h:31
int int32_t
32 bit signed int
Definition: kdrive_express_config.h:35
unsigned int uint32_t
32 bit unsigned char
Definition: kdrive_express_config.h:32
int32_t error_t
Definition: kdrive_express_config.h:47
#define KDRIVE_INVALID_DESCRIPTOR
Indicates an invalid descriptor.
Definition: kdrive_express_defs.h:39
kdriveExpress_API void kdrive_register_error_callback(kdrive_error_callback c, void *user_data)
Registers the error callback function.
#define KDRIVE_TIMEOUT_ERROR
Timeout.
Definition: kdrive_express_error.h:26
#define KDRIVE_ERROR_NONE
No Error, Everything OK.
Definition: kdrive_express_error.h:22
kdriveExpress_API void kdrive_get_error_message(error_t e, char *str, uint32_t str_len)
Gets the error message.
#define KDRIVE_EVENT_CLOSING
The closing signal is emitted when the port is about to be closed.
Definition: kdrive_express_event.h:26
kdriveExpress_API error_t kdrive_set_event_callback(int32_t ap, kdrive_event_callback c, void *user_data)
Sets the event callback, for a specific access port.
#define KDRIVE_EVENT_OPENING
The opening signal is emitted when the port is about to be opened.
Definition: kdrive_express_event.h:24
#define KDRIVE_EVENT_TELEGRAM_INDICATION
Definition: kdrive_express_event.h:34
#define KDRIVE_EVENT_TERMINATED
The terminated signal is emitted when the port was closed (internally) on error.
Definition: kdrive_express_event.h:28
#define KDRIVE_EVENT_CLOSED
The closed signal is emitted when the port was closed.
Definition: kdrive_express_event.h:27
#define KDRIVE_EVENT_INTERNAL_01
Definition: kdrive_express_event.h:38
#define KDRIVE_EVENT_KNX_BUS_DISCONNECTED
The knx bus disconnected signal is emitted when the KNX bus was disconnected.
Definition: kdrive_express_event.h:31
#define KDRIVE_EVENT_ERROR
The error signal is emitted when an error was occurred.
Definition: kdrive_express_event.h:22
#define KDRIVE_EVENT_LOCAL_DEVICE_RESET
The local device reset signal is emitted when a KNX reset.ind was received.
Definition: kdrive_express_event.h:32
#define KDRIVE_EVENT_TELEGRAM_CONFIRM_TIMEOUT
Definition: kdrive_express_event.h:36
#define KDRIVE_EVENT_KNX_BUS_CONNECTED
The knx bus connected signal is emitted when the KNX bus was connected.
Definition: kdrive_express_event.h:30
#define KDRIVE_EVENT_OPENED
The opened signal is emitted when the port was opened.
Definition: kdrive_express_event.h:25
#define KDRIVE_EVENT_TELEGRAM_CONFIRM
Definition: kdrive_express_event.h:35
#define KDRIVE_LOGGER_ERROR
An error.
Definition: kdrive_express_logger.h:28
#define KDRIVE_LOGGER_INFORMATION
An informational message, usually denoting the successful completion of an operation.
Definition: kdrive_express_logger.h:31