Welcome to mirror list, hosted at ThFree Co, Russian Federation.

readme.txt « UART_Console « UART « Examples « STM32WB5MM-DK « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 791bafbefd683b3f777623ea288d39f870f3f52b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/**
  @page UART_Console UART Console example

  @verbatim
  ******************************************************************************
  * @file    UART/UART_Console/readme.txt
  * @author  MCD Application Team
  * @brief   Description of the UART Console example.
  ******************************************************************************
  *
  * Copyright (c) 2020 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 (printf/getchar) via console with user interaction.
The UART outputs a message on the HyperTerminal and receives some characters.

Board: STM32WB5MM-DK
Tx Pin: PB.06
Rx Pin: PB.07
   _________________________
  |           ______________|                       _______________
  |          |USART         |                      | HyperTerminal |
  |          |              |                      |               |
  |          |           TX |______________________|RX             |
  |          |              |                      |               |
  |          |              |    ST-Link Cable     |               |
  |          |              |                      |               |
  |          |           RX |______________________|TX             |
  |          |              |                      |               |
  |          |______________|                      |_______________|
  |                         |
  |                         |
  |                         |
  |                         |
  |_STM32_Board_____________|

LED4 turns RED when there is an error.
LED4 turns GREEN at the end of example execution, when no error occurs.

The USART is configured as follows:
    - BaudRate = 115200 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

The user sees some printf messages on the Hyperterminal console.
For getchar test, the user is prompted to enter any sequence of characters, followed by "ENTER" key.

@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/USART, Printf, baud rate, RS-232, HyperTerminal, full-duplex,
Transmitter, Receiver, Asynchronous

@par Directory contents

  - UART/UART_Console/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - UART/UART_Console/Inc/stm32wb5mm_dk_conf.h    Discovery Module configuration file
  - UART/UART_Console/Inc/stm32wbxx_it.h          IT interrupt handlers header file
  - UART/UART_Console/Inc/main.h                  Header for main.c module
  - UART/UART_Console/Src/stm32wbxx_it.c          Interrupt handlers
  - UART/UART_Console/Src/main.c                  Main program
  - UART/UART_Console/Src/stm32wbxx_hal_msp.c     HAL MSP module
  - UART/UART_Console/Src/system_stm32wbxx.c      STM32WBxx system source file


@par Hardware and Software environment

  - This example runs on STM32WB5Mxx devices.

  - This example has been tested with STM32WB5MM-DK board and can be
    easily tailored to any other supported device and development board.

  - STM32WB5MM-DK Set-up
    - Connect ST-Link cable to the PC USB port to display data on the HyperTerminal.
      A virtual COM port will then appear in the HyperTerminal.

  - Hyperterminal configuration:
    - Data Length = 7 Bits
    - One Stop Bit
    - Odd parity
    - BaudRate = 115200 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>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */