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

readme.txt « Phy_802_15_4_Cli « Phy_802_15_4 « Applications « P-NUCLEO-WB55.Nucleo « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: bf4f8e71db74cb2b67dfa39b8f98b317c35ce7e9 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/**
  @page Phy_802_15_4_cli application
  
  @verbatim
  ******************************************************************************
  * @file    /Phy_802_15_4/Phy_802_15_4_Cli/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the Phy_802_15_4_Cli application
  ******************************************************************************
  *
  * Copyright (c) 2020 STMicroelectronics. All rights reserved.
  *
  * This software component is licensed by ST under Ultimate Liberty license 
  * SLA0044, the "License"; You may not use this file except in compliance with 
  * the License. You may obtain a copy of the License at:
  *                               www.st.com/SLA0044
  *
  ******************************************************************************
  @endverbatim

@par Application Description
  
How to create a "PHY_802.15.4 command line interface" application on STM32WB55xx boards using terminals.

@note A dedicated application allows the control and the test of the 802_15_4 radio via a command line interface.
      This application request the usage of the following wireless copro binary: stm32wb5x_Phy_802_15_4_fw.bin.

@note For this application it is requested to have:

  1 STM32WB55xx board loaded with: 
    - wireless coprocessor : stm32wb5x_Phy_802_15_4_fw.bin
    - application : Phy_802_15_4_Cli
            
  The commands are sent via an UART from an HyperTerminal (PC) to the STM32WB55RG_Nucleo Board.
  At startup. after typing return on the HyperTerminal, a prompt '802.15.4 valid cli >' should
  be displayed on the Hyperterminal.
  The Hyperterminal must be configured as follow :
  
      - BaudRate = 115200 baud  
      - Word Length = 8 Bits 
      - Stop Bit = 1 bit
      - Parity = none
      - Flow control = none


   ___________________________ 
  |                           |     
  |           ________________|                       _____________________________________
  |          |USART1          |                      |     HyperTerminal 1                 |
  |          |                |                      |=> Used to ctrl the stack via Cli Cmd|
  |          |                |                      |                                     |
  |          |                |                      |                                     |
  |          |                |______________________|                                     |
  |          |                |______________________| ST_Link virtual port                |
  |          |                |     ST_Link Cable    |                                     |             
  |          |                |                      |                                     |
  |          |                |                      |                                     |
  |          |                |                      |                                     |             
  |          |________________|                      |_____________________________________|          
  |                           |                       
  |                           |                      
  |_STM32WB55RG_Nucleo________|                      




  - Through these commands, it is possible to control and configure the board.
  
  - On the HyperTerminal, the user can type the command 'Help' in order to display the list of all
    commands available.

  - As an example, the user can launch the following commands
   
   802.15.4 valid cli >Help
      -> List all commands available
              
   802.15.4 valid cli >Set_channel 18 
       -> Set the channel to 18

   
@par Keywords

Zigbee, 802.15.4

@par Directory contents 

  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/app_common.h            	Header for all modules with common definition
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/app_conf.h              	Parameters configuration file of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/app_entry.h             	Parameters configuration file of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/app_lld_tests.h          Header for lld test of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/gpio_lld.h             	Parameters for gpio configuration file of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/hw_conf.h           		Configuration file of the HW
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/hw_if.h           		Configuration file of the HW
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/main.h                  	Header for main.c module
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/stm_logging.h		    Header for stm_logging.c module
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/stm32_lpm_if.h          	Header for stm32_lpm_if.c module
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/stm32wbxx_hal_conf.h		HAL configuration file
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/stm32wbxx_it.h          	Interrupt handlers header file
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Inc/utilities_conf.h    		Configuration file of the utilities
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/app_entry.c      		Initialization of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/app_lld_tests.c          lld test of the application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/gpio_lld.c          	    GPIO for for application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/hw_ipcc.c 			    IPCC lld test Driver
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/hw_uart.c 			    UART Driver
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/main.c                  	Main program
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/stm_logging.c            Logging for application
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/stm32_lpm_if.c		    Low Power Manager Interface
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/stm32wbxx_it.c          	Interrupt handlers
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/system_stm32wbxx.c      	stm32wbxx system source file
  - Phy_802_15_4/Phy_802_15_4_Cli/Core/Src/stm32wbxx_hal_msp.c 		HAL MPS for application 
  
@par Hardware and Software environment

  - This example runs on STM32WB55xx devices.
  
  - This example has been tested with an STMicroelectronics STM32WB55RG_Nucleo 
    board and can be easily tailored to any other supported device 
    and development board.
    
  - On STM32WB55RG_Nucleo, the jumpers must be configured as described
    in this section. Starting from the top left position up to the bottom 
    right position, the jumpers on the Board must be set as follows: 

     CN11:    GND         [OFF]
     JP4:     VDDRF       [ON]
     JP6:     VC0         [ON]
     JP2:     +3V3        [ON] 
     JP1:     USB_STL     [ON]   All others [OFF]
     CN12:    GND         [OFF]
     CN7:     <All>       [OFF]
     JP3:     VDD_MCU     [ON]
     JP5:     GND         [OFF]  All others [ON]
     CN10:    <All>       [OFF]


@par How to use it ? 

=> Loading of the stm32wb5x_Phy_802_15_4_fw.bin binary

  This application requests having the stm32wb5x_Phy_802_15_4_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. 



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