driver_hcsr04.h File Reference

driver hcsr04 header file More...

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>

Include dependency graph for driver_hcsr04.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	hcsr04_time_s
	hcsr04 time structure definition More...
struct	hcsr04_handle_s
	hcsr04 handle structure definition More...
struct	hcsr04_info_s
	hcsr04 information structure definition More...

Macros
#define	HCSR04_READ_RETRY_TIMES   3
	hcsr04 read retry times definition
#define	DRIVER_HCSR04_LINK_INIT(HANDLE, STRUCTURE)
	initialize hcsr04_handle_t structure
#define	DRIVER_HCSR04_LINK_TRIG_INIT(HANDLE, FUC)
	link trig_init function
#define	DRIVER_HCSR04_LINK_TRIG_DEINIT(HANDLE, FUC)
	link trig_deinit function
#define	DRIVER_HCSR04_LINK_TRIG_WRITE(HANDLE, FUC)
	link trig_write function
#define	DRIVER_HCSR04_LINK_ECHO_INIT(HANDLE, FUC)
	link echo_init function
#define	DRIVER_HCSR04_LINK_ECHO_DEINIT(HANDLE, FUC)
	link echo_deinit function
#define	DRIVER_HCSR04_LINK_ECHO_WRITE(HANDLE, FUC)
	link echo_read function
#define	DRIVER_HCSR04_LINK_TIMESTAMP_READ(HANDLE, FUC)
	link timestamp_read function
#define	DRIVER_HCSR04_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_HCSR04_LINK_DELAY_US(HANDLE, FUC)
	link delay_us function
#define	DRIVER_HCSR04_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct hcsr04_time_s	hcsr04_time_t
	hcsr04 time structure definition
typedef struct hcsr04_handle_s	hcsr04_handle_t
	hcsr04 handle structure definition
typedef struct hcsr04_info_s	hcsr04_info_t
	hcsr04 information structure definition

Functions
uint8_t	hcsr04_info (hcsr04_info_t *info)
	get chip's information
uint8_t	hcsr04_init (hcsr04_handle_t *handle)
	initialize the chip
uint8_t	hcsr04_deinit (hcsr04_handle_t *handle)
	close the chip
uint8_t	hcsr04_read (hcsr04_handle_t *handle, uint32_t *time_us, float *m)
	read the distance

Detailed Description

driver hcsr04 header file

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.

Version

2.0.0

Author

Shifeng Li

Date

2021-04-15

history

Date	Version	Author	Description
2021/04/15	2.0	Shifeng Li	format the code
2020/12/21	1.0	Shifeng Li	first upload

Definition in file driver_hcsr04.h.