-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #208 from xkevin190/add_docs_to_tests
added doc.txt to ds18_sensor test
- Loading branch information
Showing
2 changed files
with
30 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/** | ||
@defgroup ds18_test Ds18 sensor test module | ||
@ingroup test_group | ||
@{ | ||
|
||
|
||
## Test DS18 sensor | ||
|
||
Here unit tests are performed on the ds18_sensor module. | ||
To perform a successful test you must connect the ds18 temperature sensor to your board. | ||
|
||
you must also add the gpio where your board will be connected in the test init function in the main.c file | ||
|
||
```c | ||
void test_init_ds18(void) { | ||
int err = init_temperature_sensor(your_gpio); | ||
|
||
TEST_ASSERT_EQUAL_INT(0, error); | ||
} | ||
``` | ||
|
||
To test the code in automatic mode: | ||
|
||
```c | ||
make flash test | ||
``` | ||
|
||
@} | ||
|
||
*/ |
This file was deleted.
Oops, something went wrong.