bh1750fvi basic driver modules More...

Collaboration diagram for bh1750fvi basic driver function:

Data Structures
struct	bh1750fvi_handle_s
	bh1750fvi handle structure definition More...
struct	bh1750fvi_info_s
	bh1750fvi information structure definition More...

Typedefs
typedef struct bh1750fvi_handle_s	bh1750fvi_handle_t
	bh1750fvi handle structure definition
typedef struct bh1750fvi_info_s	bh1750fvi_info_t
	bh1750fvi information structure definition

Enumerations
enum	bh1750fvi_address_t { BH1750FVI_ADDRESS_LOW = 0x46 , BH1750FVI_ADDRESS_HIGH = 0xB8 }
	bh1750fvi address enumeration definition More...
enum	bh1750fvi_mode_t { BH1750FVI_MODE_HIGH_RESOLUTION_MODE = 0x0 , BH1750FVI_MODE_HIGH_RESOLUTION_MODE2 = 0x1 , BH1750FVI_MODE_LOW_RESOLUTION_MODE = 0x2 }
	bh1750fvi mode enumeration definition More...

Functions
uint8_t	bh1750fvi_info (bh1750fvi_info_t *info)
	get chip's information
uint8_t	bh1750fvi_set_addr_pin (bh1750fvi_handle_t *handle, bh1750fvi_address_t addr_pin)
	set the address pin
uint8_t	bh1750fvi_get_addr_pin (bh1750fvi_handle_t handle, bh1750fvi_address_t addr_pin)
	get the address pin
uint8_t	bh1750fvi_set_mode (bh1750fvi_handle_t *handle, bh1750fvi_mode_t mode)
	set the mode
uint8_t	bh1750fvi_get_mode (bh1750fvi_handle_t handle, bh1750fvi_mode_t mode)
	get the mode
uint8_t	bh1750fvi_init (bh1750fvi_handle_t *handle)
	initialize the chip
uint8_t	bh1750fvi_deinit (bh1750fvi_handle_t *handle)
	close the chip
uint8_t	bh1750fvi_single_read (bh1750fvi_handle_t handle, uint16_t raw, float *lux)
	read data from the chip once
uint8_t	bh1750fvi_continuous_read (bh1750fvi_handle_t handle, uint16_t raw, float *lux)
	read data from the chip continuously
uint8_t	bh1750fvi_start_continuous_read (bh1750fvi_handle_t *handle)
	start chip reading
uint8_t	bh1750fvi_stop_continuous_read (bh1750fvi_handle_t *handle)
	stop chip reading
uint8_t	bh1750fvi_power_down (bh1750fvi_handle_t *handle)
	power down
uint8_t	bh1750fvi_power_on (bh1750fvi_handle_t *handle)
	power on
uint8_t	bh1750fvi_reset (bh1750fvi_handle_t *handle)
	reset
uint8_t	bh1750fvi_set_measurement_time (bh1750fvi_handle_t *handle, uint8_t t)
	set the measurement time

Detailed Description

bh1750fvi basic driver modules

Typedef Documentation

◆ bh1750fvi_handle_t

typedef struct bh1750fvi_handle_s bh1750fvi_handle_t

bh1750fvi handle structure definition

◆ bh1750fvi_info_t

typedef struct bh1750fvi_info_s bh1750fvi_info_t

bh1750fvi information structure definition

Enumeration Type Documentation

◆ bh1750fvi_address_t

enum bh1750fvi_address_t

bh1750fvi address enumeration definition

Enumerator
BH1750FVI_ADDRESS_LOW	addr low
BH1750FVI_ADDRESS_HIGH	addr high

Definition at line 62 of file driver_bh1750fvi.h.

◆ bh1750fvi_mode_t

enum bh1750fvi_mode_t

bh1750fvi mode enumeration definition

Enumerator
BH1750FVI_MODE_HIGH_RESOLUTION_MODE	1lx resolution
BH1750FVI_MODE_HIGH_RESOLUTION_MODE2	0.5lx resolution
BH1750FVI_MODE_LOW_RESOLUTION_MODE	4lx resolution

Definition at line 71 of file driver_bh1750fvi.h.

Function Documentation

◆ bh1750fvi_continuous_read()

uint8_t bh1750fvi_continuous_read	(	bh1750fvi_handle_t *	handle,
		uint16_t *	raw,
		float *	lux )

read data from the chip continuously

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[out]	*raw	pointer to a raw lux buffer
[out]	*lux	pointer to a converted lux buffer

Returns

status code

0 success
1 continuous read failed
2 handle is NULL
3 handle is not initialized

Note: this function can be used only after run bh1750fvi_start_continuous_read and can be stopped by bh1750fvi_stop_continuous_read

Definition at line 620 of file driver_bh1750fvi.c.

◆ bh1750fvi_deinit()

