English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어
HCSR04 ultrasonic ranging module can provide a non-contact distance sensing function of 2cm-400cm.The ranging accuracy can reach 3mm. The module includes ultrasonic transmitter, receiver and control circuit.
LibDriver HCSR04 is the HCSR04 full function driver launched by LibDriver.It provides the function of ultrasonic ranging.LibDriver is MISRA compliant.
/src includes LibDriver HCSR04 source files.
/interface includes LibDriver HCSR04 gpio platform independent template.
/test includes LibDriver HCSR04 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver HCSR04 sample code.
/doc includes LibDriver HCSR04 offline document.
/datasheet includes HCSR04 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
Reference /interface gpio platform independent template and finish your platform gpio driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#include "driver_hcsr04_basic.h"
uint8_t res;
uint8_t i;
float m;
res = hcsr04_basic_init();
if (res != 0)
{
return 1;
}
...
for (i = 0; i < 3; i++)
{
res = hcsr04_basic_read((float *)&m);
if (res != 0)
{
(void)hcsr04_basic_deinit();
return 1;
}
hcsr04_interface_delay_ms(1000);
hcsr04_interface_debug_print("hcsr04: distance is %0.4fm.\n", m);
...
}
...
(void)hcsr04_basic_deinit();
return 0;Online documents: https://www.libdriver.com/docs/hcsr04/index.html.
Offline documents: /doc/html/index.html.
Please refer to CONTRIBUTING.md.
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Please send an e-mail to lishifenging@outlook.com.