Skip to content
This repository was archived by the owner on Oct 29, 2018. It is now read-only.

Commit f07b725

Browse files
Daniel Spindelbauergitbook-bot
Daniel Spindelbauer
authored and
gitbook-bot
committed
GitBook: [master] 30 pages modified
1 parent be2101c commit f07b725

File tree

29 files changed

+100
-133
lines changed

29 files changed

+100
-133
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to the Pycom documentation site. The documentation is split into 5 secti
44

55
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.
66

7-
* [Products](about/products.md)
7+
* [Products](products.md)
88
* [Getting Started](getting-started/introduction.md)
99
* [Tutorials](tutorials-and-examples/introduction.md)
1010
* [Product Info](product-info/introduction.md)

‎SUMMARY.md

+22-33
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
* [Introduction](README.md)
44

5-
## About
6-
7-
* [Pycom Products](about/products.md)
8-
95
## 1. Getting Started
106

117
* [1.0 Introduction](getting-started/introduction.md)
@@ -35,6 +31,7 @@
3531
* [1.4.3 LoRaWAN](getting-started/registration/lora/README.md)
3632
* [1.4.3.1 The Things Network](getting-started/registration/lora/ttn.md)
3733
* [1.4.3.2 Objenious](getting-started/registration/lora/objenious.md)
34+
* [Pycom Products](products.md)
3835

3936
## 2. Pymakr Plugin
4037

@@ -149,6 +146,7 @@
149146
* [5.3.18 ustruct](firmware-and-api-reference/micropython/ustruct.md)
150147
* [5.3.19 \_thread](firmware-and-api-reference/micropython/_thread.md)
151148
* [5.3.20 Builtin](firmware-and-api-reference/micropython/builtin.md)
149+
* [5.4 Notes](firmware-and-api-reference/notes.md)
152150

153151
## 6. Product Info
154152

@@ -178,42 +176,33 @@
178176
* [6.3.6.1 Deep Sleep API](product-info/boards/deepsleep/api.md)
179177
* [6.4 Notes](product-info/notes.md)
180178

181-
## 7. Datasheets
182-
183-
* [7.1 Development Modules](datasheets/development.md)
184-
* [7.2 OEM Modules](datasheets/oem.md)
185-
* [7.3 Expansion Boards and Shields](datasheets/boards.md)
186-
187-
## 8. Pybytes
188-
189-
* [8.1 Introduction](pybytes/introduction.md)
190-
* [8.2 Getting Started with Pybytes](pybytes/getting-started.md)
191-
* [8.3 Add a device to Pybytes](pybytes/add-device/README.md)
192-
* [8.3.1 Connect to Pybytes: Quick Add](pybytes/add-device/quick.md)
193-
* [8.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md)
194-
* [8.3.3 Add Sigfox device](pybytes/add-device/sigfox/README.md)
195-
* [8.3.3.1 DevKit contract](pybytes/add-device/sigfox/devkit.md)
196-
* [8.3.3.2 Custom contract](pybytes/add-device/sigfox/custom.md)
197-
* [8.4 Visualise data from your device](pybytes/visualise-data.md)
198-
199-
## 9. Documentation Notes
179+
## 7. Pybytes
200180

201-
* [9.1 Introduction](documentation-notes/introduction.md)
202-
* [9.2 Syntax](documentation-notes/syntax.md)
203-
* [9.3 REPL vs Scripts](documentation-notes/replscript.md)
204-
* [9.4 Mesh Networks](documentation-notes/mesh-networks.md)
181+
* [7.1 Introduction](pybytes/introduction.md)
182+
* [7.2 Getting Started with Pybytes](pybytes/getting-started.md)
183+
* [7.3 Add a device to Pybytes](pybytes/add-device/README.md)
184+
* [7.3.1 Connect to Pybytes: Quick Add](pybytes/add-device/quick.md)
185+
* [7.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md)
186+
* [7.3.3 Add Sigfox device](pybytes/add-device/sigfox/README.md)
187+
* [7.3.3.1 DevKit contract](pybytes/add-device/sigfox/devkit.md)
188+
* [7.3.3.2 Custom contract](pybytes/add-device/sigfox/custom.md)
189+
* [7.4 Visualise data from your device](pybytes/visualise-data.md)
205190

206-
## 10. Advanced Topics
191+
## 8. Documentation Notes
207192

