BaosModuleConfig SDK 2.2.1
module_config_api.h File Reference

BaosModuleConfig API. More...

Go to the source code of this file.

Data Structures

struct  mc_t
 Structure holding the baos module configuration. More...
 

Macros

#define MC_FDSK_LEN   (16)
 The Length of a factory default setup key (FDSK) More...
 
#define MC_AUTH_KEY_OEM_PROD_LEN   (16)
 The length of the OEM production authorize key. More...
 

Typedefs

typedef struct mc_t mc_t
 Structure holding the baos module configuration. More...
 

Functions

moduleConfig_API error_t mc_set_sp (int32_t sp)
 Sets the service port for the ModuleConfiguration. More...
 
moduleConfig_API error_t mc_remove_sp ()
 Remove the used service port from the ModuleConfiguration. More...
 
moduleConfig_API error_t mc_set_ind_addr (uint16_t ind_addr)
 Sets the individual address of the baos module to configure. More...
 
moduleConfig_API error_t mc_get_ind_addr (uint16_t *ind_addr)
 Gets the individual address of the baos module to configure. More...
 
moduleConfig_API error_t mc_set_auth_key (const uint32_t authorize_key)
 Sets the used authorize key of the baos module to configure. More...
 
moduleConfig_API error_t mc_clear_auth_key ()
 Clears the authorize key to be used when writing properties to the baos module to configure. More...
 
moduleConfig_API error_t mc_write_auth_key (const uint32_t authorize_key)
 Writes a new authorize key to the baos module to configure. More...
 
moduleConfig_API bool_t mc_is_oem_prod_supported ()
 Checks if the baos module Supports the individualization with OEM production properties. More...
 
moduleConfig_API error_t mc_set_auth_key_oem_prod (const uint8_t authorize_key_oem_prod[MC_AUTH_KEY_OEM_PROD_LEN])
 Sets the used OEM production authorize key of the baos module to configure. More...
 
moduleConfig_API error_t mc_clear_auth_key_oem_prod ()
 Clears the OEM production authorize key to be used when writing properties to the baos module to configure. More...
 
moduleConfig_API error_t mc_write_auth_key_oem_prod (const uint8_t authorize_key_oem_prod[MC_AUTH_KEY_OEM_PROD_LEN])
 Writes a new OEM production authorize key to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_manufacturer_id (uint8_t manufacturer_id[2])
 Reads the manufacturer id from a baos module. More...
 
moduleConfig_API error_t mc_write_manufacturer_id (uint8_t manufacturer_id[2])
 Writes the manufacturer id to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_manufacturer_data (uint8_t manufacturer_data[4])
 Reads the manufacturer data from a baos module. More...
 
moduleConfig_API error_t mc_write_manufacturer_data (uint8_t manufacturer_data[4])
 Writes the manufacturer data to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_order_info (uint8_t order_info[10])
 Reads the order info from a baos module. More...
 
moduleConfig_API error_t mc_write_order_info (uint8_t order_info[10])
 Writes the order info to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_hardware_type (uint8_t hardware_type[6])
 Reads the hardware type from a baos module. More...
 
moduleConfig_API error_t mc_write_hardware_type (uint8_t hardware_type[6])
 Writes the hardware type to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_serial_number (uint8_t serial_number[6])
 Reads the serial number from a baos module. More...
 
moduleConfig_API error_t mc_write_serial_number (uint8_t serial_number[6])
 Writes the serial number to the baos module to configure. More...
 
moduleConfig_API error_t mc_write_fdsk (uint8_t fdsk[MC_FDSK_LEN])
 Writes the FDSK (Factory Default Setup Key) to the baos module to configure. More...
 
moduleConfig_API error_t mc_read_fdsk_lock (bool_t *status)
 Reads the FDSK lock status. More...
 
moduleConfig_API error_t mc_lock_fdsk (const uint8_t fdsk[MC_FDSK_LEN])
 After call this command (with the current valid FDSK) the FDSK could no more changed. More...
 
moduleConfig_API error_t mc_read_config (mc_t *module_config)
 Reads the whole configuration (manufacturer id, manufacturer data, order info, hardware type, serial number, BUT NOT writeonly fdsk!) from a baos module. More...
 
moduleConfig_API error_t mc_write_config (mc_t module_config, uint32_t *authorize_key)
 Writes the whole basic configuration (manufacturer id, manufacturer data, order info, hardware type, serial number, fdsk) and the new authorize key to the baos module to configure. More...
 
moduleConfig_API error_t mc_write_config_oem_prod (mc_t module_config, uint8_t authorize_key_oem_prod[MC_AUTH_KEY_OEM_PROD_LEN])
 Writes the whole basic configuration (manufacturer id, manufacturer data, order info, hardware type, serial number, fdsk) and the new authorize key OEM production to the baos module to configure. More...
 
moduleConfig_API error_t mc_build_knx_qr_string_human (const uint8_t serial_number[6], const uint8_t fdsk[MC_FDSK_LEN], char qr[41+1])
 Builds the humand readable QR string of the KNX device certificate Returns 41 character string (crc4 appended, base32 encoded and separated in 6 blocks a 6 character by '-' delimiter). More...
 
moduleConfig_API error_t mc_extract_knx_qr_string_human (const char *qr, uint8_t serial_number[6], uint8_t fdsk[MC_FDSK_LEN])
 Extracts the KNX serial number and FDSK from the humand readable QR string of the KNX device certificate. More...
 
moduleConfig_API error_t mc_encode_svg_string (const char *qr, char *svg_string, uint32_t *length)
 Takes a humand readable QR string (41 character e.g. More...
 
moduleConfig_API error_t mc_encode_ascii_string (const char *qr, char *ascii_string, uint32_t *length)
 Takes a humand readable QR string (41 character e.g. More...
 

Detailed Description

BaosModuleConfig API.

Author
Copyright (c) 2002-2025 WEINZIERL ENGINEERING GmbH

Macro Definition Documentation

◆ MC_AUTH_KEY_OEM_PROD_LEN

#define MC_AUTH_KEY_OEM_PROD_LEN   (16)

The length of the OEM production authorize key.

◆ MC_FDSK_LEN

#define MC_FDSK_LEN   (16)

The Length of a factory default setup key (FDSK)

Function Documentation

◆ mc_is_oem_prod_supported()

moduleConfig_API bool_t mc_is_oem_prod_supported ( )

Checks if the baos module Supports the individualization with OEM production properties.

Returns
true if the module support OEM production properties false if not