Skip to content

minor fixes #167

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

Merged
merged 3 commits into from
Oct 28, 2019
Merged

minor fixes #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73dacd0
PR review
doniks Oct 25, 2019
d7d2a56
fix numbering
doniks Oct 25, 2019
9bdf1d0
link lopy4
doniks Oct 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ 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).

$ 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
Expand All @@ -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.

Expand All @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion content/gettingstarted/connection/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ 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" %}}

{{% refname "fipy.md" %}}

{{% refname "wipy.md" %}}

45 changes: 15 additions & 30 deletions content/pymakr/installation/atom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,55 +11,43 @@ 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

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.
Expand All @@ -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)