CCAux  2.20.0.0
CCAux API reference
CanSetting.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 2023 CrossControl AB
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; with
8  * version 2.1 of the License.
9  */
10 /*
11  * File description:
12  * Can settings
13  *
14  * Use the function GetCanSetting() to get a handle to pass on to the other functions.
15  * Use the method CanSetting_release(CANSETTINGHANDLE) to return the handle.
16  *
17  * Example Usage:
18  * @include cansetting_example.cpp
19  *
20  ************************************************/
21 #ifndef CC_CAN_SETTING_H
22 #define CC_CAN_SETTING_H
23 
24 #include "CCAuxErrors.h"
25 #include "CCPlatform.h"
26 
27 #ifdef __cplusplus
28 namespace CrossControl
29 {
30 #endif
31 
32 typedef void *CANSETTINGHANDLE;
33 
53 EXTERN_C
54 CCAUXDLL_API
56 CCAUXDLL_CALLING_CONV
58 
69 EXTERN_C
70 CCAUXDLL_API
71 void CCAUXDLL_CALLING_CONV CanSetting_release(CANSETTINGHANDLE);
72 
86 EXTERN_C
87 CCAUXDLL_API
88 eErr CCAUXDLL_CALLING_CONV CanSetting_getBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrate);
89 
103 EXTERN_C
104 CCAUXDLL_API
105 eErr CCAUXDLL_CALLING_CONV CanSetting_getFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType *frameType);
106 
121 EXTERN_C
122 CCAUXDLL_API
123 eErr CCAUXDLL_CALLING_CONV CanSetting_setBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t baudrate);
124 
135 EXTERN_C
136 CCAUXDLL_API
137 eErr CCAUXDLL_CALLING_CONV CanSetting_setFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType frameType);
138 
155 EXTERN_C
156 CCAUXDLL_API
157 eErr CCAUXDLL_CALLING_CONV CanSetting_getFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrateNominal,
158  uint16_t *baudrateData);
159 
174 EXTERN_C
175 CCAUXDLL_API
176 eErr CCAUXDLL_CALLING_CONV CanSetting_setFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t baudrateNominal,
177  uint16_t baudrateData);
178 
180 #ifdef __cplusplus
181 } /* namespace CrossControl */
182 #endif
183 
184 #endif /* CC_CAN_SETTING_H */
unsigned short uint16_t
Definition: CCAuxTypes.h:38
unsigned char uint8_t
Definition: CCAuxTypes.h:37
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_setFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t baudrateNominal, uint16_t baudrateData)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_getFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType *frameType)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CanSetting_release(CANSETTINGHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_setBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t baudrate)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_getBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrate)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_setFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType frameType)
EXTERN_C CCAUXDLL_API CANSETTINGHANDLE CCAUXDLL_CALLING_CONV GetCanSetting(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CanSetting_getFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrateNominal, uint16_t *baudrateData)
Definition: About.h:30
void * CANSETTINGHANDLE
Definition: CanSetting.h:32
CanFrameType
Definition: CCAuxTypes.h:318
eErr
Definition: CCAuxTypes.h:162