uint8_t bh1750fvi_deinit ( bh1750fvi_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 iic deinit failed
2 handle is NULL
3 handle is not initialized
4 power down failed

Note: none

Definition at line 322 of file driver_bh1750fvi.c.

◆ bh1750fvi_get_addr_pin()

uint8_t bh1750fvi_get_addr_pin	(	bh1750fvi_handle_t *	handle,
		bh1750fvi_address_t *	addr_pin )

get the address pin

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[out]	*addr_pin	pointer to a chip address pins buffer

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 140 of file driver_bh1750fvi.c.

◆ bh1750fvi_get_mode()

uint8_t bh1750fvi_get_mode	(	bh1750fvi_handle_t *	handle,
		bh1750fvi_mode_t *	mode )

get the mode

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[out]	*mode	pointer to a mode buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 188 of file driver_bh1750fvi.c.

◆ bh1750fvi_info()

uint8_t bh1750fvi_info ( bh1750fvi_info_t * info )

get chip's information

Parameters

[out] *info pointer to a bh1750fvi info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 828 of file driver_bh1750fvi.c.

◆ bh1750fvi_init()

uint8_t bh1750fvi_init ( bh1750fvi_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 iic failed
2 handle is NULL
3 linked functions is NULL
4 power on failed
5 reset failed

Note: none

Definition at line 216 of file driver_bh1750fvi.c.

◆ bh1750fvi_power_down()

uint8_t bh1750fvi_power_down ( bh1750fvi_handle_t * handle )

power down

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 366 of file driver_bh1750fvi.c.

◆ bh1750fvi_power_on()

uint8_t bh1750fvi_power_on ( bh1750fvi_handle_t * handle )

power on

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 power on failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 402 of file driver_bh1750fvi.c.

◆ bh1750fvi_reset()

uint8_t bh1750fvi_reset ( bh1750fvi_handle_t * handle )

reset

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 438 of file driver_bh1750fvi.c.

◆ bh1750fvi_set_addr_pin()

uint8_t bh1750fvi_set_addr_pin	(	bh1750fvi_handle_t *	handle,
		bh1750fvi_address_t	addr_pin )

set the address pin

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[in]	addr_pin	chip address pins

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 119 of file driver_bh1750fvi.c.

◆ bh1750fvi_set_measurement_time()

uint8_t bh1750fvi_set_measurement_time	(	bh1750fvi_handle_t *	handle,
		uint8_t	t )

set the measurement time

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[in]	t	measurement time

Returns

status code

0 success
1 set measurement time failed
2 handle is NULL
3 handle is not initialized
4 t < 31 or t > 254

Note: 31 <= t <= 254

Definition at line 476 of file driver_bh1750fvi.c.

◆ bh1750fvi_set_mode()

uint8_t bh1750fvi_set_mode	(	bh1750fvi_handle_t *	handle,
		bh1750fvi_mode_t	mode )

set the mode

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[in]	mode	chip mode

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 162 of file driver_bh1750fvi.c.

◆ bh1750fvi_single_read()

uint8_t bh1750fvi_single_read	(	bh1750fvi_handle_t *	handle,
		uint16_t *	raw,
		float *	lux )

read data from the chip once

Parameters

[in]	*handle	pointer to a bh1750fvi handle structure
[out]	*raw	pointer to a raw lux buffer
[out]	*lux	pointer to a converted lux buffer

Returns

status code

0 success
1 single read failed
2 handle is NULL
3 handle is not initialized
4 mode is invalid

Note: none

Definition at line 530 of file driver_bh1750fvi.c.

◆ bh1750fvi_start_continuous_read()

uint8_t bh1750fvi_start_continuous_read ( bh1750fvi_handle_t * handle )

start chip reading

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 start continuous read failed
2 handle is NULL
3 handle is not initialized
4 mode is invalid

Note: none

Definition at line 669 of file driver_bh1750fvi.c.

◆ bh1750fvi_stop_continuous_read()

uint8_t bh1750fvi_stop_continuous_read ( bh1750fvi_handle_t * handle )

stop chip reading

Parameters

[in] *handle pointer to a bh1750fvi handle structure

Returns

status code

0 success
1 stop continuous read failed
2 handle is NULL
3 handle is not initialized
4 mode is invalid

Note: none

Definition at line 724 of file driver_bh1750fvi.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ bh1750fvi_handle_t

◆ bh1750fvi_info_t

Enumeration Type Documentation

◆ bh1750fvi_address_t

◆ bh1750fvi_mode_t

Function Documentation

◆ bh1750fvi_continuous_read()

◆ bh1750fvi_deinit()

◆ bh1750fvi_get_addr_pin()

◆ bh1750fvi_get_mode()

◆ bh1750fvi_info()

◆ bh1750fvi_init()

◆ bh1750fvi_power_down()

◆ bh1750fvi_power_on()

◆ bh1750fvi_reset()

◆ bh1750fvi_set_addr_pin()

◆ bh1750fvi_set_measurement_time()

◆ bh1750fvi_set_mode()

◆ bh1750fvi_single_read()

◆ bh1750fvi_start_continuous_read()

◆ bh1750fvi_stop_continuous_read()