From 14c8f6adc996cc7929004bdda0a20b87cf5a8f1b Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Thu, 14 Nov 2019 15:38:01 +0100 Subject: [PATCH 1/7] README.md is not used, duplicate of _index.md --- content/pybytes/connect/README.md | 35 ------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 content/pybytes/connect/README.md diff --git a/content/pybytes/connect/README.md b/content/pybytes/connect/README.md deleted file mode 100644 index 109bf259..00000000 --- a/content/pybytes/connect/README.md +++ /dev/null @@ -1,35 +0,0 @@ - - -In this section, we will explain to you how to add a device to Pybytes. - -## Step 1: Add device wizard - -In Pybytes, go to *Devices* Page: - -1. Click on *Add Device*. - -![](/gitbook/assets/pybytes/add-device/add-device-btn.png) - -2. Select your device (WiPy, LoPy, SiPy, etc.); - -![](/gitbook/assets/pybytes/add-device/select-device-type.png) - -4. Select your network option; - -![](/gitbook/assets/pybytes/add-device/network-step.png) - -5. Enter a unique name and the network credentials (SSID and password) for your device; - -![](/gitbook/assets/pybytes/add-device/customize-step.png) - -## Step 2: Connect your device to Pybytes - -At the end of the "Add Device" wizard, Pybytes will show that your device profile was successfully created. - -![](/gitbook/assets/pybytes/add-device/final-step.png) - -Select how you would like to connect your device to Pybytes: - -1. **[Connect your device quickly](../quick) (Recommended)** - -2. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code). From bfa97800a963087f161e1e563f5be34da1905f00 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Thu, 14 Nov 2019 15:45:09 +0100 Subject: [PATCH 2/7] fix enumeration --- content/pybytes/connect/_index.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/content/pybytes/connect/_index.md b/content/pybytes/connect/_index.md index ce272593..19b66bd9 100644 --- a/content/pybytes/connect/_index.md +++ b/content/pybytes/connect/_index.md @@ -11,19 +11,15 @@ In this section, we will explain to you how to add a device to Pybytes. In Pybytes, go to *Devices* Page: 1. Click on *Add Device*. - ![](/gitbook/assets/pybytes/add-device/add-device-btn.png) -2. Select your device (WiPy, LoPy, SiPy, etc.); - +1. Select your device (WiPy, LoPy, SiPy, etc.); ![](/gitbook/assets/pybytes/add-device/select-device-type.png) -4. Select your network option; - +1. Select your network option; ![](/gitbook/assets/pybytes/add-device/network-step.png) -5. Enter a unique name and the network credentials (SSID and password) for your device; - +1. Enter a unique name and the network credentials (SSID and password) for your device; ![](/gitbook/assets/pybytes/add-device/customize-step.png) ## Step 2: Connect your device to Pybytes @@ -36,4 +32,4 @@ Select how you would like to connect your device to Pybytes: 1. **[Connect your device quickly](quick) (Recommended)** -2. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code). +1. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code). From 70f2496c87d76632296779a529a086b02232dfc6 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Thu, 14 Nov 2019 16:10:15 +0100 Subject: [PATCH 3/7] clarify Wifi --- content/pybytes/connect/_index.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/content/pybytes/connect/_index.md b/content/pybytes/connect/_index.md index 19b66bd9..2e2b814f 100644 --- a/content/pybytes/connect/_index.md +++ b/content/pybytes/connect/_index.md @@ -6,29 +6,28 @@ aliases: In this section, we will explain to you how to add a device to Pybytes. -## Step 1: Add device wizard +## Step 1: Configure the Pybytes service In Pybytes, go to *Devices* Page: 1. Click on *Add Device*. ![](/gitbook/assets/pybytes/add-device/add-device-btn.png) -1. Select your device (WiPy, LoPy, SiPy, etc.); +1. Select your device (WiPy, LoPy, SiPy, etc.). ![](/gitbook/assets/pybytes/add-device/select-device-type.png) -1. Select your network option; +1. Select your network options. This is how your device will connect to the internet and to Pybytes. For now, let's choose WiFi. ![](/gitbook/assets/pybytes/add-device/network-step.png) -1. Enter a unique name and the network credentials (SSID and password) for your device; +1. Enter a unique name for your device and the WiFi credentials (SSID and password). You can also save this WiFi, so you can later use it again for more devices. ![](/gitbook/assets/pybytes/add-device/customize-step.png) -## Step 2: Connect your device to Pybytes - -At the end of the "Add Device" wizard, Pybytes will show that your device profile was successfully created. - +1. At the end of the *Add Device* wizard, Pybytes will show that your device profile was successfully created. ![](/gitbook/assets/pybytes/add-device/final-step.png) -Select how you would like to connect your device to Pybytes: +## Step 2: Configure your device + +There are two options to connect your device to Pybytes: 1. **[Connect your device quickly](quick) (Recommended)** From c8315c314844aac3d3c7cf459b4146cebbdb89b7 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Thu, 14 Nov 2019 16:11:15 +0100 Subject: [PATCH 4/7] fix style make the style more alike with the previous page and fix the grammar --- content/pybytes/connect/quick.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/content/pybytes/connect/quick.md b/content/pybytes/connect/quick.md index fc6289cf..bf50c9cc 100644 --- a/content/pybytes/connect/quick.md +++ b/content/pybytes/connect/quick.md @@ -10,13 +10,12 @@ In this section, we explain to you how to connect your device to Pybytes quickly ### 1. Download Pycom Firmware updater tool +1. From the last step of the "Add Device" process you can download and install Pycom Firmware updater tool. (Or follow this link [pycom.io](https://pycom.io/downloads/)). ![](/gitbook/assets/pybytes/add-device/final-step.png) -From the last step of the "Add Device" process. Download and install Pycom Firmware updater tool from the provided link (Firmware updater is also available on [pycom.io](https://pycom.io/downloads/)). - +1. Copy the activation token by pressing the copy button. The activation token is valid for one hour. If your activation token is expired, you can create a new one. ![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png) -Copy the activation token by pressing the copy button. The activation token is valid for one hour. If your activation token is expired, you can create a new one. ### 2. Flash Pybytes firmware with Pycom Firmware updater tool @@ -26,12 +25,10 @@ Copy the activation token by pressing the copy button. The activation token is v #### Firmware update process -Open the Pycom Firmware updater tool on your computer and click on the Continue button. - +1. Open the Pycom Firmware updater tool on your computer and click on the Continue button. ![](/gitbook/assets/pybytes/add-device/fw-updater/intro-screen.png) -Click again on the Continue button. - +1. Click again on the Continue button. ![](/gitbook/assets/pybytes/add-device/fw-updater/attention-screen.png) {{% hint style="info" %}} @@ -39,20 +36,16 @@ If your device is already connected to your computer, on MacOS serial port will At this step, you can also click on Rescan ports button to update ports listed in the Firmware updater. {{% /hint %}} -Check the options "Erase flash file system" and "Force update Pybytes registration"; - +1. Check the options "Erase flash file system" and "Force update Pybytes registration"; ![](/gitbook/assets/pybytes/add-device/fw-updater/settings-screen.png) -Paste your activation token from Pybytes. Firmware updater should display **Registration successful!** - +1. Paste your activation token from Pybytes. Firmware updater should display **Registration successful!** ![](/gitbook/assets/pybytes/add-device/fw-updater/activation-token-screen.png) -Then press the Continue button. Your device will be flashed with the Pybytes firmware. This should take about a minute. - +1. Then press the Continue button. Your device will be flashed with the Pybytes firmware. This should take about a minute. ![](/gitbook/assets/pybytes/add-device/fw-updater/update-in-progress-screen.png) -After the updating process is done. You will be welcomed with the final screen. Click on Done to close the Firmware updater. - +1. After the updating process is done. You will be welcomed with the final screen. Click on Done to close the Firmware updater. ![](/gitbook/assets/pybytes/add-device/fw-updater/success-screen.png) ## Next step: Set up your device's dashboard! From 71d4df90b27cc50628fa37d3853def408888fcba Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Thu, 14 Nov 2019 16:13:01 +0100 Subject: [PATCH 5/7] remove first screenshot that screen wasn't helpful. docs are referring to the connect-your-device screen anyway --- content/pybytes/connect/quick.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/pybytes/connect/quick.md b/content/pybytes/connect/quick.md index bf50c9cc..3fc6f927 100644 --- a/content/pybytes/connect/quick.md +++ b/content/pybytes/connect/quick.md @@ -11,10 +11,9 @@ In this section, we explain to you how to connect your device to Pybytes quickly ### 1. Download Pycom Firmware updater tool 1. From the last step of the "Add Device" process you can download and install Pycom Firmware updater tool. (Or follow this link [pycom.io](https://pycom.io/downloads/)). -![](/gitbook/assets/pybytes/add-device/final-step.png) +![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png) 1. Copy the activation token by pressing the copy button. The activation token is valid for one hour. If your activation token is expired, you can create a new one. -![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png) ### 2. Flash Pybytes firmware with Pycom Firmware updater tool From 0751137b2a22fa41fadfe3f3b4c02fc67423c594 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Fri, 15 Nov 2019 16:53:05 +0100 Subject: [PATCH 6/7] clarifying language --- content/pybytes/connect/_index.md | 10 +++++----- content/pybytes/connect/quick.md | 16 ++++++++-------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/content/pybytes/connect/_index.md b/content/pybytes/connect/_index.md index 2e2b814f..701b77b8 100644 --- a/content/pybytes/connect/_index.md +++ b/content/pybytes/connect/_index.md @@ -8,7 +8,7 @@ In this section, we will explain to you how to add a device to Pybytes. ## Step 1: Configure the Pybytes service -In Pybytes, go to *Devices* Page: +Go to the *Devices* page in Pybytes: 1. Click on *Add Device*. ![](/gitbook/assets/pybytes/add-device/add-device-btn.png) @@ -16,10 +16,10 @@ In Pybytes, go to *Devices* Page: 1. Select your device (WiPy, LoPy, SiPy, etc.). ![](/gitbook/assets/pybytes/add-device/select-device-type.png) -1. Select your network options. This is how your device will connect to the internet and to Pybytes. For now, let's choose WiFi. +1. Select your network options. This will be how your device connects to both Pybytes and the internet. For now, choose WiFi. ![](/gitbook/assets/pybytes/add-device/network-step.png) -1. Enter a unique name for your device and the WiFi credentials (SSID and password). You can also save this WiFi, so you can later use it again for more devices. +1. Enter a unique name for your device and enter the WiFi credentials (SSID and password). You can save this WiFi, so that it will be remembered for later use when adding further devices. ![](/gitbook/assets/pybytes/add-device/customize-step.png) 1. At the end of the *Add Device* wizard, Pybytes will show that your device profile was successfully created. @@ -27,8 +27,8 @@ In Pybytes, go to *Devices* Page: ## Step 2: Configure your device -There are two options to connect your device to Pybytes: +There are two options for connecting your device to Pybytes: -1. **[Connect your device quickly](quick) (Recommended)** +1. **Recommended:** [Connect your device quickly with the help of the Firmware Updater](quick) 1. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code). diff --git a/content/pybytes/connect/quick.md b/content/pybytes/connect/quick.md index 3fc6f927..ab2b83f8 100644 --- a/content/pybytes/connect/quick.md +++ b/content/pybytes/connect/quick.md @@ -8,15 +8,15 @@ aliases: In this section, we explain to you how to connect your device to Pybytes quickly using the Firmware Updater tool. -### 1. Download Pycom Firmware updater tool +### 1. Download Pycom Firmware Updater tool -1. From the last step of the "Add Device" process you can download and install Pycom Firmware updater tool. (Or follow this link [pycom.io](https://pycom.io/downloads/)). +1. At the final step of the "Add Device" process, you can download and install the [Pycom Firmware Updater tool](https://pycom.io/downloads/)). ![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png) -1. Copy the activation token by pressing the copy button. The activation token is valid for one hour. If your activation token is expired, you can create a new one. +1. Copy the activation token by pressing the Copy button. The activation token is valid for one hour. If your activation token has expired, you can create a new one. -### 2. Flash Pybytes firmware with Pycom Firmware updater tool +### 2. Flash Pybytes firmware with Pycom Firmware Updater tool #### Before you start * Connect your device to the computer @@ -24,7 +24,7 @@ In this section, we explain to you how to connect your device to Pybytes quickly #### Firmware update process -1. Open the Pycom Firmware updater tool on your computer and click on the Continue button. +1. Open the Pycom Firmware Updater tool on your computer and click on the Continue button. ![](/gitbook/assets/pybytes/add-device/fw-updater/intro-screen.png) 1. Click again on the Continue button. @@ -32,19 +32,19 @@ In this section, we explain to you how to connect your device to Pybytes quickly {{% hint style="info" %}} If your device is already connected to your computer, on MacOS serial port will be automatically filled for you. -At this step, you can also click on Rescan ports button to update ports listed in the Firmware updater. +At this step, you can also click on Rescan ports button to update ports listed in the Firmware Updater. {{% /hint %}} 1. Check the options "Erase flash file system" and "Force update Pybytes registration"; ![](/gitbook/assets/pybytes/add-device/fw-updater/settings-screen.png) -1. Paste your activation token from Pybytes. Firmware updater should display **Registration successful!** +1. Paste your activation token from Pybytes. Firmware Updater should display **Registration successful!** ![](/gitbook/assets/pybytes/add-device/fw-updater/activation-token-screen.png) 1. Then press the Continue button. Your device will be flashed with the Pybytes firmware. This should take about a minute. ![](/gitbook/assets/pybytes/add-device/fw-updater/update-in-progress-screen.png) -1. After the updating process is done. You will be welcomed with the final screen. Click on Done to close the Firmware updater. +1. After the updating process is done, you will see the final screen. Click on Done to close the Firmware Updater. ![](/gitbook/assets/pybytes/add-device/fw-updater/success-screen.png) ## Next step: Set up your device's dashboard! From bc5b43d03a04e1a3a16bb89aff76c760f78fec19 Mon Sep 17 00:00:00 2001 From: Peter Putz Date: Mon, 18 Nov 2019 13:34:30 +0100 Subject: [PATCH 7/7] Remove top level enumeration --- content/pybytes/connect/quick.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/pybytes/connect/quick.md b/content/pybytes/connect/quick.md index ab2b83f8..064c6ffd 100644 --- a/content/pybytes/connect/quick.md +++ b/content/pybytes/connect/quick.md @@ -8,7 +8,7 @@ aliases: In this section, we explain to you how to connect your device to Pybytes quickly using the Firmware Updater tool. -### 1. Download Pycom Firmware Updater tool +### Download Pycom Firmware Updater tool 1. At the final step of the "Add Device" process, you can download and install the [Pycom Firmware Updater tool](https://pycom.io/downloads/)). ![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png) @@ -16,7 +16,7 @@ In this section, we explain to you how to connect your device to Pybytes quickly 1. Copy the activation token by pressing the Copy button. The activation token is valid for one hour. If your activation token has expired, you can create a new one. -### 2. Flash Pybytes firmware with Pycom Firmware Updater tool +### Flash Pybytes firmware with Pycom Firmware Updater tool #### Before you start * Connect your device to the computer