sem/OBD2-car-display
1
0
Fork 0
mirror of https://github.com/SemvdH/OBD2-car-display.git synced 2025-12-15 20:21:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

add comments to bluetooth driver

Browse Source
This commit is contained in:
Sem van der Hoeven
2024-01-14 12:57:06 +01:00
parent 15d560f426
commit a81322e46d
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
due_obd2/obd2_bt.h
View File

@@ -45,14 +45,38 @@ enum BluetoothState
BT_CONNECTED = 2 BT_CONNECTED = 2
}; };
/**
* @brief struct to hold bluetooth module data
*
* @param state the current state of the bluetooth module
* @param on_state_change function pointer to the function to be called when the state changes
*/
typedef struct obt2_bt_tag typedef struct obt2_bt_tag
{ {
enum BluetoothState state; enum BluetoothState state;
void (*on_state_change)(); void (*on_state_change)();
} obd2_bt_t; } obd2_bt_t;
/**
* @brief initializes the bluetooth module driver
*
* @param bt pointer to struct holding bluetooth driver data
*/
void obd2_bt_init(obd2_bt_t *bt); void obd2_bt_init(obd2_bt_t *bt);
/**
* @brief processes the bluetooth module communication with the OBD2 reader
*
* @param bt pointer to struct holding bluetooth driver data
*/
void obd2_bt_process(obd2_bt_t *bt); void obd2_bt_process(obd2_bt_t *bt);
/**
* @brief copies the current state of the bluetooth module to the state string
*
* @param bt pointer to struct holding bluetooth driver data
* @param state resulting string to hold the text representation of the state
*/
void obd2_bt_get_state(obd2_bt_t *bt, char *state); void obd2_bt_get_state(obd2_bt_t *bt, char *state);
#ifdef __cplusplus #ifdef __cplusplus