/*
 * File:        ltr329.h
 * Description: Library for the Lite-On Optical Sensor LTR-329ALS-01
 * Author:      David Zaitlik
 * Date:        2022-05-22
 *
 *
 * Copyright (c) 2024 Veles Labs s.r.o.
 *
 * 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.
 *
 */

#ifndef INC_LTR329_H_
#define INC_LTR329_H_

#include "stdint.h"
#include "stm32l0xx_ll_i2c.h"
#include "stm32l0xx_ll_utils.h"
#include "i2c.h"

#define LTR329_I2C_ADDRESS 0x29

/*
 * Return values
 */

#define LTR329_OK 0
#define LTR329_ERROR -1 // generic error

/* LTR-329ALS-01 Registers */
/* Datasheet: https://optoelectronics.liteon.com/upload/download/DS86-2014-0006/LTR-329ALS-01_DS_V1.pdf */
typedef enum
{
	LTR329_ALS_CONTR 			= 0x80,	/* RW */
	LTR329_ALS_MEAS_RATE 		= 0x85, /* RW */
	LTR329_PART_ID 				= 0x86, /* R */
	LTR329_MANUFAC_ID 			= 0x87, /* R */
	LTR329_ALS_DATA_CH1_0 		= 0x88, /* R */
	LTR329_ALS_DATA_CH1_1 		= 0x89, /* R */
	LTR329_ALS_DATA_CH0_0 		= 0x8A, /* R */
	LTR329_ALS_DATA_CH0_1 		= 0x8B, /* R */
	LTR329_ALS_STATUS 			= 0x8C /* R */
} ltr329_cmd_t;

/* Bit masks for ALS Mode */
typedef enum
{
	LTR329_MODE_STAND_BY		= 0b00000000, /* DEFAULT */
	LTR329_MODE_ACTIVE			= 0b00000001
} ltr329_als_mode_t;

/* Bit masks for Gain settings */
typedef enum
{
	LTR329_GAIN_1X 				= 0b00000000, /* DEFAULT */
	LTR329_GAIN_2X				= 0b00000100,
	LTR329_GAIN_4X				= 0b00001000,
	LTR329_GAIN_8X				= 0b00001100,
	LTR329_GAIN_48X				= 0b00011000,
	LTR329_GAIN_96X				= 0b00011100,
	LTR329_GAIN_RESERVED1		= 0b00010000,
	LTR329_GAIN_RESERVED2		= 0b00010100
} ltr329_gain_t;

/* Bit masks for Integration Time settings */
typedef enum
{
	LTR329_INTEGRATION_50MS		= 0b00001000,
	LTR329_INTEGRATION_100MS 	= 0b00000000, /* DEFAULT */
	LTR329_INTEGRATION_150MS	= 0b00100000,
	LTR329_INTEGRATION_200MS	= 0b00010000,
	LTR329_INTEGRATION_250MS	= 0b00101000,
	LTR329_INTEGRATION_300MS	= 0b00110000,
	LTR329_INTEGRATION_350MS	= 0b00111000,
	LTR329_INTEGRATION_400MS	= 0b00011000
} ltr329_integration_time_t;

/* Bit masks for Measurement Rate settings */
typedef enum
{
	LTR329_MEAS_RATE_50MS		= 0b00000000,
	LTR329_MEAS_RATE_100MS		= 0b00000001,
	LTR329_MEAS_RATE_200MS		= 0b00000010,
	LTR329_MEAS_RATE_500MS		= 0b00000011, /* DEFAULT */
	LTR329_MEAS_RATE_1000MS		= 0b00000100,
	LTR329_MEAS_RATE_2000MS		= 0b00000111
} ltr329_measurement_rate_t;

/*int8_t ltr329_read_register (ltr329_cmd_t register_addr, uint8_t *register_data );
int8_t ltr329_write_register (ltr329_cmd_t register_addr, uint8_t register_data);*/
int8_t ltr329_write_settings (ltr329_gain_t gain, ltr329_als_mode_t mode, ltr329_integration_time_t integ_time, ltr329_measurement_rate_t meas_rate);
int8_t ltr329_read_settings (ltr329_gain_t *gain, ltr329_als_mode_t *mode, ltr329_integration_time_t *integ_time, ltr329_measurement_rate_t *meas_rate);
int8_t ltr329_sw_reset( void );
int8_t ltr329_measure (uint16_t *data_ch0, uint16_t *data_ch1);
int8_t ltr329_read_status_register(uint8_t *data_valid, uint8_t *new_data, ltr329_gain_t *gain);
int8_t ltr329_read_device_info (uint8_t *manufacturer_id, uint8_t *part_id);

#endif /* INC_LTR329_H_ */