BaosModuleConfig SDK  1.0.0
module_config_api.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2002-2021 WEINZIERL ENGINEERING GmbH
3 // All rights reserved.
4 //
5 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
6 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
7 // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
8 // SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
9 // WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
10 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
11 //
12 
13 #ifndef __MODULE_CONFIG_API_H__
14 #define __MODULE_CONFIG_API_H__
15 
16 #include "module_config_config.h"
17 
25 #ifdef __cplusplus
26 extern "C"
27 {
28 #endif
29 
39  typedef struct mc_t
40  {
41  uint8_t* manufacturer_id;
42  uint8_t* manufacturer_data;
43  uint8_t* order_info;
44  uint8_t* hardware_type;
45  uint8_t* serial_number;
47  } mc_t;
48 
58  moduleConfig_API error_t mc_set_sp(int32_t sp);
59 
69 
77  moduleConfig_API error_t mc_set_ind_addr(uint16_t ind_addr);
78 
86  moduleConfig_API error_t mc_get_ind_addr(uint16_t* ind_addr);
87 
95  moduleConfig_API error_t mc_set_auth_key(const uint32_t authorize_key);
96 
105 
113  moduleConfig_API error_t mc_write_auth_key(const uint32_t authorize_key);
114 
127 
139 
150 
162 
172  moduleConfig_API error_t mc_read_order_info(uint8_t order_info[10]);
173 
184  moduleConfig_API error_t mc_write_order_info(uint8_t order_info[10]);
185 
196 
208 
219 
231 
244  moduleConfig_API error_t mc_read_config(mc_t* module_config);
245 
260  moduleConfig_API error_t mc_write_config(mc_t module_config, uint32_t* authorize_key);
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
277 #endif /* __MODULE_CONFIG_API_H__ */
moduleConfig_API error_t mc_remove_sp()
Remove the used service port from the ModuleConfiguration.
uint8_t * order_info
manufacturer specific order information
Definition: module_config_api.h:43
uint8_t * hardware_type
an identifier for the device hardware
Definition: module_config_api.h:44
moduleConfig_API error_t mc_write_auth_key(const uint32_t authorize_key)
Writes a new authorize key to the baos module to configure.
moduleConfig_API error_t mc_set_sp(int32_t sp)
Sets the service port for the ModuleConfiguration.
Structure holding the baos module configuration.
Definition: module_config_api.h:39
uint8_t * serial_number
the KNX Serial Number of the device
Definition: module_config_api.h:45
uint8_t * manufacturer_id
the KNX ID of the manufacturer
Definition: module_config_api.h:41
moduleConfig_API error_t mc_write_manufacturer_id(uint8_t manufacturer_id[2])
Writes the manufacturer id to the baos module to configure.
uint8_t * manufacturer_data
freely usable data by the manufacturer
Definition: module_config_api.h:42
moduleConfig_API error_t mc_write_config(mc_t module_config, uint32_t *authorize_key)
Writes the whole configuration (manufacturer id, manufacturer data, order info, hardware type...
moduleConfig_API error_t mc_read_hardware_type(uint8_t hardware_type[6])
Reads the hardware type from a baos module.
moduleConfig_API error_t mc_set_ind_addr(uint16_t ind_addr)
Sets the individual address of the baos module to configure.
moduleConfig_API error_t mc_read_config(mc_t *module_config)
Reads the whole configuration (manufacturer id, manufacturer data, order info, hardware type...
moduleConfig_API error_t mc_set_auth_key(const uint32_t authorize_key)
Sets the used authorize key of the baos module to configure.
moduleConfig_API error_t mc_read_manufacturer_id(uint8_t manufacturer_id[2])
Reads the manufacturer id from a baos module.
moduleConfig_API error_t mc_write_hardware_type(uint8_t hardware_type[6])
Writes the hardware type to the baos module to configure.
moduleConfig_API error_t mc_read_manufacturer_data(uint8_t manufacturer_data[4])
Reads the manufacturer data from a baos module.
moduleConfig_API error_t mc_write_order_info(uint8_t order_info[10])
Writes the order info to the baos module to configure.
moduleConfig_API error_t mc_write_manufacturer_data(uint8_t manufacturer_data[4])
Writes the manufacturer data to the baos module to configure.
moduleConfig_API error_t mc_clear_auth_key()
Clears the authorize key to be used when writing properties to the baos module to configure...
moduleConfig_API error_t mc_write_serial_number(uint8_t serial_number[6])
Writes the serial number to the baos module to configure.
#define moduleConfig_API
Definition: module_config_config.h:41
moduleConfig_API error_t mc_read_serial_number(uint8_t serial_number[6])
Reads the serial number from a baos module.
struct mc_t mc_t
Structure holding the baos module configuration.
moduleConfig_API error_t mc_get_ind_addr(uint16_t *ind_addr)
Gets the individual address of the baos module to configure.
moduleConfig_API error_t mc_read_order_info(uint8_t order_info[10])
Reads the order info from a baos module.