sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 12:05:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'publish' into pymesh

Browse Source
This commit is contained in:
Catalin Ioana
2019-10-30 16:47:12 +02:00
parent fe4554e2f3 d303ff28bf
commit 47bf9a841d
10 changed files with 125 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@@ -7,3 +7,9 @@
*.iml
out
gen
.DS_Store
static/.DS_Store
static/gitbook/.DS_Store
static/gitbook/assets/.DS_Store
static/gitbook/assets/pybytes/.DS_Store

12
README.md
View File

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

3
content/gettingstarted/connection/_index.md
View File

@@ -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" %}}

83
content/pybytes/smart/_index.md
View File

@@ -4,35 +4,78 @@ aliases:
---
Pybytes iOS app will allow you to quickly provision any number of devices effortlessly to Pybytes.
Your devices will need to run **firmware 1.20.1** or newer.
Go to App Store and download Pybytes iOS app.
User your Pybytes web app account to log in.
<span style="background-color:#00cc96;">&nbsp;Tip:&nbsp;</span>&nbsp;Your devices will need to run **firmware 1.20.1** or newer.
<img src="/gitbook/assets/pybytes/iOS/login.jpg" alt="Pybytes iOS login" width="300"/>
Further down the page you will find the following information:
Tip: Go to Pybytes web app with Safari on iOS or macOS and save your login credentials.
Then iPhone will let you pre-fill your saved password.
* [Pybytes iOS installing and Device Provisioning](#installing)
* [Take into consideration](#recommendations)
* [Quick help/FAQ](#faq)
<img src="/gitbook/assets/pybytes/iOS/loginSavedPasswords.jpg" alt="Pybytes iOS login" width="300"/>
On the next screen, you will need to enter your Wi-Fi credentials.
<a id="installing"></a>
### Pybytes iOS installing and Device Provisioning
* if you are using iOS 12, turn off your Wi-Fi completely on your iPhone.
* use only Wi-Fi network with 2.4GHz (Pycom devices cannot connect to 5GHz network)
* your device might be provisioned faster if you move your device closer to your Wi-Fi router
1. Go to the App Store and download Pybytes iOS app.
2. Use your Pybytes web app account to log in.
<br/>
<br/>
<span style="background-color:#00cc96;">&nbsp;Tip:&nbsp;</span>&nbsp;Go to Pybytes web app with Safari on iOS or macOS and save your log-in credentials.
Then your iPhone will pre-fill your saved password.
Make sure your devices are powered on and running firmware 1.20.1 or newer.
3. On the next screen, you will need to enter your Wi-Fi credentials.
<br/>
<br/>
<img src="/gitbook/assets/pybytes/iOS/login.jpg" alt="Pybytes iOS login" width="200" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>&nbsp;&nbsp;&nbsp;&nbsp;<img src="/gitbook/assets/pybytes/iOS/loginSavedPasswords.jpg" alt="Pybytes iOS login" width="200" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;" />
<img src="/gitbook/assets/pybytes/iOS/wifiSettings.jpg" alt="Pybytes iOS login" width="300"/>
4. After pressing the START button, a list of devices will appear on the screen. It may take up to several minutes to provision all of your devices. The first device usually appears on the screen within one minute.
<br/>
<br/>
<span style="background-color:#00cc96;">&nbsp;Tip:&nbsp;</span>&nbsp;The name of a device provisioned device is its Wireless MAC address.
<br/>
<br/>
<img src="/gitbook/assets/pybytes/iOS/wifiSettings.jpg" alt="Pybytes iOS login" width="200" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>&nbsp;&nbsp;&nbsp;&nbsp;
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesIOS.jpg" alt="Pybytes iOS login" width="200" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>
5. As your devices are provisioning in Pybytes devices management platform, you will see notifications appearing on the screen when the provisioning is successful. You will also see the provisioned devices in the Devices section.
<br/>
<br/>
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesPybytes.png" alt="Pybytes iOS login" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>
After a moment found devices should appear on the screen.
I might take up to several minutes until all your devices are provisioned.
The first device usually appears on the screen within one minute.
<a id="recommendations"></a>
### Take into consideration
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesIOS.jpg" alt="Pybytes iOS login" width="300"/>
* If you are using iOS 12, turn off your Wi-Fi completely on your iPhone.
* Only use a Wi-Fi network with 2.4GHz as Pycom devices cannot connect to a 5GHz network.
* Your device might be provisioned faster if you move your device closer to your Wi-Fi router.
* Make sure your devices are powered on and running firmware 1.20.1 or newer.
* You cannot provision the same devices on the different Pybytes account unless you [erased them completely](../../advance/cli/#erase-all) and flashed the latest firmware again with FW updater tool.
* If there is a spinning wheel on your screen, that means that your device is being provisioned. If it has disappeared, then press the START button again.
* Please take into account that we are developing a new feature and therefore some niggles can occur. (Please bear with us!) If any issues occur whilst you are using Pybytes iOS, then drop us a line at <a href="mailto:support@pycom.io">support@pycom.io</a>.
Then go to Pybytes -> devices. Your provisioned devices appear in the table.
The name of a device provisioned device is its Wireless MAC address.
<a id="faq"></a>
### FAQ
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesPybytes.png" alt="Pybytes iOS login"/>
<span style="background-color:#00cc96;">&nbsp;I can’t connect to Wi-Fi in Pybytes iOS&nbsp;</span>
* Firstly, check your version of iOS. If it is iOS 12, then turn off the Wi-Fi connection on your phone. Following this, try to use Pybytes iOS again, and it should now automatically connect to the WiFi.
* If you have version that is later than iOS 12, check your Wi-Fi router setting. It should run on a 2.4 HGz Wi-Fi network.
<span style="background-color:#00cc96;">&nbsp;No devices were provisioned after 5 min.&nbsp;</span>
* Check if your devices are on
* Move your devices closer to the Wi-Fi router
* Check that no-one else in the room is trying to provision devices with the Pybytes iOS app.
<span style="background-color:#00cc96;">&nbsp;How long does the provisioning take?&nbsp;</span>
* On average, it takes up to 2 minutes to provision 6 devices.
<br/>
Our hope is that Pybytes iOS will simplify the device provisioning process. However, as we are still in a development pipeline, sometimes there can be a hitch in the silk. If that happens, please let us know! Drop us a line at <a href="mailto:support@pycom.io">support@pycom.io</a>.
<br/>
<br/>
<br/>

45
content/pymakr/installation/atom.md
View File

@@ -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)

2
layouts/_default/baseof.html
View File

@@ -10,7 +10,7 @@
<title>{{ if .Title }}{{ .Title }} {{ else }}{{ .Site.Title }}{{ end }}</title>
<meta name="description" content="{{ if .Description }}{{ .Description }}{{ else }}{{ .Site.Params.SiteDescription }}{{ end }}">
<script src="/js/smooth-scroll.js"></script>
<link href="/css/doc-theme.css?" rel="stylesheet">
<link rel="icon" href="/favicon.ico">
</head>

BIN
static/gitbook/assets/pybytes/iOS/provisionedDevicesPybytes.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 820 KiB

After

Width:  |  Height:  |  Size: 273 KiB

2
themes/doc-theme/layouts/partials/toolbar.html
View File

@@ -2,7 +2,7 @@
app
fixed
height=68
class="pr-3 pl-2"
class="pr-3 pl-2 navbar"
dark
style="background-color: #171730;"
>

15
themes/doc-theme/static/css/doc-theme.css
View File

@@ -1,5 +1,6 @@
html {
/*font-size: 100%;*/
scroll-behavior: smooth;
}
/* Style the header */
@@ -122,7 +123,7 @@ a.bread:hover {
.bread {
font-family: 'BebasNeueBold',sans-serif;
letter-spacing: 0.1em;
color: rgb(120, 0, 255)!important;
color: #00cc96 !important;
}
.theme--dark.v-navigation-drawer:not(.v-navigation-drawer--floating) .v-navigation-drawer__border {
@@ -148,7 +149,7 @@ li.lefttree > a {
li.hot > a.hot {
text-decoration: none;
color: #7800FF!important;
color: #00cc96!important;
padding: 6px;
}
@@ -245,8 +246,8 @@ nav#TableOfContents {
img {
max-width: 90%;
margin-left: 5%;
padding: 18px;
margin-left: 0;
padding: 5px;
}
[v-cloak] > * { display:none }
@@ -281,11 +282,11 @@ table td, table th {
}
.ppurple {
color: #7800FF;
color: #00cc96;
}
.pbgpurple {
background-color: #7800FF!important;
background-color: #00cc96!important;
color: white;
}
@@ -324,7 +325,7 @@ code {
}
.primary--text {
color: #7800FF;
color: #00cc96;
}
.v-window {

23
themes/doc-theme/static/js/smooth-scroll.js Normal file
View File

@@ -0,0 +1,23 @@
/*
* Smooth scroll to anchor link
*/
$(document).ready(function(){
$( 'a[href^="#"]' ).on( 'click', function( e ) {
if ( this.hash !== '' ) {
e.preventDefault();
var hash = this.hash;
var nav = $( '.navbar' ).outerHeight();
var targetOffset = $( hash ).offset().top - nav;
$( 'html, body' ).animate( {
scrollTop: targetOffset
}, 1100, function() {
//window.location.hash = hash;
} );
}
} );
} );