max30100.h

Go to the documentation of this file.

/*
 * Author: Noel Eck <noel.eck@intel.com>
 * Copyright (c) 2015 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 <errno.h>
#include <stdint.h>

#include "max30100_regs.h"

#include "mraa/gpio.h"
#include "mraa/i2c.h"
#include "upm.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    /* mraa I2C context */
    mraa_i2c_context _i2c_context;

    /* mraa gpio context (for interrupt) */
    mraa_gpio_context _gpio_context;

    /* Sensor acquire mode */
    MAX30100_SAMPLE_STATE sample_state;

    /* Continuous sampling function ptr */
    func_sample_ready_handler func_sample_ready;

    /* Optional void ptr arg returned from callback */
    void* arg;
} max30100_context;

max30100_context* max30100_init(int16_t i2c_bus);

void max30100_close(max30100_context* dev);

upm_result_t max30100_sample(max30100_context* dev, max30100_value *samp);

upm_result_t max30100_sample_continuous(max30100_context* dev,
                                        int gpio_pin,
                                        bool buffered,
                                        func_sample_ready_handler isr,
                                        void* arg);

upm_result_t max30100_sample_stop(max30100_context* dev);

upm_result_t max30100_read(const max30100_context* dev, MAX30100_REG reg, uint8_t* rd_data);

upm_result_t max30100_write(const max30100_context* dev, MAX30100_REG reg, uint8_t wr_data);

upm_result_t max30100_rd_mod_wr(const max30100_context* dev,
        MAX30100_REG reg, uint8_t value, uint8_t mask);

upm_result_t max30100_get_version(const max30100_context* dev, uint16_t* version);

upm_result_t max30100_get_temperature(const max30100_context* dev, float* temperature);

upm_result_t max30100_set_mode(const max30100_context* dev, MAX30100_MODE mode);

upm_result_t max30100_get_mode(const max30100_context* dev, MAX30100_MODE* mode);

upm_result_t max30100_set_high_res(const max30100_context* dev, bool high_res);

upm_result_t max30100_get_high_res(const max30100_context* dev, bool* high_res);

upm_result_t max30100_set_sample_rate(const max30100_context* dev, MAX30100_SR sample_rate);

upm_result_t max30100_get_sample_rate(const max30100_context* dev, MAX30100_SR* sample_rate);

upm_result_t max30100_set_pulse_width(const max30100_context* dev, MAX30100_LED_PW pulse_width);

upm_result_t max30100_get_pulse_width(const max30100_context* dev, MAX30100_LED_PW* pulse_width);

upm_result_t max30100_set_current(const max30100_context* dev,
        MAX30100_LED_CURRENT ir,
        MAX30100_LED_CURRENT r);

upm_result_t max30100_get_current(const max30100_context* dev,
        MAX30100_LED_CURRENT* ir,
        MAX30100_LED_CURRENT* r);

upm_result_t max30100_reset(const max30100_context* dev);

upm_result_t max30100_sleep(const max30100_context* dev, bool sleep);

#ifdef __cplusplus
}
#endif