uvis25 example driver modules More...

Collaboration diagram for uvis25 example driver function:

Macros
#define	UVIS25_BASIC_DEFAULT_IIC UVIS25_BOOL_TRUE
	uvis25 basic example default definition
#define	UVIS25_BASIC_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4
#define	UVIS25_BASIC_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE
#define	UVIS25_BASIC_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE
#define	UVIS25_INTERRUPT_DEFAULT_IIC UVIS25_BOOL_TRUE /* enable iic */
	uvis25 interrupt example default definition
#define	UVIS25_INTERRUPT_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4 /* 4 wire spi */
#define	UVIS25_INTERRUPT_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE /* normal boot mode */
#define	UVIS25_INTERRUPT_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE /* disable block data update */
#define	UVIS25_INTERRUPT_DEFAULT_INTERRUPT_ACTIVE_LEVEL UVIS25_INTERRUPT_ACTIVE_LEVEL_LOWER /* low level */
#define	UVIS25_INTERRUPT_DEFAULT_INTERRUPT_PIN_TYPE UVIS25_INTERRUPT_PIN_TYPE_PUSH_PULL /* set push-pull */
#define	UVIS25_INTERRUPT_DEFAULT_INTERRUPT UVIS25_BOOL_TRUE /* enable interrupt */
#define	UVIS25_INTERRUPT_DEFAULT_LATCH_INTERRUPT UVIS25_BOOL_FALSE /* disable latch interrupt */
#define	UVIS25_INTERRUPT_DEFAULT_HIGH_THRESHOLD_INTERRUPT UVIS25_BOOL_TRUE /* enable high threshold interrupt */
#define	UVIS25_INTERRUPT_DEFAULT_LOW_THRESHOLD_INTERRUPT UVIS25_BOOL_TRUE /* enable low threshold interrupt */
#define	UVIS25_SHOT_DEFAULT_IIC UVIS25_BOOL_TRUE
	uvis25 shot example default definition
#define	UVIS25_SHOT_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4
#define	UVIS25_SHOT_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE
#define	UVIS25_SHOT_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE

Functions
uint8_t	uvis25_basic_init (uvis25_interface_t interface)
	basic example init
uint8_t	uvis25_basic_deinit (void)
	basic example deinit
uint8_t	uvis25_basic_read (float *uv)
	basic example read
uint8_t	uvis25_interrupt_irq_handler (void)
	interrupt example irq handler
uint8_t	uvis25_interrupt_init (uvis25_interface_t interface, uvis25_interrupt_type_t mode, float uv_threshold, void(*callback)(uint8_t type))
	interrupt example init
uint8_t	uvis25_interrupt_deinit (void)
	basic interrupt deinit
uint8_t	uvis25_interrupt_read (float *uv)
	interrupt example read
uint8_t	uvis25_shot_init (uvis25_interface_t interface)
	shot example init
uint8_t	uvis25_shot_deinit (void)
	basic shot deinit
uint8_t	uvis25_shot_read (float *uv)
	shot example read

Detailed Description

uvis25 example driver modules

Macro Definition Documentation

◆ UVIS25_BASIC_DEFAULT_BLOCK_DATA_UPDATE

#define UVIS25_BASIC_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE

disable block data update

Definition at line 60 of file driver_uvis25_basic.h.

◆ UVIS25_BASIC_DEFAULT_BOOT_MODE

#define UVIS25_BASIC_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE

normal boot mode

Definition at line 59 of file driver_uvis25_basic.h.

◆ UVIS25_BASIC_DEFAULT_IIC

#define UVIS25_BASIC_DEFAULT_IIC UVIS25_BOOL_TRUE

uvis25 basic example default definition

enable iic

Definition at line 57 of file driver_uvis25_basic.h.

◆ UVIS25_BASIC_DEFAULT_SPI_WIRE

#define UVIS25_BASIC_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4

4 wire spi

Definition at line 58 of file driver_uvis25_basic.h.

