Skip to content

Commit bd58b27

Browse files
authored
Updated Pybytes app information (#353)
* added android app information * cleared up usage
1 parent 06d88ea commit bd58b27

File tree

8 files changed

+47
-47
lines changed

8 files changed

+47
-47
lines changed

config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1271,7 +1271,7 @@ theme = "doc-theme"
12711271
weight = 20
12721272

12731273
[[menu.main]]
1274-
name = "Pybytes iOS"
1274+
name = "Pybytes App"
12751275
url = "/pybytes/smart/"
12761276
identifier = "pybytes@smart"
12771277
parent = "pybytes"

content/gettingstarted/programming/ftp.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,23 @@ This page discusses the possibility to upload files through the internal FTP ser
1010

1111
On each Pycom device, there is a small internal filesystem called `/flash`, to which the Python code is uploaded. We can access this filesystem through an internally running FTP server, that allows us to make changes to the files. Next to that, a Telnet connection can be made to communicate with the device through the REPL.
1212
## Connecting
13-
1. **Connect through the Access Point**
1413

14+
In the past, Pycom devices came with the Access Point enabled from the factory. Nowadays, they come with [smart-configuration](/pybytes/smart/) and Pybytes enabled by default, allowing quick and easy provisioning to Pybytes using the app. Follow the steps below to disable that and use enable the Access Point or connect to another WiFi network on boot.
15+
16+
1. **Connect through the Access Point**
17+
1518
You can activate the internal Access Point (AP) on boot by using the following:
1619
```python
1720
import pycom
1821
from network import WLAN
22+
import machine
1923
pycom.pybytes_on_boot(False) #we do not want Pybytes using the WLAN
2024
pycom.smart_config_on_boot(False) #we also do not want smart config
2125
pycom.wifi_on_boot(True)
2226
pycom.wifi_mode_on_boot(WLAN.AP)
2327
pycom.wifi_ssid_ap('ssid')
28+
pycom.wifi_pwd_ap('')
29+
machine.reset()
2430
```
2531

2632
> You can find the methods to change the default settings [here](/firmwareapi/pycom/pycom/#boot-methods)
@@ -29,9 +35,20 @@ On each Pycom device, there is a small internal filesystem called `/flash`, to w
2935

3036
It is also possible to connect your pycom device to a WiFi network first, and then connect to its IP address. Note that you will have to figure out its IP address before you can access the FTP server or use [MDNS](/tutorials/networkprotocols/mdns/). For that, you can use the following command. This will return a tuple with four items, where the first item will contain the assigned IP address.
3137
```python
38+
import pycom
39+
from network import WLAN
40+
import machine
41+
#You can set this to True if Pybytes connects to your router already, and skip the rest
42+
pycom.pybytes_on_boot(False)
43+
44+
pycom.smart_config_on_boot(False)
45+
pycom.wifi_on_boot(True)
46+
pycom.wifi_mode_on_boot(WLAN.STA)
47+
pycom.wifi_ssid_sta('router ssid')
48+
pycom.wifi_pwd_sta('router password')
3249
wlan.ifconfig()
50+
machine.reset()
3351
```
34-
3552
Note that if you make changes to the WLAN Configuration in the uploaded Python code, for example by using Pybytes or changing the WiFi credentials, the connection might drop. Moreover, if your program contains continuous reboot loops, sleep cycles or coredumps, you might not be able to recover the wireless connection without [safe booting](../safeboot/)
3653

3754
## FTP Server

content/pybytes/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati
3131
3232
## Let's get started!
3333

34-
34+
* [Provision your device using the Pybytes app](/pybytes/smart/)
3535
* [Getting started with Pybytes](/pybytes/gettingstarted/)
3636
* [Connect your Pycom module to Pybytes](/pybytes/connect/)
3737
* [Visualise data from your device](/pybytes/dashboard/)

content/pybytes/gettingstarted.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ If you already have a Forum or Webshop account, you can use the same credentials
1515
Else, go to [Pybytes](https://pybytes.pycom.io) and create an account
1616

1717
## Step 2: Create a device
18-
1. Click on [Add Device](https://pybytes.pycom.io/devices). You can either add a device using USB, or the Pybytes App for [iPhone](https://apps.apple.com/us/app/pybytes/id1465696479) or [Android](https://play.google.com/store/apps/details?id=io.pycom.pybytes_android&hl=en). In this guide, we will describe the process using USB.
18+
1. Click on [Add Device](https://pybytes.pycom.io/devices). You can either add a device using USB, or the [Pybytes App](/pybytes/smart/). If you are planning on provisioning a lot of devices, we would definitely recommend using the Pybytes app. In this guide, we will describe the process using USB.
19+
1920
![](/gitbook/assets/pybytes/add-device/add-device-btn.png)
2021

2122
2. Select your device (WiPy, LoPy, SiPy, etc.).

content/pybytes/smart/_index.md

Lines changed: 24 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,63 @@
11
---
2-
title: "Pybytes iOS"
2+
title: "Pybytes App"
33
aliases:
44
---
55

6-
Pybytes iOS app will allow you to quickly provision any number of devices effortlessly to Pybytes.
6+
The Pybytes app will allow you to quickly provision any number of devices effortlessly to Pybytes. This is especially useful if you are planning to provision multiple devices, as the device type, WiFi network and name get automatically assigned in the Pybytes application, and all you will need to do is power up the devices that need provisioning.
77

8-
<span style="background-color:#00cc96;">&nbsp;Tip:&nbsp;</span>&nbsp;Your devices will need to run **firmware 1.20.1** or newer.
8+
> Your devices will need to run **firmware 1.20.1** or newer.
99
1010
Further down the page you will find the following information:
1111

12-
* [Pybytes iOS installing and Device Provisioning](#installing)
13-
* [Take into consideration](#recommendations)
12+
* [Pybytes app installing and Device Provisioning](#pybytes-app-installing-and-device-provisioning)
13+
* [Take into consideration](#take-into-consideration)
1414
* [Quick help/FAQ](#faq)
1515

16+
> Before starting, make sure you have enabled Pybytes smart config on the devices you want to provision by using `pybytes.smart_config(True)`, or by checking the option in the firmware updater tool. New devices will come with pybytes and smart config enabled by default.
1617
17-
<a id="installing"></a>
18-
### Pybytes iOS installing and Device Provisioning
19-
20-
1. Go to the App Store and download Pybytes iOS app.
21-
2. Use your Pybytes web app account to log in.
22-
<br/>
23-
<br/>
24-
<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.
25-
Then your iPhone will pre-fill your saved password.
18+
## Pybytes app installing and Device Provisioning
2619

20+
1. Install the app for [iPhone](https://apps.apple.com/us/app/pybytes/id1465696479) or [Android](https://play.google.com/store/apps/details?id=io.pycom.pybytes_android&hl=en).
21+
2. Use your Pybytes account to log in.
2722
3. On the next screen, you will need to enter your Wi-Fi credentials.
28-
<br/>
29-
<br/>
30-
<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;" />
31-
3223
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.
33-
<br/>
34-
<br/>
35-
<span style="background-color:#00cc96;">&nbsp;Tip:&nbsp;</span>&nbsp;The name of a device provisioned device is its Wireless MAC address.
36-
<br/>
37-
<br/>
38-
<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;
39-
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesIOS.jpg" alt="Pybytes iOS login" width="200" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>
24+
25+
![](/gitbook/assets/pybytes/iOS/login.jpg)
26+
![](/gitbook/assets/pybytes/iOS/wifiSettings.jpg)
27+
![](/gitbook/assets/pybytes/iOS/provisionedDevicesIOS.jpg)
28+
29+
> The name of a device provisioned device is its Wireless MAC address.
30+
4031
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.
41-
<br/>
42-
<br/>
43-
<img src="/gitbook/assets/pybytes/iOS/provisionedDevicesPybytes.png" alt="Pybytes iOS login" style="padding:0px;box-shadow: 2px 2px 8px 2px #cccccc;"/>
4432

45-
<a id="recommendations"></a>
46-
### Take into consideration
33+
![](/gitbook/assets/pybytes/iOS/provisionedDevicesPybytes.png)
34+
35+
## Take into consideration
4736

4837
* If you are using iOS 12, turn off your Wi-Fi completely on your iPhone.
4938
* Only use a Wi-Fi network with 2.4GHz as Pycom devices cannot connect to a 5GHz network.
5039
* Your device might be provisioned faster if you move your device closer to your Wi-Fi router.
5140
* Make sure your devices are powered on and running firmware 1.20.1 or newer.
5241
* 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.
5342
* 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.
54-
* 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:[email protected]">[email protected]</a>.
5543

56-
<a id="faq"></a>
57-
### FAQ
5844

59-
<span style="background-color:#00cc96;">&nbsp;I can’t connect to Wi-Fi in Pybytes iOS&nbsp;</span>
45+
## FAQ
46+
47+
### I can’t connect to Wi-Fi in Pybytes iOS
6048

6149
* 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.
6250

6351
* 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.
6452

65-
<span style="background-color:#00cc96;">&nbsp;No devices were provisioned after 5 min.&nbsp;</span>
53+
### No devices were provisioned after 5 min.
6654

6755
* Check if your devices are on
6856

6957
* Move your devices closer to the Wi-Fi router
7058

7159
* Check that no-one else in the room is trying to provision devices with the Pybytes iOS app.
7260

73-
<span style="background-color:#00cc96;">&nbsp;How long does the provisioning take?&nbsp;</span>
61+
### How long does the provisioning take?
7462

7563
* On average, it takes up to 2 minutes to provision 6 devices.
76-
77-
<br/>
78-
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:[email protected]">[email protected]</a>.
79-
<br/>
80-
<br/>
81-
<br/>
-42.4 KB
Loading
-66.6 KB
Loading
-46.2 KB
Loading

0 commit comments

Comments
 (0)