From 73dacd0ad74fa8655f33affa4ea2a99f462d9e73 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Fri, 25 Oct 2019 13:06:26 +0200 Subject: [PATCH 1/3] PR review --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8c4aa64a..617c2a00 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ They require approved PR. A webhook has been installed on the publish branch to https://publish.d20i0wkqbblkur.amplifyapp.com/ https://github.com/pycom/pycom-documentation/tree/master - + ### Updating documentation pages (no development firmware API changes) Use this workflow if you want to update documentation pages (you are not updating pages with new development firmware API). @@ -29,12 +29,12 @@ Use this workflow if you want to update documentation pages $ git checkout publish $ git pull $ git checkout -b my-docs-update - + After you push your changes to your branch, go to GitHub and create two pull requests. So your branch is merged both to `publish` and `development-publish` branch. -After a moment both https://docs.pycom.io and https://development.pycom.io will be updated. - +After your pull request has been reviewed and merged both https://docs.pycom.io and https://development.pycom.io will be updated. + ![no fw api changes](static/github/nonFwChanges.jpg) ### Adding development firmware API changes @@ -47,7 +47,7 @@ When a user clicks on development dropdown on any firmware API change, he/she wi $ git checkout development-publish $ git pull $ git checkout -b my-fw-api-update - + After you push your changes to your branch, go to GitHub and create a pull with **development-publish** branch as a base branch. @@ -62,7 +62,7 @@ In this case, you want to sync "development" version of docs with the "stable" d $ git pull $ git checkout -b my-sync-branch $ git merge development-publish - + After you push your changes to your branch, go to GitHub and create a pull with **development-publish** branch as a base branch. From d7d2a562da7225cf6953a2f558ab6979a62d76fb Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Fri, 25 Oct 2019 13:36:12 +0200 Subject: [PATCH 2/3] fix numbering --- content/pymakr/installation/atom.md | 45 ++++++++++------------------- 1 file changed, 15 insertions(+), 30 deletions(-) diff --git a/content/pymakr/installation/atom.md b/content/pymakr/installation/atom.md index 83d286f3..fc5b72e9 100644 --- a/content/pymakr/installation/atom.md +++ b/content/pymakr/installation/atom.md @@ -11,23 +11,18 @@ For beginners, users getting started with MicroPython & Pycom as well as Atom te Please follow these steps to install the Pymakr Plugin: 1. Ensure that you have Atom installed and open. - ![](/gitbook/assets/atom_setup_step_1-1.png) -2. Navigate to the Install page, via `Atom > Preferences > Install` - +1. Navigate to the Install page, via `Atom > Preferences > Install` ![](/gitbook/assets/atom_setup_step_2-1.png) -3. Search for `Pymakr` and select the official Pycom Pymakr Plugin. - +1. Search for `Pymakr` and select the official Pycom Pymakr Plugin. ![](/gitbook/assets/atom_setup_step_3-1.png) -4. You should now see and click the Install button. This will download and install the Pymakr Plugin. - +1. You should now see and click the Install button. This will download and install the Pymakr Plugin. ![](/gitbook/assets/atom_setup_step_4-1.png) -5. That's it! You've installed the Pymakr Plugin for Atom. - +1. That's it! You've installed the Pymakr Plugin for Atom. ![](/gitbook/assets/atom_setup_step_5-1.png) ## Connecting via Serial USB @@ -35,31 +30,24 @@ Please follow these steps to install the Pymakr Plugin: After installing the Pymakr Plugin, you need to take a few seconds to configure it for first time use. Please follow these steps: 1. Connect your Pycom device to your computer via USB. If you are using an Expansion Board 2.0, and have just finished a firmware upgrade, be sure to **remove the wire between GND and G23** and reset your device by pressing the button. - Note: you don't need the wire for Expansion Board 3.0 -2. Open Atom and ensure that the Pymakr Plugin has correctly installed. - +1. Open Atom and ensure that the Pymakr Plugin has correctly installed. ![](/gitbook/assets/atom_config_step_2-1.png) -3. Open the Pymakr console by clicking the `^` button, located in the lower right side of the Atom window. - +1. Open the Pymakr console by clicking the `^` button, located in the lower right side of the Atom window. ![](/gitbook/assets/atom_config_step_3%20%281%29.png) -4. Click, `More` followed by `Get Serial Ports`. This will copy the serial address of your expansion board to your clipboard. - +1. Click, `More` followed by `Get Serial Ports`. This will copy the serial address of your expansion board to your clipboard. ![](/gitbook/assets/atom_config_step_4.png) -5. Navigate to `Settings > Global Settings` - +1. Navigate to `Settings > Global Settings` ![](/gitbook/assets/atom_config_step_5.png) -6. Paste the serial address you copied earlier into the text field `Device Address` - +1. Paste the serial address you copied earlier into the text field `Device Address` ![](/gitbook/assets/atom_config_step_6%20%281%29.png) -7. Press connect and the Pymakr console should show three arrows `>>>`, indicating that you are connected - +1. Press connect and the Pymakr console should show three arrows `>>>`, indicating that you are connected ![](/gitbook/assets/atom_config_step_7%20%281%29.png) These settings can also be applied on a per project basis by clicking `Settings` then `Project Settings`. This will open a JSON file which you can edit to enter your desired settings. @@ -73,13 +61,10 @@ This process is easiest with either a Pycom Expansion Board or a Pytrack/Pysense After installing the Pymakr Plugin, a device may be connected via the telnet interface. Please see the following steps: 1. Ensure that Pycom device is turned on -2. Connect the host computer to the WiFi Access Point named after your board (the SSID will be as follows e.g. `lopy-wlan-xxxx`, `wipy-wlan-xxxx`, etc.). The password is `www.pycom.io`. -3. Follow the steps as above in the "Connecting via Serial USB" section but - - enter `192.168.4.1` as the address. - -4. The default username and password are `micro` and `python`, respectively. -5. Click `Connect` in the Pymakr pane, Pymakr will now connect via telnet. +1. Connect the host computer to the WiFi Access Point named after your board (the SSID will be as follows e.g. `lopy-wlan-xxxx`, `wipy-wlan-xxxx`, etc.). The password is `www.pycom.io`. +1. Follow the steps as above in the "Connecting via Serial USB" section but +enter `192.168.4.1` as the address. +1. The default username and password are `micro` and `python`, respectively. +1. Click `Connect` in the Pymakr pane, Pymakr will now connect via telnet. ![](/gitbook/assets/pymakr-plugin-settings-1.png) - From 9bdf1d0e3e07a7874d8e0b95f255548a91bac264 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Fri, 25 Oct 2019 13:40:09 +0200 Subject: [PATCH 3/3] link lopy4 --- content/gettingstarted/connection/_index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/gettingstarted/connection/_index.md b/content/gettingstarted/connection/_index.md index b4cb389a..4586e691 100644 --- a/content/gettingstarted/connection/_index.md +++ b/content/gettingstarted/connection/_index.md @@ -7,6 +7,8 @@ This chapter of the documentation will show you how to connect you Pycom module. {{% refname "lopy.md" %}} +{{% refname "lopy4.md" %}} + {{% refname "sipy.md" %}} {{% refname "gpy.md" %}} @@ -14,4 +16,3 @@ This chapter of the documentation will show you how to connect you Pycom module. {{% refname "fipy.md" %}} {{% refname "wipy.md" %}} -