Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add changed send trigger to list of changes in IDE 2.x Serial Monitor #287

Merged
merged 2 commits into from
Jun 28, 2022
Merged

Add changed send trigger to list of changes in IDE 2.x Serial Monitor #287

merged 2 commits into from
Jun 28, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 10, 2022

What This PR Changes

In the Arduino IDE 1.x Serial Monitor, sending is triggered via the "Send" button or by pressing the "Enter" key.

There is no "Send" button in the Arduino IDE 2.x Serial Monitor.

The keyboard trigger was changed from "Enter" to "Ctrl + Enter". This is explained to the user by placeholder text in the input field, but that text disappears as soon as they click on the field, so it is easy to miss that information. Feedback from users indicates this is the case (see: arduino/arduino-ide#348, arduino/arduino-ide#572).

For this reason, it will be important to clearly document the change.

I had to adjust the heading structure of the existing content of this "Notable Changes" section because the previous structure would not accommodate the listing of multiple changes (only one was listed previously).

Contribution Guidelines

@per1234
Create a dedicated sub section for "Integrated Monitor" item in IDE 2…
e7b01d7 
….x SM change docs

The previous structure would not allow multiple changes to be listed.
@per1234
Add changed send trigger to list of changes in IDE 2.x Serial Monitor
5d8de4f 
In the Arduino IDE 1.x Serial Monitor, sending is triggered via the "Send" button or by pressing the "Enter" key.

There is no "Send" button in the Arduino IDE 2.x Serial Monitor.

The keyboard trigger was changed from "Enter" to "Ctrl + Enter". This is explained to the user by placeholder text in
the input field, but that text disappears as soon as they click on the field, so it is easy to miss that information.
Feedback from users indicates this is the case.

For this reason, it will be important to clearly document the change.
@per1234 per1234 added enhancement New feature or request arduino Bugs and fixes added by the Arduino Team labels Jun 10, 2022
@per1234 per1234 requested a review from karlsoderby June 10, 2022 09:34
@per1234 per1234 requested a review from sebromero June 20, 2022 11:30
jhansson-ard
jhansson-ard approved these changes Jun 28, 2022
View reviewed changes
Copy link
Contributor

@jhansson-ard jhansson-ard left a comment

Choose a reason for hiding this comment

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

LGTM

@per1234 per1234 merged commit 0a55130 into arduino:main Jun 28, 2022
@per1234 per1234 mentioned this pull request Jun 28, 2022
Closed
@per1234 per1234 mentioned this pull request Nov 30, 2022
Merged
1 task
Serjlee pushed a commit that referenced this pull request Mar 9, 2023
@martab1994 @Jorgetrujilloroman
@jcarolinares @aliphys
Martab94/portenta-x8-user-manual (#287)
c7c8f86 
* Create content

* Rename content to content.md

* Create images

* Update content.md

* Add files via upload

* Delete images

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Delete linux_arduino_RPC.png

* Add files via upload

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OOTB_Cloud_device.png

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete adb-connection.png

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Delete OOTB_WiFi_button.png

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OOTB_Cloud_button.png

* Delete OOTB_Cloud_device.png

* Delete OOTB_Python_button.png

* Delete OOTB_X8_manager_button.png

* Delete OOTB_home.png

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Delete x8-terminal-ADB-push.png

* Add files via upload

* Update content.md

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Delete OOTB_WiFi_connection_done.png

* Delete OOTB_WiFi_password.png

* Delete OOTB_WiFi_selection.png

* Delete portenta-x8-call-outs.png

* Delete python_shell_running.png

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update out-of-the-box update

Specify out-of-the-box update

* Andrea review

Adding Andrea's feedbacks

* Fix typo

Fix typo

* Add OS release image

* Portenta X8 update offline

Adding aktualizer lite offline documentation for X8

* Localhost command update

Update localhost command

* Delete OOTB_WiFi_first_setup.png

* Delete OOTB_homepage.png

* Add files via upload

* Add files via upload

* Delete OOTB_homepage_shell.png

* Add files via upload

* Delete OOTB_homepage_cloud.png

* New image upload

New image cloud

* Delete OOTB_cloud_device_name.png

* new cloud image

* Delete OOTB_cloud_generate_API.png

* New OOTB cloud API image

* Add files via upload

* Delete OOTB_cloud_API_copy.png

* New OOTB Cloud API copy image

* Upload organization ID image

* Update Cloud flow

* Add OOTB Cloud successful provisioning

* Adding content cloud example

* Add files via upload

* Delete OOTB_example_dashboard_launch.png

* Update example dashboard picture

* Add Portenta X8 thing created image

* Add Cloud dashboard image

* Fixing some ref links in the tutorial (internal links ref tags in the page)

* Links fixed in the tutorial

* Fixing image adress for OOTB_cloud_success.png

* Fixing some links

* Typo fixed

* Updating Cloud section

* Fixing some links on the tutorial

* Small typo fix

Fixing a word.

* Add working with Cloud section

* Continuing integrating Working with cloud chapter

* Update working with Cloud section

* Add portenta x8 use case for working with cloud

* Update Cloud container documentation

* Add update selection image

* Add update section (still to be finalized)

* Update working with cloud section to integrate Andrea's comments

* Remove NCM support

* Fix typo

* Continue on line 674. Grammar check in progress. Small typos and grammar problems fixed

* Grammar check finished

* Add successful update image

* Update OOTB update

* Architecture Overview moved at top of the section to improve readability/reading flow

* Pinout order updated

* Goals removed

* Number of hardware items

* Small fix, overview changed to introduction

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/what-is-portenta-x8/content.md

* 399 update section correction

* Fix typo

* Banner added- Folder renamed to portenta-x8-user-manual

* Changed folder name to user-manual

* <snip> Error fixed

* Over-The-Air inconsistency solved

* Wi-F -> Wi-Fi®

* Julian's conflicts solution

* Ali Wifi suggestions added

---------

Co-authored-by: Jorge Trujillo <j.trujilloroman@ext.arduino.cc>
Co-authored-by: Jorge Trujillo Román <124149761+Jorgetrujilloroman@users.noreply.github.com>
Co-authored-by: jcarolinares <jcarolinares@gmail.com>
Co-authored-by: aliphys <alicompute@yahoo.com>
jcarolinares added a commit that referenced this pull request Mar 9, 2023
@ArduinoBot @martab1994
@Jorgetrujilloroman @jcarolinares @aliphys @TaddyHC @marqdevx
Post-launch Portenta X8 Redefinition 09-03-23 (#897)
f66efdc 
* Martab94/portenta-x8-user-manual (#287)

* Create content

* Rename content to content.md

* Create images

* Update content.md

* Add files via upload

* Delete images

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Add files via upload

* Delete linux_arduino_RPC.png

* Add files via upload

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OOTB_Cloud_device.png

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete adb-connection.png

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Delete OOTB_WiFi_button.png

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Delete OOTB_Cloud_button.png

* Delete OOTB_Cloud_device.png

* Delete OOTB_Python_button.png

* Delete OOTB_X8_manager_button.png

* Delete OOTB_home.png

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Delete x8-terminal-ADB-push.png

* Add files via upload

* Update content.md

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Add files via upload

* Add files via upload

* Update content.md

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Delete OOTB_WiFi_connection_done.png

* Delete OOTB_WiFi_password.png

* Delete OOTB_WiFi_selection.png

* Delete portenta-x8-call-outs.png

* Delete python_shell_running.png

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update content.md

* Update out-of-the-box update

Specify out-of-the-box update

* Andrea review

Adding Andrea's feedbacks

* Fix typo

Fix typo

* Add OS release image

* Portenta X8 update offline

Adding aktualizer lite offline documentation for X8

* Localhost command update

Update localhost command

* Delete OOTB_WiFi_first_setup.png

* Delete OOTB_homepage.png

* Add files via upload

* Add files via upload

* Delete OOTB_homepage_shell.png

* Add files via upload

* Delete OOTB_homepage_cloud.png

* New image upload

New image cloud

* Delete OOTB_cloud_device_name.png

* new cloud image

* Delete OOTB_cloud_generate_API.png

* New OOTB cloud API image

* Add files via upload

* Delete OOTB_cloud_API_copy.png

* New OOTB Cloud API copy image

* Upload organization ID image

* Update Cloud flow

* Add OOTB Cloud successful provisioning

* Adding content cloud example

* Add files via upload

* Delete OOTB_example_dashboard_launch.png

* Update example dashboard picture

* Add Portenta X8 thing created image

* Add Cloud dashboard image

* Fixing some ref links in the tutorial (internal links ref tags in the page)

* Links fixed in the tutorial

* Fixing image adress for OOTB_cloud_success.png

* Fixing some links

* Typo fixed

* Updating Cloud section

* Fixing some links on the tutorial

* Small typo fix

Fixing a word.

* Add working with Cloud section

* Continuing integrating Working with cloud chapter

* Update working with Cloud section

* Add portenta x8 use case for working with cloud

* Update Cloud container documentation

* Add update selection image

* Add update section (still to be finalized)

* Update working with cloud section to integrate Andrea's comments

* Remove NCM support

* Fix typo

* Continue on line 674. Grammar check in progress. Small typos and grammar problems fixed

* Grammar check finished

* Add successful update image

* Update OOTB update

* Architecture Overview moved at top of the section to improve readability/reading flow

* Pinout order updated

* Goals removed

* Number of hardware items

* Small fix, overview changed to introduction

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/what-is-portenta-x8/content.md

* 399 update section correction

* Fix typo

* Banner added- Folder renamed to portenta-x8-user-manual

* Changed folder name to user-manual

* <snip> Error fixed

* Over-The-Air inconsistency solved

* Wi-F -> Wi-Fi®

* Julian's conflicts solution

* Ali Wifi suggestions added

---------

Co-authored-by: Jorge Trujillo <j.trujilloroman@ext.arduino.cc>
Co-authored-by: Jorge Trujillo Román <124149761+Jorgetrujilloroman@users.noreply.github.com>
Co-authored-by: jcarolinares <jcarolinares@gmail.com>
Co-authored-by: aliphys <alicompute@yahoo.com>

* [PC-1031] Portenta X8: Create and Upload a Custom Container to the Portenta X8 Redefinition (#357)

* Initial commit - Tutorial content minor update

* Tutorial content title update (Pending Suggestion)

* Tutorial content title readjustment

* Tutorial content update

* Tutorial content update

* Tutorial content update (Added Docker Hub Upload Section WIP)

* Tutorial content minor update

* [PC-1023] Getting Started Tutorial review (#365)

* [PC-1023] Grammar fixes

Some grammar fixes in the tutorial.

* [PC-1023] Documentation Fix

FIxing some URLs

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/out-of-the-box/content.md

Co-authored-by: Pablo Marquínez Ferrándiz <11246294+marqdevx@users.noreply.github.com>

* Revert "Update content/hardware/04.pro/boards/portenta-x8/tutorials/out-of-the-box/content.md"

This reverts commit 74800a2c819e3b170f84166e72158f80ec8a7b5a.

* [PC-1023] Adding information about IP address

Adding images and information about how to connect to the Portenta X8 webpage when the default IP on the tutorial is not working properly.

---------

Co-authored-by: Pablo Marquínez Ferrándiz <11246294+marqdevx@users.noreply.github.com>

* [PC-1027] Portenta X8: Data Exchange Between Python on Linux and an Arduino Sketch Redefintion (#356)

* Initial commit - minor content update

* Tutorial content update

* Tutorial content minor update

* Tutorial content update

* Tutorial content update

* [PC-1026] Portenta X8: Container Management with Docker & Python on Linux Redefinition (#334)

* Initial Commit - Content clean base

* Tutorial content minor update

* Docker management tutorial major update

* Added small bootloader flash link (Portenta X8)

* tutorial content minor update

* Tutorial content update

* Tutorial content update

* Tutorial content minor update

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/docker-container/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/docker-container/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Tutorial content minor update

* Tutorial content minor update

---------

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* [PC-1030] Portenta X8: How To Flash Your Portenta X8 Redefinition (#358)

* Initial commit - Tutorial content minor update

* Tutorial content update

* Tutorial content update

* [PC-1033] Portenta X8: How To Build a Custom Image for Your Portenta X8 Redefinition (#359)

* Initial commit - Tutorial content update

* Tutorial content minor update

* Tutorial content update

* [PC-####] Portenta X8: Using FoundriesFactory Waves Fleet Management Redefinition (#362)

* Initial commit - Tutorial content update

* Tutorial content update

* [PC-####] Portenta X8: Uploading Sketches to the M4 Core on Arduino Portenta X8 Redefinition (#361)

* Initial commit - Tutorial content update

* Tutorial content minor update

* Tutorial content update w/ graphic swap

* Tutorial content minor update

* [PC-1035] Grammar fixes (#366)

Some grammar fixes on the tutorial. Changing Wordpress to WordPress.

* [PC-1034] Portenta X8: Data Logging with MQTT, Node-RED, InfluxDB and Grafana Redefinition (#370)

* Initial commit - Tutorial content update

* Tutorial content minor update

* Tutorial content minor update

* Tutorial content update (Header consistency)

* [PC-1032] Portenta X8: Output WebGL Content on a Screen Redefinition (#363)

* Initial commit - Tutorial content update

* Tutorial content minor update

* Tutorial content update

* Tutorial content update

* Tutorial content update

* user manual-linter error fix

* user manual-linter fix

* Essentials updated

* Getting started button updated to user manual

* Suggested libraries updated

* Initial commit - Tutorial content update (Retesting) (#368)

* [PC-1036] Portenta X8: Multi-Protocol Gateway w/ Max Carrier Tutorial Redefinition  (#344)

* Initial commit - Initial adjustments

* Tutorial content major update

* Tutorial content update

* Tutorial content minor fix

* Tutorial content minor update

* Tutorial content graphics update

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Update content/hardware/04.pro/boards/portenta-x8/tutorials/multi-protocol-gateway/content.md

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Tutorial content update w/ Review feedback

---------

Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>

* Tutorials in order. Essentials fix

* Flashing tutorial PO feedback updated

* Linter general fix for Portenta X8

* Small number fix

---------

Co-authored-by: martab1994 <93210545+martab1994@users.noreply.github.com>
Co-authored-by: Jorge Trujillo <j.trujilloroman@ext.arduino.cc>
Co-authored-by: Jorge Trujillo Román <124149761+Jorgetrujilloroman@users.noreply.github.com>
Co-authored-by: jcarolinares <jcarolinares@gmail.com>
Co-authored-by: aliphys <alicompute@yahoo.com>
Co-authored-by: TaddyHC <94547080+TaddyHC@users.noreply.github.com>
Co-authored-by: Pablo Marquínez Ferrándiz <11246294+marqdevx@users.noreply.github.com>
Co-authored-by: TaddyHC <k.hochung@arduino.cc>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhansson-ard jhansson-ard jhansson-ard approved these changes

@karlsoderby karlsoderby Awaiting requested review from karlsoderby

@sebromero sebromero Awaiting requested review from sebromero

Assignees
No one assigned
Labels
arduino Bugs and fixes added by the Arduino Team enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@per1234 @jhansson-ard