embedded-software
reusable software modules for embedded systems
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Ultrasonic Module

Functions

uint8_t Ultrasonic_Init (uint16_t period, filter_t *filter, void(*callback)(uint16_t))
 Initialization of ultrasonic module, returns a uint8_t sensor_handle. More...
 
void Ultrasonic_Deinit (uint8_t sensor_handle)
 Deinitialization of specific ultrasonic module. More...
 

Detailed Description

Function Documentation

void Ultrasonic_Deinit ( uint8_t  sensor_handle)

Deinitialization of specific ultrasonic module.

Parameters
sensor_handleThis will tell the function which sensor needs to be deinitialized/turned off
uint8_t Ultrasonic_Init ( uint16_t  period,
filter_t filter,
void(*)(uint16_t)  callback 
)

Initialization of ultrasonic module, returns a uint8_t sensor_handle.

Parameters
periodPeriod between the end of one measurement and the beginning of another
filterAn optional paramater for to filter any data
callbackA function that is executed at the end of the Init function that tells the program the Init was successful