Commit 9dd2ad6d authored by David Gauchard's avatar David Gauchard
Browse files

Merge branch 'jal/develop' into 'master'

corrected images glitch in README

See merge request !13
parents c57bdfa4 8091b028
......@@ -100,22 +100,24 @@ firefox localhost:9080
![Getting started step1 - Download VSCode](docs/figures/image.png)
2. PlatformIO: Launch Visual Studio Code. On the left side menu, click on the extension icon ![extension_icon](docs/figures/image1.png). In the search engine, type "PlatformIO IDE", and click install. Finally, restart Visual Studio Code when you are prompted to do so.
2. PlatformIO: Launch Visual Studio Code. On the left side menu, click on the extension icon ![extension_icon](docs/figures/image2.png).
![Getting started step 2 - PlatformIO installation](docs/figures/image2.png)
In the search engine, type "PlatformIO IDE", and click install. Finally, restart Visual Studio Code when you are prompted to do so.
![Getting started step 2 - PlatformIO installation](docs/figures/image3.png)
Now we will download the code from Git to Visual Studio, and compile it.
3. In Visual Studio code, on the left side menu, click on PlatformIO icon ![platformio_icon](docs/figures/image3.png)! Pro tip: if the alien icon does not show up spontaneously, wait for a few more seconds, then press F1 key and type platformio home.
3. In Visual Studio code, on the left side menu, click on PlatformIO icon ![platformio_icon](docs/figures/image4.png)! Pro tip: if the alien icon does not show up spontaneously, wait for a few more seconds, then press F1 key and type platformio home.
4. In Platform.io, select "Clone Git Project ". PlatformIO will automatically open a field in which you can type `https://gitlab.laas.fr/fablaas/pousseseringue/pousseseringue-arduino` and press enter. PlatformIO will ask you in which folder to clone the project. Choose the folder you have created previously. A pop up will appear asking if you trust the authors. You can trust us. :smile:
![Getting started step4 - clone the git repository](docs/figures/image4.png)
![Getting started step4 - clone the git repository](docs/figures/image5.png)
:warning: Make sure that the name of the cloned project has no space in its path as it would create issues.
5. Make sure you are on the main branch of the Git project. You should see the following file tree.
![Getting started step 5 - File tree and main branch](docs/figures/image5.png)
![Getting started step 5 - File tree and main branch](docs/figures/image6.png)
## Step-by-step implementation
......@@ -125,12 +127,12 @@ Now we will connect the serynge to the PC with a micro USB cable.
7. Build and Upload
* In the bottom menu, click on the Build icon ![build_icon](docs/figures/image6.png). This will launch the compilation of the code. If this is the first time that you compile, Visual Studio Code will download several extensions that are required to write the code onto the serynge microcontroller. When the compilation is completed, you should see \[SUCCESS\] in the terminal.
* In the bottom menu, click on the Upload icon ![flash_icon](docs/figures/image7.png). This will flash the compiled code on the microcontroller of serynge. When the process is completed, you should see \[SUCCESS\] in the terminal.
* In the bottom menu, click on the Build icon ![build_icon](docs/figures/image7.png). This will launch the compilation of the code. If this is the first time that you compile, Visual Studio Code will download several extensions that are required to write the code onto the serynge microcontroller. When the compilation is completed, you should see \[SUCCESS\] in the terminal.
* In the bottom menu, click on the Upload icon ![flash_icon](docs/figures/image8.png). This will flash the compiled code on the microcontroller of serynge. When the process is completed, you should see \[SUCCESS\] in the terminal.
:warning: For Linux users, you may have the LIBUSB_ERROR_ACCESS error when uploading to the board, check your udev permissions: <https://community.platformio.org/t/stm32-vs-code-mbed-upload-issue-error-libusb-open-failed-with-libusb-error-access-error-open-failed/10650>
8. In the bottom toolbar, click on the Serial Monitor icon ![serial_icon](docs/figures/image8.png). You will be able to see the messages from the serynge in the terminal.
8. In the bottom toolbar, click on the Serial Monitor icon ![serial_icon](docs/figures/image9.png). You will be able to see the messages from the serynge in the terminal.
That’s it!
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment