diff options
Diffstat (limited to 'Projects/NUCLEO-WB35CE/Examples/UART/UART_HyperTerminal_IT/readme.txt')
| -rw-r--r-- | Projects/NUCLEO-WB35CE/Examples/UART/UART_HyperTerminal_IT/readme.txt | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB35CE/Examples/UART/UART_HyperTerminal_IT/readme.txt b/Projects/NUCLEO-WB35CE/Examples/UART/UART_HyperTerminal_IT/readme.txt new file mode 100644 index 000000000..db4746c04 --- /dev/null +++ b/Projects/NUCLEO-WB35CE/Examples/UART/UART_HyperTerminal_IT/readme.txt @@ -0,0 +1,141 @@ +/** + @page UART_Hyperterminal_IT UART Hyperterminal IT example + + @verbatim + ****************************************************************************** + * @file UART/UART_Hyperterminal_IT/readme.txt + * @author MCD Application Team + * @brief Description of the UART Hyperterminal example. + ****************************************************************************** + * + * Copyright (c) 2019 STMicroelectronics. All rights reserved. + * + * This software component is licensed by ST under BSD 3-Clause license, + * the "License"; You may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * opensource.org/licenses/BSD-3-Clause + * + ****************************************************************************** + @endverbatim + +@par Example Description + +UART transmission (transmit/receive) in Interrupt mode between a board and +an HyperTerminal PC application. + +Board: NUCLEO-WB35CE +Tx Pin: PB.06 (Pin 35 in CN10) +Rx Pin: PB.07 (Pin 37 in CN10) + _________________________ + | ______________| _______________ + | |USART | | HyperTerminal | + | | | | | + | | TX |______________________|RX | + | | | | | + | | | RS232 Cable | | + | | | | | + | | RX |______________________|TX | + | | | | | + | |______________| |_______________| + | | + | | + | | + | | + |_STM32_Board_____________| + +At the beginning of the main program the HAL_Init() function is called to reset +all the peripherals, initialize the Flash interface and the systick. +Then the SystemClock_Config() function is used to configure the system +clock (SYSCLK) to run at 64 MHz for STM32WBxx Devices. + +The UART peripheral configuration is ensured by the HAL_UART_Init() function. +This later is calling the HAL_UART_MspInit() function which core is implementing +the configuration of the needed UART resources according to the used hardware (CLOCK, +GPIO and NVIC). You may update this function to change UART configuration. + +The UART/Hyperterminal communication is then initiated. +The HAL_UART_Receive_IT() and the HAL_UART_Transmit_IT() functions allow respectively +the reception of Data from Hyperterminal and the transmission of a predefined data +buffer. + +The Asynchronous communication aspect of the UART is clearly highlighted as the +data buffers transmission/reception to/from Hyperterminal are done simultaneously. + +For this example the TxBuffer (aTxStartMessage) is predefined and the RxBuffer (aRxBuffer) +size is limited to 10 data by the mean of the RXBUFFERSIZE define in the main.c file. + +In a first step the TxBuffer buffer content will be displayed in the Hyperterminal +interface and the received data will be stored in the RxBuffer buffer. +In a second step the received data in the RxBuffer buffer will be sent back to +Hyperterminal and displayed. +The end of this two steps are monitored through the HAL_UART_GetState() function +result. + +NUCLEO-WB35CE board LEDs are used to monitor the transfer status: + - LED2 turns ON if transmission/reception is complete and OK. + - LED3 turns ON when when there is an error in transmission/reception process. + +The UART is configured as follows: + - BaudRate = 9600 baud + - Word Length = 8 Bits (7 data bit + 1 parity bit) + - One Stop Bit + - Odd parity + - Hardware flow control disabled (RTS and CTS signals) + - Reception and transmission are enabled in the time + +@note When the parity is enabled, the computed parity is inserted at the MSB +position of the transmitted data. + +@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds) + based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from + a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower) + than the peripheral interrupt. Otherwise the caller ISR process will be blocked. + To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function. + +@note The application needs to ensure that the SysTick time base is always set to 1 millisecond + to have correct HAL operation. + +@par Keywords + +Connectivity, UART, Printf, Baud rate, RS-232, HyperTerminal, full-duplex, HyperTerminal, +Transmission, Reception, Asynchronous, interrupt + +@par Directory contents + + - UART/UART_HyperTerminal_IT/Inc/stm32wbxx_hal_conf.h HAL configuration file + - UART/UART_HyperTerminal_IT/Inc/stm32wbxx_it.h IT interrupt handlers header file + - UART/UART_HyperTerminal_IT/Inc/main.h Header for main.c module + - UART/UART_HyperTerminal_IT/Src/stm32wbxx_it.c IT interrupt handlers + - UART/UART_HyperTerminal_IT/Src/main.c Main program + - UART/UART_HyperTerminal_IT/Src/stm32wbxx_hal_msp.c HAL MSP module + - UART/UART_HyperTerminal_IT/Src/system_stm32wbxx.c STM32WBxx system source file + + +@par Hardware and Software environment + + - This example runs on STM32WB35CEUx devices. + + - This example has been tested with STMicroelectronics NUCLEO-WB35CE board and can be + easily tailored to any other supported device and development board. + + - NUCLEO-WB35CE Set-up + + - Connect USART1 TX (PB6) to RX pin of PC serial port (or USB to UART adapter) + and USART1 RX (PB7) to TX pin of PC serial port (or USB to UART adapter). + + - Hyperterminal configuration: + - Data Length = 7 Bits + - One Stop Bit + - Odd parity + - BaudRate = 9600 baud + - Flow control: None + +@par How to use it ? + +In order to make the program work, you must do the following : + - Open your preferred toolchain + - Rebuild all files and load your image into target memory + - Run the example + + * <h3><center>© COPYRIGHT STMicroelectronics</center></h3> + */ |