Skip to content

Commit 3f5c2de

Browse files
committed
zephyr: windows dox
1 parent bf27059 commit 3f5c2de

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

documentation/devices/zephyr.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,10 @@ The Moddable SDK build uses Zephyr SDK v4.3 or later.
167167
### Troubleshooting
168168

169169
#### Serial / USB Port
170-
Different silicon families connect in different ways. For many ST boards, for example, the Moddable SDK build can automatically detect the correct port. For ESP boards, you specify the serial port by setting the `UPLOAD_PORT` environment variable:
170+
Different silicon families connect in different ways. For many ST boards, for example, the Moddable SDK build can automatically detect the correct port. For ESP boards, you specify the serial port by setting the `DEBUGGER_PORT` environment variable:
171171

172172
```sh
173-
UPLOAD_PORT=/dev/tty.usbserial-1410 mcconfig -d -m -p zephyr/esp32_ethernet_kit
173+
DEBUGGER_PORT=/dev/tty.usbserial-1410 mcconfig -d -m -p zephyr/esp32_ethernet_kit
174174
```
175175

176176
Other silicon families may have different requirements.
@@ -184,7 +184,9 @@ Other silicon families may have different requirements.
184184
1. Install the Moddable SDK tools by following the instructions in the [Getting Started document](./../Moddable%20SDK%20-%20Getting%20Started.md).
185185

186186
2. Install Zephyr for Windows by following the instructions in the Zephyr [Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). A summary is presented below:
187-
187+
188+
> Note: Moddable tools use the CMD shell. When installing Zephyr from the instructions, choose the `Batchfile` instructions.
189+
188190
3. Install Zephyr requirements:
189191

190192
```sh
@@ -210,9 +212,9 @@ Other silicon families may have different requirements.
210212
```sh
211213
zephyrproject\.venv\Scripts\activate.bat
212214
```
213-
214-
> Note: You can deactivate the virtual environment by typing `deactivate` in your shell.
215-
215+
216+
> Note: You can deactivate the virtual environment by typing `deactivate` in your shell.
217+
216218
7. Install the `west` tool:
217219

218220
```sh
@@ -241,15 +243,14 @@ Other silicon families may have different requirements.
241243
west sdk install
242244
```
243245

244-
3. Open the "Environment Variables" dialog of the Control Panel app by following [these instructions](https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/). From that dialog:
246+
11. Set the environment variables `ZEPHYR_BASE` and `DEBUGGER_PORT` using the instructions below:
247+
248+
Open the "Environment Variables" dialog of the Control Panel app by following [these instructions](https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/). From that dialog:
245249
- Create a User Variable called `ZEPHYR_BASE` and set it to %USERPROFILE%\zephyrproject\zephyr
246250
- Variable name: `ZEPHYR_BASE`
247251
- Variable value (Use the "Browse Directory..." button to make this selection): `C:\Users\<user>\zephyrproject\zephyr`
248-
249-
<a id="upload_port_win"></a>
250-
There is one optional environment variable for advanced users: `UPLOAD_PORT`.<br><br>
251-
252-
- `UPLOAD_PORT`: the COM port for your device, e.g. `COM3`
252+
253+
- Create a User Variable called `DEBUGGER_PORT`: the COM port for your device, e.g. `COM3`. This is used to connect your device to the `xsbug` JavaScript debugger.
253254

254255
To identify the correct serial port, launch the Windows Device Manager. Open the "Ports (COM & LPT)" section, verify the Serial port adapter is displayed, and note the associated COM port (e.g. COM3).
255256

0 commit comments

Comments
 (0)