Embedded System Design 2 - Project
cable.h
Go to the documentation of this file.
1 /***************************************************************************//**
2  * @file cable.h
3  * @brief Cable checking functionality.
4  * @version 2.1
5  * @author Brecht Van Eeckhoudt
6  *
7  * ******************************************************************************
8  *
9  * @section License
10  *
11  * **Copyright (C) 2019 - Brecht Van Eeckhoudt**
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the **GNU General Public License** as published by
15  * the Free Software Foundation, either **version 3** of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * *A copy of the GNU General Public License can be found in the `LICENSE`
24  * file along with this source code.*
25  *
26  * @n
27  *
28  * Some methods use code obtained from examples from [Silicon Labs' GitHub](https://github.com/SiliconLabs/peripheral_examples).
29  * These sections are licensed under the Silabs License Agreement. See the file
30  * "Silabs_License_Agreement.txt" for details. Before using this software for
31  * any purpose, you must agree to the terms of that agreement.
32  *
33  ******************************************************************************/
34 
35 
36 /* Include guards prevent multiple inclusions of the same header */
37 #ifndef _CABLE_H_
38 #define _CABLE_H_
39 
40 
41 /* Includes necessary for this header file */
42 #include <stdbool.h> /* "bool", "true", "false" */
43 #include "datatypes.h" /* Definitions of the custom data-types */
44 
45 
46 /* Public prototype */
47 bool checkCable (MeasurementData_t data);
48 
49 
50 #endif /* _CABLE_H_ */
checkCable
bool checkCable(MeasurementData_t data)
Method to check if the wire is broken.
Definition: cable.c:92
datatypes.h
Definitions of the custom data-types used.
data
MeasurementData_t data
Definition: main.c:189
MeasurementData_t
Definition: datatypes.h:69