bh1749.h

Go to the documentation of this file.

/*
* The MIT License (MIT)
*
* Author: Assam Boudjelthia
* Copyright (c) 2018 Rohm Semiconductor.
*
* 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

#ifdef __cplusplus
extern "C"
{
#endif

#include <mraa/i2c.h>
#include <mraa/gpio.h>
#include <unistd.h>
#include <upm_types.h>
#include "bh1749_registers.h"

typedef enum {
    INT_JUDGE_0 = BH1749_PERSISTENCE_MODE_STATUS_ACTIVE_AFTER_MEASUREMENT,
    INT_JUDGE_1 = BH1749_PERSISTENCE_MODE_STATUS_UPDATE_AFTER_MEASUREMENT,
    INT_JUDGE_4 = BH1749_PERSISTENCE_MODE_STATUS_UPDATE_AFTER_4_SAME,
    INT_JUDGE_8 = BH1749_PERSISTENCE_MODE_STATUS_UPDATE_AFTER_8_SAME,
} OPERATING_MODES;

typedef enum {
    MEAS_35MS = BH1749_MODE_CONTROL1_ODR_28P6,
    MEAS_120MS = BH1749_MODE_CONTROL1_ODR_8P333,
    MEAS_240MS = BH1749_MODE_CONTROL1_ODR_4P167
} MEAS_TIMES;

typedef enum {
    RGB_GAIN_1X = BH1749_MODE_CONTROL1_RGB_GAIN_1X,
    RGB_GAIN_32X = BH1749_MODE_CONTROL1_RGB_GAIN_32X
} RGB_GAINS;

typedef enum {
    IR_GAIN_1X = BH1749_MODE_CONTROL1_IR_GAIN_1X,
    IR_GAIN_32X = BH1749_MODE_CONTROL1_IR_GAIN_32X
} IR_GAINS;

typedef enum {
    RED = BH1749_INTERRUPT_SOURCE_SELECT_RED,
    GREEN = BH1749_INTERRUPT_SOURCE_SELECT_GREEN,
    BLUE = BH1749_INTERRUPT_SOURCE_SELECT_BLUE
} INT_SOURCES;

typedef struct _bh1749_context
{
    mraa_i2c_context i2c;
    mraa_gpio_context interrupt;
    bool enabled;
    bool isrEnabled;
    uint16_t int_thh;
    uint16_t int_thl;
    INT_SOURCES int_src;
    IR_GAINS ir_gain;
    RGB_GAINS rgb_gain;
    MEAS_TIMES meas_time;
    OPERATING_MODES operating_mode;
} *bh1749_context;

upm_result_t bh1749_check_who_am_i(bh1749_context dev);

bh1749_context bh1749_init(int bus, int addr);

void bh1749_close(bh1749_context dev);

upm_result_t bh1749_enable(bh1749_context dev);

upm_result_t bh1749_disable(bh1749_context dev);

upm_result_t bh1749_sensor_init(bh1749_context dev, OPERATING_MODES opMode,
                        MEAS_TIMES measTime,
                        RGB_GAINS rgbGain,
                        IR_GAINS irGain,
                        INT_SOURCES intSource);

upm_result_t bh1749_set_operating_mode(bh1749_context dev, OPERATING_MODES opMode);

upm_result_t bh1749_get_operating_mode(bh1749_context dev, uint8_t *opMode);

upm_result_t bh1749_set_measurement_time(bh1749_context dev, MEAS_TIMES measTime);

upm_result_t bh1749_get_measurement_time(bh1749_context dev, uint8_t *meas_time);

upm_result_t bh1749_set_rgb_gain(bh1749_context dev, RGB_GAINS rgbGain);

upm_result_t bh1749_get_rgb_gain(bh1749_context dev, uint8_t *gain);

upm_result_t bh1749_set_ir_gain(bh1749_context dev, IR_GAINS irGain);

upm_result_t bh1749_get_ir_gain(bh1749_context dev, uint8_t *gain);

upm_result_t bh1749_set_int_source(bh1749_context dev, INT_SOURCES intSource);

char bh1749_get_interrupt_source_char(bh1749_context dev);

upm_result_t bh1749_enable_interrupt(bh1749_context dev);

upm_result_t bh1749_disable_interrupt(bh1749_context dev);

upm_result_t bh1749_reset_interrupt(bh1749_context dev);

bool bh1749_is_interrupted(bh1749_context dev);

bool bh1749_is_interrupt_enabled(bh1749_context dev);

upm_result_t bh1749_soft_reset(bh1749_context dev);

upm_result_t bh1749_set_threshold_high(bh1749_context dev, uint16_t threshold);

upm_result_t bh1749_get_threshold_high(bh1749_context dev, uint16_t *threshold);

upm_result_t bh1749_set_threshold_low(bh1749_context dev, uint16_t threshold);

upm_result_t bh1749_get_threshold_low(bh1749_context dev, uint16_t *threshold);

upm_result_t bh1749_get_red(bh1749_context dev, uint16_t *red);

upm_result_t bh1749_get_green(bh1749_context dev, uint16_t *green);

upm_result_t bh1749_get_blue(bh1749_context dev, uint16_t *blue);

upm_result_t bh1749_get_ir(bh1749_context dev, uint16_t *ir);

upm_result_t bh1749_get_green2(bh1749_context dev, uint16_t *green2);

upm_result_t bh1749_get_measurements(bh1749_context dev, uint16_t *result);

upm_result_t bh1749_install_isr(bh1749_context dev, mraa_gpio_edge_t edge, int pin,
                        void (*isr)(void *), void *isr_args);

void bh1749_remove_isr(bh1749_context dev);

upm_result_t bh1749_registers_dump(bh1749_context dev, char *dump);

#ifdef __cplusplus
}
#endif