ds18b20_driver.h

Go to the documentation of this file.

 
#if !defined(DRIVER_DS18B20_DRIVER_H_)
#define DRIVER_DS18B20_DRIVER_H_
 
#include "onewire_driver.h"
 
#include <stdbool.h>
#include <stdint.h>
 
#define DS18B20_SCRATCHPAD_SIZE 9U
#define DS18B20_CONVERSION_TIME_MS 750U
#define DS18B20_FAMILY_CODE 0x28U
#define DS18B20_MAX_DEVICES 8U
typedef enum {
    DS18B20_STATE_IDLE = 0,
    DS18B20_STATE_CONVERTING,
    DS18B20_STATE_DATA_READY,
    DS18B20_STATE_ERROR,
} ds18b20_state_t;
 
typedef enum {
    DS18B20_BUS_STATE_IDLE = 0,
    DS18B20_BUS_STATE_CONVERTING,
    DS18B20_BUS_STATE_READING,
    DS18B20_BUS_STATE_ERROR,
} ds18b20_bus_state_t;
 
typedef struct {
    onewire_driver_t bus;
    bool initialized;
    bool use_match_rom;
    uint8_t rom_code[ONEWIRE_ROM_CODE_SIZE];
    bool sample_valid;
    int16_t last_raw_temperature;
    uint16_t conversion_elapsed_ms;
    ds18b20_state_t state;
} ds18b20_driver_t;
 
typedef struct {
    uint8_t rom_code[ONEWIRE_ROM_CODE_SIZE];
    bool sample_valid;
    int16_t last_raw_temperature;
} ds18b20_device_t;
 
typedef struct {
    onewire_driver_t bus;
    bool initialized;
    uint8_t device_count;
    uint8_t current_index;
    uint16_t conversion_elapsed_ms;
    ds18b20_bus_state_t state;
    ds18b20_device_t devices[DS18B20_MAX_DEVICES];
} ds18b20_bus_driver_t;
 
bool ds18b20_init(ds18b20_driver_t* driver, const onewire_pin_config_t* pin_config);
 
bool ds18b20_init_with_rom(ds18b20_driver_t* driver,
                           const onewire_pin_config_t* pin_config,
                           const uint8_t rom_code[ONEWIRE_ROM_CODE_SIZE]);
 
uint8_t ds18b20_discover(const onewire_pin_config_t* pin_config,
                         uint8_t rom_codes[][ONEWIRE_ROM_CODE_SIZE],
                         uint8_t max_devices);
 
bool ds18b20_is_present(ds18b20_driver_t* driver);
 
bool ds18b20_start_conversion(ds18b20_driver_t* driver);
 
void ds18b20_process(ds18b20_driver_t* driver, uint16_t elapsed_ms);
 
bool ds18b20_is_busy(const ds18b20_driver_t* driver);
 
bool ds18b20_has_valid_sample(const ds18b20_driver_t* driver);
 
bool ds18b20_get_latest_raw(const ds18b20_driver_t* driver, int16_t* raw_temperature);
 
bool ds18b20_get_latest_temperature_celsius(const ds18b20_driver_t* driver,
                                            float* temperature_celsius);
 
bool ds18b20_read_scratchpad(ds18b20_driver_t* driver, uint8_t scratchpad[DS18B20_SCRATCHPAD_SIZE]);
 
bool ds18b20_read_temperature_celsius(ds18b20_driver_t* driver, float* temperature_celsius);
 
bool ds18b20_read_raw(ds18b20_driver_t* driver, int16_t* raw_temperature);
 
bool ds18b20_bus_init(ds18b20_bus_driver_t* driver, const onewire_pin_config_t* pin_config);
 
uint8_t ds18b20_bus_discover(ds18b20_bus_driver_t* driver);
 
bool ds18b20_bus_start_conversion(ds18b20_bus_driver_t* driver);
 
void ds18b20_bus_process(ds18b20_bus_driver_t* driver, uint16_t elapsed_ms);
 
bool ds18b20_bus_is_busy(const ds18b20_bus_driver_t* driver);
 
uint8_t ds18b20_bus_get_device_count(const ds18b20_bus_driver_t* driver);
 
bool ds18b20_bus_has_valid_sample(const ds18b20_bus_driver_t* driver, uint8_t index);
 
bool ds18b20_bus_get_latest_raw(const ds18b20_bus_driver_t* driver,
                                uint8_t index,
                                int16_t* raw_temperature);
 
bool ds18b20_bus_get_latest_temperature_celsius(const ds18b20_bus_driver_t* driver,
                                                uint8_t index,
                                                float* temperature_celsius);
 
bool ds18b20_bus_get_rom_code(const ds18b20_bus_driver_t* driver,
                              uint8_t index,
                              uint8_t rom_code[ONEWIRE_ROM_CODE_SIZE]);
 
#endif // DRIVER_DS18B20_DRIVER_H_