STM32F4xx-Nucleo BSP User Manual: STM32F4XX NUCLEO LOW LEVEL Exported Functions

STM32F4xx Nucleo BSP Drivers

STM32F4xx-Nucleo BSP User Manual
STM32F4XX NUCLEO LOW LEVEL Exported Functions

Functions

uint32_t BSP_GetVersion (void)
 This method returns the STM32F4xx NUCLEO BSP Driver revision.
void BSP_LED_Init (Led_TypeDef Led)
 Configures LED GPIO.
void BSP_LED_DeInit (Led_TypeDef Led)
 DeInit LEDs.
void BSP_LED_On (Led_TypeDef Led)
 Turns selected LED On.
void BSP_LED_Off (Led_TypeDef Led)
 Turns selected LED Off.
void BSP_LED_Toggle (Led_TypeDef Led)
 Toggles the selected LED.
void BSP_PB_Init (Button_TypeDef Button, ButtonMode_TypeDef ButtonMode)
 Configures Button GPIO and EXTI Line.
void BSP_PB_DeInit (Button_TypeDef Button)
 Push Button DeInit.
uint32_t BSP_PB_GetState (Button_TypeDef Button)
 Returns the selected Button state.
uint8_t BSP_JOY_Init (void)
 Configures joystick available on adafruit 1.8" TFT shield managed through ADC to detect motion.
JOYState_TypeDef BSP_JOY_GetState (void)
 Returns the Joystick key pressed.
void BSP_JOY_DeInit (void)
 DeInit joystick GPIOs.

Function Documentation

uint32_t BSP_GetVersion ( void  )

This method returns the STM32F4xx NUCLEO BSP Driver revision.

Return values:
version,:0xXYZR (8bits for each decimal, R for RC)

Definition at line 179 of file stm32f4xx_nucleo.c.

References __STM32F4xx_NUCLEO_BSP_VERSION.

void BSP_JOY_DeInit ( void  )

DeInit joystick GPIOs.

Note:
JOY DeInit does not disable the Mfx, just set the Mfx pins in Off modee.

Definition at line 776 of file stm32f4xx_nucleo.c.

References ADCx_DeInit().

Returns the Joystick key pressed.

Note:
To know which Joystick key is pressed we need to detect the voltage level on each key output
  • None : 3.3 V / 4095
  • SEL : 1.055 V / 1308
  • DOWN : 0.71 V / 88
  • LEFT : 3.0 V / 3720
  • RIGHT : 0.595 V / 737
  • UP : 1.65 V / 2046
Return values:
JOYState_TypeDef,:Code of the Joystick key pressed.

Definition at line 793 of file stm32f4xx_nucleo.c.

References hnucleo_Adc, JOY_DOWN, JOY_LEFT, JOY_NONE, JOY_RIGHT, JOY_SEL, and JOY_UP.

uint8_t BSP_JOY_Init ( void  )

Configures joystick available on adafruit 1.8" TFT shield managed through ADC to detect motion.

Return values:
Joystickstatus(0=> success, 1=> fail)

Definition at line 756 of file stm32f4xx_nucleo.c.

References ADCx_Init(), hnucleo_Adc, NUCLEO_ADCx_CHANNEL, and sConfig.

void BSP_LED_DeInit ( Led_TypeDef  Led)

DeInit LEDs.

Parameters:
Led,:LED to be de-init. This parameter can be one of the following values:
  • LED2
Note:
Led DeInit does not disable the GPIO clock nor disable the Mfx

Definition at line 215 of file stm32f4xx_nucleo.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_Init ( Led_TypeDef  Led)

Configures LED GPIO.

Parameters:
Led,:Specifies the Led to be configured. This parameter can be one of following parameters:
  • LED2

Definition at line 190 of file stm32f4xx_nucleo.c.

References GPIO_PIN, GPIO_PORT, and LEDx_GPIO_CLK_ENABLE.

void BSP_LED_Off ( Led_TypeDef  Led)

Turns selected LED Off.

Parameters:
Led,:Specifies the Led to be set off. This parameter can be one of following parameters:
  • LED2

Definition at line 243 of file stm32f4xx_nucleo.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_On ( Led_TypeDef  Led)

Turns selected LED On.

Parameters:
Led,:Specifies the Led to be set on. This parameter can be one of following parameters:
  • LED2

Definition at line 232 of file stm32f4xx_nucleo.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_LED_Toggle ( Led_TypeDef  Led)

Toggles the selected LED.

Parameters:
Led,:Specifies the Led to be toggled. This parameter can be one of following parameters:
  • LED2

Definition at line 254 of file stm32f4xx_nucleo.c.

References GPIO_PIN, and GPIO_PORT.

void BSP_PB_DeInit ( Button_TypeDef  Button)

Push Button DeInit.

Parameters:
Button,:Button to be configured This parameter should be: BUTTON_KEY
Note:
PB DeInit does not disable the GPIO clock

Definition at line 306 of file stm32f4xx_nucleo.c.

References BUTTON_IRQn, BUTTON_PIN, and BUTTON_PORT.

uint32_t BSP_PB_GetState ( Button_TypeDef  Button)

Returns the selected Button state.

Parameters:
Button,:Specifies the Button to be checked. This parameter should be: BUTTON_KEY
Return values:
TheButton GPIO pin value.

Definition at line 321 of file stm32f4xx_nucleo.c.

References BUTTON_PIN, and BUTTON_PORT.

void BSP_PB_Init ( Button_TypeDef  Button,
ButtonMode_TypeDef  ButtonMode 
)

Configures Button GPIO and EXTI Line.

Parameters:
Button,:Specifies the Button to be configured. This parameter should be: BUTTON_KEY
ButtonMode,:Specifies Button mode. This parameter can be one of following parameters:
  • BUTTON_MODE_GPIO: Button will be used as simple IO
  • BUTTON_MODE_EXTI: Button will be connected to EXTI line with interrupt generation capability

Definition at line 269 of file stm32f4xx_nucleo.c.

References BUTTON_IRQn, BUTTON_MODE_EXTI, BUTTON_MODE_GPIO, BUTTON_PIN, BUTTON_PORT, and BUTTONx_GPIO_CLK_ENABLE.

Generated on Fri Jan 20 2017 15:36:09 for STM32F4xx-Nucleo BSP User Manual by   doxygen 1.7.6.1