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

readme.txt « Thread_Cli_Cmd « Thread « Applications « P-NUCLEO-WB55.USBDongle « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 9b161ff71d85ac64e425dd0615bff78068a8f27d (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/**
  @page Thread_Cli_Cmd application
  
  @verbatim
  ******************************************************************************
  * @file    Thread/Thread_Cli_Cmd/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the Thread Cli command application
  ******************************************************************************
  *
  * Copyright (c) 2019-2021 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  @endverbatim

@par Application Description 

How to control the Thread stack via Cli commands.
The Cli (Command Line Interface) commands are sent via USB from STM32WB55xx_Usb_Dongle 
to an HyperTerminal (PC).

   _________________________                         ________________________________
  |                         |                       |                                | 
  |      ________           |                       |    _________________________   |
  |     |        |          |                       |   | HyperTerminal 1         |  |
  |     |        |          |                       |   |=> Used to control the   |  |
  |     |        |          |     Cli commands      |   |   stack via Cli commands|  |                    |
  |     |        |          |                       |   |                         |  |
  |     |        |    USB   | _____________________ |   |                         |  |
  |     |        |          |      USB Connector    |   |                         |  |
  |     |        |          |                       |   |_________________________|  |           
  |     |________|          |                       |                                |
  |                         |                       |                                |
  |                         |                       |                                |             
  |                         |                       |                                |          
  |                         |                       |________________PC______________|
  |_STM32WB55xx_Usb_Dongle _|                      



- Through the Cli commands, it is possible to control and configure the Thread 
stack.
- On the HyperTerminal, the user can type the command 'help' in order to display the list of 
all available cli commands. Additional information can be found looking to the OpenThread 
web site :https://openThread.io/guides/

- As example, the user can play the following scenario in order to properly initiate the Thread
mesh network by typing the following commands:

  >panid 0x1234
   Done
  >channel 12
   Done
  >ifconfig up
   Done
  >thread start
   Done

At this point, the user can check the state of its device by using the cli command 'state' 
   >state
   Leader

- When running on two STM32WB55xx_Usb_Dongle boards the same Thread_Cli_Cmd application, and by 
  playing the same scenario as described above on both boards, the first board should reach the 
  state 'leader'while the second one should reach the state 'child'. 

- When the Thread device changes state, a specific LED color is being displayed.
  LED2 ON (Green) means that the device is in "Leader" mode.
  LED3 ON (Red) means that the device is in "Router" or "Child" mode.
  LED2 OFF and LED3 OFF means that the device is disabled or detached.
  
- When all LEDS are blinking, it means that a fatal error has been detected.

     
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Keywords

THREAD

@par Directory contents 
  
  - Thread/Thread_Cli_Cmd/Core/Inc/app_common.h            Header for all modules with common definition
  - Thread/Thread_Cli_Cmd/Core/Inc/app_conf.h              Parameters configuration file of the application 
  - Thread/Thread_Cli_Cmd/Core/Inc/app_entry.h             Parameters configuration file of the application
  - Thread/Thread_Cli_Cmd/STM32_WPAN/App/app_thread.h      Header for app_thread.c module
  - Thread/Thread_Cli_Cmd/Core/Inc/hw_conf.h               Configuration file of the HW 
  - Thread/Thread_Cli_Cmd/Core/Inc/main.h                  Header for main.c module
  - Thread/Thread_Cli_Cmd/Core/Inc/stm_logging.h           Header for stm_logging.c module
  - Thread/Thread_Cli_Cmd/Core/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - Thread/Thread_Cli_Cmd/Core/Src/stm32wbxx_it.h          Interrupt header file
  - Thread/Thread_Cli_Cmd/Core/Inc/system_infra.h          System infrastructure header file
  - Thread/Thread_Cli_Cmd/Core/Inc/utilities_conf.h        Configuration file of the utilities
  - Thread/Thread_Cli_Cmd/Core/Src/app_entry.c             Initialization of the application
  - Thread/Thread_Cli_Cmd/STM32_WPAN/App/app_thread.c      Thread application implementation
  - Thread/Thread_Cli_Cmd/STM32_WPAN/Target/hw_ipcc.c      IPCC Driver
  - Thread/Thread_Cli_Cmd/Core/Src/stm32_lpm_if.c          Low Power Manager Interface
  - Thread/Thread_Cli_Cmd/Core/Src/hw_uart.c               UART driver
  - Thread/Thread_Cli_Cmd/Core/Src/main.c                  Main program
  - Thread/Thread_Cli_Cmd/Core/Src/stm_logging.c           Logging module for traces
  - Thread/Thread_Cli_Cmd/Core/Src/stm32xx_it.c            Interrupt handlers
  - Thread/Thread_Cli_Cmd/Core/Src/system_stm32wbxx.c      stm32wbxx system source file


@par Hardware and Software environment

  - This example runs on STM32WB55xx devices.
  
  - This example has been tested with an STMicroelectronics STM32WB55xx_Usb_Dongle 
    board and can be easily tailored to any other supported device 
    and development board.
     
@par How to use it ? 

This application requests having the stm32wb5x_Thread_FTD_fw.bin binary flashed on the Wireless Coprocessor.
If it is not the case, you need to use STM32CubeProgrammer to load the appropriate binary.
All available binaries are located under /Projects/STM32_Copro_Wireless_Binaries directory.
Refer to UM2237 to learn how to use/install STM32CubeProgrammer.
Refer to /Projects/STM32_Copro_Wireless_Binaries/ReleaseNote.html for the detailed procedure to change the
Wireless Coprocessor binary. 


In order to make the program work, you must do the following: 
 - Plug your STM32WB55xx_Usb_Dongle board to your PC 
 - Rebuild all files and load your image
 - Run the example and use the HyperTerminal to interact with the Board via the Cli commands

Note: when LED1, LED2 and LED3 are toggling it is indicating an error has occurred on application.

 * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */