uartinterface.h
Go to the documentation of this file.
1 
8 #ifndef TOPOSENS_LINUX_UARTINTERFACE_H /* include control, avoid multiple includes of header file \
9  */
10 #define TOPOSENS_LINUX_UARTINTERFACE_H
11 
12 /*---- <system includes> --------------------------------------------------------------*/
13 /*---- "library includes" -------------------------------------------------------------*/
14 
15 /*---- "project includes" -------------------------------------------------------------*/
16 #include "toposens/sensor_lib.h"
17 /*---- public macros and constants ----------------------------------------------------*/
18 
19 /*---- public types -------------------------------------------------------------------*/
20 
21 /*---- public variables prototypes ----------------------------------------------------*/
22 
23 /*---- public functions prototypes ----------------------------------------------------*/
24 
34 int WriteUARTPayload(uint8_t* Payload_pu8, uint8_t Length_u8, uint8_t InterfaceId_u8);
35 
46 int SetupUARTPort(char* InterfaceName_cp, uint32_t InterfaceBitrate_u32, uint8_t InterfaceId_u8);
47 
55 int DeinitUARTPort();
56 
64 void RegisterUARTReadCallback(void (*Callback)(uint8_t* UARTMsg_pu8, uint16_t UARTMsgSize_u16,
65  uint8_t InterfaceId_u8));
66 /*---- public inline functions --------------------------------------------------------*/
67 
68 #endif // TOPOSENS_LINUX_UARTINTERFACE_H
DeinitUARTPort
int DeinitUARTPort()
Called from the can-library, this function will close the socket and take care of ReceiverThread term...
Definition: uartinterface.c:204
WriteUARTPayload
int WriteUARTPayload(uint8_t *Payload_pu8, uint8_t Length_u8, uint8_t InterfaceId_u8)
Called to send messages to can socket.
Definition: uartinterface.c:140
SetupUARTPort
int SetupUARTPort(char *InterfaceName_cp, uint32_t InterfaceBitrate_u32, uint8_t InterfaceId_u8)
Called from the library, this function will take care of all linux-related uart-setup,...
Definition: uartinterface.c:189
sensor_lib.h
This file contains the highlevel interface prototypes to the low-level Protocol.
RegisterUARTReadCallback
void RegisterUARTReadCallback(void(*Callback)(uint8_t *UARTMsg_pu8, uint16_t UARTMsgSize_u16, uint8_t InterfaceId_u8))
This function is called by the library to set a callback function for incoming can-traffic.
Definition: uartinterface.c:126

toposens-library
Author(s): Andrej Wallwitz, Thomas Böhm , Sebastian Kruber
autogenerated on Wed Apr 27 2022 08:10:01