208-
* [10.1 Firmware Downgrade](advanced-topics/downgrade.md)
209-
* [10.2 CLI Updater](advanced-topics/cli.md)
210-
* [10.3 SecureBoot and Encryption](advanced-topics/encryption.md)
193+
* [8.1 Introduction](documentation-notes/introduction.md)
194+
* [8.2 Syntax](documentation-notes/syntax.md)
195+
* [8.3 REPL vs Scripts](documentation-notes/replscript.md)
196+
* [8.4 Mesh Networks](documentation-notes/mesh-networks.md)
211197

212-
## 11. License
198+
## 9. Advanced Topics
213199

214-
* [11.1 License](license/license.md)
200+
* [9.1 Firmware Downgrade](advanced-topics/downgrade.md)
201+
* [9.2 CLI Updater](advanced-topics/cli.md)
202+
* [9.3 SecureBoot and Encryption](advanced-topics/encryption.md)
215203

216204
## Have a question?
217205

218206
* [Ask on the Forum](https://forum.pycom.io)
207+
* [License](license.md)
219208

‎about/products.md

-39
This file was deleted.

‎advanced-topics/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 10.2 CLI Updater
1+
# 9.2 CLI Updater
22

33
## Command Line Update Utility
44

‎advanced-topics/downgrade.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 10.1 Firmware Downgrade
1+
# 9.1 Firmware Downgrade
22

33
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.
44

‎advanced-topics/encryption.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 10.3 SecureBoot and Encryption
1+
# 9.3 SecureBoot and Encryption
22

33
## Summary
44

‎datasheets/boards.md

-12
This file was deleted.

‎datasheets/development.md

-16
This file was deleted.

‎datasheets/oem.md

-10
This file was deleted.

‎documentation-notes/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 9.1 Introduction
1+
# 8.1 Introduction
22

33
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.
44

‎documentation-notes/mesh-networks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 9.4 Mesh Networks
1+
# 8.4 Mesh Networks
22

33
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.
44

‎documentation-notes/replscript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 9.3 REPL vs Scripts
1+
# 8.3 REPL vs Scripts
22

33
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.
44

‎documentation-notes/syntax.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 9.2 Syntax
1+
# 8.2 Syntax
22

33
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.
44

‎firmware-and-api-reference/notes.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 5.4 Notes
2+
3+
## Interrupt Handling
4+
5+
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.
6+
7+
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.
8+
9+
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.
10+
11+
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.
12+
13+
{% hint style="info" %}
14+
Currently the interrupt system can queue up to **16 interrupts**.
15+
{% endhint %}
16+

‎firmware-and-api-reference/pycom/machine/pin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ p_in.callback(Pin.IRQ_FALLING | Pin.IRQ_RISING, pin_handler)
119119
```
120120

121121
{% hint style="info" %}
122-
For more information on how Pycom’s products handle interrupts, see [here](https://github.com/pycom/pycom-docs/tree/37661883902849b1a931ee273a23ae8e0f3d773e/chapter/toolsandfeatures/notes.md).
122+
For more information on how Pycom’s products handle interrupts, see [here](../../notes.md#interrupt-handling).
123123
{% endhint %}
124124

125125
## Attributes

‎firmware-and-api-reference/pycom/machine/timer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,6 @@ clock = Clock()
118118
```
119119

120120
{% hint style="info" %}
121-
For more information on how Pycom’s products handle interrupts, see [notes](https://github.com/pycom/pycom-docs/tree/37661883902849b1a931ee273a23ae8e0f3d773e/chapter/toolsandfeatures/notes.md).
121+
For more information on how Pycom’s products handle interrupts, see [notes](../../notes.md#interrupt-handling).
122122
{% endhint %}
123123

‎getting-started/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 1.0 Introduction
22

3-
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.
3+
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.
44

55
![](../.gitbook/assets/getting_started.png)
66

‎license/license.md ‎license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 11.1 License
1+
# License
22

33
The MIT License \(MIT\)
44

‎products.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Pycom Products
2+
3+
## Pycom Products
4+
5+
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.
6+
7+
## Development Boards
8+
9+
| Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1 NB-IoT |
10+
| :--- | :--- | :--- | :--- | :--- | :--- |
11+
| [![](.gitbook/assets/wipy2.png) WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | |
12+
| [![](.gitbook/assets/sipy%20%281%29.png) SiPy](product-info/development/sipy.md) | ✔ | ✔ | | ✔ | |
13+
| [![](.gitbook/assets/gpy.png) GPy](product-info/development/gpy.md) | ✔ | ✔ | | | ✔ |
14+
| [![](.gitbook/assets/lopy.png) LoPy](product-info/development/lopy.md) | ✔ | ✔ | ✔ | | |
15+
| [![](.gitbook/assets/lopy4%20%282%29.png) LoPy4](product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | |
16+
| [![](.gitbook/assets/fipy%20%282%29.png) FiPy](product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ |
17+
| 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/) | | | | |
18+
19+
## Accessories
20+
21+
| 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) |
22+
| :--- | :--- | :--- | :--- | :--- |
23+
| [![](.gitbook/assets/pycase.png) PyCase](https://pycom.io/product/pycase/) | ✔ | | | |
24+
| [![](.gitbook/assets/ip67_case_exp.png) IP67 Case for Expansion Board](https://pycom.io/product/ip67-expansion-board-case/) | ✔ | | | |
25+
| [![](.gitbook/assets/ip67_case_py.png) IP67 Case for Pysense/Pytrack/Pyscan](https://pycom.io/product/ip67-case/) | | ✔ | ✔ | ✔ |
26+
| [![](.gitbook/assets/ip67_case.png) IP67 Case \(universal\)](https://pycom.io/product/universal-ip67-case/) | ✔ | ✔ | ✔ | ✔ |
27+
| ![](.gitbook/assets/lipo.jpg) LiPo Battery \(user-supplied\) | ✔ | ✔ | ✔ | ✔ |
28+
| ![](.gitbook/assets/microusb.png) Micro USB Cable Required \(user-supplied\) | ✔ | ✔ | ✔ | ✔ |
29+
| 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/) | ✔ | | | |
30+
31+
## OEM Modules
32+
33+
| 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) |
34+
| :--- | :--- | :--- |
35+
| [![](.gitbook/assets/w01%20%281%29.png) W01](product-info/oem/w01.md) | ✔ | ✔ |
36+
| [![](.gitbook/assets/l01.png) L01](product-info/oem/l01.md) | ✔ | ✔ |
37+
| [![](.gitbook/assets/l04.png) L04](product-info/oem/l04.md) | | ✔ |
38+
| [![](.gitbook/assets/g01.png) G01](product-info/oem/g01.md) | | ✔ |
39+

‎pybytes/add-device/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3 Add a device to Pybytes
1+
# 7.3 Add a device to Pybytes
22

33
In this section, we will explain to you how to add a device to Pybytes
44

‎pybytes/add-device/flash.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3.2 Connect to Pybytes: Flash Pybytes library manually
1+
# 7.3.2 Connect to Pybytes: Flash Pybytes library manually
22

33
## Connecting a device to Pybytes by flashing Pybytes library manually
44

‎pybytes/add-device/quick.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3.1 Connect to Pybytes: Quick Add
1+
# 7.3.1 Connect to Pybytes: Quick Add
22

33
## Connecting a device to Pybytes quickly by using the Firmware Updater
44

‎pybytes/add-device/sigfox/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3.3 Add Sigfox device
1+
# 7.3.3 Add Sigfox device
22

33
{% hint style="danger" %}
44
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).

‎pybytes/add-device/sigfox/custom.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3.3.2 Custom contract
1+
# 7.3.3.2 Custom contract
22

33
For building Sigfox application on Pybytes we recommend to [buy Sigfox contract](https://buy.sigfox.com/).
44

‎pybytes/add-device/sigfox/devkit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.3.3.1 DevKit contract
1+
# 7.3.3.1 DevKit contract
22

33
Every Sigfox Pycom device comes with free Sigfox connectivity - Sigfox DevKit contract. It provides one year of Sigfox connectivity. This is great for prototyping.
44

‎pybytes/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.2 Getting Started with Pybytes
1+
# 7.2 Getting Started with Pybytes
22

33
Follow these steps to create a Pybytes account:
44

‎pybytes/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.1 Introduction
1+
# 7.1 Introduction
22

33
![](../.gitbook/assets/pybyteslogo.png)
44

‎pybytes/visualise-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 8.4 Visualise data from your device
1+
# 7.4 Visualise data from your device
22

33
In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes.
44

0 commit comments

Comments
 (0)