◆ UVIS25_INTERRUPT_DEFAULT_BLOCK_DATA_UPDATE

#define UVIS25_INTERRUPT_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE /* disable block data update */

Definition at line 58 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_BOOT_MODE

#define UVIS25_INTERRUPT_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE /* normal boot mode */

Definition at line 57 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_HIGH_THRESHOLD_INTERRUPT

#define UVIS25_INTERRUPT_DEFAULT_HIGH_THRESHOLD_INTERRUPT UVIS25_BOOL_TRUE /* enable high threshold interrupt */

Definition at line 63 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_IIC

#define UVIS25_INTERRUPT_DEFAULT_IIC UVIS25_BOOL_TRUE /* enable iic */

uvis25 interrupt example default definition

Definition at line 55 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT

#define UVIS25_INTERRUPT_DEFAULT_INTERRUPT UVIS25_BOOL_TRUE /* enable interrupt */

Definition at line 61 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT_ACTIVE_LEVEL

#define UVIS25_INTERRUPT_DEFAULT_INTERRUPT_ACTIVE_LEVEL UVIS25_INTERRUPT_ACTIVE_LEVEL_LOWER /* low level */

Definition at line 59 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT_PIN_TYPE

#define UVIS25_INTERRUPT_DEFAULT_INTERRUPT_PIN_TYPE UVIS25_INTERRUPT_PIN_TYPE_PUSH_PULL /* set push-pull */

Definition at line 60 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_LATCH_INTERRUPT

#define UVIS25_INTERRUPT_DEFAULT_LATCH_INTERRUPT UVIS25_BOOL_FALSE /* disable latch interrupt */

Definition at line 62 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_LOW_THRESHOLD_INTERRUPT

#define UVIS25_INTERRUPT_DEFAULT_LOW_THRESHOLD_INTERRUPT UVIS25_BOOL_TRUE /* enable low threshold interrupt */

Definition at line 64 of file driver_uvis25_interrupt.h.

◆ UVIS25_INTERRUPT_DEFAULT_SPI_WIRE

#define UVIS25_INTERRUPT_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4 /* 4 wire spi */

Definition at line 56 of file driver_uvis25_interrupt.h.

◆ UVIS25_SHOT_DEFAULT_BLOCK_DATA_UPDATE

#define UVIS25_SHOT_DEFAULT_BLOCK_DATA_UPDATE UVIS25_BOOL_FALSE

disable block data update

Definition at line 58 of file driver_uvis25_shot.h.

◆ UVIS25_SHOT_DEFAULT_BOOT_MODE

#define UVIS25_SHOT_DEFAULT_BOOT_MODE UVIS25_BOOT_NORMAL_MODE

normal boot mode

Definition at line 57 of file driver_uvis25_shot.h.

◆ UVIS25_SHOT_DEFAULT_IIC

#define UVIS25_SHOT_DEFAULT_IIC UVIS25_BOOL_TRUE

uvis25 shot example default definition

enable iic

Definition at line 55 of file driver_uvis25_shot.h.

◆ UVIS25_SHOT_DEFAULT_SPI_WIRE

#define UVIS25_SHOT_DEFAULT_SPI_WIRE UVIS25_SPI_WIRE_4

4 wire spi

Definition at line 56 of file driver_uvis25_shot.h.

Function Documentation

◆ uvis25_basic_deinit()

uint8_t uvis25_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 179 of file driver_uvis25_basic.c.

Here is the call graph for this function:

◆ uvis25_basic_init()

uint8_t uvis25_basic_init ( uvis25_interface_t interface )

basic example init

Parameters

[in] interface chip interface

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_uvis25_basic.c.

Here is the call graph for this function:

◆ uvis25_basic_read()

uint8_t uvis25_basic_read ( float * uv )

basic example read

Parameters

[out] *uv pointer to a uv index buffer

Returns

status code

0 success
1 read failed

Note: none

Definition at line 157 of file driver_uvis25_basic.c.

