From cd2dc25acf7b91c9a8adf2f53319c16e50254e98 Mon Sep 17 00:00:00 2001 From: Daniel Spindelbauer Date: Wed, 15 Aug 2018 09:36:40 +0000 Subject: [PATCH] GitBook: [master] 74 pages modified --- README.md | 8 +-- SUMMARY.md | 56 +++++++++---------- datasheets/{modules.md => development.md} | 0 .../{docnotes.md => introduction.md} | 0 .../{firmwareapi.md => introduction.md} | 0 getting-started/introduction.md | 2 +- getting-started/programming/README.md | 2 +- .../{first_project.md => first-project.md} | 4 +- getting-started/programming/repl/serial.md | 2 +- getting-started/programming/repl/telnet.md | 2 +- .../README.md | 0 .../drivers.md | 0 .../firmwaretool.md | 0 .../pymakr.md | 4 +- product-info/development/fipy.md | 6 +- product-info/development/gpy.md | 6 +- product-info/development/lopy.md | 2 +- product-info/development/lopy4.md | 2 +- product-info/development/sipy.md | 2 +- product-info/development/wipy2.md | 2 +- product-info/development/wipy3.md | 2 +- .../{datasheets.md => introduction.md} | 0 product-info/oem/g01.md | 6 +- product-info/oem/l01.md | 2 +- product-info/oem/l04.md | 2 +- product-info/oem/w01.md | 2 +- pybytes/{intro-1 => add-device}/README.md | 0 pybytes/{intro-1 => add-device}/flash.md | 4 +- pybytes/{intro-1 => add-device}/quick.md | 2 +- .../{intro-1 => add-device}/sigfox/README.md | 8 +-- .../sigfox/custom.md} | 0 .../sigfox/devkit.md} | 0 pybytes/{intro.md => getting-started.md} | 2 +- pybytes/{pybytes.md => introduction.md} | 6 +- pybytes/{intro-2.md => visualise-data.md} | 2 +- .../toolsfeatures.md => pymakr/features.md | 0 .../installation/README.md | 0 .../installation/atom.md | 0 .../installation/vscode.md | 0 {pymakr-plugin => pymakr}/settings.md | 0 .../{pytrackpysense.md => introduction.md} | 0 .../{tutorials.md => introduction.md} | 2 +- ...37-rn2483-to-lopy.md => rn2483-to-lopy.md} | 0 .../lte/{cat_m1.md => cat-m1.md} | 0 tutorials-and-examples/lte/firmware.md | 2 +- .../lte/{nb_iot.md => nb-iot.md} | 0 46 files changed, 71 insertions(+), 71 deletions(-) rename datasheets/{modules.md => development.md} (100%) rename documentation-notes/{docnotes.md => introduction.md} (100%) rename firmware-and-api-reference/{firmwareapi.md => introduction.md} (100%) rename getting-started/programming/{first_project.md => first-project.md} (96%) rename getting-started/{installingsoftware => software}/README.md (100%) rename getting-started/{installingsoftware => software}/drivers.md (100%) rename getting-started/{installingsoftware => software}/firmwaretool.md (100%) rename getting-started/{installingsoftware => software}/pymakr.md (69%) rename product-info/{datasheets.md => introduction.md} (100%) rename pybytes/{intro-1 => add-device}/README.md (100%) rename pybytes/{intro-1 => add-device}/flash.md (96%) rename pybytes/{intro-1 => add-device}/quick.md (97%) rename pybytes/{intro-1 => add-device}/sigfox/README.md (83%) rename pybytes/{intro-1/sigfox/sigfoxcustomcontract.md => add-device/sigfox/custom.md} (100%) rename pybytes/{intro-1/sigfox/sigfoxdevkit.md => add-device/sigfox/devkit.md} (100%) rename pybytes/{intro.md => getting-started.md} (93%) rename pybytes/{pybytes.md => introduction.md} (88%) rename pybytes/{intro-2.md => visualise-data.md} (97%) rename pymakr-plugin/toolsfeatures.md => pymakr/features.md (100%) rename {pymakr-plugin => pymakr}/installation/README.md (100%) rename {pymakr-plugin => pymakr}/installation/atom.md (100%) rename {pymakr-plugin => pymakr}/installation/vscode.md (100%) rename {pymakr-plugin => pymakr}/settings.md (100%) rename pytrack-pysense-pyscan/{pytrackpysense.md => introduction.md} (100%) rename tutorials-and-examples/{tutorials.md => introduction.md} (94%) rename tutorials-and-examples/lora/{537-rn2483-to-lopy.md => rn2483-to-lopy.md} (100%) rename tutorials-and-examples/lte/{cat_m1.md => cat-m1.md} (100%) rename tutorials-and-examples/lte/{nb_iot.md => nb-iot.md} (100%) diff --git a/README.md b/README.md index 2de0b60..75c32d8 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ To get started, read through the Getting Started Guide then feel free to jump st * [Products](about/products.md) * [Getting Started](getting-started/introduction.md) -* [Tutorials](tutorials-and-examples/tutorials.md) -* [Product Info](product-info/datasheets.md) -* [API Documentation](firmware-and-api-reference/firmwareapi.md) -* [Pybytes](pybytes/pybytes.md) +* [Tutorials](tutorials-and-examples/introduction.md) +* [Product Info](product-info/introduction.md) +* [API Documentation](firmware-and-api-reference/introduction.md) +* [Pybytes](pybytes/introduction.md) diff --git a/SUMMARY.md b/SUMMARY.md index 1dcb6c3..dc07e49 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -16,14 +16,14 @@ * [1.1.4 GPy](getting-started/hardwaresetup/gpy.md) * [1.1.5 FiPy](getting-started/hardwaresetup/fipy.md) * [1.1.6 WiPy](getting-started/hardwaresetup/wipy.md) -* [1.2 Software](getting-started/installingsoftware/README.md) - * [1.2.1 Drivers](getting-started/installingsoftware/drivers.md) - * [1.2.2 Updating Firmware](getting-started/installingsoftware/firmwaretool.md) - * [1.2.3 Pymakr](getting-started/installingsoftware/pymakr.md) +* [1.2 Software](getting-started/software/README.md) + * [1.2.1 Drivers](getting-started/software/drivers.md) + * [1.2.2 Updating Firmware](getting-started/software/firmwaretool.md) + * [1.2.3 Pymakr](getting-started/software/pymakr.md) * [1.3 Programming the modules](getting-started/programming/README.md) * [1.3.1 Introduction to MicroPython](getting-started/programming/micropython.md) * [1.3.2 MicroPython Examples](getting-started/programming/examples.md) - * [1.3.3 Your first Pymakr project](getting-started/programming/first_project.md) + * [1.3.3 Your first Pymakr project](getting-started/programming/first-project.md) * [1.3.4 REPL](getting-started/programming/repl/README.md) * [1.3.4.1 Serial USB \(UART\)](getting-started/programming/repl/serial.md) * [1.3.4.2 Telnet REPL](getting-started/programming/repl/telnet.md) @@ -38,15 +38,15 @@ ## 2. Pymakr Plugin -* [2.1 Installation](pymakr-plugin/installation/README.md) - * [2.1.1 Atom](pymakr-plugin/installation/atom.md) - * [2.1.2 Visual Studio Code](pymakr-plugin/installation/vscode.md) -* [2.2 Tools/Features](pymakr-plugin/toolsfeatures.md) -* [2.3 Settings](pymakr-plugin/settings.md) +* [2.1 Installation](pymakr/installation/README.md) + * [2.1.1 Atom](pymakr/installation/atom.md) + * [2.1.2 Visual Studio Code](pymakr/installation/vscode.md) +* [2.2 Tools/Features](pymakr/features.md) +* [2.3 Settings](pymakr/settings.md) ## 3. Pytrack, Pysense, Pyscan -* [3.1 Introduction](pytrack-pysense-pyscan/pytrackpysense.md) +* [3.1 Introduction](pytrack-pysense-pyscan/introduction.md) * [3.2 Installing Software](pytrack-pysense-pyscan/installation/README.md) * [3.2.1 Updating Firmware](pytrack-pysense-pyscan/installation/firmware.md) * [3.2.2 Installing Drivers - Windows 7](pytrack-pysense-pyscan/installation/drivers.md) @@ -59,7 +59,7 @@ ## 4. Tutorials & Examples -* [4.1 Introduction](tutorials-and-examples/tutorials.md) +* [4.1 Introduction](tutorials-and-examples/introduction.md) * [4.2 All Pycom Device Examples](tutorials-and-examples/all/README.md) * [4.2.1 REPL](tutorials-and-examples/all/repl.md) * [4.2.2 WLAN](tutorials-and-examples/all/wlan.md) @@ -84,11 +84,11 @@ * [4.3.4 LoRa-MAC Nano-Gateway](tutorials-and-examples/lora/lora-mac-nano-gateway.md) * [4.3.5 LoPy to LoPy](tutorials-and-examples/lora/module-module.md) * [4.3.6 LoRaWAN Nano-Gateway](tutorials-and-examples/lora/lorawan-nano-gateway.md) - * [4.3.7 RN2483 to LoPy](tutorials-and-examples/lora/537-rn2483-to-lopy.md) + * [4.3.7 RN2483 to LoPy](tutorials-and-examples/lora/rn2483-to-lopy.md) * [4.4 Sigfox Examples](tutorials-and-examples/sigfox.md) * [4.5 LTE Examples](tutorials-and-examples/lte/README.md) - * [4.5.1 CAT-M1](tutorials-and-examples/lte/cat_m1.md) - * [4.5.2 NB-IoT](tutorials-and-examples/lte/nb_iot.md) + * [4.5.1 CAT-M1](tutorials-and-examples/lte/cat-m1.md) + * [4.5.2 NB-IoT](tutorials-and-examples/lte/nb-iot.md) * [4.5.3 Module IMEI](tutorials-and-examples/lte/imei.md) * [4.5.4 Modem Firmware Update](tutorials-and-examples/lte/firmware.md) * [4.6 Pytrack Examples](tutorials-and-examples/pytrack.md) @@ -97,7 +97,7 @@ ## 5. Firmware & API Reference -* [5.1 Introduction](firmware-and-api-reference/firmwareapi.md) +* [5.1 Introduction](firmware-and-api-reference/introduction.md) * [5.2 Pycom Modules](firmware-and-api-reference/pycom/README.md) * [5.2.1 machine](firmware-and-api-reference/pycom/machine/README.md) * [5.2.1.1 ADC](firmware-and-api-reference/pycom/machine/adc.md) @@ -152,7 +152,7 @@ ## 6. Product Info -* [6.0 Introduction](product-info/datasheets.md) +* [6.0 Introduction](product-info/introduction.md) * [6.1 Development Modules](product-info/development/README.md) * [6.1.1 WiPy 2.0](product-info/development/wipy2.md) * [6.1.2 WiPy 3.0](product-info/development/wipy3.md) @@ -180,25 +180,25 @@ ## 7. Datasheets -* [7.1 Development Modules](datasheets/modules.md) +* [7.1 Development Modules](datasheets/development.md) * [7.2 OEM Modules](datasheets/oem.md) * [7.3 Expansion Boards and Shields](datasheets/boards.md) ## 8. Pybytes -* [8.1 Introduction](pybytes/pybytes.md) -* [8.2 Getting Started with Pybytes](pybytes/intro.md) -* [8.3 Add a device to Pybytes](pybytes/intro-1/README.md) - * [8.3.1 Connect to Pybytes: Quick Add](pybytes/intro-1/quick.md) - * [8.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/intro-1/flash.md) - * [8.3.3 Add Sigfox device](pybytes/intro-1/sigfox/README.md) - * [8.3.3.1 DevKit contract](pybytes/intro-1/sigfox/sigfoxdevkit.md) - * [8.3.3.2 Custom contract](pybytes/intro-1/sigfox/sigfoxcustomcontract.md) -* [8.4 Visualise data from your device](pybytes/intro-2.md) +* [8.1 Introduction](pybytes/introduction.md) +* [8.2 Getting Started with Pybytes](pybytes/getting-started.md) +* [8.3 Add a device to Pybytes](pybytes/add-device/README.md) + * [8.3.1 Connect to Pybytes: Quick Add](pybytes/add-device/quick.md) + * [8.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md) + * [8.3.3 Add Sigfox device](pybytes/add-device/sigfox/README.md) + * [8.3.3.1 DevKit contract](pybytes/add-device/sigfox/devkit.md) + * [8.3.3.2 Custom contract](pybytes/add-device/sigfox/custom.md) +* [8.4 Visualise data from your device](pybytes/visualise-data.md) ## 9. Documentation Notes -* [9.1 Introduction](documentation-notes/docnotes.md) +* [9.1 Introduction](documentation-notes/introduction.md) * [9.2 Syntax](documentation-notes/syntax.md) * [9.3 REPL vs Scripts](documentation-notes/replscript.md) * [9.4 Mesh Networks](documentation-notes/mesh-networks.md) diff --git a/datasheets/modules.md b/datasheets/development.md similarity index 100% rename from datasheets/modules.md rename to datasheets/development.md diff --git a/documentation-notes/docnotes.md b/documentation-notes/introduction.md similarity index 100% rename from documentation-notes/docnotes.md rename to documentation-notes/introduction.md diff --git a/firmware-and-api-reference/firmwareapi.md b/firmware-and-api-reference/introduction.md similarity index 100% rename from firmware-and-api-reference/firmwareapi.md rename to firmware-and-api-reference/introduction.md diff --git a/getting-started/introduction.md b/getting-started/introduction.md index 136cb73..5dbe4d3 100644 --- a/getting-started/introduction.md +++ b/getting-started/introduction.md @@ -8,7 +8,7 @@ So, you've decided to order a Pycom development module. Firstly we would like to In the first part of this getting started guide, we will take you through setting up your device. Firstly we will cover how to connect the module to your computer either via USB or WiFi. Secondly we will explain how to connect various accessories such as antennas or SIM cards to your module. -## [Step 2: Setting up your computer](installingsoftware/) +## [Step 2: Setting up your computer](software/) Now that your module is successfully connected, you will need to install some software on your computer to interface with it. The second part of this guide will guide you through installing drivers; performing firmware updates for your module/accessories to ensure you have the most stable and feature packed version; and how to setup the software use to program the device. diff --git a/getting-started/programming/README.md b/getting-started/programming/README.md index 1d3fbcb..fefa839 100644 --- a/getting-started/programming/README.md +++ b/getting-started/programming/README.md @@ -6,7 +6,7 @@ If this is your first time using a Pycom module we highly recommend you read thr * [**Introduction to MicroPython:**](micropython.md) This page will explain what Micropython is and its relation to Python. * [**MicroPython Examples:**](examples.md) We also recommend you browse these short MicroPython examples to familiarise yourself with its syntax. This is not meant as a comprehensive guide to MicroPython programming but rather a reference to those who already know programming. If you are new to python, or programming all together, we highly recommend searching the internet for Python tutorials. There are many very good tutorials available for free and the skills you learn will be easily transferable to our platform. -* [**Your first Pymakr project:**](first_project.md) Once you understand what MicroPython is, this guide will take you through setting up your first Pymakr project to blink the on-board RGB LED. This guide will explain the structure of a MicroPython project as well as how to upload it to your module. +* [**Your first Pymakr project:**](first-project.md) Once you understand what MicroPython is, this guide will take you through setting up your first Pymakr project to blink the on-board RGB LED. This guide will explain the structure of a MicroPython project as well as how to upload it to your module. Once you are familiar with MicroPython and Pymakr, the recommended way of uploading code to your module, you can explore the pages below. These will discuss in greater detail the various mechanisms for running code on your device as well as how to recover it if something goes wrong. diff --git a/getting-started/programming/first_project.md b/getting-started/programming/first-project.md similarity index 96% rename from getting-started/programming/first_project.md rename to getting-started/programming/first-project.md index e21bfda..7fc36a7 100644 --- a/getting-started/programming/first_project.md +++ b/getting-started/programming/first-project.md @@ -60,11 +60,11 @@ RGB-Blink For this example, you will just need to create a `main.py` file. -Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr-plugin/settings.md). +Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr/settings.md). ## Controlling the on-board LED -Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmware-and-api-reference/firmwareapi.md). For this example you will need to open the `main.py` file and add the following code: +Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmware-and-api-reference/introduction.md). For this example you will need to open the `main.py` file and add the following code: ```python import pycom diff --git a/getting-started/programming/repl/serial.md b/getting-started/programming/repl/serial.md index b879cce..231afd5 100644 --- a/getting-started/programming/repl/serial.md +++ b/getting-started/programming/repl/serial.md @@ -6,7 +6,7 @@ In order to connect to the REPL over USB serial, there are multiple methods. Det ## All platforms -By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). +By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). ## macOS and Linux diff --git a/getting-started/programming/repl/telnet.md b/getting-started/programming/repl/telnet.md index 81b46fe..e99c27e 100644 --- a/getting-started/programming/repl/telnet.md +++ b/getting-started/programming/repl/telnet.md @@ -15,7 +15,7 @@ See [network.server](../../../firmware-and-api-reference/pycom/network/server.md ## All platforms -By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). +By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). ## macOS and Linux diff --git a/getting-started/installingsoftware/README.md b/getting-started/software/README.md similarity index 100% rename from getting-started/installingsoftware/README.md rename to getting-started/software/README.md diff --git a/getting-started/installingsoftware/drivers.md b/getting-started/software/drivers.md similarity index 100% rename from getting-started/installingsoftware/drivers.md rename to getting-started/software/drivers.md diff --git a/getting-started/installingsoftware/firmwaretool.md b/getting-started/software/firmwaretool.md similarity index 100% rename from getting-started/installingsoftware/firmwaretool.md rename to getting-started/software/firmwaretool.md diff --git a/getting-started/installingsoftware/pymakr.md b/getting-started/software/pymakr.md similarity index 69% rename from getting-started/installingsoftware/pymakr.md rename to getting-started/software/pymakr.md index 455d50a..b76abcf 100644 --- a/getting-started/installingsoftware/pymakr.md +++ b/getting-started/software/pymakr.md @@ -6,9 +6,9 @@ To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms: -{% page-ref page="../../pymakr-plugin/installation/atom.md" %} +{% page-ref page="../../pymakr/installation/atom.md" %} -{% page-ref page="../../pymakr-plugin/installation/vscode.md" %} +{% page-ref page="../../pymakr/installation/vscode.md" %} diff --git a/product-info/development/fipy.md b/product-info/development/fipy.md index bb32d10..4bf1789 100644 --- a/product-info/development/fipy.md +++ b/product-info/development/fipy.md @@ -48,13 +48,13 @@ The AT commands for the Sequans Monarch modem on the FiPy are available in a PDF ## Tutorials -Tutorials on how to the FiPy module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: +Tutorials on how to the FiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [Sigfox](../../tutorials-and-examples/sigfox.md) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb_iot.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/product-info/development/gpy.md b/product-info/development/gpy.md index 5a1afd7..25c97a5 100644 --- a/product-info/development/gpy.md +++ b/product-info/development/gpy.md @@ -48,10 +48,10 @@ The AT commands for the Sequans Monarch modem on the GPy are available in a [PDF ## Tutorials -Tutorials on how to the GPy module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the GPy: +Tutorials on how to the GPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the GPy: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb_iot.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/product-info/development/lopy.md b/product-info/development/lopy.md index dea8fb2..7216c23 100644 --- a/product-info/development/lopy.md +++ b/product-info/development/lopy.md @@ -40,7 +40,7 @@ Due to a couple issues with the LoPy design the module draws more current than i ## Tutorials -Tutorials on how to the LoPy module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: +Tutorials on how to the LoPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) diff --git a/product-info/development/lopy4.md b/product-info/development/lopy4.md index 1afacca..2e569d6 100644 --- a/product-info/development/lopy4.md +++ b/product-info/development/lopy4.md @@ -38,7 +38,7 @@ The `Vin` pin on the LoPy4 can be supplied with a voltage ranging from `3.5v` to ## Tutorials -Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: +Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) diff --git a/product-info/development/sipy.md b/product-info/development/sipy.md index 49c7487..5cd287c 100644 --- a/product-info/development/sipy.md +++ b/product-info/development/sipy.md @@ -40,7 +40,7 @@ Due to a couple issues with the SiPy design the module draws more current than i ## Tutorials -Tutorials on how to the SiPy module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: +Tutorials on how to the SiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [Sigfox](../../tutorials-and-examples/sigfox.md) diff --git a/product-info/development/wipy2.md b/product-info/development/wipy2.md index 53a3e9b..e93de46 100644 --- a/product-info/development/wipy2.md +++ b/product-info/development/wipy2.md @@ -40,7 +40,7 @@ Due to a couple issues with the WiPy2 design the module draws more current than ## Tutorials -Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: +Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/product-info/development/wipy3.md b/product-info/development/wipy3.md index cb4f24a..706b030 100644 --- a/product-info/development/wipy3.md +++ b/product-info/development/wipy3.md @@ -47,7 +47,7 @@ The `Vin` pin on the WiPy3 can be supplied with a voltage ranging from `3.5v` to ## Tutorials -Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: +Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/product-info/datasheets.md b/product-info/introduction.md similarity index 100% rename from product-info/datasheets.md rename to product-info/introduction.md diff --git a/product-info/oem/g01.md b/product-info/oem/g01.md index 7a1b37b..e3360b2 100644 --- a/product-info/oem/g01.md +++ b/product-info/oem/g01.md @@ -34,10 +34,10 @@ The AT commands for the Sequans Monarch modem on the G01 are available in a PDF ## Tutorials -Tutorials on how to the G01 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the G01: +Tutorials on how to the G01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the G01: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb_iot.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/product-info/oem/l01.md b/product-info/oem/l01.md index a8fcad6..7f4139a 100644 --- a/product-info/oem/l01.md +++ b/product-info/oem/l01.md @@ -28,7 +28,7 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the L01 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the L01: +Tutorials on how to the L01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L01: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) diff --git a/product-info/oem/l04.md b/product-info/oem/l04.md index e0ef048..fff6c81 100644 --- a/product-info/oem/l04.md +++ b/product-info/oem/l04.md @@ -28,7 +28,7 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the L04 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the L04: +Tutorials on how to the L04 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L04: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) diff --git a/product-info/oem/w01.md b/product-info/oem/w01.md index 5931b80..beb8779 100644 --- a/product-info/oem/w01.md +++ b/product-info/oem/w01.md @@ -28,7 +28,7 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the W01 module can be found in the [examples](../../tutorials-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the W01: +Tutorials on how to the W01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the W01: * [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/pybytes/intro-1/README.md b/pybytes/add-device/README.md similarity index 100% rename from pybytes/intro-1/README.md rename to pybytes/add-device/README.md diff --git a/pybytes/intro-1/flash.md b/pybytes/add-device/flash.md similarity index 96% rename from pybytes/intro-1/flash.md rename to pybytes/add-device/flash.md index 29328f3..fa633ca 100644 --- a/pybytes/intro-1/flash.md +++ b/pybytes/add-device/flash.md @@ -29,7 +29,7 @@ You can also download _Pybytes library_ at the device's settings page: ### Step 2. Flash your device with Pymakr {% hint style="info" %} -In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr-plugin/installation/atom.md). +In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr/installation/atom.md). {% endhint %} 1. Connect your device to your computer with USB cable. @@ -63,5 +63,5 @@ Pybytes library is written to `/flash` folder and will take precedence over buil Now it's time to display data from your device into Pybytes dashboard. -{% page-ref page="../intro-2.md" %} +{% page-ref page="../visualise-data.md" %} diff --git a/pybytes/intro-1/quick.md b/pybytes/add-device/quick.md similarity index 97% rename from pybytes/intro-1/quick.md rename to pybytes/add-device/quick.md index 0144a67..142b6a8 100644 --- a/pybytes/intro-1/quick.md +++ b/pybytes/add-device/quick.md @@ -50,5 +50,5 @@ Install the Firmware updater on your computer. Now it's time to display data from your device into Pybytes dashboard. -{% page-ref page="../intro-2.md" %} +{% page-ref page="../visualise-data.md" %} diff --git a/pybytes/intro-1/sigfox/README.md b/pybytes/add-device/sigfox/README.md similarity index 83% rename from pybytes/intro-1/sigfox/README.md rename to pybytes/add-device/sigfox/README.md index c90a535..d63c339 100644 --- a/pybytes/intro-1/sigfox/README.md +++ b/pybytes/add-device/sigfox/README.md @@ -28,15 +28,15 @@ In Pybytes go to Settings → Sigfox API or [follow this link](https://pybytes.p ### Sigfox DevKit contracts -Read more how to use Sigfox with [devKit contract](sigfoxdevkit.md). +Read more how to use Sigfox with [devKit contract](devkit.md). -{% page-ref page="sigfoxdevkit.md" %} +{% page-ref page="devkit.md" %} ### Sigfox custom contracts -Read more how to use Sigfox with [Custom contract](sigfoxdevkit.md). +Read more how to use Sigfox with [Custom contract](devkit.md). -{% page-ref page="sigfoxcustomcontract.md" %} +{% page-ref page="custom.md" %} diff --git a/pybytes/intro-1/sigfox/sigfoxcustomcontract.md b/pybytes/add-device/sigfox/custom.md similarity index 100% rename from pybytes/intro-1/sigfox/sigfoxcustomcontract.md rename to pybytes/add-device/sigfox/custom.md diff --git a/pybytes/intro-1/sigfox/sigfoxdevkit.md b/pybytes/add-device/sigfox/devkit.md similarity index 100% rename from pybytes/intro-1/sigfox/sigfoxdevkit.md rename to pybytes/add-device/sigfox/devkit.md diff --git a/pybytes/intro.md b/pybytes/getting-started.md similarity index 93% rename from pybytes/intro.md rename to pybytes/getting-started.md index 711a985..beb7cd0 100644 --- a/pybytes/intro.md +++ b/pybytes/getting-started.md @@ -13,7 +13,7 @@ Follow these steps to create a Pybytes account: Now it's time to explore Pybytes. You can start by connecting your Pycom board to Pybytes. -{% page-ref page="intro-1/" %} +{% page-ref page="add-device/" %} diff --git a/pybytes/pybytes.md b/pybytes/introduction.md similarity index 88% rename from pybytes/pybytes.md rename to pybytes/introduction.md index 9e0fc99..075c5a2 100644 --- a/pybytes/pybytes.md +++ b/pybytes/introduction.md @@ -25,7 +25,7 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati ## Let's get started! -* [Getting started with Pybytes](intro.md) -* [Connect your Pycom module to Pybytes](intro-1/) -* [Visualise data from your device](intro-2.md) +* [Getting started with Pybytes](getting-started.md) +* [Connect your Pycom module to Pybytes](add-device/) +* [Visualise data from your device](visualise-data.md) diff --git a/pybytes/intro-2.md b/pybytes/visualise-data.md similarity index 97% rename from pybytes/intro-2.md rename to pybytes/visualise-data.md index 532918c..8cfc240 100644 --- a/pybytes/intro-2.md +++ b/pybytes/visualise-data.md @@ -3,7 +3,7 @@ In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes. {% hint style="info" %} -We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](intro-1/). After your done with that, you can proceed to the next example. +We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](add-device/). After your done with that, you can proceed to the next example. {% endhint %} ## Step 1: Set up your application \(main.py\) diff --git a/pymakr-plugin/toolsfeatures.md b/pymakr/features.md similarity index 100% rename from pymakr-plugin/toolsfeatures.md rename to pymakr/features.md diff --git a/pymakr-plugin/installation/README.md b/pymakr/installation/README.md similarity index 100% rename from pymakr-plugin/installation/README.md rename to pymakr/installation/README.md diff --git a/pymakr-plugin/installation/atom.md b/pymakr/installation/atom.md similarity index 100% rename from pymakr-plugin/installation/atom.md rename to pymakr/installation/atom.md diff --git a/pymakr-plugin/installation/vscode.md b/pymakr/installation/vscode.md similarity index 100% rename from pymakr-plugin/installation/vscode.md rename to pymakr/installation/vscode.md diff --git a/pymakr-plugin/settings.md b/pymakr/settings.md similarity index 100% rename from pymakr-plugin/settings.md rename to pymakr/settings.md diff --git a/pytrack-pysense-pyscan/pytrackpysense.md b/pytrack-pysense-pyscan/introduction.md similarity index 100% rename from pytrack-pysense-pyscan/pytrackpysense.md rename to pytrack-pysense-pyscan/introduction.md diff --git a/tutorials-and-examples/tutorials.md b/tutorials-and-examples/introduction.md similarity index 94% rename from tutorials-and-examples/tutorials.md rename to tutorials-and-examples/introduction.md index c06ce6c..4ccd92d 100644 --- a/tutorials-and-examples/tutorials.md +++ b/tutorials-and-examples/introduction.md @@ -8,7 +8,7 @@ This section contains tutorials and examples for use with Pycom modules and Expa General Pycom tutorials contains tutorials that may be run on any Pycom device, such as connecting to a WiFi network, Bluetooth, controlling I/O pins etc. Later sections are specific to the LoPy and SiPy devices such as setting up a LoRa node or connecting to the Sigfox network. The final sections are related to examples using the Pytrack and Pysense. -Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../getting-started/installingsoftware/firmwaretool.md). +Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../getting-started/software/firmwaretool.md). The source code for these tutorials, along with the required libraries can be found in in the [pycom-libraries](https://github.com/pycom/pycom-libraries) repository. diff --git a/tutorials-and-examples/lora/537-rn2483-to-lopy.md b/tutorials-and-examples/lora/rn2483-to-lopy.md similarity index 100% rename from tutorials-and-examples/lora/537-rn2483-to-lopy.md rename to tutorials-and-examples/lora/rn2483-to-lopy.md diff --git a/tutorials-and-examples/lte/cat_m1.md b/tutorials-and-examples/lte/cat-m1.md similarity index 100% rename from tutorials-and-examples/lte/cat_m1.md rename to tutorials-and-examples/lte/cat-m1.md diff --git a/tutorials-and-examples/lte/firmware.md b/tutorials-and-examples/lte/firmware.md index bfca3c8..f0c1442 100644 --- a/tutorials-and-examples/lte/firmware.md +++ b/tutorials-and-examples/lte/firmware.md @@ -20,7 +20,7 @@ Before proceeding you will need: If your module is running the factory LTE chip firmware, you **MUST** first perform an update to the latest CAT-M1 firmware before trying to upgrade to the NB-IoT firmware. Skipping this step will cause your radio to become unresponsive and it will require access to the test points in order to re-flash the firmware. {% endhint %} -Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr-plugin/installation/) +Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr/installation/) Next you need to download the firmware file from [here](https://software.pycom.io/downloads/sequans.html). You will need to place the firmware on a FAT32 formatted microSD card, then insert the SD card into a Expansion Board, Pytrack, Pysense or Pyscan. Power-up the system and connect to the interactive REPL and run the following code: diff --git a/tutorials-and-examples/lte/nb_iot.md b/tutorials-and-examples/lte/nb-iot.md similarity index 100% rename from tutorials-and-examples/lte/nb_iot.md rename to tutorials-and-examples/lte/nb-iot.md