driver_ds18b20.h

Go to the documentation of this file.

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



#ifndef DS18B20_MAX_SEARCH_SIZE
    #define DS18B20_MAX_SEARCH_SIZE 64        
#endif



typedef enum
{
    DS18B20_MODE_SKIP_ROM  = 0x00,        
    DS18B20_MODE_MATCH_ROM = 0x01,        
} ds18b20_mode_t;

typedef enum
{
    DS18B20_POWER_MODE_PARASITE   = 0x00,        
    DS18B20_POWER_MODE_EXTERNALLY = 0x01,        
} ds18b20_power_mode_t;

typedef enum
{
    DS18B20_RESOLUTION_9BIT  = 0x00,        
    DS18B20_RESOLUTION_10BIT = 0x01,        
    DS18B20_RESOLUTION_11BIT = 0x02,        
    DS18B20_RESOLUTION_12BIT = 0x03,        
} ds18b20_resolution_t;

typedef struct ds18b20_handle_s
{
    uint8_t (*bus_init)(void);                              
    uint8_t (*bus_deinit)(void);                            
    uint8_t (*bus_read)(uint8_t *value);                    
    uint8_t (*bus_write)(uint8_t value);                    
    void (*delay_ms)(uint32_t ms);                          
    void (*delay_us)(uint32_t us);                          
    void (*enable_irq)(void);                               
    void (*disable_irq)(void);                              
    void (*debug_print)(const char *const fmt, ...);        
    uint8_t inited;                                         
    uint8_t mode;                                           
    uint8_t rom[8];                                         
} ds18b20_handle_t;

typedef struct ds18b20_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;           
} ds18b20_info_t;



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

#define DRIVER_DS18B20_LINK_BUS_INIT(HANDLE, FUC)    (HANDLE)->bus_init = FUC

#define DRIVER_DS18B20_LINK_BUS_DEINIT(HANDLE, FUC)  (HANDLE)->bus_deinit = FUC

#define DRIVER_DS18B20_LINK_BUS_READ(HANDLE, FUC)    (HANDLE)->bus_read = FUC

#define DRIVER_DS18B20_LINK_BUS_WRITE(HANDLE, FUC)   (HANDLE)->bus_write = FUC

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

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

#define DRIVER_DS18B20_LINK_ENABLE_IRQ(HANDLE, FUC)  (HANDLE)->enable_irq = FUC

#define DRIVER_DS18B20_LINK_DISABLE_IRQ(HANDLE, FUC) (HANDLE)->disable_irq = FUC

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



uint8_t ds18b20_info(ds18b20_info_t *info);

uint8_t ds18b20_init(ds18b20_handle_t *handle);

uint8_t ds18b20_deinit(ds18b20_handle_t *handle);

uint8_t ds18b20_read(ds18b20_handle_t *handle, int16_t *raw, float *temp);

uint8_t ds18b20_set_mode(ds18b20_handle_t *handle, ds18b20_mode_t mode);

uint8_t ds18b20_get_mode(ds18b20_handle_t *handle, ds18b20_mode_t *mode);

uint8_t ds18b20_set_rom(ds18b20_handle_t *handle, uint8_t rom[8]);

uint8_t ds18b20_get_rom(ds18b20_handle_t *handle, uint8_t rom[8]);

uint8_t ds18b20_scratchpad_set_resolution(ds18b20_handle_t *handle, ds18b20_resolution_t resolution);

uint8_t ds18b20_scratchpad_get_resolution(ds18b20_handle_t *handle, ds18b20_resolution_t *resolution);

uint8_t ds18b20_copy_scratchpad_to_eeprom(ds18b20_handle_t *handle);

uint8_t ds18b20_copy_eeprom_to_scratchpad(ds18b20_handle_t *handle);



uint8_t ds18b20_scratchpad_set_alarm_threshold(ds18b20_handle_t *handle, int8_t threshold_high, int8_t threshold_low);

uint8_t ds18b20_scrachpad_get_alarm_threshold(ds18b20_handle_t *handle, int8_t *threshold_high, int8_t *threshold_low);

uint8_t ds18b20_alarm_convert_to_register(ds18b20_handle_t *handle, float temp, int8_t *reg);

uint8_t ds18b20_alarm_convert_to_data(ds18b20_handle_t *handle, int8_t reg, float *temp);

uint8_t ds18b20_search_rom(ds18b20_handle_t *handle, uint8_t (*rom)[8], uint8_t *num);

uint8_t ds18b20_search_alarm(ds18b20_handle_t *handle, uint8_t (*rom)[8], uint8_t *num);

uint8_t ds18b20_get_power_mode(ds18b20_handle_t *handle, ds18b20_power_mode_t *power_mode);


 
#ifdef __cplusplus
}
#endif
 
#endif