module_config_api.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2021 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
//
 
#ifndef __MODULE_CONFIG_API_H__
#define __MODULE_CONFIG_API_H__
 
#include "module_config_config.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/*******************************
** Defines
********************************/
 
#define MC_FDSK_LEN                                     (16)            
#define MC_AUTH_KEY_OEM_PROD_LEN        (16)            
/*******************************
** Structures
********************************/
 
typedef struct mc_t
{
        uint8_t* manufacturer_id;   
        uint8_t* manufacturer_data; 
        uint8_t* order_info;        
        uint8_t* hardware_type;     
        uint8_t* serial_number;     
        uint8_t* fdsk;                          
} mc_t;
 
/*******************************
** Functions
********************************/
 
moduleConfig_API error_t mc_set_sp(int32_t sp);
 
moduleConfig_API error_t mc_remove_sp();
 
moduleConfig_API error_t mc_set_ind_addr(uint16_t ind_addr);
 
moduleConfig_API error_t mc_get_ind_addr(uint16_t* ind_addr);
 
moduleConfig_API error_t mc_set_auth_key(const uint32_t authorize_key);
 
moduleConfig_API error_t mc_clear_auth_key();
 
moduleConfig_API error_t mc_write_auth_key(const uint32_t authorize_key);
 
moduleConfig_API bool_t mc_is_oem_prod_supported();
 
moduleConfig_API error_t mc_set_auth_key_oem_prod(const uint8_t authorize_key_oem_prod[MC_AUTH_KEY_OEM_PROD_LEN]);
 
moduleConfig_API error_t mc_clear_auth_key_oem_prod();
 
moduleConfig_API error_t mc_write_auth_key_oem_prod(const uint8_t authorize_key_oem_prod[MC_AUTH_KEY_OEM_PROD_LEN]);
 
moduleConfig_API error_t mc_read_manufacturer_id(uint8_t manufacturer_id[2]);
 
moduleConfig_API error_t mc_write_manufacturer_id(uint8_t manufacturer_id[2]);
 
moduleConfig_API error_t mc_read_manufacturer_data(uint8_t manufacturer_data[4]);
 
moduleConfig_API error_t mc_write_manufacturer_data(uint8_t manufacturer_data[4]);
 
moduleConfig_API error_t mc_read_order_info(uint8_t order_info[10]);
 
moduleConfig_API error_t mc_write_order_info(uint8_t order_info[10]);
 
moduleConfig_API error_t mc_read_hardware_type(uint8_t hardware_type[6]);
 
moduleConfig_API error_t mc_write_hardware_type(uint8_t hardware_type[6]);
 
moduleConfig_API error_t mc_read_serial_number(uint8_t serial_number[6]);
 
moduleConfig_API error_t mc_write_serial_number(uint8_t serial_number[6]);
 
moduleConfig_API error_t mc_write_fdsk(uint8_t fdsk[MC_FDSK_LEN]);
 
moduleConfig_API error_t mc_read_fdsk_lock(bool_t* status);
 
moduleConfig_API error_t mc_lock_fdsk(const uint8_t fdsk[MC_FDSK_LEN]);
 
moduleConfig_API error_t mc_read_config(mc_t* module_config);
 
moduleConfig_API error_t mc_write_config(mc_t module_config, uint32_t* authorize_key);
 
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]);
 
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]);
 
moduleConfig_API error_t mc_extract_knx_qr_string_human(const char* qr, uint8_t serial_number[6], uint8_t fdsk[MC_FDSK_LEN]);
 
moduleConfig_API error_t mc_encode_svg_string(const char* qr, char* svg_string, uint32_t* length);
 
moduleConfig_API error_t mc_encode_ascii_string(const char* qr, char* ascii_string, uint32_t* length);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __MODULE_CONFIG_API_H__ */