ds18b20.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016-2017 Intel Corporation.
 *
 * 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.
 */
#pragma once

#include <stdlib.h>
#include <unistd.h>
#include <string.h>

#include <mraa/uart_ow.h>
#include <upm.h>
#include "ds18b20_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    // forward declaration
    typedef struct _ds18b20_info_t ds18b20_info_t;

    typedef struct _ds18b20_context {
        mraa_uart_ow_context ow;

        // number of devices found
        int numDevices;

        // list of allocated ds18b20_info_t instances
        ds18b20_info_t *devices;
    } *ds18b20_context;

    ds18b20_context ds18b20_init(unsigned int uart);

    void ds18b20_close(ds18b20_context dev);

    void ds18b20_update(const ds18b20_context dev, int index);

    float ds18b20_get_temperature(const ds18b20_context dev,
                                  unsigned int index);

    void ds18b20_set_resolution(const ds18b20_context dev, unsigned int index,
                                DS18B20_RESOLUTIONS_T res);

    void ds18b20_copy_scratchpad(const ds18b20_context dev, unsigned int index);

    void ds18b20_recall_eeprom(const ds18b20_context dev, unsigned int index);

    unsigned int ds18b20_devices_found(const ds18b20_context dev);

    const uint8_t *ds18b20_get_id(const ds18b20_context dev,
                                  unsigned int index);

#ifdef __cplusplus
}
#endif