Skip to content

Commit 16f0f6a

Browse files
authored
Improving troubleshooting and getting started links and fixing TOC (#214)
1 parent 973a004 commit 16f0f6a

File tree

5 files changed

+30
-8
lines changed

5 files changed

+30
-8
lines changed

azure-pipelines.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ steps:
510510
$textToAdd = "items:
511511
- name: Home
512512
href: ../index.md"
513-
$fileContents[1] = $fileContents[1].Replace("items:", $textToAdd)
513+
$fileContents[1] = $fileContents[1].Replace("- name: Content", $textToAdd)
514514
515515
# write all lines back to file
516516
$fileContents | Set-Content $filePath

content/getting-started-guides/index.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ You only need to build it if you plan to debug the native code, add new targets
88
If your goal is to code in C# you just have to flash your MCU with the appropriate firmware image.
99
There are available ready to flash firmware images for several targets, please check the [reference targets](../reference-targets/index.md) and several others [community contributed](../community-targets/index.md).
1010

11+
Check out our [special beginner content](./beginner-explained.md)! All what you have ever wanted to know about GPIO, I2C, SPI, DAC, ADC, UART and more!
12+
1113
## Managed (C#)
1214

13-
- [Getting started guide for C#](getting-started-managed.md)
14-
- [Getting started trouble shooting guide](trouble-shooting-guide.md)
15-
- [Getting started with VS Code extension](getting-started-vs-code.md)
16-
- [Compare .NET **nanoFramework** with .NET IoT](dotnet-iot-core-vs-nanoframework.md)
17-
- [Virtual Device](virtual-device.md)
15+
- [Getting started guide for C#](./getting-started-managed.md)
16+
- [Getting started trouble shooting guide](./trouble-shooting-guide.md)
17+
- [Getting started trouble shooting device connection guide](./troubleshooting-device-connection.md)
18+
- [Getting started with VS Code extension](./getting-started-vs-code.md)
19+
- [Compare .NET **nanoFramework** with .NET IoT](./dotnet-iot-core-vs-nanoframework.md)
20+
- [Virtual Device](./virtual-device.md)
1821

1922
## Build instructions
2023

content/getting-started-guides/trouble-shooting-guide.md

+7
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,10 @@ Here are solutions to some common problems when getting started.
4949
- This is due to the nanoff will try to read and backup config partition before the actual flash.
5050
- If the chip is flashed with something else before (e.g. Arduino), it will cause a read error and stop the process.
5151
- Add `--masserase` to bypass the backup process and erase the flash.
52+
53+
## nanoff failed to read from ESP32 chip (E4000)
54+
55+
- This is most likely due to the fact that the device needs to be placed manually into boot mode.
56+
- You will have to handle the `reset` button, press the `boot` button, then release the `reset` button. This places the device into boot mode. It is strongly recommended to close Visual Studio during this process.
57+
- The serial port can change! So, make sure you are checking the new port number.
58+
- Once flashed, the device needs to be rebooted manually (press the reset button or disconnect and reconnect the device) to be seen by Visual Studio.

content/getting-started-guides/troubleshooting-device-connection.md

+8
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,11 @@ Regardless of your device, once you connect it, you will see the message `NFPKTV
9191
Don't worry about the possible scramble characters before, they are the ones from the boot of the device itself. Some devices like ESP32 are quite chatty (see previous section), some devices like STM32 are very quite!
9292

9393
From that point, seeing this message means the device is properly working, so look again at [this troubleshooting guide](./trouble-shooting-guide.md).
94+
95+
### Devices with multiple serial ports
96+
97+
Some devices like the ESP32 S3 may come with multiple serial ports. They usually have one named USB, the other one named UART. In those cases, one port is used to flash the device with nanoff and the other one to be seen by Visual Studio.
98+
99+
If you are not sure which port to use, plug one, try to flash on it, if it doesn't work, use the other one.
100+
101+
In most cases, you **cannot** connect both serial ports to your machine, as this interferes with the flash process and does not allow the device to go into boot mode.

content/getting-started-guides/where-to-buy-devices.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
This is a list of recommended devices to start with .NET nanoFramework and links where you can find them. While this list is far to be exhaustive, contribution to adjust this list and especially where to buy them will be very appreciated.
44

5-
> Important: Those lists are just suggestions, the links to buy as well, we are not linked or related to any of those vendors neither any of the resellers.
5+
> [!Important]
6+
>
7+
> Those lists are just suggestions, the links to buy as well, we are not linked or related to any of those vendors neither any of the resellers.
68
79
| MCU|Specifications|Manufacturer SKU|Firmware Target|Purchase Option|
810
|---|---|---|---|---|
@@ -29,4 +31,6 @@ Integrated devices with additional sensors like accelerometers, screens, leds:
2931

3032
Note that you can find most of those boards as well on Amazon and various local websites. Again, feel free to submit a PR with more links on where we can find your favorite device!
3133

32-
> Important: Those lists are just suggestions, the links to buy as well, we are not linked or related to any of those vendors neither any of the resellers.
34+
> [!Important]
35+
>
36+
> Those lists are just suggestions, the links to buy as well, we are not linked or related to any of those vendors neither any of the resellers.

0 commit comments

Comments
 (0)