diff --git a/README.md b/README.md index 75c32d8..c25d552 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Welcome to the Pycom documentation site. The documentation is split into 5 secti To get started, read through the Getting Started Guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects. -* [Products](about/products.md) +* [Products](products.md) * [Getting Started](getting-started/introduction.md) * [Tutorials](tutorials-and-examples/introduction.md) * [Product Info](product-info/introduction.md) diff --git a/SUMMARY.md b/SUMMARY.md index e651dd2..2aca02f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -2,10 +2,6 @@ * [Introduction](README.md) -## About - -* [Pycom Products](about/products.md) - ## 1. Getting Started * [1.0 Introduction](getting-started/introduction.md) @@ -35,6 +31,7 @@ * [1.4.3 LoRaWAN](getting-started/registration/lora/README.md) * [1.4.3.1 The Things Network](getting-started/registration/lora/ttn.md) * [1.4.3.2 Objenious](getting-started/registration/lora/objenious.md) +* [Pycom Products](products.md) ## 2. Pymakr Plugin @@ -149,6 +146,7 @@ * [5.3.18 ustruct](firmware-and-api-reference/micropython/ustruct.md) * [5.3.19 \_thread](firmware-and-api-reference/micropython/_thread.md) * [5.3.20 Builtin](firmware-and-api-reference/micropython/builtin.md) +* [5.4 Notes](firmware-and-api-reference/notes.md) ## 6. Product Info @@ -178,42 +176,33 @@ * [6.3.6.1 Deep Sleep API](product-info/boards/deepsleep/api.md) * [6.4 Notes](product-info/notes.md) -## 7. Datasheets +## 7. Pybytes -* [7.1 Development Modules](datasheets/development.md) -* [7.2 OEM Modules](datasheets/oem.md) -* [7.3 Expansion Boards and Shields](datasheets/boards.md) +* [7.1 Introduction](pybytes/introduction.md) +* [7.2 Getting Started with Pybytes](pybytes/getting-started.md) +* [7.3 Add a device to Pybytes](pybytes/add-device/README.md) + * [7.3.1 Connect to Pybytes: Quick Add](pybytes/add-device/quick.md) + * [7.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md) + * [7.3.3 Add Sigfox device](pybytes/add-device/sigfox/README.md) + * [7.3.3.1 DevKit contract](pybytes/add-device/sigfox/devkit.md) + * [7.3.3.2 Custom contract](pybytes/add-device/sigfox/custom.md) +* [7.4 Visualise data from your device](pybytes/visualise-data.md) -## 8. Pybytes +## 8. Documentation Notes -* [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) +* [8.1 Introduction](documentation-notes/introduction.md) +* [8.2 Syntax](documentation-notes/syntax.md) +* [8.3 REPL vs Scripts](documentation-notes/replscript.md) +* [8.4 Mesh Networks](documentation-notes/mesh-networks.md) -## 9. Documentation Notes +## 9. Advanced Topics -* [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) - -## 10. Advanced Topics - -* [10.1 Firmware Downgrade](advanced-topics/downgrade.md) -* [10.2 CLI Updater](advanced-topics/cli.md) -* [10.3 SecureBoot and Encryption](advanced-topics/encryption.md) - -## 11. License - -* [11.1 License](license/license.md) +* [9.1 Firmware Downgrade](advanced-topics/downgrade.md) +* [9.2 CLI Updater](advanced-topics/cli.md) +* [9.3 SecureBoot and Encryption](advanced-topics/encryption.md) ## Have a question? * [Ask on the Forum](https://forum.pycom.io) +* [License](license.md) diff --git a/about/products.md b/about/products.md deleted file mode 100644 index 0705e15..0000000 --- a/about/products.md +++ /dev/null @@ -1,39 +0,0 @@ -# Pycom Products - -## Pycom Products - -Below you will find tables of all Pycom products. These tables illustrate the functionality of our various products, their compatibility with each other, as well as what accessories are required to utilise certain functionality. - -## Development Boards - -| Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1 NB-IoT | -| :--- | :--- | :--- | :--- | :--- | :--- | -| [![](../.gitbook/assets/wipy2.png) WiPy 3.0](../product-info/development/wipy3.md) | ✔ | ✔ | | | | -| [![](../.gitbook/assets/sipy%20%281%29.png) SiPy](../product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | -| [![](../.gitbook/assets/gpy.png) GPy](../product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | -| [![](../.gitbook/assets/lopy.png) LoPy](../product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | -| [![](../.gitbook/assets/lopy4%20%282%29.png) LoPy4](../product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | -| [![](../.gitbook/assets/fipy%20%282%29.png) FiPy](../product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | -| Antennas [![](../.gitbook/assets/wifi_ant.png) External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/)[![](../.gitbook/assets/lora_ant.png) LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [![](../.gitbook/assets/lte_ant.png) LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) | | | | | - -## Accessories - -| Accessory | [![](../.gitbook/assets/expansion3.png) Expansion Board](../product-info/boards/expansion3.md) | [![](../.gitbook/assets/pysense_new.png) Pysense](../product-info/boards/pysense.md) | [![](../.gitbook/assets/pytrack_new.png) Pytrack](../product-info/boards/pytrack.md) | [![](../.gitbook/assets/pyscan.png) Pyscan](../product-info/boards/pyscan.md) | -| :--- | :--- | :--- | :--- | :--- | -| [![](../.gitbook/assets/pycase.png) PyCase](https://pycom.io/product/pycase/) | ✔ | | | | -| [![](../.gitbook/assets/ip67_case_exp.png) IP67 Case for Expansion Board](https://pycom.io/product/ip67-expansion-board-case/) | ✔ | | | | -| [![](../.gitbook/assets/ip67_case_py.png) IP67 Case for Pysense/Pytrack/Pyscan](https://pycom.io/product/ip67-case/) | | ✔ | ✔ | ✔ | -| [![](../.gitbook/assets/ip67_case.png) IP67 Case \(universal\)](https://pycom.io/product/universal-ip67-case/) | ✔ | ✔ | ✔ | ✔ | -| ![](../.gitbook/assets/lipo.jpg) LiPo Battery \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | -| ![](../.gitbook/assets/microusb.png) Micro USB Cable Required \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | -| Pyscan Modules [![](../.gitbook/assets/oled.png) OLED Module](https://pycom.io/product/oled-screen/)[![](../.gitbook/assets/2mp.png) 2MP Camera](https://pycom.io/product/2mp-camera/)[![](../.gitbook/assets/barcode.png) Barcode Reader](https://pycom.io/product/barcode-reader)[![](../.gitbook/assets/fingerprint.png) Fingerprint Scanner](https://pycom.io/product/fingerprint-scanner/)[![](../.gitbook/assets/ir.png) IR Image Sensor](https://pycom.io/product/infared-image-sensor/) | ✔ | | | | - -## OEM Modules - -| OEM Module | [![](../.gitbook/assets/oem_l01_ref.png) L01/W01 Reference Board](../product-info/oem/l01_reference.md) | [![](../.gitbook/assets/oem_universal_ref.png) Universal Reference Board](../product-info/oem/universal_reference.md) | -| :--- | :--- | :--- | -| [![](../.gitbook/assets/w01%20%281%29.png) W01](../product-info/oem/w01.md) | ✔ | ✔ | -| [![](../.gitbook/assets/l01.png) L01](../product-info/oem/l01.md) | ✔ | ✔ | -| [![](../.gitbook/assets/l04.png) L04](../product-info/oem/l04.md) | | ✔ | -| [![](../.gitbook/assets/g01.png) G01](../product-info/oem/g01.md) | | ✔ | - diff --git a/advanced-topics/cli.md b/advanced-topics/cli.md index 2fa868f..4a6c4af 100644 --- a/advanced-topics/cli.md +++ b/advanced-topics/cli.md @@ -1,4 +1,4 @@ -# 10.2 CLI Updater +# 9.2 CLI Updater ## Command Line Update Utility diff --git a/advanced-topics/downgrade.md b/advanced-topics/downgrade.md index 2bebd04..7f09a81 100644 --- a/advanced-topics/downgrade.md +++ b/advanced-topics/downgrade.md @@ -1,4 +1,4 @@ -# 10.1 Firmware Downgrade +# 9.1 Firmware Downgrade The firmware upgrade tool usually updates your device to the latest available firmware version. If you require to downgrade your device to a previous firmware there are two methods to achieve this. diff --git a/advanced-topics/encryption.md b/advanced-topics/encryption.md index 0b031a9..7f08932 100644 --- a/advanced-topics/encryption.md +++ b/advanced-topics/encryption.md @@ -1,4 +1,4 @@ -# 10.3 SecureBoot and Encryption +# 9.3 SecureBoot and Encryption ## Summary diff --git a/datasheets/boards.md b/datasheets/boards.md deleted file mode 100644 index 8faa3dd..0000000 --- a/datasheets/boards.md +++ /dev/null @@ -1,12 +0,0 @@ -# 7.3 Expansion Boards and Shields - -{% file src="../.gitbook/assets/expansion3-specsheet.pdf" caption="Expansion Board 3.0" %} - -{% file src="../.gitbook/assets/pytrack-specsheet.pdf" caption="Pytrack" %} - -{% file src="../.gitbook/assets/pysense-specsheet \(1\).pdf" caption="Pysense" %} - -{% file src="../.gitbook/assets/pyscan-specsheet \(1\).pdf" caption="Pyscan" %} - -{% file src="../.gitbook/assets/expansion2-specsheet \(1\).pdf" caption="Expansion Board 2.0" %} - diff --git a/datasheets/development.md b/datasheets/development.md deleted file mode 100644 index 310b96c..0000000 --- a/datasheets/development.md +++ /dev/null @@ -1,16 +0,0 @@ -# 7.1 Development Modules - -{% file src="../.gitbook/assets/wipy2-specsheet \(1\).pdf" caption="WiPy 2.0" %} - -{% file src="../.gitbook/assets/wipy3-specsheet \(1\).pdf" caption="WiPy 3.0" %} - -{% file src="../.gitbook/assets/lopy-specsheet \(1\).pdf" caption="LoPy" %} - -{% file src="../.gitbook/assets/lopy4-specsheet.pdf" caption="LoPy 4" %} - -{% file src="../.gitbook/assets/sipy-specsheet \(1\).pdf" caption="SiPy" %} - -{% file src="../.gitbook/assets/gpy-specsheet \(1\).pdf" caption="GPy" %} - -{% file src="../.gitbook/assets/fipy-specsheet.pdf" caption="FiPy" %} - diff --git a/datasheets/oem.md b/datasheets/oem.md deleted file mode 100644 index badaf39..0000000 --- a/datasheets/oem.md +++ /dev/null @@ -1,10 +0,0 @@ -# 7.2 OEM Modules - -{% file src="../.gitbook/assets/w01-specsheet.pdf" caption="W01" %} - -{% file src="../.gitbook/assets/l01-specsheet.pdf" caption="L01" %} - -{% file src="../.gitbook/assets/l04-specsheet \(1\).pdf" caption="L04" %} - -{% file src="../.gitbook/assets/g01-specsheet \(1\).pdf" caption="G01" %} - diff --git a/documentation-notes/introduction.md b/documentation-notes/introduction.md index b5cc6f8..90defc7 100644 --- a/documentation-notes/introduction.md +++ b/documentation-notes/introduction.md @@ -1,4 +1,4 @@ -# 9.1 Introduction +# 8.1 Introduction The Pycom documentation aims to be straightforward and to adhere to typical Python documentation to allow for ease of understanding. However, there may be some unusual features for those not used to Python documentation or that are new to the MicroPython Language. This section of the documentation aims to provide clarity for any of the design specifics that might be confusing for those new to Python and this style of documentation. diff --git a/documentation-notes/mesh-networks.md b/documentation-notes/mesh-networks.md index 988bb4f..ea6eeb2 100644 --- a/documentation-notes/mesh-networks.md +++ b/documentation-notes/mesh-networks.md @@ -1,4 +1,4 @@ -# 9.4 Mesh Networks +# 8.4 Mesh Networks Mesh Networking is currently under development. Please click [here](https://docs.pycom.io/v/development_release/chapter/tutorials/lora/lora-mesh.html) for the documentation. Please keep in mind that this document is still only informational. diff --git a/documentation-notes/replscript.md b/documentation-notes/replscript.md index c3063f2..7126495 100644 --- a/documentation-notes/replscript.md +++ b/documentation-notes/replscript.md @@ -1,4 +1,4 @@ -# 9.3 REPL vs Scripts +# 8.3 REPL vs Scripts Users of this documentation should be aware that examples given in the docs are under the expectation that they are being executed using the MicroPython REPL. This means that when certain functions are called, their output may not necessarily be printed to the console if they are run from a script. When using the REPL many classes/functions automatically produce a printed output displaying the return value of the function to the console. The code snippet below demonstrates some examples of classes/functions that might display this behaviour. diff --git a/documentation-notes/syntax.md b/documentation-notes/syntax.md index 61d4f8b..d78d3db 100644 --- a/documentation-notes/syntax.md +++ b/documentation-notes/syntax.md @@ -1,4 +1,4 @@ -# 9.2 Syntax +# 8.2 Syntax The Pycom documentation follows standard Python Library format using the popular Sphinx Docs tool. There are some notable points regarding the syntax of classes, methods and constants. Please see the notes below and familiarise yourself with the specific details before reviewing the documentation. diff --git a/firmware-and-api-reference/notes.md b/firmware-and-api-reference/notes.md new file mode 100644 index 0000000..57db98d --- /dev/null +++ b/firmware-and-api-reference/notes.md @@ -0,0 +1,16 @@ +# 5.4 Notes + +## Interrupt Handling + +In Pycom’s ESP32 MicroPython port there are no restrictions on what can be done within an interrupt handler. For example, other ports do not allow allocating memory inside the handler or the use of sockets. + +These limitations were raised by handling the interrupt events differently. When an interrupt happens, a message is posted into a queue, notifying a separate thread that the appropriate callback handler should be called. Such handler would receive an argument. By default it is the object associated with the event. + +The user can do whatever is required inside of the callback, such as creating new variables, or even sending network packets. Bear in mind that interrupts are processed sequentially and thus it is ideal to keep the handlers as short as possible in order to attend all of them in the minimum time. + +Currently, there are 2 classes that support interrupts; the [`Alarm`](pycom/machine/timer.md#class-timer-alarm-handler-none-s-ms-us-arg-none-periodic-false) and [`Pin`](pycom/machine/pin.md) classes. Both classes provide the `.callback()` method that enables the interrupt and registers the given handler. For more details about interrupt usage along with examples, please visit their respective sections. + +{% hint style="info" %} +Currently the interrupt system can queue up to **16 interrupts**. +{% endhint %} + diff --git a/firmware-and-api-reference/pycom/machine/pin.md b/firmware-and-api-reference/pycom/machine/pin.md index e4ab2a2..f2ebf29 100644 --- a/firmware-and-api-reference/pycom/machine/pin.md +++ b/firmware-and-api-reference/pycom/machine/pin.md @@ -119,7 +119,7 @@ p_in.callback(Pin.IRQ_FALLING | Pin.IRQ_RISING, pin_handler) ``` {% hint style="info" %} -For more information on how Pycom’s products handle interrupts, see [here](https://github.com/pycom/pycom-docs/tree/37661883902849b1a931ee273a23ae8e0f3d773e/chapter/toolsandfeatures/notes.md). +For more information on how Pycom’s products handle interrupts, see [here](../../notes.md#interrupt-handling). {% endhint %} ## Attributes diff --git a/firmware-and-api-reference/pycom/machine/timer.md b/firmware-and-api-reference/pycom/machine/timer.md index 062f65f..3fe8d6d 100644 --- a/firmware-and-api-reference/pycom/machine/timer.md +++ b/firmware-and-api-reference/pycom/machine/timer.md @@ -118,6 +118,6 @@ clock = Clock() ``` {% hint style="info" %} -For more information on how Pycom’s products handle interrupts, see [notes](https://github.com/pycom/pycom-docs/tree/37661883902849b1a931ee273a23ae8e0f3d773e/chapter/toolsandfeatures/notes.md). +For more information on how Pycom’s products handle interrupts, see [notes](../../notes.md#interrupt-handling). {% endhint %} diff --git a/getting-started/introduction.md b/getting-started/introduction.md index 5890283..be61ba0 100644 --- a/getting-started/introduction.md +++ b/getting-started/introduction.md @@ -1,6 +1,6 @@ # 1.0 Introduction -So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](../about/products.md) page before you place your order to ensure you know which accessories you might require. +So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](../products.md) page before you place your order to ensure you know which accessories you might require. ![](../.gitbook/assets/getting_started.png) diff --git a/license/license.md b/license.md similarity index 98% rename from license/license.md rename to license.md index f3b1eb5..2d64517 100644 --- a/license/license.md +++ b/license.md @@ -1,4 +1,4 @@ -# 11.1 License +# License The MIT License \(MIT\) diff --git a/products.md b/products.md new file mode 100644 index 0000000..33dc1e0 --- /dev/null +++ b/products.md @@ -0,0 +1,39 @@ +# Pycom Products + +## Pycom Products + +Below you will find tables of all Pycom products. These tables illustrate the functionality of our various products, their compatibility with each other, as well as what accessories are required to utilise certain functionality. + +## Development Boards + +| Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1 NB-IoT | +| :--- | :--- | :--- | :--- | :--- | :--- | +| [![](.gitbook/assets/wipy2.png) WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | | +| [![](.gitbook/assets/sipy%20%281%29.png) SiPy](product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | +| [![](.gitbook/assets/gpy.png) GPy](product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | +| [![](.gitbook/assets/lopy.png) LoPy](product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | +| [![](.gitbook/assets/lopy4%20%282%29.png) LoPy4](product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | +| [![](.gitbook/assets/fipy%20%282%29.png) FiPy](product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | +| Antennas [![](.gitbook/assets/wifi_ant.png) External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/)[![](.gitbook/assets/lora_ant.png) LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [![](.gitbook/assets/lte_ant.png) LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) | | | | | + +## Accessories + +| Accessory | [![](.gitbook/assets/expansion3.png) Expansion Board](product-info/boards/expansion3.md) | [![](.gitbook/assets/pysense_new.png) Pysense](product-info/boards/pysense.md) | [![](.gitbook/assets/pytrack_new.png) Pytrack](product-info/boards/pytrack.md) | [![](.gitbook/assets/pyscan.png) Pyscan](product-info/boards/pyscan.md) | +| :--- | :--- | :--- | :--- | :--- | +| [![](.gitbook/assets/pycase.png) PyCase](https://pycom.io/product/pycase/) | ✔ | | | | +| [![](.gitbook/assets/ip67_case_exp.png) IP67 Case for Expansion Board](https://pycom.io/product/ip67-expansion-board-case/) | ✔ | | | | +| [![](.gitbook/assets/ip67_case_py.png) IP67 Case for Pysense/Pytrack/Pyscan](https://pycom.io/product/ip67-case/) | | ✔ | ✔ | ✔ | +| [![](.gitbook/assets/ip67_case.png) IP67 Case \(universal\)](https://pycom.io/product/universal-ip67-case/) | ✔ | ✔ | ✔ | ✔ | +| ![](.gitbook/assets/lipo.jpg) LiPo Battery \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | +| ![](.gitbook/assets/microusb.png) Micro USB Cable Required \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | +| Pyscan Modules [![](.gitbook/assets/oled.png) OLED Module](https://pycom.io/product/oled-screen/)[![](.gitbook/assets/2mp.png) 2MP Camera](https://pycom.io/product/2mp-camera/)[![](.gitbook/assets/barcode.png) Barcode Reader](https://pycom.io/product/barcode-reader)[![](.gitbook/assets/fingerprint.png) Fingerprint Scanner](https://pycom.io/product/fingerprint-scanner/)[![](.gitbook/assets/ir.png) IR Image Sensor](https://pycom.io/product/infared-image-sensor/) | ✔ | | | | + +## OEM Modules + +| OEM Module | [![](.gitbook/assets/oem_l01_ref.png) L01/W01 Reference Board](product-info/oem/l01_reference.md) | [![](.gitbook/assets/oem_universal_ref.png) Universal Reference Board](product-info/oem/universal_reference.md) | +| :--- | :--- | :--- | +| [![](.gitbook/assets/w01%20%281%29.png) W01](product-info/oem/w01.md) | ✔ | ✔ | +| [![](.gitbook/assets/l01.png) L01](product-info/oem/l01.md) | ✔ | ✔ | +| [![](.gitbook/assets/l04.png) L04](product-info/oem/l04.md) | | ✔ | +| [![](.gitbook/assets/g01.png) G01](product-info/oem/g01.md) | | ✔ | + diff --git a/pybytes/add-device/README.md b/pybytes/add-device/README.md index 94d0727..3134e82 100644 --- a/pybytes/add-device/README.md +++ b/pybytes/add-device/README.md @@ -1,4 +1,4 @@ -# 8.3 Add a device to Pybytes +# 7.3 Add a device to Pybytes In this section, we will explain to you how to add a device to Pybytes diff --git a/pybytes/add-device/flash.md b/pybytes/add-device/flash.md index fa633ca..b7374f6 100644 --- a/pybytes/add-device/flash.md +++ b/pybytes/add-device/flash.md @@ -1,4 +1,4 @@ -# 8.3.2 Connect to Pybytes: Flash Pybytes library manually +# 7.3.2 Connect to Pybytes: Flash Pybytes library manually ## Connecting a device to Pybytes by flashing Pybytes library manually diff --git a/pybytes/add-device/quick.md b/pybytes/add-device/quick.md index 142b6a8..be1f9eb 100644 --- a/pybytes/add-device/quick.md +++ b/pybytes/add-device/quick.md @@ -1,4 +1,4 @@ -# 8.3.1 Connect to Pybytes: Quick Add +# 7.3.1 Connect to Pybytes: Quick Add ## Connecting a device to Pybytes quickly by using the Firmware Updater diff --git a/pybytes/add-device/sigfox/README.md b/pybytes/add-device/sigfox/README.md index d63c339..7ff35ff 100644 --- a/pybytes/add-device/sigfox/README.md +++ b/pybytes/add-device/sigfox/README.md @@ -1,4 +1,4 @@ -# 8.3.3 Add Sigfox device +# 7.3.3 Add Sigfox device {% hint style="danger" %} Before you start you need to create Sigfox account. You need Pycom device with Sigfox to get your Sigfox account. [**Follow these instructions**](../../../getting-started/registration/sigfox.md). diff --git a/pybytes/add-device/sigfox/custom.md b/pybytes/add-device/sigfox/custom.md index 229e9d3..e953e24 100644 --- a/pybytes/add-device/sigfox/custom.md +++ b/pybytes/add-device/sigfox/custom.md @@ -1,4 +1,4 @@ -# 8.3.3.2 Custom contract +# 7.3.3.2 Custom contract For building Sigfox application on Pybytes we recommend to [buy Sigfox contract](https://buy.sigfox.com/). diff --git a/pybytes/add-device/sigfox/devkit.md b/pybytes/add-device/sigfox/devkit.md index c7e2686..df8ec5f 100644 --- a/pybytes/add-device/sigfox/devkit.md +++ b/pybytes/add-device/sigfox/devkit.md @@ -1,4 +1,4 @@ -# 8.3.3.1 DevKit contract +# 7.3.3.1 DevKit contract Every Sigfox Pycom device comes with free Sigfox connectivity - Sigfox DevKit contract. It provides one year of Sigfox connectivity. This is great for prototyping. diff --git a/pybytes/getting-started.md b/pybytes/getting-started.md index beb7cd0..b8f4935 100644 --- a/pybytes/getting-started.md +++ b/pybytes/getting-started.md @@ -1,4 +1,4 @@ -# 8.2 Getting Started with Pybytes +# 7.2 Getting Started with Pybytes Follow these steps to create a Pybytes account: diff --git a/pybytes/introduction.md b/pybytes/introduction.md index 075c5a2..3a386df 100644 --- a/pybytes/introduction.md +++ b/pybytes/introduction.md @@ -1,4 +1,4 @@ -# 8.1 Introduction +# 7.1 Introduction ![](../.gitbook/assets/pybyteslogo.png) diff --git a/pybytes/visualise-data.md b/pybytes/visualise-data.md index 8cfc240..e702abc 100644 --- a/pybytes/visualise-data.md +++ b/pybytes/visualise-data.md @@ -1,4 +1,4 @@ -# 8.4 Visualise data from your device +# 7.4 Visualise data from your device In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes. diff --git a/tutorials-and-examples/all/timers.md b/tutorials-and-examples/all/timers.md index 3f18fc1..2d53fb6 100644 --- a/tutorials-and-examples/all/timers.md +++ b/tutorials-and-examples/all/timers.md @@ -1,6 +1,6 @@ # 4.2.12 Timers -Detailed information about this class can be found in [`Timer`](https://github.com/pycom/pycom-docs/tree/37661883902849b1a931ee273a23ae8e0f3d773e/chapter/firmwareapi/pycom/machine/Timer.html). +Detailed information about this class can be found in [`Timer`](../../firmware-and-api-reference/pycom/machine/timer.md). ## Chronometer @@ -48,6 +48,6 @@ clock = Clock() ``` {% hint style="info" %} -There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](timers.md). +There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](../../firmware-and-api-reference/notes.md#interrupt-handling). {% endhint %}