LibDriver TSL2561
Loading...
Searching...
No Matches
driver_tsl2561.h File Reference

driver tsl2561 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_tsl2561.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  tsl2561_handle_s
 tsl2561 handle structure definition More...
struct  tsl2561_info_s
 tsl2561 information structure definition More...

Macros

#define DRIVER_TSL2561_LINK_INIT(HANDLE, STRUCTURE)
 initialize tsl2561_handle_t structure
#define DRIVER_TSL2561_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_TSL2561_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_TSL2561_LINK_IIC_READ(HANDLE, FUC)
 link iic_read function
#define DRIVER_TSL2561_LINK_IIC_WRITE(HANDLE, FUC)
 link iic_write function
#define DRIVER_TSL2561_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_TSL2561_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct tsl2561_handle_s tsl2561_handle_t
 tsl2561 handle structure definition
typedef struct tsl2561_info_s tsl2561_info_t
 tsl2561 information structure definition

Enumerations

enum  tsl2561_address_t { TSL2561_ADDRESS_GND = 0x52 , TSL2561_ADDRESS_FLOAT = 0x72 , TSL2561_ADDRESS_VCC = 0x92 }
 tsl2561 address enumeration definition More...
enum  tsl2561_bool_t { TSL2561_BOOL_FALSE = 0x00 , TSL2561_BOOL_TRUE = 0x01 }
 tsl2561 bool enumeration definition More...
enum  tsl2561_gain_t { TSL2561_GAIN_1 = 0x00 , TSL2561_GAIN_16 = 0x01 }
 tsl2561 gain enumeration definition More...
enum  tsl2561_integration_time_t { TSL2561_INTEGRATION_TIME_13MS = 0x00 , TSL2561_INTEGRATION_TIME_101MS = 0x01 , TSL2561_INTEGRATION_TIME_402MS = 0x02 }
 tsl2561 integration time enumeration definition More...
enum  tsl2561_interrupt_mode_t {
  TSL2561_INTERRUPT_MODE_EVERY_ADC_CYCLE = 0x00 , TSL2561_INTERRUPT_MODE_ANY_VALUE_OUT_OF_THRESHOLD_RANGE = 0x01 , TSL2561_INTERRUPT_MODE_2_INTEGRATION_TIME_OUT_OF_RANGE = 0x02 , TSL2561_INTERRUPT_MODE_3_INTEGRATION_TIME_OUT_OF_RANGE = 0x03 ,
  TSL2561_INTERRUPT_MODE_4_INTEGRATION_TIME_OUT_OF_RANGE = 0x04 , TSL2561_INTERRUPT_MODE_5_INTEGRATION_TIME_OUT_OF_RANGE = 0x05 , TSL2561_INTERRUPT_MODE_6_INTEGRATION_TIME_OUT_OF_RANGE = 0x06 , TSL2561_INTERRUPT_MODE_7_INTEGRATION_TIME_OUT_OF_RANGE = 0x07 ,
  TSL2561_INTERRUPT_MODE_8_INTEGRATION_TIME_OUT_OF_RANGE = 0x08 , TSL2561_INTERRUPT_MODE_9_INTEGRATION_TIME_OUT_OF_RANGE = 0x09 , TSL2561_INTERRUPT_MODE_10_INTEGRATION_TIME_OUT_OF_RANGE = 0x0A , TSL2561_INTERRUPT_MODE_11_INTEGRATION_TIME_OUT_OF_RANGE = 0x0B ,
  TSL2561_INTERRUPT_MODE_12_INTEGRATION_TIME_OUT_OF_RANGE = 0x0C , TSL2561_INTERRUPT_MODE_13_INTEGRATION_TIME_OUT_OF_RANGE = 0x0D , TSL2561_INTERRUPT_MODE_14_INTEGRATION_TIME_OUT_OF_RANGE = 0x0E , TSL2561_INTERRUPT_MODE_15_INTEGRATION_TIME_OUT_OF_RANGE = 0x0F
}
 tsl2561 interrupt mode enumeration definition More...

Functions

uint8_t tsl2561_info (tsl2561_info_t *info)
 get chip's information
uint8_t tsl2561_set_addr_pin (tsl2561_handle_t *handle, tsl2561_address_t addr_pin)
 set the iic address pin
uint8_t tsl2561_get_addr_pin (tsl2561_handle_t *handle, tsl2561_address_t *addr_pin)
 get the iic address pin
uint8_t tsl2561_init (tsl2561_handle_t *handle)
 initialize the chip
uint8_t tsl2561_deinit (tsl2561_handle_t *handle)
 close the chip
uint8_t tsl2561_read (tsl2561_handle_t *handle, uint16_t *channel_0_raw, uint16_t *channel_1_raw, uint32_t *lux)
 read data from the chip
uint8_t tsl2561_power_down (tsl2561_handle_t *handle)
 power down the chip
uint8_t tsl2561_wake_up (tsl2561_handle_t *handle)
 wake up the chip
uint8_t tsl2561_set_gain (tsl2561_handle_t *handle, tsl2561_gain_t gain)
 set the adc gain
uint8_t tsl2561_get_gain (tsl2561_handle_t *handle, tsl2561_gain_t *gain)
 get the adc gain
uint8_t tsl2561_set_integration_time (tsl2561_handle_t *handle, tsl2561_integration_time_t t)
 set the integration time
uint8_t tsl2561_get_integration_time (tsl2561_handle_t *handle, tsl2561_integration_time_t *t)
 get the integration time
uint8_t tsl2561_set_interrupt_mode (tsl2561_handle_t *handle, tsl2561_interrupt_mode_t mode)
 set the interrupt mode
uint8_t tsl2561_get_interrupt_mode (tsl2561_handle_t *handle, tsl2561_interrupt_mode_t *mode)
 get the interrupt mode
uint8_t tsl2561_set_interrupt (tsl2561_handle_t *handle, tsl2561_bool_t enable)
 enable or disable the chip interrupt
uint8_t tsl2561_get_interrupt (tsl2561_handle_t *handle, tsl2561_bool_t *enable)
 get the chip interrupt
uint8_t tsl2561_set_interrupt_high_threshold (tsl2561_handle_t *handle, uint16_t ch0_raw)
 set the interrupt high threshold
uint8_t tsl2561_get_interrupt_high_threshold (tsl2561_handle_t *handle, uint16_t *ch0_raw)
 get the interrupt high threshold
uint8_t tsl2561_set_interrupt_low_threshold (tsl2561_handle_t *handle, uint16_t ch0_raw)
 set the interrupt low threshold
uint8_t tsl2561_get_interrupt_low_threshold (tsl2561_handle_t *handle, uint16_t *ch0_raw)
 get the interrupt low threshold
uint8_t tsl2561_set_reg (tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 set the chip register
uint8_t tsl2561_get_reg (tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 get the chip register

Detailed Description

driver tsl2561 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

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.

Version
2.0.0
Author
Shifeng Li
Date
2021-02-26

history

Date Version Author Description
2021/02/26 2.0 Shifeng Li format the code
2020/10/28 1.0 Shifeng Li first upload

Definition in file driver_tsl2561.h.