Skip to content

Commit 9538f65

Browse files
author
Jirka Krepl
authored
Merge pull request #167 from doniks/fixes
minor fixes
2 parents a6a7a97 + 9bdf1d0 commit 9538f65

File tree

3 files changed

+23
-37
lines changed

3 files changed

+23
-37
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ They require approved PR.
2121
A webhook has been installed on the publish branch to
2222
https://publish.d20i0wkqbblkur.amplifyapp.com/
2323
https://github.com/pycom/pycom-documentation/tree/master
24-
24+
2525
### Updating documentation pages (no development firmware API changes)
2626
Use this workflow if you want to update documentation pages
2727
(you are not updating pages with new development firmware API).
2828

2929
$ git checkout publish
3030
$ git pull
3131
$ git checkout -b my-docs-update
32-
32+
3333
After you push your changes to your branch, go to GitHub and create two pull requests.
3434
So your branch is merged both to `publish` and `development-publish` branch.
3535

36-
After a moment both https://docs.pycom.io and https://development.pycom.io will be updated.
37-
36+
After your pull request has been reviewed and merged both https://docs.pycom.io and https://development.pycom.io will be updated.
37+
3838
![no fw api changes](static/github/nonFwChanges.jpg)
3939

4040
### Adding development firmware API changes
@@ -47,7 +47,7 @@ When a user clicks on development dropdown on any firmware API change, he/she wi
4747
$ git checkout development-publish
4848
$ git pull
4949
$ git checkout -b my-fw-api-update
50-
50+
5151
After you push your changes to your branch,
5252
go to GitHub and create a pull with **development-publish** branch as a base branch.
5353

@@ -62,7 +62,7 @@ In this case, you want to sync "development" version of docs with the "stable" d
6262
$ git pull
6363
$ git checkout -b my-sync-branch
6464
$ git merge development-publish
65-
65+
6666
After you push your changes to your branch,
6767
go to GitHub and create a pull with **development-publish** branch as a base branch.
6868

content/gettingstarted/connection/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ This chapter of the documentation will show you how to connect you Pycom module.
77

88
{{% refname "lopy.md" %}}
99

10+
{{% refname "lopy4.md" %}}
11+
1012
{{% refname "sipy.md" %}}
1113

1214
{{% refname "gpy.md" %}}
1315

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

1618
{{% refname "wipy.md" %}}
17-

content/pymakr/installation/atom.md

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,43 @@ For beginners, users getting started with MicroPython & Pycom as well as Atom te
1111
Please follow these steps to install the Pymakr Plugin:
1212

1313
1. Ensure that you have Atom installed and open.
14-
1514
![](/gitbook/assets/atom_setup_step_1-1.png)
1615

17-
2. Navigate to the Install page, via `Atom > Preferences > Install`
18-
16+
1. Navigate to the Install page, via `Atom > Preferences > Install`
1917
![](/gitbook/assets/atom_setup_step_2-1.png)
2018

21-
3. Search for `Pymakr` and select the official Pycom Pymakr Plugin.
22-
19+
1. Search for `Pymakr` and select the official Pycom Pymakr Plugin.
2320
![](/gitbook/assets/atom_setup_step_3-1.png)
2421

25-
4. You should now see and click the Install button. This will download and install the Pymakr Plugin.
26-
22+
1. You should now see and click the Install button. This will download and install the Pymakr Plugin.
2723
![](/gitbook/assets/atom_setup_step_4-1.png)
2824

29-
5. That's it! You've installed the Pymakr Plugin for Atom.
30-
25+
1. That's it! You've installed the Pymakr Plugin for Atom.
3126
![](/gitbook/assets/atom_setup_step_5-1.png)
3227

3328
## Connecting via Serial USB
3429

3530
After installing the Pymakr Plugin, you need to take a few seconds to configure it for first time use. Please follow these steps:
3631

3732
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.
38-
3933
Note: you don't need the wire for Expansion Board 3.0
4034

41-
2. Open Atom and ensure that the Pymakr Plugin has correctly installed.
42-
35+
1. Open Atom and ensure that the Pymakr Plugin has correctly installed.
4336
![](/gitbook/assets/atom_config_step_2-1.png)
4437

45-
3. Open the Pymakr console by clicking the `^` button, located in the lower right side of the Atom window.
46-
38+
1. Open the Pymakr console by clicking the `^` button, located in the lower right side of the Atom window.
4739
![](/gitbook/assets/atom_config_step_3%20%281%29.png)
4840

49-
4. Click, `More` followed by `Get Serial Ports`. This will copy the serial address of your expansion board to your clipboard.
50-
41+
1. Click, `More` followed by `Get Serial Ports`. This will copy the serial address of your expansion board to your clipboard.
5142
![](/gitbook/assets/atom_config_step_4.png)
5243

53-
5. Navigate to `Settings > Global Settings`
54-
44+
1. Navigate to `Settings > Global Settings`
5545
![](/gitbook/assets/atom_config_step_5.png)
5646

57-
6. Paste the serial address you copied earlier into the text field `Device Address`
58-
47+
1. Paste the serial address you copied earlier into the text field `Device Address`
5948
![](/gitbook/assets/atom_config_step_6%20%281%29.png)
6049

61-
7. Press connect and the Pymakr console should show three arrows `>>>`, indicating that you are connected
62-
50+
1. Press connect and the Pymakr console should show three arrows `>>>`, indicating that you are connected
6351
![](/gitbook/assets/atom_config_step_7%20%281%29.png)
6452

6553
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
7361
After installing the Pymakr Plugin, a device may be connected via the telnet interface. Please see the following steps:
7462

7563
1. Ensure that Pycom device is turned on
76-
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`.
77-
3. Follow the steps as above in the "Connecting via Serial USB" section but
78-
79-
enter `192.168.4.1` as the address.
80-
81-
4. The default username and password are `micro` and `python`, respectively.
82-
5. Click `Connect` in the Pymakr pane, Pymakr will now connect via telnet.
64+
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`.
65+
1. Follow the steps as above in the "Connecting via Serial USB" section but
66+
enter `192.168.4.1` as the address.
67+
1. The default username and password are `micro` and `python`, respectively.
68+
1. Click `Connect` in the Pymakr pane, Pymakr will now connect via telnet.
8369

8470
![](/gitbook/assets/pymakr-plugin-settings-1.png)
85-

0 commit comments

Comments
 (0)