uvis25 base driver modules More...

Collaboration diagram for uvis25 base driver function:

Data Structures
struct	uvis25_handle_s
	uvis25 handle structure definition More...
struct	uvis25_info_s
	uvis25 information structure definition More...

Typedefs
typedef struct uvis25_handle_s	uvis25_handle_t
	uvis25 handle structure definition
typedef struct uvis25_info_s	uvis25_info_t
	uvis25 information structure definition

Enumerations
enum	uvis25_bool_t { UVIS25_BOOL_FALSE = 0x00 , UVIS25_BOOL_TRUE = 0x01 }
	uvis25 bool enumeration definition More...
enum	uvis25_spi_wire_t { UVIS25_SPI_WIRE_4 = 0x00 , UVIS25_SPI_WIRE_3 = 0x01 }
	uvis25 spi wire enumeration definition More...
enum	uvis25_interface_t { UVIS25_INTERFACE_IIC = 0x00 , UVIS25_INTERFACE_SPI = 0x01 }
	uvis25 interface enumeration definition More...
enum	uvis25_boot_mode_t { UVIS25_BOOT_NORMAL_MODE = 0x00 , UVIS25_BOOT_REBOOT_MEMORY_CONTENT = 0x01 }
	uvis25 boot enumeration definition More...

Functions
uint8_t	uvis25_info (uvis25_info_t *info)
	get chip's information
uint8_t	uvis25_init (uvis25_handle_t *handle)
	initialize the chip
uint8_t	uvis25_deinit (uvis25_handle_t *handle)
	close the chip
uint8_t	uvis25_single_read (uvis25_handle_t handle, uint8_t raw, float *uv)
	read data once
uint8_t	uvis25_start_continuous_read (uvis25_handle_t *handle)
	start reading
uint8_t	uvis25_stop_continuous_read (uvis25_handle_t *handle)
	stop reading
uint8_t	uvis25_continuous_read (uvis25_handle_t handle, uint8_t raw, float *uv)
	read data continuously
uint8_t	uvis25_set_interface (uvis25_handle_t *handle, uvis25_interface_t interface)
	set the chip interface
uint8_t	uvis25_get_interface (uvis25_handle_t handle, uvis25_interface_t interface)
	get the chip interface
uint8_t	uvis25_irq_handler (uvis25_handle_t *handle)
	irq handler
uint8_t	uvis25_set_block_data_update (uvis25_handle_t *handle, uvis25_bool_t enable)
	enable or disable blocking data update
uint8_t	uvis25_get_block_data_update (uvis25_handle_t handle, uvis25_bool_t enable)
	get blocking data update status
uint8_t	uvis25_set_boot (uvis25_handle_t *handle, uvis25_boot_mode_t mode)
	set the boot mode
uint8_t	uvis25_get_boot (uvis25_handle_t handle, uvis25_boot_mode_t mode)
	get the boot mode
uint8_t	uvis25_set_iic (uvis25_handle_t *handle, uvis25_bool_t enable)
	enable or disable the chip iic
uint8_t	uvis25_get_iic (uvis25_handle_t handle, uvis25_bool_t enable)
	get the chip iic status
uint8_t	uvis25_set_spi_wire (uvis25_handle_t *handle, uvis25_spi_wire_t wire)
	set the spi wire
uint8_t	uvis25_get_spi_wire (uvis25_handle_t handle, uvis25_spi_wire_t wire)
	get the spi wire

Detailed Description

uvis25 base driver modules

Typedef Documentation

◆ uvis25_handle_t

typedef struct uvis25_handle_s uvis25_handle_t

uvis25 handle structure definition

◆ uvis25_info_t

typedef struct uvis25_info_s uvis25_info_t

uvis25 information structure definition

Enumeration Type Documentation

◆ uvis25_bool_t

enum uvis25_bool_t

uvis25 bool enumeration definition

Enumerator
UVIS25_BOOL_FALSE	disable function
UVIS25_BOOL_TRUE	enable function

Definition at line 63 of file driver_uvis25.h.

◆ uvis25_boot_mode_t

enum uvis25_boot_mode_t

uvis25 boot enumeration definition

Enumerator
UVIS25_BOOT_NORMAL_MODE	normal mode
UVIS25_BOOT_REBOOT_MEMORY_CONTENT	reboot memory content

Definition at line 90 of file driver_uvis25.h.

◆ uvis25_interface_t

enum uvis25_interface_t

uvis25 interface enumeration definition

Enumerator
UVIS25_INTERFACE_IIC	iic interface
UVIS25_INTERFACE_SPI	spi interface

Definition at line 81 of file driver_uvis25.h.

◆ uvis25_spi_wire_t

enum uvis25_spi_wire_t

uvis25 spi wire enumeration definition

Enumerator
UVIS25_SPI_WIRE_4	4 wire
UVIS25_SPI_WIRE_3	3 wire

Definition at line 72 of file driver_uvis25.h.

Function Documentation

◆ uvis25_continuous_read()

uint8_t uvis25_continuous_read	(	uvis25_handle_t *	handle,
		uint8_t *	raw,
		float *	uv )

read data continuously

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*raw	pointer to a raw data buffer
[out]	*uv	pointer to a uv index buffer

Returns

status code

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

Note: none

Definition at line 1603 of file driver_uvis25.c.

◆ uvis25_deinit()

