driver_hcsr04.h

Go to the documentation of this file.

 
#ifndef DRIVER_HCSR04_H
#define DRIVER_HCSR04_H
 
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



#ifndef HCSR04_READ_RETRY_TIMES
    #define HCSR04_READ_RETRY_TIMES 3        
#endif

typedef struct hcsr04_time_s
{
    uint64_t microsecond;        
    uint32_t millisecond;        
} hcsr04_time_t;

typedef struct hcsr04_handle_s
{
    uint8_t (*trig_init)(void);                            
    uint8_t (*trig_deinit)(void);                          
    uint8_t (*trig_write)(uint8_t value);                  
    uint8_t (*echo_init)(void);                            
    uint8_t (*echo_deinit)(void);                          
    uint8_t (*echo_read)(uint8_t *value);                  
    uint8_t (*timestamp_read)(hcsr04_time_t *time);        
    void (*delay_us)(uint32_t ms);                         
    void (*delay_ms)(uint32_t ms);                         
    void (*debug_print)(const char *const fmt, ...);       
    uint8_t inited;                                        
} hcsr04_handle_t;

typedef struct hcsr04_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} hcsr04_info_t;



#define DRIVER_HCSR04_LINK_INIT(HANDLE, STRUCTURE)      memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_HCSR04_LINK_TRIG_INIT(HANDLE, FUC)      (HANDLE)->trig_init = FUC

#define DRIVER_HCSR04_LINK_TRIG_DEINIT(HANDLE, FUC)    (HANDLE)->trig_deinit = FUC

#define DRIVER_HCSR04_LINK_TRIG_WRITE(HANDLE, FUC)     (HANDLE)->trig_write = FUC

#define DRIVER_HCSR04_LINK_ECHO_INIT(HANDLE, FUC)      (HANDLE)->echo_init = FUC

#define DRIVER_HCSR04_LINK_ECHO_DEINIT(HANDLE, FUC)    (HANDLE)->echo_deinit = FUC

#define DRIVER_HCSR04_LINK_ECHO_WRITE(HANDLE, FUC)     (HANDLE)->echo_read = FUC

#define DRIVER_HCSR04_LINK_TIMESTAMP_READ(HANDLE, FUC) (HANDLE)->timestamp_read = FUC

#define DRIVER_HCSR04_LINK_DELAY_MS(HANDLE, FUC)       (HANDLE)->delay_ms = FUC

#define DRIVER_HCSR04_LINK_DELAY_US(HANDLE, FUC)       (HANDLE)->delay_us = FUC

#define DRIVER_HCSR04_LINK_DEBUG_PRINT(HANDLE, FUC)    (HANDLE)->debug_print = FUC



uint8_t hcsr04_info(hcsr04_info_t *info);

uint8_t hcsr04_init(hcsr04_handle_t *handle);

uint8_t hcsr04_deinit(hcsr04_handle_t *handle);

uint8_t hcsr04_read(hcsr04_handle_t *handle, uint32_t *time_us, float *m);


 
#ifdef __cplusplus
}
#endif
 
#endif