kdriveExpress SDK 22.1.1
kdrive_express_keyring.h File Reference

kdriveExpress KNX Keyring API More...

Go to the source code of this file.

Data Structures

struct  keyring_dev_t
 
struct  keyring_tun_t
 

Typedefs

typedef struct keyring_dev_t keyring_dev_t
 
typedef struct keyring_tun_t keyring_tun_t
 

Functions

kdriveExpress_API int32_t kdrive_keyring_create (const char *name)
 Create a new keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_import_knxkeys (const char *filename, const char *password, int32_t *keyring)
 Imports an ETS keyring project file (*.knxkeys) More...
 
kdriveExpress_API bool_t kdrive_keyring_remove (int32_t keyring)
 Removes a keyring project Returns true if successfully released false otherwise (i.e. More...
 
kdriveExpress_API error_t kdrive_keyring_get_proj_name (int32_t keyring, char name[], uint32_t *name_length)
 Gets keyring project name Null-terminated string in utf8 encoding. More...
 
kdriveExpress_API error_t kdrive_keyring_get_proj_creator (int32_t keyring, char creator[], uint32_t *creator_length)
 Gets keyring project creator (e.g. More...
 
kdriveExpress_API error_t kdrive_keyring_set_device (int32_t keyring, const keyring_dev_t *device)
 Set a device to the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_get_device (int32_t keyring, keyring_dev_t *device)
 Get a device from the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_set_tunnel (int32_t keyring, const keyring_tun_t *tunnel)
 Set a tunneling interface to the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_get_tunnel (int32_t keyring, keyring_tun_t *tunnel)
 Get a tunneling interface from the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_remove_device_tunnel (int32_t keyring, uint16_t address)
 Removes a device or tunneling interface chosen by it's individual address from the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_set_group_addr (int32_t keyring, uint16_t group_addr, const uint8_t key[KDRIVE_SEC_KEY_LEN])
 Set a group address with it's key to the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_get_group_addr (int32_t keyring, uint16_t group_addr, uint8_t key[KDRIVE_SEC_KEY_LEN])
 Get the key for a group address from the keyring. More...
 
kdriveExpress_API error_t kdrive_keyring_remove_group_addr (int32_t keyring, uint16_t group_addr)
 Removes a group address with it's key from the keyring. More...
 

Detailed Description

kdriveExpress KNX Keyring API

Author
Copyright (c) 2002-2022 WEINZIERL ENGINEERING GmbH

Typedef Documentation

◆ keyring_dev_t

typedef struct keyring_dev_t keyring_dev_t

◆ keyring_tun_t

typedef struct keyring_tun_t keyring_tun_t