uint8_t uvis25_deinit ( uvis25_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to a uvis25 handle structure

Returns

status code

0 success
1 iic or spi deinit failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1321 of file driver_uvis25.c.

◆ uvis25_get_block_data_update()

uint8_t uvis25_get_block_data_update	(	uvis25_handle_t *	handle,
		uvis25_bool_t *	enable )

get blocking data update status

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get block data update failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 246 of file driver_uvis25.c.

◆ uvis25_get_boot()

uint8_t uvis25_get_boot	(	uvis25_handle_t *	handle,
		uvis25_boot_mode_t *	mode )

get the boot mode

Parameters

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

Returns

status code

0 success
1 get boot failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 321 of file driver_uvis25.c.

◆ uvis25_get_iic()

uint8_t uvis25_get_iic	(	uvis25_handle_t *	handle,
		uvis25_bool_t *	enable )

get the chip iic status

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get iic failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 396 of file driver_uvis25.c.

◆ uvis25_get_interface()

uint8_t uvis25_get_interface	(	uvis25_handle_t *	handle,
		uvis25_interface_t *	interface )

get the chip interface

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*interface	pointer to a chip interface

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 185 of file driver_uvis25.c.

◆ uvis25_get_spi_wire()

uint8_t uvis25_get_spi_wire	(	uvis25_handle_t *	handle,
		uvis25_spi_wire_t *	wire )

get the spi wire

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*wire	pointer to a spi wire buffer

Returns

status code

0 success
1 get spi wire failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 471 of file driver_uvis25.c.

◆ uvis25_info()

uint8_t uvis25_info ( uvis25_info_t * info )

get chip's information

Parameters

[out] *info pointer to a uvis25 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 1707 of file driver_uvis25.c.

◆ uvis25_init()

uint8_t uvis25_init ( uvis25_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a uvis25 handle structure

Returns

status code

0 success
1 iic or spi initialization failed
2 handle is NULL
3 linked functions is NULL

Note: none

Definition at line 1193 of file driver_uvis25.c.

◆ uvis25_irq_handler()

uint8_t uvis25_irq_handler ( uvis25_handle_t * handle )

irq handler

Parameters

[in] *handle pointer to a uvis25 handle structure

Returns

status code

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

Note: none

Definition at line 1082 of file driver_uvis25.c.

◆ uvis25_set_block_data_update()

uint8_t uvis25_set_block_data_update	(	uvis25_handle_t *	handle,
		uvis25_bool_t	enable )

enable or disable blocking data update

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set block data update failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 208 of file driver_uvis25.c.

◆ uvis25_set_boot()

uint8_t uvis25_set_boot	(	uvis25_handle_t *	handle,
		uvis25_boot_mode_t	mode )

set the boot mode

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[in]	mode	boot mode

Returns

status code

0 success
1 set boot failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 283 of file driver_uvis25.c.

◆ uvis25_set_iic()

uint8_t uvis25_set_iic	(	uvis25_handle_t *	handle,
		uvis25_bool_t	enable )

enable or disable the chip iic

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set iic failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 358 of file driver_uvis25.c.

◆ uvis25_set_interface()

uint8_t uvis25_set_interface	(	uvis25_handle_t *	handle,
		uvis25_interface_t	interface )

set the chip interface

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[in]	interface	chip interface

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 164 of file driver_uvis25.c.

◆ uvis25_set_spi_wire()

uint8_t uvis25_set_spi_wire	(	uvis25_handle_t *	handle,
		uvis25_spi_wire_t	wire )

set the spi wire

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[in]	wire	spi wire

Returns

status code

0 success
1 set spi wire failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 433 of file driver_uvis25.c.

◆ uvis25_single_read()

uint8_t uvis25_single_read	(	uvis25_handle_t *	handle,
		uint8_t *	raw,
		float *	uv )

read data once

Parameters

[in]	*handle	pointer to a uvis25 handle structure
[out]	*raw	pointer to a raw data buffer
[out]	*uv	pointer to a uv index buffer

Returns

status code

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

Note: none

Definition at line 1388 of file driver_uvis25.c.

◆ uvis25_start_continuous_read()

uint8_t uvis25_start_continuous_read ( uvis25_handle_t * handle )

start reading

Parameters

[in] *handle pointer to a uvis25 handle structure

Returns

status code

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

Note: none

Definition at line 1484 of file driver_uvis25.c.

◆ uvis25_stop_continuous_read()

uint8_t uvis25_stop_continuous_read ( uvis25_handle_t * handle )

stop reading

Parameters

[in] *handle pointer to a uvis25 handle structure

Returns

status code

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

Note: none

Definition at line 1543 of file driver_uvis25.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ uvis25_handle_t

◆ uvis25_info_t

Enumeration Type Documentation

◆ uvis25_bool_t

◆ uvis25_boot_mode_t

◆ uvis25_interface_t

◆ uvis25_spi_wire_t

Function Documentation

◆ uvis25_continuous_read()

◆ uvis25_deinit()

◆ uvis25_get_block_data_update()

◆ uvis25_get_boot()

◆ uvis25_get_iic()

◆ uvis25_get_interface()

◆ uvis25_get_spi_wire()

◆ uvis25_info()

◆ uvis25_init()

◆ uvis25_irq_handler()

◆ uvis25_set_block_data_update()

◆ uvis25_set_boot()

◆ uvis25_set_iic()

◆ uvis25_set_interface()

◆ uvis25_set_spi_wire()

◆ uvis25_single_read()

◆ uvis25_start_continuous_read()

◆ uvis25_stop_continuous_read()