Evironmental Shield API

Embed: (wiki syntax)

« Back to documentation index

X_NUCLEO_IKE01X1_UV_Exported_Functions

X_NUCLEO_IKE01X1_UV_Exported_Functions
[X_NUCLEO_IKE01X1_UV]

Functions

uint8_t BSP_UV_Init (void)
 Set UV Initialization.
void BSP_UV_Reset (void)
 Reboot memory content of UV.
uint8_t BSP_UV_ReadID (void)
 Read ID of Uv component.
void BSP_UV_ITConfig (void)
 Configure INT1 interrupt.
void BSP_UV_EnableIT (uint8_t IntPin)
 Enable INT1 or INT2 interrupt.
void BSP_UV_DisableIT (uint8_t IntPin)
 Disable INT1 or INT2 interrupt.
void BSP_UV_GetIndex (float *pfData)
 Get Index UV.

Function Documentation

void BSP_UV_DisableIT ( uint8_t  IntPin )

Disable INT1 or INT2 interrupt.

Parameters:
IntPin,:Interrupt pin This parameter can be:

  • UVIS3_INT1
  • UVIS3_INT2
Return values:
None

Definition at line 212 of file x_nucleo_ike01x1_uv.c.

void BSP_UV_EnableIT ( uint8_t  IntPin )

Enable INT1 or INT2 interrupt.

Parameters:
IntPin,:Interrupt pin This parameter can be:

  • UVIS3_INT1
  • UVIS3_INT2
Return values:
None

Definition at line 196 of file x_nucleo_ike01x1_uv.c.

void BSP_UV_GetIndex ( float *  pfData )

Get Index UV.

Parameters:
pfData,:pointer on floating data
Return values:
None

Definition at line 225 of file x_nucleo_ike01x1_uv.c.

uint8_t BSP_UV_Init ( void   )

Set UV Initialization.

Parameters:
None
Return values:
UV_OKif no problem during initialization

Definition at line 106 of file x_nucleo_ike01x1_uv.c.

void BSP_UV_ITConfig ( void   )

Configure INT1 interrupt.

Parameters:
pIntConfig,:pointer to a UVIS3_InterruptConfig_TypeDef structure that contains the configuration setting for the UVIS3 Interrupt.
Return values:
None

Definition at line 172 of file x_nucleo_ike01x1_uv.c.

uint8_t BSP_UV_ReadID ( void   )

Read ID of Uv component.

Parameters:
None
Return values:
ID

Definition at line 141 of file x_nucleo_ike01x1_uv.c.

void BSP_UV_Reset ( void   )

Reboot memory content of UV.

Parameters:
None
Return values:
None

Definition at line 157 of file x_nucleo_ike01x1_uv.c.