bh1792.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 <pthread.h>
#include "bh1792glc_registers.h"

#define ONE_SEC_IN_MIRCO_SEC 1000000
#define FIFO_WATERMARK 32
#define LED_CURRENT_MAX 63

typedef enum {
    MSR_64Hz = BH1792_MEAS_CONTROL1_MSR_64HZ,
    MSR_32Hz = BH1792_MEAS_CONTROL1_MSR_32HZ,
    MSR_128Hz = BH1792_MEAS_CONTROL1_MSR_128HZ,
    MSR_256Hz = BH1792_MEAS_CONTROL1_MSR_256HZ,
    MSR_1024Hz = BH1792_MEAS_CONTROL1_MSR_1024HZ,
    MSR_NON_SYNC = BH1792_MEAS_CONTROL1_MSR_NON_SYNCH_MODE,
    MSR_SINGLE = BH1792_MEAS_CONTROL1_MSR_SINGLE_MEAS_MODE
} MEAS_MODES;

typedef enum {
    GREEN,
    IR
} LED_TYPES;

typedef enum {
    WATER_MARK = BH1792_MEAS_CONTROL5_INT_SEL_FIFO_WATERMARK,
    IR_THRESHOLD_JUDGE = BH1792_MEAS_CONTROL5_INT_SEL_IR_THRESHOLD,
    ON_COMPLETE = BH1792_MEAS_CONTROL5_INT_SEL_ON_COMPLETE
} INTERRUPT_MODES;

typedef enum {
    SYNCHRONIZED,
    NON_SYNCHRONIZED,
    SINGLE_GREEN,
    SINGLE_IR
} OP_MODES;

typedef struct _bh1792_context
{
    mraa_i2c_context i2c;
    mraa_gpio_context interrupt;
    bool enabled;
    bool isrEnabled;
    OP_MODES op_mode;
    pthread_t sync_thread;
    bool sync_thread_alive;
    LED_TYPES led_type;
    INTERRUPT_MODES interrupt_mode;
    uint16_t meas_freq;
    uint8_t green_current;
    uint8_t ir_current;
    uint16_t threshold;
} *bh1792_context;

bh1792_context bh1792_init(int bus, int addr);

void bh1792_close(bh1792_context dev);

upm_result_t bh1792_check_who_am_i(bh1792_context dev);

bool bh1792_is_enabled(bh1792_context dev);

upm_result_t bh1792_soft_reset(bh1792_context dev);

upm_result_t bh1792_get_meas_time_ms(bh1792_context dev, float *meas_time);

upm_result_t bh1792_set_green_leds_current(bh1792_context dev, uint8_t current);

upm_result_t bh1792_get_green_leds_current(bh1792_context dev, uint8_t *current);

upm_result_t bh1792_set_ir_led_current(bh1792_context dev, uint8_t current);

upm_result_t bh1792_get_ir_led_current(bh1792_context dev, uint8_t *current);

upm_result_t bh1792_set_ir_threshold(bh1792_context dev, uint16_t threshold);

upm_result_t bh1792_get_ir_threshold(bh1792_context dev, uint16_t *threshold);

upm_result_t bh1792_get_fifo_size(bh1792_context dev, uint8_t *count);

upm_result_t bh1792_disable_interrupt(bh1792_context dev);

upm_result_t bh1792_clear_interrupt(bh1792_context dev);

upm_result_t bh1792_start_measurement(bh1792_context dev);

upm_result_t bh1792_stop_measurement(bh1792_context dev);

upm_result_t bh1792_restart_measurement(bh1792_context dev);

upm_result_t bh1792_get_fifo_data(bh1792_context dev, uint16_t fifo_led_off[],
                                    uint16_t fifo_led_on[]);

upm_result_t bh1792_discard_fifo_data(bh1792_context dev);

upm_result_t bh1792_get_green_data(bh1792_context dev, uint16_t *green_led_off,
                                    uint16_t *green_led_on);

upm_result_t bh1792_get_ir_data(bh1792_context dev, uint16_t *ir_led_off,
                                uint16_t *ir_led_on);

upm_result_t bh1792_enable_sync_mode(bh1792_context dev, uint16_t meas_freq,
                                    uint8_t green_current);

upm_result_t bh1792_enable_non_sync_mode(bh1792_context dev, uint8_t ir_current,
                                        uint16_t threshold);

upm_result_t bh1792_enable_single_mode(bh1792_context dev, LED_TYPES led_type,
                                        uint8_t current);

upm_result_t bh1792_install_isr(bh1792_context dev, mraa_gpio_edge_t edge,
                                int pin, void (*isr)(void *), void *isr_args);

upm_result_t bh1792_install_isr_falling_edge(bh1792_context dev, int pin,
                                void (*isr)(void *), void *isr_args);

void bh1792_remove_isr(bh1792_context dev);

upm_result_t bh1792_registers_dump(bh1792_context dev, char *dump);

#ifdef __cplusplus
}
#endif