kdriveExpress SDK 23.2.0
kdrive_express_mprop.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2002-2023 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 __KDRIVE_EXPRESS_MPROP_H__
14 #define __KDRIVE_EXPRESS_MPROP_H__
15 
16 #include "kdrive_express_config.h"
17 #include "kdrive_express_defs.h"
18 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 /**************************************************************
31 ** Local Service: M_Prop_Read
32 ***************************************************************/
33 
53  uint16_t object_type,
54  uint16_t object_instance,
55  uint16_t prop_id,
56  uint8_t nr_of_elems,
57  uint16_t start_index,
58  uint8_t data[],
59  uint32_t* data_length);
60 
61 
62 /**************************************************************
63 ** Local Service: M_Prop_Write
64 ***************************************************************/
65 
83  uint16_t object_type,
84  uint16_t object_instance,
85  uint16_t prop_id,
86  uint8_t nr_of_elems,
87  uint16_t start_index,
88  const uint8_t data[],
89  uint32_t data_length,
90  uint8_t* return_code);
91 
92 /**************************************************************
93 ** Local Service: M_FuncProp_Command
94 ***************************************************************/
95 
116  uint16_t object_type,
117  uint16_t object_instance,
118  uint16_t prop_id,
119  const uint8_t input_data[],
120  uint32_t input_data_length,
121  uint8_t* return_code,
122  uint8_t output_data[],
123  uint32_t* output_data_length);
124 
125 /**************************************************************
126 ** Device Service: M_FuncProp_StateRead
127 ***************************************************************/
128 
149  uint16_t object_type,
150  uint16_t object_instance,
151  uint16_t prop_id,
152  const uint8_t input_data[],
153  uint32_t input_data_length,
154  uint8_t* return_code,
155  uint8_t output_data[],
156  uint32_t* output_data_length);
157 
158 #ifdef __cplusplus
159 }
160 #endif
161 
162 #endif /* __KDRIVE_EXPRESS_MPROP_H__ */
kdriveExpress_API error_t kdrive_ap_m_prop_read(int32_t ap, uint16_t object_type, uint16_t object_instance, uint16_t prop_id, uint8_t nr_of_elems, uint16_t start_index, uint8_t data[], uint32_t *data_length)
kdriveExpress_API error_t kdrive_ap_m_func_prop_command(int32_t ap, uint16_t object_type, uint16_t object_instance, uint16_t prop_id, const uint8_t input_data[], uint32_t input_data_length, uint8_t *return_code, uint8_t output_data[], uint32_t *output_data_length)
kdriveExpress_API error_t kdrive_ap_m_func_prop_state_read(int32_t ap, uint16_t object_type, uint16_t object_instance, uint16_t prop_id, const uint8_t input_data[], uint32_t input_data_length, uint8_t *return_code, uint8_t output_data[], uint32_t *output_data_length)
kdriveExpress_API error_t kdrive_ap_m_prop_write(int32_t ap, uint16_t object_type, uint16_t object_instance, uint16_t prop_id, uint8_t nr_of_elems, uint16_t start_index, const uint8_t data[], uint32_t data_length, uint8_t *return_code)
#define kdriveExpress_API
Definition: kdrive_express_config.h:89
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
unsigned char uint8_t
8 bit unsigned char
Definition: kdrive_express_config.h:30
kdriveExpress Defines