Here is the call graph for this function:

◆ uvis25_interrupt_deinit()

uint8_t uvis25_interrupt_deinit ( void )

basic interrupt deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 283 of file driver_uvis25_interrupt.c.

Here is the call graph for this function:

◆ uvis25_interrupt_init()

uint8_t uvis25_interrupt_init	(	uvis25_interface_t	interface,
		uvis25_interrupt_type_t	mode,
		float	uv_threshold,
		void(*	callback )(uint8_t type) )

interrupt example init

Parameters

[in]	interface	chip interface
[in]	mode	interrupt mode type
[in]	uv_threshold	uv threshold
[in]	*callback	pointer to a callback function

Returns

status code

0 success
1 init failed

Note: none

Definition at line 72 of file driver_uvis25_interrupt.c.

Here is the call graph for this function:

◆ uvis25_interrupt_irq_handler()

uint8_t uvis25_interrupt_irq_handler ( void )

interrupt example irq handler

Returns

status code

0 success
1 run failed

Note: none

Definition at line 49 of file driver_uvis25_interrupt.c.

Here is the call graph for this function:

◆ uvis25_interrupt_read()

uint8_t uvis25_interrupt_read ( float * uv )

interrupt example read

Parameters

[out] *uv pointer to a uv index buffer

Returns

status code

0 success
1 read failed

Note: none

Definition at line 261 of file driver_uvis25_interrupt.c.

Here is the call graph for this function:

◆ uvis25_shot_deinit()

uint8_t uvis25_shot_deinit ( void )

basic shot deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 169 of file driver_uvis25_shot.c.

Here is the call graph for this function:

◆ uvis25_shot_init()

uint8_t uvis25_shot_init ( uvis25_interface_t interface )

shot example init

Parameters

[in] interface chip interface

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_uvis25_shot.c.

Here is the call graph for this function:

◆ uvis25_shot_read()

uint8_t uvis25_shot_read ( float * uv )

shot example read

Parameters

[out] *uv pointer to a uv index buffer

Returns

status code

0 success
1 read failed

Note: none

Definition at line 147 of file driver_uvis25_shot.c.

Here is the call graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ UVIS25_BASIC_DEFAULT_BLOCK_DATA_UPDATE

◆ UVIS25_BASIC_DEFAULT_BOOT_MODE

◆ UVIS25_BASIC_DEFAULT_IIC

◆ UVIS25_BASIC_DEFAULT_SPI_WIRE

◆ UVIS25_INTERRUPT_DEFAULT_BLOCK_DATA_UPDATE

◆ UVIS25_INTERRUPT_DEFAULT_BOOT_MODE

◆ UVIS25_INTERRUPT_DEFAULT_HIGH_THRESHOLD_INTERRUPT

◆ UVIS25_INTERRUPT_DEFAULT_IIC

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT_ACTIVE_LEVEL

◆ UVIS25_INTERRUPT_DEFAULT_INTERRUPT_PIN_TYPE

◆ UVIS25_INTERRUPT_DEFAULT_LATCH_INTERRUPT

◆ UVIS25_INTERRUPT_DEFAULT_LOW_THRESHOLD_INTERRUPT

◆ UVIS25_INTERRUPT_DEFAULT_SPI_WIRE

◆ UVIS25_SHOT_DEFAULT_BLOCK_DATA_UPDATE

◆ UVIS25_SHOT_DEFAULT_BOOT_MODE

◆ UVIS25_SHOT_DEFAULT_IIC

◆ UVIS25_SHOT_DEFAULT_SPI_WIRE

Function Documentation

◆ uvis25_basic_deinit()

◆ uvis25_basic_init()

◆ uvis25_basic_read()

◆ uvis25_interrupt_deinit()

◆ uvis25_interrupt_init()

◆ uvis25_interrupt_irq_handler()

◆ uvis25_interrupt_read()

◆ uvis25_shot_deinit()

◆ uvis25_shot_init()

◆ uvis25_shot_read()