Skip to content

Portenta X8: Python-data-exchange tutorial clarification #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 16, 2022

Conversation

i-herrera
Copy link
Contributor

This PR clarifies a bit more some steps needed to complete the tutorial for people that might not be so skilled with command operations.

Also one comment: in line 72: "Then run the container by executing cd.. and then sudo docker-compose up -d." In my case I didn't have to navigate one level up and has to stay in the container directory in order to run it. So I would remove: "by executing cd.. "

What This PR Changes

  • (Please explain here why you created the pull request and specify what it changes)

Contribution Guidelines

This PR clarifies a bit more some steps needed to complete the tutorial for people that might not be so skilled with command operations.

Also one comment: in line 72: "Then run the container by executing `cd..` and then `sudo docker-compose up -d`." In my case I didn't have to navigate one level up and has to stay in the container directory in order to run it. So I would remove: "by executing `cd..` "
@@ -67,7 +67,7 @@ Make sure you've installed the "Arduino Mbed OS Portenta Boards" core and upload

### Debugging the Arduino Sketch

To check if the Arduino sketch is working correctly you may want to read the messages from the `Serial.println` statements. You can't currently read them directly in the serial monitor of the Arduino IDE. Instead, you can use a simple service called `py-serialrpc` which listens for those messages and prints them to the console. This service needs to run on the Linux side of the X8. You can get the files [here](assets/py-serialrpc.zip). Upload them to the X8 with `adb push py-serialrpc /home/fio`.
To check if the Arduino sketch is working correctly you may want to read the messages from the `Serial.println` statements. You can't currently read them directly in the serial monitor of the Arduino IDE. Instead, you can use a simple service called `py-serialrpc` which listens for those messages and prints them to the console. This service needs to run on the Linux side of the X8. You can get the files [here](assets/py-serialrpc.zip). From the command prompt of your local machine, navigate to the adb tool folder and upload the files to the X8 with `adb push <local directory path>/py-serialrpc /home/fio`.

Log into the X8 shell with `adb shell` and navigate into the `serialrpc` folder. Build the container using `sudo docker build . -t py-serialrpc`. The `-t` flag assigns a tag to the container. Then run the container by executing `cd..` and then `sudo docker-compose up -d`. The `-d` flag detaches the container so it runs in the background. Note that this will run the docker container persistently across reboots by registering it as a systemd service. To stop the container, run `sudo docker-compose stop`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Log into the X8 shell with `adb shell` and navigate into the `serialrpc` folder. Build the container using `sudo docker build . -t py-serialrpc`. The `-t` flag assigns a tag to the container. Then run the container by executing `cd..` and then `sudo docker-compose up -d`. The `-d` flag detaches the container so it runs in the background. Note that this will run the docker container persistently across reboots by registering it as a systemd service. To stop the container, run `sudo docker-compose stop`.
Log into the X8 shell with `adb shell` and navigate into the `serialrpc` folder. Build the container using `sudo docker build . -t py-serialrpc`. The `-t` flag assigns a tag to the container. Then run the container by executing `sudo docker-compose up -d`. The `-d` flag detaches the container so it runs in the background. Note that this will run the docker container persistently across reboots by registering it as a systemd service. To stop the container, run `sudo docker-compose stop`.

@gatsby-cloud
Copy link

gatsby-cloud bot commented Jul 29, 2022

✅ docs-content deploy preview ready

@marqdevx marqdevx changed the title Update content.md Portenta X8: Python-data-exchange tutorial clarification Aug 1, 2022
@marqdevx marqdevx added fix/update A small fix or update Tutorial arduino Bugs and fixes added by the Arduino Team pro labels Aug 1, 2022
@marqdevx marqdevx requested a review from sebromero October 17, 2022 07:58
@marqdevx
Copy link
Member

@sebromero Could you please check this out? 😄

@sebromero sebromero merged commit 6062206 into main Dec 16, 2022
@sebromero sebromero deleted the x8-python-m4-clarifications branch December 16, 2022 12:17
Serjlee pushed a commit that referenced this pull request Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arduino Bugs and fixes added by the Arduino Team fix/update A small fix or update pro Tutorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants