From 78cc91b995d57190ceadb3a05df6e04c6c5687a9 Mon Sep 17 00:00:00 2001 From: Daniel Spindelbauer Date: Wed, 15 Aug 2018 13:01:04 +0000 Subject: [PATCH] GitBook: [master] 173 pages modified --- README.md | 2 + SUMMARY.md | 364 +++++++++--------- advanced-topics/cli.md | 2 +- advanced-topics/downgrade.md | 2 +- advanced-topics/encryption.md | 2 +- documentation-notes/introduction.md | 2 +- documentation-notes/mesh-networks.md | 2 +- documentation-notes/replscript.md | 2 +- documentation-notes/syntax.md | 2 +- firmware-and-api-reference/introduction.md | 2 +- .../micropython/README.md | 2 +- .../micropython/_thread.md | 2 +- .../micropython/array.md | 2 +- .../micropython/builtin.md | 2 +- .../micropython/cmath.md | 2 +- firmware-and-api-reference/micropython/gc.md | 2 +- .../micropython/math.md | 2 +- .../micropython/micropython.md | 2 +- .../micropython/select.md | 2 +- firmware-and-api-reference/micropython/sys.md | 2 +- .../micropython/ubinascii.md | 2 +- .../micropython/ucrypto.md | 2 +- .../micropython/uctypes.md | 2 +- .../micropython/uhashlib.md | 2 +- .../micropython/ujson.md | 2 +- firmware-and-api-reference/micropython/uos.md | 2 +- firmware-and-api-reference/micropython/ure.md | 2 +- .../micropython/usocket.md | 2 +- .../micropython/ussl.md | 2 +- .../micropython/ustruct.md | 2 +- .../micropython/utime.md | 2 +- firmware-and-api-reference/notes.md | 2 +- firmware-and-api-reference/pycom/README.md | 2 +- firmware-and-api-reference/pycom/aes.md | 2 +- .../pycom/machine/README.md | 2 +- .../pycom/machine/adc.md | 2 +- .../pycom/machine/can.md | 2 +- .../pycom/machine/dac.md | 2 +- .../pycom/machine/i2c.md | 2 +- .../pycom/machine/pin.md | 2 +- .../pycom/machine/pwm.md | 2 +- .../pycom/machine/rmt.md | 2 +- .../pycom/machine/rtc.md | 2 +- .../pycom/machine/sd.md | 2 +- .../pycom/machine/spi.md | 2 +- .../pycom/machine/timer.md | 2 +- .../pycom/machine/uart.md | 2 +- .../pycom/machine/wdt.md | 2 +- .../pycom/network/README.md | 2 +- .../pycom/network/bluetooth/README.md | 2 +- .../pycom/network/bluetooth/gatt.md | 2 +- .../network/bluetooth/gattccharacteristic.md | 2 +- .../network/bluetooth/gattcconnection.md | 2 +- .../pycom/network/bluetooth/gattccservice.md | 2 +- .../network/bluetooth/gattscharacteristic.md | 2 +- .../pycom/network/bluetooth/gattsservice.md | 2 +- .../pycom/network/lora.md | 2 +- .../pycom/network/lte.md | 2 +- .../pycom/network/server.md | 2 +- .../pycom/network/sigfox.md | 2 +- .../pycom/network/wlan.md | 2 +- firmware-and-api-reference/pycom/pycom.md | 2 +- getting-started/hardware/README.md | 2 +- getting-started/hardware/fipy.md | 2 +- getting-started/hardware/gpy.md | 2 +- getting-started/hardware/lopy.md | 2 +- getting-started/hardware/lopy4.md | 2 +- getting-started/hardware/sipy.md | 2 +- getting-started/hardware/wipy.md | 2 +- getting-started/introduction.md | 2 +- getting-started/programming/README.md | 2 +- getting-started/programming/examples.md | 2 +- getting-started/programming/first-project.md | 2 +- getting-started/programming/ftp.md | 2 +- getting-started/programming/micropython.md | 2 +- getting-started/programming/repl/README.md | 2 +- getting-started/programming/repl/serial.md | 2 +- getting-started/programming/repl/telnet.md | 2 +- getting-started/programming/safeboot.md | 2 +- getting-started/registration/README.md | 2 +- getting-started/registration/cellular.md | 2 +- getting-started/registration/lora/README.md | 2 +- .../registration/lora/objenious.md | 2 +- getting-started/registration/lora/ttn.md | 2 +- getting-started/registration/sigfox.md | 2 +- getting-started/software/README.md | 2 +- getting-started/software/drivers.md | 2 +- getting-started/software/firmwaretool.md | 2 +- getting-started/software/pymakr.md | 2 +- product-info/boards/README.md | 16 +- product-info/boards/deepsleep/README.md | 2 +- product-info/boards/deepsleep/api.md | 2 +- product-info/boards/expansion2.md | 2 +- product-info/boards/expansion3.md | 2 +- product-info/boards/pyscan.md | 2 +- product-info/boards/pysense.md | 2 +- product-info/boards/pytrack.md | 2 +- product-info/development/README.md | 24 +- product-info/development/fipy.md | 2 +- product-info/development/gpy.md | 2 +- 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 +- product-info/introduction.md | 58 ++- product-info/notes.md | 2 +- product-info/oem/README.md | 19 +- product-info/oem/g01.md | 2 +- product-info/oem/l01.md | 2 +- product-info/oem/l01_reference.md | 2 +- product-info/oem/l04.md | 2 +- product-info/oem/universal_reference.md | 2 +- product-info/oem/w01.md | 2 +- pybytes/add-device/README.md | 2 +- pybytes/add-device/flash.md | 2 +- pybytes/add-device/quick.md | 2 +- pybytes/add-device/sigfox/README.md | 2 +- pybytes/add-device/sigfox/custom.md | 2 +- pybytes/add-device/sigfox/devkit.md | 2 +- pybytes/getting-started.md | 2 +- pybytes/introduction.md | 2 +- pybytes/visualise-data.md | 2 +- pymakr/features.md | 2 +- pymakr/installation/README.md | 2 +- pymakr/installation/atom.md | 2 +- pymakr/installation/vscode.md | 2 +- pymakr/settings.md | 2 +- pytrack-pysense-pyscan/apireference/README.md | 2 +- pytrack-pysense-pyscan/apireference/pyscan.md | 2 +- .../apireference/pysense.md | 2 +- .../apireference/pytrack.md | 2 +- pytrack-pysense-pyscan/apireference/sleep.md | 2 +- pytrack-pysense-pyscan/installation/README.md | 2 +- .../installation/drivers.md | 2 +- .../installation/firmware.md | 2 +- .../installation/libraries.md | 2 +- pytrack-pysense-pyscan/introduction.md | 2 +- tutorials-and-examples/all/README.md | 2 +- tutorials-and-examples/all/adc.md | 2 +- tutorials-and-examples/all/aws.md | 2 +- tutorials-and-examples/all/ble.md | 2 +- tutorials-and-examples/all/https.md | 2 +- tutorials-and-examples/all/i2c.md | 2 +- tutorials-and-examples/all/modbus.md | 2 +- tutorials-and-examples/all/mqtt.md | 2 +- tutorials-and-examples/all/ota.md | 2 +- tutorials-and-examples/all/owd.md | 2 +- tutorials-and-examples/all/pir.md | 2 +- tutorials-and-examples/all/repl.md | 2 +- tutorials-and-examples/all/rgbled.md | 2 +- tutorials-and-examples/all/rmt.md | 2 +- tutorials-and-examples/all/threading.md | 2 +- tutorials-and-examples/all/timers.md | 2 +- tutorials-and-examples/all/wlan.md | 2 +- tutorials-and-examples/introduction.md | 2 +- tutorials-and-examples/lora/README.md | 2 +- .../lora/lora-mac-nano-gateway.md | 2 +- tutorials-and-examples/lora/lora-mac.md | 2 +- tutorials-and-examples/lora/lorawan-abp.md | 2 +- .../lora/lorawan-nano-gateway.md | 2 +- tutorials-and-examples/lora/lorawan-otaa.md | 2 +- tutorials-and-examples/lora/module-module.md | 2 +- tutorials-and-examples/lora/rn2483-to-lopy.md | 2 +- tutorials-and-examples/lte/README.md | 2 +- tutorials-and-examples/lte/cat-m1.md | 2 +- tutorials-and-examples/lte/firmware.md | 2 +- tutorials-and-examples/lte/imei.md | 2 +- tutorials-and-examples/lte/nb-iot.md | 2 +- tutorials-and-examples/pyscan.md | 2 +- tutorials-and-examples/pysense.md | 2 +- tutorials-and-examples/pytrack.md | 2 +- tutorials-and-examples/sigfox.md | 2 +- 173 files changed, 431 insertions(+), 386 deletions(-) diff --git a/README.md b/README.md index c25d552..ffce601 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,5 @@ To get started, read through the Getting Started Guide then feel free to jump st * [API Documentation](firmware-and-api-reference/introduction.md) * [Pybytes](pybytes/introduction.md) + + diff --git a/SUMMARY.md b/SUMMARY.md index 2aca02f..3e16511 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,205 +1,205 @@ # Table of contents * [Introduction](README.md) - -## 1. Getting Started - -* [1.0 Introduction](getting-started/introduction.md) -* [1.1 Hardware Setup](getting-started/hardware/README.md) - * [1.1.1 LoPy](getting-started/hardware/lopy.md) - * [1.1.2 LoPy4](getting-started/hardware/lopy4.md) - * [1.1.3 SiPy](getting-started/hardware/sipy.md) - * [1.1.4 GPy](getting-started/hardware/gpy.md) - * [1.1.5 FiPy](getting-started/hardware/fipy.md) - * [1.1.6 WiPy](getting-started/hardware/wipy.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.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) - * [1.3.5 FTP](getting-started/programming/ftp.md) - * [1.3.6 Safe boot](getting-started/programming/safeboot.md) -* [1.4 Device Registration](getting-started/registration/README.md) - * [1.4.1 Sigfox](getting-started/registration/sigfox.md) - * [1.4.2 Cellular](getting-started/registration/cellular.md) - * [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 +## Getting Started -* [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) +* [Introduction](getting-started/introduction.md) +* [Hardware Setup](getting-started/hardware/README.md) + * [LoPy](getting-started/hardware/lopy.md) + * [LoPy 4](getting-started/hardware/lopy4.md) + * [SiPy](getting-started/hardware/sipy.md) + * [GPy](getting-started/hardware/gpy.md) + * [FiPy](getting-started/hardware/fipy.md) + * [WiPy](getting-started/hardware/wipy.md) +* [Software](getting-started/software/README.md) + * [Drivers](getting-started/software/drivers.md) + * [Updating Firmware](getting-started/software/firmwaretool.md) + * [Pymakr](getting-started/software/pymakr.md) +* [Programming the modules](getting-started/programming/README.md) + * [Introduction to MicroPython](getting-started/programming/micropython.md) + * [MicroPython Examples](getting-started/programming/examples.md) + * [Your first Pymakr project](getting-started/programming/first-project.md) + * [REPL](getting-started/programming/repl/README.md) + * [Serial USB \(UART\)](getting-started/programming/repl/serial.md) + * [Telnet REPL](getting-started/programming/repl/telnet.md) + * [FTP](getting-started/programming/ftp.md) + * [Safe boot](getting-started/programming/safeboot.md) +* [Device Registration](getting-started/registration/README.md) + * [Sigfox](getting-started/registration/sigfox.md) + * [Cellular](getting-started/registration/cellular.md) + * [LoRaWAN](getting-started/registration/lora/README.md) + * [The Things Network](getting-started/registration/lora/ttn.md) + * [Objenious](getting-started/registration/lora/objenious.md) -## 3. Pytrack, Pysense, Pyscan +## Pymakr Plugin -* [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) - * [3.2.3 Installing Libraries](pytrack-pysense-pyscan/installation/libraries.md) -* [3.3 API Reference](pytrack-pysense-pyscan/apireference/README.md) - * [3.3.1 Pytrack](pytrack-pysense-pyscan/apireference/pytrack.md) - * [3.3.2 Pysense](pytrack-pysense-pyscan/apireference/pysense.md) - * [3.3.4 Pyscan](pytrack-pysense-pyscan/apireference/pyscan.md) - * [3.3.5 Sleep](pytrack-pysense-pyscan/apireference/sleep.md) +* [Installation](pymakr/installation/README.md) + * [Atom](pymakr/installation/atom.md) + * [Visual Studio Code](pymakr/installation/vscode.md) +* [Tools/Features](pymakr/features.md) +* [Settings](pymakr/settings.md) -## 4. Tutorials & Examples +## Pytrack, Pysense, Pyscan -* [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) - * [4.2.3 Bluetooth](tutorials-and-examples/all/ble.md) - * [4.2.4 HTTPS](tutorials-and-examples/all/https.md) - * [4.2.5 MQTT](tutorials-and-examples/all/mqtt.md) - * [4.2.6 AWS](tutorials-and-examples/all/aws.md) - * [4.2.7 ADC](tutorials-and-examples/all/adc.md) - * [4.2.8 I2C](tutorials-and-examples/all/i2c.md) - * [4.2.9 Onewire Driver](tutorials-and-examples/all/owd.md) - * [4.2.10 Threading](tutorials-and-examples/all/threading.md) - * [4.2.11 RGB LED](tutorials-and-examples/all/rgbled.md) - * [4.2.12 Timers](tutorials-and-examples/all/timers.md) - * [4.2.13 PIR Sensor](tutorials-and-examples/all/pir.md) - * [4.2.14 Modbus](tutorials-and-examples/all/modbus.md) - * [4.2.15 OTA update](tutorials-and-examples/all/ota.md) - * [4.2.16 RMT](tutorials-and-examples/all/rmt.md) -* [4.3 LoRa Examples](tutorials-and-examples/lora/README.md) - * [4.3.1 LoRa-MAC \(Raw LoRa\)](tutorials-and-examples/lora/lora-mac.md) - * [4.3.2 LoRaWAN with OTAA](tutorials-and-examples/lora/lorawan-otaa.md) - * [4.3.3 LoRaWAN with ABP](tutorials-and-examples/lora/lorawan-abp.md) - * [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/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.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) -* [4.7 Pysense Examples](tutorials-and-examples/pysense.md) -* [4.8 Pyscan Examples](tutorials-and-examples/pyscan.md) +* [Introduction](pytrack-pysense-pyscan/introduction.md) +* [Installing Software](pytrack-pysense-pyscan/installation/README.md) + * [Updating Firmware](pytrack-pysense-pyscan/installation/firmware.md) + * [Installing Drivers - Windows 7](pytrack-pysense-pyscan/installation/drivers.md) + * [Installing Libraries](pytrack-pysense-pyscan/installation/libraries.md) +* [API Reference](pytrack-pysense-pyscan/apireference/README.md) + * [Pytrack](pytrack-pysense-pyscan/apireference/pytrack.md) + * [Pysense](pytrack-pysense-pyscan/apireference/pysense.md) + * [Pyscan](pytrack-pysense-pyscan/apireference/pyscan.md) + * [Sleep](pytrack-pysense-pyscan/apireference/sleep.md) -## 5. Firmware & API Reference +## Tutorials & Examples -* [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) - * [5.2.1.2 DAC](firmware-and-api-reference/pycom/machine/dac.md) - * [5.2.1.3 I2C](firmware-and-api-reference/pycom/machine/i2c.md) - * [5.2.1.4 Pin](firmware-and-api-reference/pycom/machine/pin.md) - * [5.2.1.5 PWM](firmware-and-api-reference/pycom/machine/pwm.md) - * [5.2.1.6 RTC](firmware-and-api-reference/pycom/machine/rtc.md) - * [5.2.1.7 SPI](firmware-and-api-reference/pycom/machine/spi.md) - * [5.2.1.8 UART](firmware-and-api-reference/pycom/machine/uart.md) - * [5.2.1.9 WDT](firmware-and-api-reference/pycom/machine/wdt.md) - * [5.2.1.10 Timer](firmware-and-api-reference/pycom/machine/timer.md) - * [5.2.1.11 SD](firmware-and-api-reference/pycom/machine/sd.md) - * [5.2.1.12 CAN](firmware-and-api-reference/pycom/machine/can.md) - * [5.2.1.13 RMT](firmware-and-api-reference/pycom/machine/rmt.md) - * [5.2.2 network](firmware-and-api-reference/pycom/network/README.md) - * [5.2.2.1 WLAN](firmware-and-api-reference/pycom/network/wlan.md) - * [5.2.2.2 Server](firmware-and-api-reference/pycom/network/server.md) - * [5.2.2.3 Bluetooth](firmware-and-api-reference/pycom/network/bluetooth/README.md) - * [5.2.2.3.1 GATT](firmware-and-api-reference/pycom/network/bluetooth/gatt.md) - * [5.2.2.3.2 GATTCConnection](firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) - * [5.2.2.3.3 GATTCService](firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) - * [5.2.2.3.4 GATTCCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) - * [5.2.2.3.5 GATTSService](firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) - * [5.2.2.3.6 GATTSCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) - * [5.2.2.4 LoRa](firmware-and-api-reference/pycom/network/lora.md) - * [5.2.2.5 Sigfox](firmware-and-api-reference/pycom/network/sigfox.md) - * [5.2.2.6 LTE](firmware-and-api-reference/pycom/network/lte.md) - * [5.2.3 AES](firmware-and-api-reference/pycom/aes.md) - * [5.2.4 pycom](firmware-and-api-reference/pycom/pycom.md) -* [5.3 MicroPython Modules](firmware-and-api-reference/micropython/README.md) - * [5.3.1 micropython](firmware-and-api-reference/micropython/micropython.md) - * [5.3.2 uctypes](firmware-and-api-reference/micropython/uctypes.md) - * [5.3.3 sys](firmware-and-api-reference/micropython/sys.md) - * [5.3.4 uos](firmware-and-api-reference/micropython/uos.md) - * [5.3.5 array](firmware-and-api-reference/micropython/array.md) - * [5.3.6 cmath](firmware-and-api-reference/micropython/cmath.md) - * [5.3.7 math](firmware-and-api-reference/micropython/math.md) - * [5.3.8 gc](firmware-and-api-reference/micropython/gc.md) - * [5.3.9 ubinascii](firmware-and-api-reference/micropython/ubinascii.md) - * [5.3.10 ujson](firmware-and-api-reference/micropython/ujson.md) - * [5.3.11 ure](firmware-and-api-reference/micropython/ure.md) - * [5.3.12 usocket](firmware-and-api-reference/micropython/usocket.md) - * [5.3.13 select](firmware-and-api-reference/micropython/select.md) - * [5.3.14 utime](firmware-and-api-reference/micropython/utime.md) - * [5.3.15 uhashlib](firmware-and-api-reference/micropython/uhashlib.md) - * [5.3.16 ussl](firmware-and-api-reference/micropython/ussl.md) - * [5.3.17 ucrypto](firmware-and-api-reference/micropython/ucrypto.md) - * [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) +* [Introduction](tutorials-and-examples/introduction.md) +* [All Pycom Device Examples](tutorials-and-examples/all/README.md) + * [REPL](tutorials-and-examples/all/repl.md) + * [WLAN](tutorials-and-examples/all/wlan.md) + * [Bluetooth](tutorials-and-examples/all/ble.md) + * [HTTPS](tutorials-and-examples/all/https.md) + * [MQTT](tutorials-and-examples/all/mqtt.md) + * [AWS](tutorials-and-examples/all/aws.md) + * [ADC](tutorials-and-examples/all/adc.md) + * [I2C](tutorials-and-examples/all/i2c.md) + * [Onewire Driver](tutorials-and-examples/all/owd.md) + * [Threading](tutorials-and-examples/all/threading.md) + * [RGB LED](tutorials-and-examples/all/rgbled.md) + * [Timers](tutorials-and-examples/all/timers.md) + * [PIR Sensor](tutorials-and-examples/all/pir.md) + * [Modbus](tutorials-and-examples/all/modbus.md) + * [OTA update](tutorials-and-examples/all/ota.md) + * [RMT](tutorials-and-examples/all/rmt.md) +* [LoRa Examples](tutorials-and-examples/lora/README.md) + * [LoRa-MAC \(Raw LoRa\)](tutorials-and-examples/lora/lora-mac.md) + * [LoRaWAN with OTAA](tutorials-and-examples/lora/lorawan-otaa.md) + * [LoRaWAN with ABP](tutorials-and-examples/lora/lorawan-abp.md) + * [LoRa-MAC Nano-Gateway](tutorials-and-examples/lora/lora-mac-nano-gateway.md) + * [LoPy to LoPy](tutorials-and-examples/lora/module-module.md) + * [LoRaWAN Nano-Gateway](tutorials-and-examples/lora/lorawan-nano-gateway.md) + * [RN2483 to LoPy](tutorials-and-examples/lora/rn2483-to-lopy.md) +* [Sigfox Examples](tutorials-and-examples/sigfox.md) +* [LTE Examples](tutorials-and-examples/lte/README.md) + * [CAT-M1](tutorials-and-examples/lte/cat-m1.md) + * [NB-IoT](tutorials-and-examples/lte/nb-iot.md) + * [Module IMEI](tutorials-and-examples/lte/imei.md) + * [Modem Firmware Update](tutorials-and-examples/lte/firmware.md) +* [Pytrack Examples](tutorials-and-examples/pytrack.md) +* [Pysense Examples](tutorials-and-examples/pysense.md) +* [Pyscan Examples](tutorials-and-examples/pyscan.md) -## 6. Product Info +## Firmware & API Reference -* [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) - * [6.1.3 LoPy](product-info/development/lopy.md) - * [6.1.4 LoPy 4](product-info/development/lopy4.md) - * [6.1.5 SiPy](product-info/development/sipy.md) - * [6.1.6 GPy](product-info/development/gpy.md) - * [6.1.7 FiPy](product-info/development/fipy.md) -* [6.2 OEM Modules](product-info/oem/README.md) - * [6.2.1 W01](product-info/oem/w01.md) - * [6.2.2 L01](product-info/oem/l01.md) - * [6.2.3 L04](product-info/oem/l04.md) - * [6.2.4 G01](product-info/oem/g01.md) - * [6.2.5 L01 OEM Baseboard Reference](product-info/oem/l01_reference.md) - * [6.2.6 Universal OEM Baseboard Reference](product-info/oem/universal_reference.md) -* [6.3 Expansion Boards and Shields](product-info/boards/README.md) - * [6.3.1 Expansion Board 3.0](product-info/boards/expansion3.md) - * [6.3.2 Pytrack](product-info/boards/pytrack.md) - * [6.3.3 Pysense](product-info/boards/pysense.md) - * [6.3.4 Pyscan](product-info/boards/pyscan.md) - * [6.3.5 Expansion Board 2.0](product-info/boards/expansion2.md) - * [6.3.6 Deep Sleep Shield](product-info/boards/deepsleep/README.md) - * [6.3.6.1 Deep Sleep API](product-info/boards/deepsleep/api.md) -* [6.4 Notes](product-info/notes.md) +* [Introduction](firmware-and-api-reference/introduction.md) +* [Pycom Modules](firmware-and-api-reference/pycom/README.md) + * [machine](firmware-and-api-reference/pycom/machine/README.md) + * [ADC](firmware-and-api-reference/pycom/machine/adc.md) + * [DAC](firmware-and-api-reference/pycom/machine/dac.md) + * [I2C](firmware-and-api-reference/pycom/machine/i2c.md) + * [Pin](firmware-and-api-reference/pycom/machine/pin.md) + * [PWM](firmware-and-api-reference/pycom/machine/pwm.md) + * [RTC](firmware-and-api-reference/pycom/machine/rtc.md) + * [SPI](firmware-and-api-reference/pycom/machine/spi.md) + * [UART](firmware-and-api-reference/pycom/machine/uart.md) + * [WDT](firmware-and-api-reference/pycom/machine/wdt.md) + * [Timer](firmware-and-api-reference/pycom/machine/timer.md) + * [SD](firmware-and-api-reference/pycom/machine/sd.md) + * [CAN](firmware-and-api-reference/pycom/machine/can.md) + * [RMT](firmware-and-api-reference/pycom/machine/rmt.md) + * [network](firmware-and-api-reference/pycom/network/README.md) + * [WLAN](firmware-and-api-reference/pycom/network/wlan.md) + * [Server](firmware-and-api-reference/pycom/network/server.md) + * [Bluetooth](firmware-and-api-reference/pycom/network/bluetooth/README.md) + * [GATT](firmware-and-api-reference/pycom/network/bluetooth/gatt.md) + * [GATTCConnection](firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) + * [GATTCService](firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) + * [GATTCCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) + * [GATTSService](firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) + * [GATTSCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) + * [LoRa](firmware-and-api-reference/pycom/network/lora.md) + * [Sigfox](firmware-and-api-reference/pycom/network/sigfox.md) + * [LTE](firmware-and-api-reference/pycom/network/lte.md) + * [AES](firmware-and-api-reference/pycom/aes.md) + * [pycom](firmware-and-api-reference/pycom/pycom.md) +* [MicroPython Modules](firmware-and-api-reference/micropython/README.md) + * [micropython](firmware-and-api-reference/micropython/micropython.md) + * [uctypes](firmware-and-api-reference/micropython/uctypes.md) + * [sys](firmware-and-api-reference/micropython/sys.md) + * [uos](firmware-and-api-reference/micropython/uos.md) + * [array](firmware-and-api-reference/micropython/array.md) + * [cmath](firmware-and-api-reference/micropython/cmath.md) + * [math](firmware-and-api-reference/micropython/math.md) + * [gc](firmware-and-api-reference/micropython/gc.md) + * [ubinascii](firmware-and-api-reference/micropython/ubinascii.md) + * [ujson](firmware-and-api-reference/micropython/ujson.md) + * [ure](firmware-and-api-reference/micropython/ure.md) + * [usocket](firmware-and-api-reference/micropython/usocket.md) + * [select](firmware-and-api-reference/micropython/select.md) + * [utime](firmware-and-api-reference/micropython/utime.md) + * [uhashlib](firmware-and-api-reference/micropython/uhashlib.md) + * [ussl](firmware-and-api-reference/micropython/ussl.md) + * [ucrypto](firmware-and-api-reference/micropython/ucrypto.md) + * [ustruct](firmware-and-api-reference/micropython/ustruct.md) + * [\_thread](firmware-and-api-reference/micropython/_thread.md) + * [Builtin](firmware-and-api-reference/micropython/builtin.md) +* [Notes](firmware-and-api-reference/notes.md) -## 7. Pybytes +## Product Info -* [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) +* [Introduction](product-info/introduction.md) +* [Development Modules](product-info/development/README.md) + * [WiPy 2.0](product-info/development/wipy2.md) + * [WiPy 3.0](product-info/development/wipy3.md) + * [LoPy](product-info/development/lopy.md) + * [LoPy 4](product-info/development/lopy4.md) + * [SiPy](product-info/development/sipy.md) + * [GPy](product-info/development/gpy.md) + * [FiPy](product-info/development/fipy.md) +* [OEM Modules](product-info/oem/README.md) + * [W01](product-info/oem/w01.md) + * [L01](product-info/oem/l01.md) + * [L04](product-info/oem/l04.md) + * [G01](product-info/oem/g01.md) + * [L01 OEM Baseboard Reference](product-info/oem/l01_reference.md) + * [Universal OEM Baseboard Reference](product-info/oem/universal_reference.md) +* [Expansion Boards and Shields](product-info/boards/README.md) + * [Expansion Board 3.0](product-info/boards/expansion3.md) + * [Pytrack](product-info/boards/pytrack.md) + * [Pysense](product-info/boards/pysense.md) + * [Pyscan](product-info/boards/pyscan.md) + * [Expansion Board 2.0](product-info/boards/expansion2.md) + * [Deep Sleep Shield](product-info/boards/deepsleep/README.md) + * [Deep Sleep API](product-info/boards/deepsleep/api.md) +* [Notes](product-info/notes.md) -## 8. Documentation Notes +## Pybytes -* [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) +* [Introduction](pybytes/introduction.md) +* [Getting Started with Pybytes](pybytes/getting-started.md) +* [Add a device to Pybytes](pybytes/add-device/README.md) + * [Connect to Pybytes: Quick Add](pybytes/add-device/quick.md) + * [Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md) + * [Add Sigfox device](pybytes/add-device/sigfox/README.md) + * [DevKit contract](pybytes/add-device/sigfox/devkit.md) + * [Custom contract](pybytes/add-device/sigfox/custom.md) +* [Visualise data from your device](pybytes/visualise-data.md) -## 9. Advanced Topics +## Documentation Notes -* [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) +* [Introduction](documentation-notes/introduction.md) +* [Syntax](documentation-notes/syntax.md) +* [REPL vs Scripts](documentation-notes/replscript.md) +* [Mesh Networks](documentation-notes/mesh-networks.md) + +## Advanced Topics + +* [Firmware Downgrade](advanced-topics/downgrade.md) +* [CLI Updater](advanced-topics/cli.md) +* [SecureBoot and Encryption](advanced-topics/encryption.md) ## Have a question? diff --git a/advanced-topics/cli.md b/advanced-topics/cli.md index 4a6c4af..e367c85 100644 --- a/advanced-topics/cli.md +++ b/advanced-topics/cli.md @@ -1,4 +1,4 @@ -# 9.2 CLI Updater +# CLI Updater ## Command Line Update Utility diff --git a/advanced-topics/downgrade.md b/advanced-topics/downgrade.md index 7f09a81..7f3ef3c 100644 --- a/advanced-topics/downgrade.md +++ b/advanced-topics/downgrade.md @@ -1,4 +1,4 @@ -# 9.1 Firmware Downgrade +# 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 7f08932..1ef8d3d 100644 --- a/advanced-topics/encryption.md +++ b/advanced-topics/encryption.md @@ -1,4 +1,4 @@ -# 9.3 SecureBoot and Encryption +# SecureBoot and Encryption ## Summary diff --git a/documentation-notes/introduction.md b/documentation-notes/introduction.md index 90defc7..69449b9 100644 --- a/documentation-notes/introduction.md +++ b/documentation-notes/introduction.md @@ -1,4 +1,4 @@ -# 8.1 Introduction +# 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 ea6eeb2..9a7da06 100644 --- a/documentation-notes/mesh-networks.md +++ b/documentation-notes/mesh-networks.md @@ -1,4 +1,4 @@ -# 8.4 Mesh Networks +# 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 7126495..07e588f 100644 --- a/documentation-notes/replscript.md +++ b/documentation-notes/replscript.md @@ -1,4 +1,4 @@ -# 8.3 REPL vs Scripts +# 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 d78d3db..38454ce 100644 --- a/documentation-notes/syntax.md +++ b/documentation-notes/syntax.md @@ -1,4 +1,4 @@ -# 8.2 Syntax +# 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/introduction.md b/firmware-and-api-reference/introduction.md index 2e89639..f065fcc 100644 --- a/firmware-and-api-reference/introduction.md +++ b/firmware-and-api-reference/introduction.md @@ -1,4 +1,4 @@ -# 5.1 Introduction +# Introduction This chapter describes modules \(function and class libraries\) that are built into MicroPython. There are a number of categories for the available modules: diff --git a/firmware-and-api-reference/micropython/README.md b/firmware-and-api-reference/micropython/README.md index 28694f2..c84c996 100644 --- a/firmware-and-api-reference/micropython/README.md +++ b/firmware-and-api-reference/micropython/README.md @@ -1,4 +1,4 @@ -# 5.3 MicroPython Modules +# MicroPython Modules The following list contains the standard Python libraries, MicroPython-specific libraries and Pycom specific modules that are available on the Pycom devices. diff --git a/firmware-and-api-reference/micropython/_thread.md b/firmware-and-api-reference/micropython/_thread.md index df7b2ae..7b5a52e 100644 --- a/firmware-and-api-reference/micropython/_thread.md +++ b/firmware-and-api-reference/micropython/_thread.md @@ -1,4 +1,4 @@ -# 5.3.19 \_thread +# \_thread This module provides low-level primitives for working with multiple threads \(also called light-weight processes or tasks\) — multiple threads of control sharing their global data space. For synchronisation, simple locks \(also called mutexes or binary semaphores\) are provided. diff --git a/firmware-and-api-reference/micropython/array.md b/firmware-and-api-reference/micropython/array.md index 8839f23..16f75c0 100644 --- a/firmware-and-api-reference/micropython/array.md +++ b/firmware-and-api-reference/micropython/array.md @@ -1,4 +1,4 @@ -# 5.3.5 array +# array See [Python array](https://docs.python.org/3/library/array.html) for more information. diff --git a/firmware-and-api-reference/micropython/builtin.md b/firmware-and-api-reference/micropython/builtin.md index da64fe4..9314075 100644 --- a/firmware-and-api-reference/micropython/builtin.md +++ b/firmware-and-api-reference/micropython/builtin.md @@ -1,4 +1,4 @@ -# 5.3.20 Builtin +# Builtin All builtin functions are described here. They are also available via [builtins](builtin.md) module. diff --git a/firmware-and-api-reference/micropython/cmath.md b/firmware-and-api-reference/micropython/cmath.md index 02c5c9a..bae6213 100644 --- a/firmware-and-api-reference/micropython/cmath.md +++ b/firmware-and-api-reference/micropython/cmath.md @@ -1,4 +1,4 @@ -# 5.3.6 cmath +# cmath The `cmath` module provides some basic mathematical functions for working with complex numbers. Floating point support required for this module. diff --git a/firmware-and-api-reference/micropython/gc.md b/firmware-and-api-reference/micropython/gc.md index e82dd29..4d49d83 100644 --- a/firmware-and-api-reference/micropython/gc.md +++ b/firmware-and-api-reference/micropython/gc.md @@ -1,4 +1,4 @@ -# 5.3.8 gc +# gc ## Functions diff --git a/firmware-and-api-reference/micropython/math.md b/firmware-and-api-reference/micropython/math.md index 9c25178..450f493 100644 --- a/firmware-and-api-reference/micropython/math.md +++ b/firmware-and-api-reference/micropython/math.md @@ -1,4 +1,4 @@ -# 5.3.7 math +# math The math module provides some basic mathematical functions for working with floating-point numbers. Floating point support required for this module. diff --git a/firmware-and-api-reference/micropython/micropython.md b/firmware-and-api-reference/micropython/micropython.md index 75e0362..2b870fe 100644 --- a/firmware-and-api-reference/micropython/micropython.md +++ b/firmware-and-api-reference/micropython/micropython.md @@ -1,4 +1,4 @@ -# 5.3.1 micropython +# micropython ## Functions diff --git a/firmware-and-api-reference/micropython/select.md b/firmware-and-api-reference/micropython/select.md index 27947ec..7c90131 100644 --- a/firmware-and-api-reference/micropython/select.md +++ b/firmware-and-api-reference/micropython/select.md @@ -1,4 +1,4 @@ -# 5.3.13 select +# select This module provides functions to wait for events on streams \(select streams which are ready for operations\). diff --git a/firmware-and-api-reference/micropython/sys.md b/firmware-and-api-reference/micropython/sys.md index 3d031a5..7de4f97 100644 --- a/firmware-and-api-reference/micropython/sys.md +++ b/firmware-and-api-reference/micropython/sys.md @@ -1,4 +1,4 @@ -# 5.3.3 sys +# sys ## Functions diff --git a/firmware-and-api-reference/micropython/ubinascii.md b/firmware-and-api-reference/micropython/ubinascii.md index f9924c9..9e7871b 100644 --- a/firmware-and-api-reference/micropython/ubinascii.md +++ b/firmware-and-api-reference/micropython/ubinascii.md @@ -1,4 +1,4 @@ -# 5.3.9 ubinascii +# ubinascii This module implements conversions between binary data and various encodings of it in ASCII form \(in both directions\). diff --git a/firmware-and-api-reference/micropython/ucrypto.md b/firmware-and-api-reference/micropython/ucrypto.md index 0b7a01a..33963fb 100644 --- a/firmware-and-api-reference/micropython/ucrypto.md +++ b/firmware-and-api-reference/micropython/ucrypto.md @@ -1,4 +1,4 @@ -# 5.3.17 ucrypto +# ucrypto This module provides native support for cryptographic algorithms. It’s loosely based on PyCrypto. diff --git a/firmware-and-api-reference/micropython/uctypes.md b/firmware-and-api-reference/micropython/uctypes.md index c223a26..5cefc2a 100644 --- a/firmware-and-api-reference/micropython/uctypes.md +++ b/firmware-and-api-reference/micropython/uctypes.md @@ -1,4 +1,4 @@ -# 5.3.2 uctypes +# uctypes This module implements "foreign data interface" for MicroPython. The idea behind it is similar to CPython’s `ctypes` modules, but the actual API is different, streamlined and optimised for small size. The basic idea of the module is to define data structure layout with about the same power as the C language allows, and the access it using familiar dot-syntax to reference sub-fields. diff --git a/firmware-and-api-reference/micropython/uhashlib.md b/firmware-and-api-reference/micropython/uhashlib.md index 2be5dfb..b6ac905 100644 --- a/firmware-and-api-reference/micropython/uhashlib.md +++ b/firmware-and-api-reference/micropython/uhashlib.md @@ -1,4 +1,4 @@ -# 5.3.15 uhashlib +# uhashlib This module implements binary data hashing algorithms. MD5 and SHA are supported. By limitations in the hardware, only one active hashing operation is supported at a time. diff --git a/firmware-and-api-reference/micropython/ujson.md b/firmware-and-api-reference/micropython/ujson.md index 4dd7bcf..54ff968 100644 --- a/firmware-and-api-reference/micropython/ujson.md +++ b/firmware-and-api-reference/micropython/ujson.md @@ -1,4 +1,4 @@ -# 5.3.10 ujson +# ujson This modules allows to convert between Python objects and the JSON data format. diff --git a/firmware-and-api-reference/micropython/uos.md b/firmware-and-api-reference/micropython/uos.md index d5169e6..e053546 100644 --- a/firmware-and-api-reference/micropython/uos.md +++ b/firmware-and-api-reference/micropython/uos.md @@ -1,4 +1,4 @@ -# 5.3.4 uos +# uos The `uos` module contains functions for filesystem access and `urandom` function. diff --git a/firmware-and-api-reference/micropython/ure.md b/firmware-and-api-reference/micropython/ure.md index f549e10..4d51e81 100644 --- a/firmware-and-api-reference/micropython/ure.md +++ b/firmware-and-api-reference/micropython/ure.md @@ -1,4 +1,4 @@ -# 5.3.11 ure +# ure This module implements regular expression operations. Regular expression syntax supported is a subset of CPython re module \(and actually is a subset of POSIX extended regular expressions\). diff --git a/firmware-and-api-reference/micropython/usocket.md b/firmware-and-api-reference/micropython/usocket.md index 8ac2c41..3bc7a9c 100644 --- a/firmware-and-api-reference/micropython/usocket.md +++ b/firmware-and-api-reference/micropython/usocket.md @@ -1,4 +1,4 @@ -# 5.3.12 usocket +# usocket This module provides access to the BSD socket interface. diff --git a/firmware-and-api-reference/micropython/ussl.md b/firmware-and-api-reference/micropython/ussl.md index 272ef7a..0353455 100644 --- a/firmware-and-api-reference/micropython/ussl.md +++ b/firmware-and-api-reference/micropython/ussl.md @@ -1,4 +1,4 @@ -# 5.3.16 ussl +# ussl This module provides access to Transport Layer Security \(often known as "Secure Sockets Layer"\) encryption and peer authentication facilities for network sockets, both client-side and server-side. diff --git a/firmware-and-api-reference/micropython/ustruct.md b/firmware-and-api-reference/micropython/ustruct.md index 791bf33..f0f6a67 100644 --- a/firmware-and-api-reference/micropython/ustruct.md +++ b/firmware-and-api-reference/micropython/ustruct.md @@ -1,4 +1,4 @@ -# 5.3.18 ustruct +# ustruct See Python [struct](https://docs.python.org/3/library/struct.html) for more information. diff --git a/firmware-and-api-reference/micropython/utime.md b/firmware-and-api-reference/micropython/utime.md index 90b3a65..a06186d 100644 --- a/firmware-and-api-reference/micropython/utime.md +++ b/firmware-and-api-reference/micropython/utime.md @@ -1,4 +1,4 @@ -# 5.3.14 utime +# utime The `utime` module provides functions for getting the current time and date, measuring time intervals, and for delays. diff --git a/firmware-and-api-reference/notes.md b/firmware-and-api-reference/notes.md index 57db98d..23470ae 100644 --- a/firmware-and-api-reference/notes.md +++ b/firmware-and-api-reference/notes.md @@ -1,4 +1,4 @@ -# 5.4 Notes +# Notes ## Interrupt Handling diff --git a/firmware-and-api-reference/pycom/README.md b/firmware-and-api-reference/pycom/README.md index e41e0e2..25d7137 100644 --- a/firmware-and-api-reference/pycom/README.md +++ b/firmware-and-api-reference/pycom/README.md @@ -1,4 +1,4 @@ -# 5.2 Pycom Modules +# Pycom Modules These modules are specific to the Pycom devices and may have slightly different implementations to other variations of MicroPython \(i.e. for Non-Pycom devices\). Modules include those which support access to underlying hardware, e.g. I2C, SPI, WLAN, Bluetooth, etc. diff --git a/firmware-and-api-reference/pycom/aes.md b/firmware-and-api-reference/pycom/aes.md index 2b3cde6..9d6a391 100644 --- a/firmware-and-api-reference/pycom/aes.md +++ b/firmware-and-api-reference/pycom/aes.md @@ -1,4 +1,4 @@ -# 5.2.3 AES +# AES AES \(Advanced Encryption Standard\) is a symmetric block cipher standardised by NIST. It has a fixed data block size of 16 bytes. Its keys can be 128, 192, or 256 bits long. diff --git a/firmware-and-api-reference/pycom/machine/README.md b/firmware-and-api-reference/pycom/machine/README.md index 0655b1e..80a5876 100644 --- a/firmware-and-api-reference/pycom/machine/README.md +++ b/firmware-and-api-reference/pycom/machine/README.md @@ -1,4 +1,4 @@ -# 5.2.1 machine +# machine The `machine` module contains specific functions related to the board. diff --git a/firmware-and-api-reference/pycom/machine/adc.md b/firmware-and-api-reference/pycom/machine/adc.md index ee5d417..d2a116d 100644 --- a/firmware-and-api-reference/pycom/machine/adc.md +++ b/firmware-and-api-reference/pycom/machine/adc.md @@ -6,7 +6,7 @@ search: - ADCChannel --- -# 5.2.1.1 ADC +# ADC ## class ADC – Analog to Digital Conversion diff --git a/firmware-and-api-reference/pycom/machine/can.md b/firmware-and-api-reference/pycom/machine/can.md index 53848fa..2fee506 100644 --- a/firmware-and-api-reference/pycom/machine/can.md +++ b/firmware-and-api-reference/pycom/machine/can.md @@ -1,4 +1,4 @@ -# 5.2.1.12 CAN +# CAN The CAN class supports the full CAN 2.0 specification with standard and extended frames, as well as acceptance filtering. diff --git a/firmware-and-api-reference/pycom/machine/dac.md b/firmware-and-api-reference/pycom/machine/dac.md index 046f3e4..be5ab3f 100644 --- a/firmware-and-api-reference/pycom/machine/dac.md +++ b/firmware-and-api-reference/pycom/machine/dac.md @@ -1,4 +1,4 @@ -# 5.2.1.2 DAC +# DAC The DAC is used to output analog values \(a specific voltage\) on pin `P22` or pin `P21`. The voltage will be between `0` and `3.3V`. diff --git a/firmware-and-api-reference/pycom/machine/i2c.md b/firmware-and-api-reference/pycom/machine/i2c.md index e5958f4..32ea48e 100644 --- a/firmware-and-api-reference/pycom/machine/i2c.md +++ b/firmware-and-api-reference/pycom/machine/i2c.md @@ -1,4 +1,4 @@ -# 5.2.1.3 I2C +# I2C I2C is a two-wire protocol for communicating between devices. At the physical level it consists of 2 wires: SCL and SDA, the clock and data lines respectively. diff --git a/firmware-and-api-reference/pycom/machine/pin.md b/firmware-and-api-reference/pycom/machine/pin.md index f2ebf29..344c47d 100644 --- a/firmware-and-api-reference/pycom/machine/pin.md +++ b/firmware-and-api-reference/pycom/machine/pin.md @@ -1,4 +1,4 @@ -# 5.2.1.4 Pin +# Pin A pin is the basic object to control I/O pins \(also known as GPIO - general-purpose input/output\). It has methods to set the mode of the pin \(input, output, etc\) and methods to get and set the digital logic level. For analog control of a pin, see the ADC class. diff --git a/firmware-and-api-reference/pycom/machine/pwm.md b/firmware-and-api-reference/pycom/machine/pwm.md index 9d62660..24a8d30 100644 --- a/firmware-and-api-reference/pycom/machine/pwm.md +++ b/firmware-and-api-reference/pycom/machine/pwm.md @@ -1,4 +1,4 @@ -# 5.2.1.5 PWM +# PWM ## class PWM – Pulse Width Modulation diff --git a/firmware-and-api-reference/pycom/machine/rmt.md b/firmware-and-api-reference/pycom/machine/rmt.md index 1d266e7..eac97aa 100644 --- a/firmware-and-api-reference/pycom/machine/rmt.md +++ b/firmware-and-api-reference/pycom/machine/rmt.md @@ -7,7 +7,7 @@ search: - Pulse --- -# 5.2.1.13 RMT +# RMT The RMT \(Remote Control\) module is primarily designed to send and receive infrared remote control signals that use on-off-keying of a carrier frequency, but due to its design it can be used to generate various types of signals. diff --git a/firmware-and-api-reference/pycom/machine/rtc.md b/firmware-and-api-reference/pycom/machine/rtc.md index cb0eadf..547a13d 100644 --- a/firmware-and-api-reference/pycom/machine/rtc.md +++ b/firmware-and-api-reference/pycom/machine/rtc.md @@ -1,4 +1,4 @@ -# 5.2.1.6 RTC +# RTC The RTC is used to keep track of the date and time. diff --git a/firmware-and-api-reference/pycom/machine/sd.md b/firmware-and-api-reference/pycom/machine/sd.md index e91b55f..b3fbec4 100644 --- a/firmware-and-api-reference/pycom/machine/sd.md +++ b/firmware-and-api-reference/pycom/machine/sd.md @@ -1,4 +1,4 @@ -# 5.2.1.11 SD +# SD The SD card class allows to configure and enable the memory card module of your Pycom module and automatically mount it as `/sd` as part of the file system. There is a single pin combination that can be used for the SD card, and the current implementation only works in 1-bit mode. The pin connections are as follows: diff --git a/firmware-and-api-reference/pycom/machine/spi.md b/firmware-and-api-reference/pycom/machine/spi.md index 09a478f..c3e4f78 100644 --- a/firmware-and-api-reference/pycom/machine/spi.md +++ b/firmware-and-api-reference/pycom/machine/spi.md @@ -1,4 +1,4 @@ -# 5.2.1.7 SPI +# SPI SPI is a serial protocol that is driven by a master. At the physical level there are 3 lines: SCK, MOSI, MISO. diff --git a/firmware-and-api-reference/pycom/machine/timer.md b/firmware-and-api-reference/pycom/machine/timer.md index 3fe8d6d..e14275c 100644 --- a/firmware-and-api-reference/pycom/machine/timer.md +++ b/firmware-and-api-reference/pycom/machine/timer.md @@ -1,4 +1,4 @@ -# 5.2.1.10 Timer +# Timer ## class Timer – Measure Time and Set Alarms diff --git a/firmware-and-api-reference/pycom/machine/uart.md b/firmware-and-api-reference/pycom/machine/uart.md index a8a63d0..215211d 100644 --- a/firmware-and-api-reference/pycom/machine/uart.md +++ b/firmware-and-api-reference/pycom/machine/uart.md @@ -1,4 +1,4 @@ -# 5.2.1.8 UART +# UART UART implements the standard UART/USART duplex serial communications protocol. At the physical level it consists of 2 lines: RXD and TXD. The unit of communication is a character \(not to be confused with a string character\) which can be 5, 6, 7 or 8 bits wide. diff --git a/firmware-and-api-reference/pycom/machine/wdt.md b/firmware-and-api-reference/pycom/machine/wdt.md index 3c1d8b9..73019f0 100644 --- a/firmware-and-api-reference/pycom/machine/wdt.md +++ b/firmware-and-api-reference/pycom/machine/wdt.md @@ -1,4 +1,4 @@ -# 5.2.1.9 WDT +# WDT The WDT is used to restart the system when the application crashes and ends up into a non recoverable state. After enabling, the application must "feed" the watchdog periodically to prevent it from expiring and resetting the system. diff --git a/firmware-and-api-reference/pycom/network/README.md b/firmware-and-api-reference/pycom/network/README.md index 38c5f92..57b7462 100644 --- a/firmware-and-api-reference/pycom/network/README.md +++ b/firmware-and-api-reference/pycom/network/README.md @@ -1,4 +1,4 @@ -# 5.2.2 network +# network This module provides access to network drivers and routing configuration. Network drivers for specific hardware are available within this module and are used to configure specific hardware network interfaces. diff --git a/firmware-and-api-reference/pycom/network/bluetooth/README.md b/firmware-and-api-reference/pycom/network/bluetooth/README.md index 6f1b1df..1353ae3 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/README.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/README.md @@ -1,4 +1,4 @@ -# 5.2.2.3 Bluetooth +# Bluetooth This class provides a driver for the Bluetooth radio in the module. Currently, only basic BLE functionality is available. diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gatt.md b/firmware-and-api-reference/pycom/network/bluetooth/gatt.md index 48fa28a..c93fee7 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gatt.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gatt.md @@ -1,4 +1,4 @@ -# 5.2.2.3.1 GATT +# GATT GATT stands for the Generic Attribute Profile and it defines the way that two Bluetooth Low Energy devices communicate between each other using concepts called Services and Characteristics. GATT uses a data protocol known as the Attribute Protocol \(ATT\), which is used to store/manage Services, Characteristics and related data in a lookup table. diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md index 21f6c70..380652b 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md @@ -1,4 +1,4 @@ -# 5.2.2.3.4 GATTCCharacteristic +# GATTCCharacteristic The smallest concept in GATT is the Characteristic, which encapsulates a single data point \(though it may contain an array of related data, such as X/Y/Z values from a 3-axis accelerometer, longitude and latitude from a GPS, etc.\). diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md b/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md index 4111157..c787c7f 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md @@ -1,4 +1,4 @@ -# 5.2.2.3.2 GATTCConnection +# GATTCConnection The GATT Client is the device that requests data from the server, otherwise known as the master device \(commonly this might be a phone/tablet/PC\). All transactions are initiated by the master, which receives a response from the slave. diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md index 68da939..7813a39 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md @@ -1,4 +1,4 @@ -# 5.2.2.3.3 GATTCService +# GATTCService Services are used to categorise data up into specific chunks of data known as characteristics. A service may have multiple characteristics, and each service has a unique numeric ID called a UUID. diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md index ded34d6..8861c86 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md @@ -1,4 +1,4 @@ -# 5.2.2.3.6 GATTSCharacteristic +# GATTSCharacteristic The smallest concept in GATT is the Characteristic, which encapsulates a single data point \(though it may contain an array of related data, such as X/Y/Z values from a 3-axis accelerometer, longitude and latitude from a GPS, etc.\). diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md index dfdc657..70e404a 100644 --- a/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md +++ b/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md @@ -1,4 +1,4 @@ -# 5.2.2.3.5 GATTSService +# GATTSService The GATT Server allows the device to act as a peripheral and hold its own ATT lookup data, server & characteristic definitions. In this mode, the device acts as a slave and a master must initiate a request. diff --git a/firmware-and-api-reference/pycom/network/lora.md b/firmware-and-api-reference/pycom/network/lora.md index 45da6a8..3584248 100644 --- a/firmware-and-api-reference/pycom/network/lora.md +++ b/firmware-and-api-reference/pycom/network/lora.md @@ -1,4 +1,4 @@ -# 5.2.2.4 LoRa +# LoRa This class provides a LoRaWAN 1.0.2 compliant driver for the LoRa network processor in the LoPy and FiPy. Below is an example demonstrating LoRaWAN Activation by Personalisation usage: diff --git a/firmware-and-api-reference/pycom/network/lte.md b/firmware-and-api-reference/pycom/network/lte.md index 8cd02ba..68263fa 100644 --- a/firmware-and-api-reference/pycom/network/lte.md +++ b/firmware-and-api-reference/pycom/network/lte.md @@ -1,4 +1,4 @@ -# 5.2.2.6 LTE +# LTE The LTE class provides access to the LTE-M/NB-IoT modem on the GPy and FiPy. LTE-M/NB-IoT are new categories of cellular protocols developed by the [3GPP](http://www.3gpp.org) and optimised for long battery life power and longer range. These are new protocols currently in the process of being deployed by mobile networks across the world. diff --git a/firmware-and-api-reference/pycom/network/server.md b/firmware-and-api-reference/pycom/network/server.md index 51c725e..2b6e1d8 100644 --- a/firmware-and-api-reference/pycom/network/server.md +++ b/firmware-and-api-reference/pycom/network/server.md @@ -1,4 +1,4 @@ -# 5.2.2.2 Server +# Server The `Server` class controls the behaviour and the configuration of the FTP and telnet services running on the Pycom device. Any changes performed using this class’ methods will affect both. diff --git a/firmware-and-api-reference/pycom/network/sigfox.md b/firmware-and-api-reference/pycom/network/sigfox.md index 8e2aae3..f80e920 100644 --- a/firmware-and-api-reference/pycom/network/sigfox.md +++ b/firmware-and-api-reference/pycom/network/sigfox.md @@ -1,4 +1,4 @@ -# 5.2.2.5 Sigfox +# Sigfox Sigfox is a Low Power Wide Area Network protocol that enables remote devices to connect using ultra-narrow band, UNB technology. The protocol is bi-directional, messages can both be sent up to and down from the Sigfox servers. diff --git a/firmware-and-api-reference/pycom/network/wlan.md b/firmware-and-api-reference/pycom/network/wlan.md index aac6597..7838592 100644 --- a/firmware-and-api-reference/pycom/network/wlan.md +++ b/firmware-and-api-reference/pycom/network/wlan.md @@ -1,4 +1,4 @@ -# 5.2.2.1 WLAN +# WLAN This class provides a driver for the WiFi network processor in the module. Example usage: diff --git a/firmware-and-api-reference/pycom/pycom.md b/firmware-and-api-reference/pycom/pycom.md index e87c42c..335e6f4 100644 --- a/firmware-and-api-reference/pycom/pycom.md +++ b/firmware-and-api-reference/pycom/pycom.md @@ -1,4 +1,4 @@ -# 5.2.4 pycom +# pycom The `pycom` module contains functions to control specific features of the Pycom devices, such as the heartbeat RGB LED. diff --git a/getting-started/hardware/README.md b/getting-started/hardware/README.md index ec18aa0..2447edb 100644 --- a/getting-started/hardware/README.md +++ b/getting-started/hardware/README.md @@ -1,4 +1,4 @@ -# 1.1 Hardware Setup +# Hardware Setup This chapter of the documentation will show you how to connect you Pycom module. For each device there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter or WiFi as well as what antennas you might need to connect. Please select your module below to be taken to the appropriate guide. diff --git a/getting-started/hardware/fipy.md b/getting-started/hardware/fipy.md index 5acf3a5..3cafde0 100644 --- a/getting-started/hardware/fipy.md +++ b/getting-started/hardware/fipy.md @@ -1,4 +1,4 @@ -# 1.1.5 FiPy +# FiPy ## Basic connection diff --git a/getting-started/hardware/gpy.md b/getting-started/hardware/gpy.md index 8e6eeb0..a87dbd8 100644 --- a/getting-started/hardware/gpy.md +++ b/getting-started/hardware/gpy.md @@ -1,4 +1,4 @@ -# 1.1.4 GPy +# GPy ## Basic connection diff --git a/getting-started/hardware/lopy.md b/getting-started/hardware/lopy.md index b53f7b1..e678f59 100644 --- a/getting-started/hardware/lopy.md +++ b/getting-started/hardware/lopy.md @@ -1,4 +1,4 @@ -# 1.1.1 LoPy +# LoPy ## Basic connection diff --git a/getting-started/hardware/lopy4.md b/getting-started/hardware/lopy4.md index ec5d9b3..eb21738 100644 --- a/getting-started/hardware/lopy4.md +++ b/getting-started/hardware/lopy4.md @@ -1,4 +1,4 @@ -# 1.1.2 LoPy4 +# LoPy 4 ## Basic connection diff --git a/getting-started/hardware/sipy.md b/getting-started/hardware/sipy.md index b267f46..de948e4 100644 --- a/getting-started/hardware/sipy.md +++ b/getting-started/hardware/sipy.md @@ -1,4 +1,4 @@ -# 1.1.3 SiPy +# SiPy ## Basic connection diff --git a/getting-started/hardware/wipy.md b/getting-started/hardware/wipy.md index fe88323..4cddffc 100644 --- a/getting-started/hardware/wipy.md +++ b/getting-started/hardware/wipy.md @@ -1,4 +1,4 @@ -# 1.1.6 WiPy +# WiPy ## Basic connection diff --git a/getting-started/introduction.md b/getting-started/introduction.md index be61ba0..1e74caa 100644 --- a/getting-started/introduction.md +++ b/getting-started/introduction.md @@ -1,4 +1,4 @@ -# 1.0 Introduction +# 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](../products.md) page before you place your order to ensure you know which accessories you might require. diff --git a/getting-started/programming/README.md b/getting-started/programming/README.md index fefa839..2ca30f5 100644 --- a/getting-started/programming/README.md +++ b/getting-started/programming/README.md @@ -1,4 +1,4 @@ -# 1.3 Programming the modules +# Programming the modules Now that you have connected and updated your pycom module and installed all the required software on your computer, we can begin programming your Pycom module. diff --git a/getting-started/programming/examples.md b/getting-started/programming/examples.md index b44e938..36b38f1 100644 --- a/getting-started/programming/examples.md +++ b/getting-started/programming/examples.md @@ -1,4 +1,4 @@ -# 1.3.2 MicroPython Examples +# MicroPython Examples To get you started with Python \(MicroPython\) syntax, we've provided you with a number of code examples. diff --git a/getting-started/programming/first-project.md b/getting-started/programming/first-project.md index 7fc36a7..867d576 100644 --- a/getting-started/programming/first-project.md +++ b/getting-started/programming/first-project.md @@ -1,4 +1,4 @@ -# 1.3.3 Your first Pymakr project +# Your first Pymakr project This guide will take you through how to setup your first project with Pymakr and make the on-board RGB LED flash various colours. diff --git a/getting-started/programming/ftp.md b/getting-started/programming/ftp.md index 8a03c7a..3b01383 100644 --- a/getting-started/programming/ftp.md +++ b/getting-started/programming/ftp.md @@ -1,4 +1,4 @@ -# 1.3.5 FTP +# FTP There is a small internal file system accessible with each Pycom device, called `/flash`. This is stored within the external serial flash memory. If a microSD card is also connected and mounted, it will be available as well. When the device starts up, it will always boot from the `boot.py` located in the `/flash` file system. diff --git a/getting-started/programming/micropython.md b/getting-started/programming/micropython.md index 4c94370..6689c75 100644 --- a/getting-started/programming/micropython.md +++ b/getting-started/programming/micropython.md @@ -1,4 +1,4 @@ -# 1.3.1 Introduction to MicroPython +# Introduction to MicroPython Our boards work with [MicroPython](https://micropython.org/); a Python 3.5 implementation that is optimised to run on micro controllers. This allows for much faster and more simple development process than using C. diff --git a/getting-started/programming/repl/README.md b/getting-started/programming/repl/README.md index 17eb9c5..e4f08d1 100644 --- a/getting-started/programming/repl/README.md +++ b/getting-started/programming/repl/README.md @@ -1,4 +1,4 @@ -# 1.3.4 REPL +# REPL REPL stands for Read Evaluate Print Loop, and is the name given to the interactive MicroPython prompt that is accessible on the Pycom devices. Using the REPL is by far the easiest way to test out Python code and run commands. You can use the REPL in addition to writing scripts in `main.py`. diff --git a/getting-started/programming/repl/serial.md b/getting-started/programming/repl/serial.md index 231afd5..0a06e6b 100644 --- a/getting-started/programming/repl/serial.md +++ b/getting-started/programming/repl/serial.md @@ -1,4 +1,4 @@ -# 1.3.4.1 Serial USB \(UART\) +# Serial USB \(UART\) To use the REPL, a Pycom device must be connected to the host computer with a USB connection either to an Expansion Board or to serial converter \(a diagram of how to do this can be found the the [getting started](../../introduction.md) page for your module\). diff --git a/getting-started/programming/repl/telnet.md b/getting-started/programming/repl/telnet.md index e99c27e..9bf8312 100644 --- a/getting-started/programming/repl/telnet.md +++ b/getting-started/programming/repl/telnet.md @@ -1,4 +1,4 @@ -# 1.3.4.2 Telnet REPL +# Telnet REPL Pycom devices also support a connection via `telnet`, using the device's on board WiFi/WLAN. Connect to the device's WiFi Access Point \(AP\) and using the following credentials to connect to the AP. The WiFi `SSID` will appear upon powering on a Pycom Device for the first time \(e.g. `lopy-`\). To re-enable this feature at a later date, please see [network.WLAN](../../../firmware-and-api-reference/pycom/network/wlan.md). diff --git a/getting-started/programming/safeboot.md b/getting-started/programming/safeboot.md index 930a2cf..5d78765 100644 --- a/getting-started/programming/safeboot.md +++ b/getting-started/programming/safeboot.md @@ -1,4 +1,4 @@ -# 1.3.6 Safe boot +# Safe boot If powering up normally or upon pressing the reset button, a Pycom module will boot into standard mode; the `boot.py` file will be executed first, followed by `main.py`. It is possible to alter the boot procedure of the module by tying certain pins `high` or `low` when the module boots. diff --git a/getting-started/registration/README.md b/getting-started/registration/README.md index beca95a..c80c352 100644 --- a/getting-started/registration/README.md +++ b/getting-started/registration/README.md @@ -1,4 +1,4 @@ -# 1.4 Device Registration +# Device Registration Some of our devices require registration before you can utilise specific features such as certain types of networking. Please see the list below for setup guides to ensure that your device is registered and activated on the various platforms required to access all of the available features. diff --git a/getting-started/registration/cellular.md b/getting-started/registration/cellular.md index 710536d..670aa1a 100644 --- a/getting-started/registration/cellular.md +++ b/getting-started/registration/cellular.md @@ -1,4 +1,4 @@ -# 1.4.2 Cellular +# Cellular In order to use your GPy/FiPy on a cellular network you are required to get a SIM card from a local provider. _Note:_ This might differ from a standard SIM you can buy in a store, our devices do not support standard LTE. diff --git a/getting-started/registration/lora/README.md b/getting-started/registration/lora/README.md index 20bdb82..c329101 100644 --- a/getting-started/registration/lora/README.md +++ b/getting-started/registration/lora/README.md @@ -1,4 +1,4 @@ -# 1.4.3 LoRaWAN +# LoRaWAN ## Raw LoRa diff --git a/getting-started/registration/lora/objenious.md b/getting-started/registration/lora/objenious.md index ac6488b..7a6b2dd 100644 --- a/getting-started/registration/lora/objenious.md +++ b/getting-started/registration/lora/objenious.md @@ -1,4 +1,4 @@ -# 1.4.3.2 Objenious +# Objenious ## Identifiers diff --git a/getting-started/registration/lora/ttn.md b/getting-started/registration/lora/ttn.md index 6f81d70..23bd37e 100644 --- a/getting-started/registration/lora/ttn.md +++ b/getting-started/registration/lora/ttn.md @@ -1,4 +1,4 @@ -# 1.4.3.1 The Things Network +# The Things Network In order to use The Things Network \(TTN\) you should navigate to their website and create/register an account. Enter a username and an email address to verify with their platform. diff --git a/getting-started/registration/sigfox.md b/getting-started/registration/sigfox.md index 2d6283d..8dffa92 100644 --- a/getting-started/registration/sigfox.md +++ b/getting-started/registration/sigfox.md @@ -1,4 +1,4 @@ -# 1.4.1 Sigfox +# Sigfox Before you start, update your device to the latest firmware. Select _stable_ firmware in Firmware updater. After firmware update is done, _Sigfox ID_ and _Sigfox PAC_ were assigned to your device. diff --git a/getting-started/software/README.md b/getting-started/software/README.md index 6ad3310..918a459 100644 --- a/getting-started/software/README.md +++ b/getting-started/software/README.md @@ -1,4 +1,4 @@ -# 1.2 Software +# Software To get you up and running, Pycom provides a suite of tools to assist with developing and programming your Pycom Devices: diff --git a/getting-started/software/drivers.md b/getting-started/software/drivers.md index 3a93781..12b6cf8 100644 --- a/getting-started/software/drivers.md +++ b/getting-started/software/drivers.md @@ -1,4 +1,4 @@ -# 1.2.1 Drivers +# Drivers ## Linux diff --git a/getting-started/software/firmwaretool.md b/getting-started/software/firmwaretool.md index 092906a..cac4fc2 100644 --- a/getting-started/software/firmwaretool.md +++ b/getting-started/software/firmwaretool.md @@ -1,4 +1,4 @@ -# 1.2.2 Updating Firmware +# Updating Firmware We strongly recommend you to upgrade your firmware to the latest version as we are constantly making improvements and adding new features to the devices. diff --git a/getting-started/software/pymakr.md b/getting-started/software/pymakr.md index b76abcf..83db745 100644 --- a/getting-started/software/pymakr.md +++ b/getting-started/software/pymakr.md @@ -1,4 +1,4 @@ -# 1.2.3 Pymakr +# Pymakr ![](../../.gitbook/assets/pymakr-logo%20%281%29.png) diff --git a/product-info/boards/README.md b/product-info/boards/README.md index 1ec1162..cfdc730 100644 --- a/product-info/boards/README.md +++ b/product-info/boards/README.md @@ -1,4 +1,18 @@ -# 6.3 Expansion Boards and Shields +# Expansion Boards and Shields This section contains all of the datasheets for the Pycom Expansion Boards and Shields. This includes the Expansion Board, Pytrack, Pysense and Deep Sleep Shield. +{% page-ref page="expansion3.md" %} + +{% page-ref page="pytrack.md" %} + +{% page-ref page="pysense.md" %} + +{% page-ref page="pyscan.md" %} + +{% page-ref page="expansion2.md" %} + +{% page-ref page="deepsleep/" %} + + + diff --git a/product-info/boards/deepsleep/README.md b/product-info/boards/deepsleep/README.md index 5628e63..2059ae2 100644 --- a/product-info/boards/deepsleep/README.md +++ b/product-info/boards/deepsleep/README.md @@ -1,4 +1,4 @@ -# 6.3.6 Deep Sleep Shield +# Deep Sleep Shield The schematic of the Deep Sleep Shield is available as a PDF File. diff --git a/product-info/boards/deepsleep/api.md b/product-info/boards/deepsleep/api.md index 77055f6..9106580 100644 --- a/product-info/boards/deepsleep/api.md +++ b/product-info/boards/deepsleep/api.md @@ -1,4 +1,4 @@ -# 6.3.6.1 Deep Sleep API +# Deep Sleep API This chapter describes the library which controls the Deep Sleep Shield. This includes the controls for external interrupts and timer setup of the deep sleep functionality. diff --git a/product-info/boards/expansion2.md b/product-info/boards/expansion2.md index c193ec4..a9407b0 100644 --- a/product-info/boards/expansion2.md +++ b/product-info/boards/expansion2.md @@ -1,4 +1,4 @@ -# 6.3.5 Expansion Board 2.0 +# Expansion Board 2.0 ![](../../.gitbook/assets/expansion2.png) diff --git a/product-info/boards/expansion3.md b/product-info/boards/expansion3.md index dea7756..e0fc5c5 100644 --- a/product-info/boards/expansion3.md +++ b/product-info/boards/expansion3.md @@ -1,4 +1,4 @@ -# 6.3.1 Expansion Board 3.0 +# Expansion Board 3.0 ![](../../.gitbook/assets/expansion3.png) diff --git a/product-info/boards/pyscan.md b/product-info/boards/pyscan.md index 21effa7..818b96b 100644 --- a/product-info/boards/pyscan.md +++ b/product-info/boards/pyscan.md @@ -1,4 +1,4 @@ -# 6.3.4 Pyscan +# Pyscan ![](../../.gitbook/assets/pyscan-new.png) diff --git a/product-info/boards/pysense.md b/product-info/boards/pysense.md index 7b78562..cfeebd9 100644 --- a/product-info/boards/pysense.md +++ b/product-info/boards/pysense.md @@ -1,4 +1,4 @@ -# 6.3.3 Pysense +# Pysense ![](../../.gitbook/assets/pysense.png) diff --git a/product-info/boards/pytrack.md b/product-info/boards/pytrack.md index 37930a7..c322317 100644 --- a/product-info/boards/pytrack.md +++ b/product-info/boards/pytrack.md @@ -1,4 +1,4 @@ -# 6.3.2 Pytrack +# Pytrack ![](../../.gitbook/assets/pytrack.png) diff --git a/product-info/development/README.md b/product-info/development/README.md index 70b2bed..7e467f1 100644 --- a/product-info/development/README.md +++ b/product-info/development/README.md @@ -1,12 +1,20 @@ -# 6.1 Development Modules +# Development Modules This section contains all of the datasheets for the Pycom Development Devices. This includes the WiPy 2.0 and 3.0, LoPy, LoPy 4, SiPy, GPy, and FiPy. -* [6.1.1 WiPy 2.0](wipy2.md) -* [6.1.2 WiPy 3.0](wipy3.md) -* [6.1.3 LoPy](lopy.md) -* [6.1.4 LoPy4](lopy4.md) -* [6.1.5 SiPy](sipy.md) -* [6.1.6 GPy](gpy.md) -* [6.1.7 FiPy](fipy.md) +{% page-ref page="wipy2.md" %} + +{% page-ref page="wipy3.md" %} + +{% page-ref page="lopy.md" %} + +{% page-ref page="lopy4.md" %} + +{% page-ref page="sipy.md" %} + +{% page-ref page="gpy.md" %} + +{% page-ref page="fipy.md" %} + + diff --git a/product-info/development/fipy.md b/product-info/development/fipy.md index 4bf1789..848a7c1 100644 --- a/product-info/development/fipy.md +++ b/product-info/development/fipy.md @@ -1,4 +1,4 @@ -# 6.1.7 FiPy +# FiPy ![](../../.gitbook/assets/fipy%20%281%29.png) diff --git a/product-info/development/gpy.md b/product-info/development/gpy.md index 25c97a5..7fc661f 100644 --- a/product-info/development/gpy.md +++ b/product-info/development/gpy.md @@ -1,4 +1,4 @@ -# 6.1.6 GPy +# GPy ![](../../.gitbook/assets/gpy%20%281%29.png) diff --git a/product-info/development/lopy.md b/product-info/development/lopy.md index 7216c23..5e2213b 100644 --- a/product-info/development/lopy.md +++ b/product-info/development/lopy.md @@ -1,4 +1,4 @@ -# 6.1.3 LoPy +# LoPy ![](../../.gitbook/assets/lopy%20%281%29.png) diff --git a/product-info/development/lopy4.md b/product-info/development/lopy4.md index 2e569d6..0a16652 100644 --- a/product-info/development/lopy4.md +++ b/product-info/development/lopy4.md @@ -1,4 +1,4 @@ -# 6.1.4 LoPy 4 +# LoPy 4 ![](../../.gitbook/assets/lopy4%20%281%29.png) diff --git a/product-info/development/sipy.md b/product-info/development/sipy.md index 5cd287c..e5a9630 100644 --- a/product-info/development/sipy.md +++ b/product-info/development/sipy.md @@ -1,4 +1,4 @@ -# 6.1.5 SiPy +# SiPy ![](../../.gitbook/assets/sipy%20%282%29.png) diff --git a/product-info/development/wipy2.md b/product-info/development/wipy2.md index e93de46..2c15876 100644 --- a/product-info/development/wipy2.md +++ b/product-info/development/wipy2.md @@ -1,4 +1,4 @@ -# 6.1.1 WiPy 2.0 +# WiPy 2.0 ![](../../.gitbook/assets/wipy2%20%281%29.png) diff --git a/product-info/development/wipy3.md b/product-info/development/wipy3.md index 706b030..89b963d 100644 --- a/product-info/development/wipy3.md +++ b/product-info/development/wipy3.md @@ -1,4 +1,4 @@ -# 6.1.2 WiPy 3.0 +# WiPy 3.0 ## diff --git a/product-info/introduction.md b/product-info/introduction.md index d393f0b..06fb616 100644 --- a/product-info/introduction.md +++ b/product-info/introduction.md @@ -1,32 +1,48 @@ -# 6.0 Introduction +# Introduction The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes. ## Development Modules -* [WiPy 2.0](development/wipy2.md) -* [WiPy 3.0](development/wipy3.md) -* [SiPy](development/sipy.md) -* [LoPy](development/lopy.md) -* [LoPy4](development/lopy4.md) -* [GPy](development/gpy.md) -* [FiPy](development/fipy.md) +{% page-ref page="development/wipy2.md" %} + +{% page-ref page="development/wipy3.md" %} + +{% page-ref page="development/lopy.md" %} + +{% page-ref page="development/lopy4.md" %} + +{% page-ref page="development/sipy.md" %} + +{% page-ref page="development/gpy.md" %} + +{% page-ref page="development/fipy.md" %} ## OEM modules -* [W01](oem/w01.md) -* [L01](oem/l01.md) -* [L04](oem/l04.md) -* [G01](oem/g01.md) -* [L01/W01 Reference Board](oem/l01_reference.md) -* [Universal Reference Board](oem/universal_reference.md) +{% page-ref page="oem/w01.md" %} + +{% page-ref page="oem/l01.md" %} + +{% page-ref page="oem/g01.md" %} + +{% page-ref page="oem/l01\_reference.md" %} + +{% page-ref page="oem/universal\_reference.md" %} + +## Expansion Boards and Shields + +{% page-ref page="boards/expansion3.md" %} + +{% page-ref page="boards/pytrack.md" %} + +{% page-ref page="boards/pysense.md" %} + +{% page-ref page="boards/pyscan.md" %} + +{% page-ref page="boards/expansion2.md" %} + +{% page-ref page="boards/deepsleep/" %} -## Shields and Expansion boards -* [Expansion Board 3.0](boards/expansion3.md) -* [Pysense](boards/pysense.md) -* [Pytrack](boards/pytrack.md) -* [Pyscan](boards/pyscan.md) -* [Deep Sleep Shield](boards/deepsleep/) -* [Expansion Board 2.0](boards/expansion2.md) diff --git a/product-info/notes.md b/product-info/notes.md index ef57a84..7f5f037 100644 --- a/product-info/notes.md +++ b/product-info/notes.md @@ -1,4 +1,4 @@ -# 6.4 Notes +# Notes ## Powering with an external power source diff --git a/product-info/oem/README.md b/product-info/oem/README.md index d926e5a..e3c5304 100644 --- a/product-info/oem/README.md +++ b/product-info/oem/README.md @@ -1,11 +1,16 @@ -# 6.2 OEM Modules +# OEM Modules This section contains all of the datasheets for the Pycom OEM Devices. This includes the W01, L01, L04, and G01. -* [6.2.1 W01](w01.md) -* [6.2.2 L01](l01.md) -* [6.2.3 L04](l04.md) -* [6.2.4 G01](g01.md) -* [6.2.5 L01 OEM Baseboard Reference](l01_reference.md) -* [6.2.6 Universal OEM Baseboard Reference](universal_reference.md) +{% page-ref page="w01.md" %} + +{% page-ref page="l01.md" %} + +{% page-ref page="g01.md" %} + +{% page-ref page="l01\_reference.md" %} + +{% page-ref page="universal\_reference.md" %} + + diff --git a/product-info/oem/g01.md b/product-info/oem/g01.md index e3360b2..b8ea66f 100644 --- a/product-info/oem/g01.md +++ b/product-info/oem/g01.md @@ -1,4 +1,4 @@ -# 6.2.4 G01 +# G01 ![](../../.gitbook/assets/g01%20%281%29.png) diff --git a/product-info/oem/l01.md b/product-info/oem/l01.md index 7f4139a..55fb4e6 100644 --- a/product-info/oem/l01.md +++ b/product-info/oem/l01.md @@ -1,4 +1,4 @@ -# 6.2.2 L01 +# L01 ![](../../.gitbook/assets/l01%20%281%29.png) diff --git a/product-info/oem/l01_reference.md b/product-info/oem/l01_reference.md index 57ca621..49d3d27 100644 --- a/product-info/oem/l01_reference.md +++ b/product-info/oem/l01_reference.md @@ -1,4 +1,4 @@ -# 6.2.5 L01 OEM Baseboard Reference +# L01 OEM Baseboard Reference ![](../../.gitbook/assets/l01-reference.png) diff --git a/product-info/oem/l04.md b/product-info/oem/l04.md index fff6c81..b1011be 100644 --- a/product-info/oem/l04.md +++ b/product-info/oem/l04.md @@ -1,4 +1,4 @@ -# 6.2.3 L04 +# L04 ![](../../.gitbook/assets/l04%20%281%29.png) diff --git a/product-info/oem/universal_reference.md b/product-info/oem/universal_reference.md index de36847..8376821 100644 --- a/product-info/oem/universal_reference.md +++ b/product-info/oem/universal_reference.md @@ -1,4 +1,4 @@ -# 6.2.6 Universal OEM Baseboard Reference +# Universal OEM Baseboard Reference ![](../../.gitbook/assets/universal_reference.png) diff --git a/product-info/oem/w01.md b/product-info/oem/w01.md index beb8779..f86967b 100644 --- a/product-info/oem/w01.md +++ b/product-info/oem/w01.md @@ -1,4 +1,4 @@ -# 6.2.1 W01 +# W01 ![](../../.gitbook/assets/w01.png) diff --git a/pybytes/add-device/README.md b/pybytes/add-device/README.md index 3134e82..a6acb01 100644 --- a/pybytes/add-device/README.md +++ b/pybytes/add-device/README.md @@ -1,4 +1,4 @@ -# 7.3 Add a device to Pybytes +# 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 b7374f6..71ae8fe 100644 --- a/pybytes/add-device/flash.md +++ b/pybytes/add-device/flash.md @@ -1,4 +1,4 @@ -# 7.3.2 Connect to Pybytes: Flash Pybytes library manually +# 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 be1f9eb..86ed08b 100644 --- a/pybytes/add-device/quick.md +++ b/pybytes/add-device/quick.md @@ -1,4 +1,4 @@ -# 7.3.1 Connect to Pybytes: Quick Add +# 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 7ff35ff..2287cdf 100644 --- a/pybytes/add-device/sigfox/README.md +++ b/pybytes/add-device/sigfox/README.md @@ -1,4 +1,4 @@ -# 7.3.3 Add Sigfox device +# 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 e953e24..8c149ca 100644 --- a/pybytes/add-device/sigfox/custom.md +++ b/pybytes/add-device/sigfox/custom.md @@ -1,4 +1,4 @@ -# 7.3.3.2 Custom contract +# 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 df8ec5f..e8a2aa8 100644 --- a/pybytes/add-device/sigfox/devkit.md +++ b/pybytes/add-device/sigfox/devkit.md @@ -1,4 +1,4 @@ -# 7.3.3.1 DevKit contract +# 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 b8f4935..c813e39 100644 --- a/pybytes/getting-started.md +++ b/pybytes/getting-started.md @@ -1,4 +1,4 @@ -# 7.2 Getting Started with Pybytes +# Getting Started with Pybytes Follow these steps to create a Pybytes account: diff --git a/pybytes/introduction.md b/pybytes/introduction.md index 3a386df..89672dc 100644 --- a/pybytes/introduction.md +++ b/pybytes/introduction.md @@ -1,4 +1,4 @@ -# 7.1 Introduction +# Introduction ![](../.gitbook/assets/pybyteslogo.png) diff --git a/pybytes/visualise-data.md b/pybytes/visualise-data.md index e702abc..73ac352 100644 --- a/pybytes/visualise-data.md +++ b/pybytes/visualise-data.md @@ -1,4 +1,4 @@ -# 7.4 Visualise data from your device +# 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/pymakr/features.md b/pymakr/features.md index 15a861a..b10047f 100644 --- a/pymakr/features.md +++ b/pymakr/features.md @@ -1,4 +1,4 @@ -# 2.2 Tools/Features +# Tools/Features ## Console \(REPL\) diff --git a/pymakr/installation/README.md b/pymakr/installation/README.md index eaf8070..0315f26 100644 --- a/pymakr/installation/README.md +++ b/pymakr/installation/README.md @@ -1,4 +1,4 @@ -# 2.1 Installation +# Installation ![](../../.gitbook/assets/pymakr-logo%20%281%29.png) diff --git a/pymakr/installation/atom.md b/pymakr/installation/atom.md index 58afaae..0068720 100644 --- a/pymakr/installation/atom.md +++ b/pymakr/installation/atom.md @@ -1,4 +1,4 @@ -# 2.1.1 Atom +# Atom For beginners, users getting started with MicroPython & Pycom as well as Atom text editor users, we recommend the **Pymakr Plugin for Atom**. This section will help you get started using the Atom Text Editor & Pymakr Plugin. diff --git a/pymakr/installation/vscode.md b/pymakr/installation/vscode.md index 61fd514..86c9307 100644 --- a/pymakr/installation/vscode.md +++ b/pymakr/installation/vscode.md @@ -1,4 +1,4 @@ -# 2.1.2 Visual Studio Code +# Visual Studio Code Pycom also supports Microsoft's Visual Studio Code IDE platform with the Pymakr Plugin. To download Visual Studio Code, navigate to [VS Code](https://code.visualstudio.com/). diff --git a/pymakr/settings.md b/pymakr/settings.md index 3a6c5a7..3e75c85 100644 --- a/pymakr/settings.md +++ b/pymakr/settings.md @@ -1,4 +1,4 @@ -# 2.3 Settings +# Settings Below you will find a description of the various settings available for Pymakr. diff --git a/pytrack-pysense-pyscan/apireference/README.md b/pytrack-pysense-pyscan/apireference/README.md index 4b4948e..79e556c 100644 --- a/pytrack-pysense-pyscan/apireference/README.md +++ b/pytrack-pysense-pyscan/apireference/README.md @@ -1,4 +1,4 @@ -# 3.3 API Reference +# API Reference To simplify usability, APIs for the libraries have been created, abstracting away the low level interactions with the sensors. The next following pages refer to the respective libraries for the Pytrack, Pysense, and Pyscan. diff --git a/pytrack-pysense-pyscan/apireference/pyscan.md b/pytrack-pysense-pyscan/apireference/pyscan.md index 08d4500..c8af681 100644 --- a/pytrack-pysense-pyscan/apireference/pyscan.md +++ b/pytrack-pysense-pyscan/apireference/pyscan.md @@ -1,4 +1,4 @@ -# 3.3.4 Pyscan +# Pyscan This chapter describes the various libraries which are designed for the Pyscan board. This includes details about the various methods and classes available for each of the Pyscan’s sensors. diff --git a/pytrack-pysense-pyscan/apireference/pysense.md b/pytrack-pysense-pyscan/apireference/pysense.md index 888657d..66345ba 100644 --- a/pytrack-pysense-pyscan/apireference/pysense.md +++ b/pytrack-pysense-pyscan/apireference/pysense.md @@ -1,4 +1,4 @@ -# 3.3.2 Pysense +# Pysense This chapter describes the various libraries which are designed for the Pysense board. This includes details about the various methods and classes available for each of the Pysense’s sensors. diff --git a/pytrack-pysense-pyscan/apireference/pytrack.md b/pytrack-pysense-pyscan/apireference/pytrack.md index bc7c1c2..0ff52a1 100644 --- a/pytrack-pysense-pyscan/apireference/pytrack.md +++ b/pytrack-pysense-pyscan/apireference/pytrack.md @@ -1,4 +1,4 @@ -# 3.3.1 Pytrack +# Pytrack This chapter describes the various libraries which are designed for the Pytrack board. This includes details about the various methods and classes available for each of the Pytrack’s sensors. diff --git a/pytrack-pysense-pyscan/apireference/sleep.md b/pytrack-pysense-pyscan/apireference/sleep.md index 76fbc64..42ea2fa 100644 --- a/pytrack-pysense-pyscan/apireference/sleep.md +++ b/pytrack-pysense-pyscan/apireference/sleep.md @@ -1,4 +1,4 @@ -# 3.3.5 Sleep +# Sleep This chapter describes the various methods for sleep and wakeup which are embedded in Pytrack and Pysense libraries. Both Pytrack and Pysense have the same methods, although the appropriate class, either `pytrack` or `pysense`, has to be instantiated. diff --git a/pytrack-pysense-pyscan/installation/README.md b/pytrack-pysense-pyscan/installation/README.md index 7a16c31..841cde4 100644 --- a/pytrack-pysense-pyscan/installation/README.md +++ b/pytrack-pysense-pyscan/installation/README.md @@ -1,4 +1,4 @@ -# 3.2 Installing Software +# Installing Software As the development for these devices are on going with additional features being added, every week, it is essential to ensure you frequently check for updates on the Pytrack/Pysense/Pyscan. As well as updating the device firmware, it is important to check the [GitHub repository](https://github.com/pycom/pycom-libraries) for the respective library files as they as also being updated, to include additional features/functionality. diff --git a/pytrack-pysense-pyscan/installation/drivers.md b/pytrack-pysense-pyscan/installation/drivers.md index 4a2de9f..9948b4d 100644 --- a/pytrack-pysense-pyscan/installation/drivers.md +++ b/pytrack-pysense-pyscan/installation/drivers.md @@ -1,4 +1,4 @@ -# 3.2.2 Installing Drivers - Windows 7 +# Installing Drivers - Windows 7 Pytrack and Pysense will work out of the box for Windows 8/10/+, macOS as well as Linux. If using Windows 7, drivers to support the boards will need to be installed. diff --git a/pytrack-pysense-pyscan/installation/firmware.md b/pytrack-pysense-pyscan/installation/firmware.md index a031472..1e354c1 100644 --- a/pytrack-pysense-pyscan/installation/firmware.md +++ b/pytrack-pysense-pyscan/installation/firmware.md @@ -1,4 +1,4 @@ -# 3.2.1 Updating Firmware +# Updating Firmware To update the firmware on the Pysense/Pytrack/Pyscan/Expansion Board v3, please see the following instructions. The firmware of Pysense/Pytrack/Pyscan/Expansion Board v3 can be updated via the USB port using the terminal tool, `DFU-util`. diff --git a/pytrack-pysense-pyscan/installation/libraries.md b/pytrack-pysense-pyscan/installation/libraries.md index fe06053..235a667 100644 --- a/pytrack-pysense-pyscan/installation/libraries.md +++ b/pytrack-pysense-pyscan/installation/libraries.md @@ -1,4 +1,4 @@ -# 3.2.3 Installing Libraries +# Installing Libraries To utilise the sensors on the Pytrack and Pysense, Pycom has written libraries to make reading to/from the various sensors accessible via an API. These libraries reside at the Pycom GitHub repository and the latest versions can be found under the releases page. diff --git a/pytrack-pysense-pyscan/introduction.md b/pytrack-pysense-pyscan/introduction.md index c53d60e..0969c8a 100644 --- a/pytrack-pysense-pyscan/introduction.md +++ b/pytrack-pysense-pyscan/introduction.md @@ -1,4 +1,4 @@ -# 3.1 Introduction +# Introduction In addition to the Expansion Board, Pycom also offers three additional sensor boards, which are ideal for quickly building a fully functioning IoT solution! Whether the application is environment sensing or asset tracking, these additional boards support a variety of sensors. diff --git a/tutorials-and-examples/all/README.md b/tutorials-and-examples/all/README.md index 6cd893e..5a8d26a 100644 --- a/tutorials-and-examples/all/README.md +++ b/tutorials-and-examples/all/README.md @@ -1,4 +1,4 @@ -# 4.2 All Pycom Device Examples +# All Pycom Device Examples This section contains generic examples that will work across all Pycom devices and Expansion Boards. diff --git a/tutorials-and-examples/all/adc.md b/tutorials-and-examples/all/adc.md index 762aab6..8a86ac4 100644 --- a/tutorials-and-examples/all/adc.md +++ b/tutorials-and-examples/all/adc.md @@ -1,4 +1,4 @@ -# 4.2.7 ADC +# ADC This example is a simple ADC sample. For more information please see [`ADC`](../../firmware-and-api-reference/pycom/machine/adc.md). diff --git a/tutorials-and-examples/all/aws.md b/tutorials-and-examples/all/aws.md index 0d02eec..21b96fe 100644 --- a/tutorials-and-examples/all/aws.md +++ b/tutorials-and-examples/all/aws.md @@ -1,4 +1,4 @@ -# 4.2.6 AWS +# AWS The AWS IoT platform enables devices to connect to the Amazon cloud and lets applications in the cloud interact with Internet-connected things. Common IoT applications either collect and process telemetry from devices or enable users to control a device remotely. Things report their state by publishing messages, in JSON format, on MQTT topics. diff --git a/tutorials-and-examples/all/ble.md b/tutorials-and-examples/all/ble.md index 1f2f03f..b056ed1 100644 --- a/tutorials-and-examples/all/ble.md +++ b/tutorials-and-examples/all/ble.md @@ -1,4 +1,4 @@ -# 4.2.3 Bluetooth +# Bluetooth At present, basic BLE functionality is available. More features will be implemented in the near future, such as pairing. This page will be updated in line with these features. diff --git a/tutorials-and-examples/all/https.md b/tutorials-and-examples/all/https.md index ff0845e..59bcfaa 100644 --- a/tutorials-and-examples/all/https.md +++ b/tutorials-and-examples/all/https.md @@ -1,4 +1,4 @@ -# 4.2.4 HTTPS +# HTTPS Basic connection using `ssl.wrap_socket()`. diff --git a/tutorials-and-examples/all/i2c.md b/tutorials-and-examples/all/i2c.md index d48f43e..ce1e665 100644 --- a/tutorials-and-examples/all/i2c.md +++ b/tutorials-and-examples/all/i2c.md @@ -1,4 +1,4 @@ -# 4.2.8 I2C +# I2C The following example receives data from a light sensor using I2C. Sensor used is the BH1750FVI Digital Light Sensor. diff --git a/tutorials-and-examples/all/modbus.md b/tutorials-and-examples/all/modbus.md index 3a2c585..56c3829 100644 --- a/tutorials-and-examples/all/modbus.md +++ b/tutorials-and-examples/all/modbus.md @@ -1,4 +1,4 @@ -# 4.2.14 Modbus +# Modbus Modbus is a messaging protocol that defines the packet structure for transferring data between devices in a master/slave architecture. The protocol is independent of the transmission medium and is usually transmitted over TCP \(MODBUS TCP\) or serial communication \(MODBUS RTU\). Modbus is intended as a request/reply protocol and delivers services specified by function codes. The function code in the request tells the addressed slave what kind of action to perform. The function codes most commonly supported by devices are listed below. diff --git a/tutorials-and-examples/all/mqtt.md b/tutorials-and-examples/all/mqtt.md index 6151130..c031536 100644 --- a/tutorials-and-examples/all/mqtt.md +++ b/tutorials-and-examples/all/mqtt.md @@ -1,4 +1,4 @@ -# 4.2.5 MQTT +# MQTT MQTT is a lightweight messaging protocol that is ideal for sending small packets of data to and from IoT devices via WiFi. diff --git a/tutorials-and-examples/all/ota.md b/tutorials-and-examples/all/ota.md index 7864499..9e353c4 100644 --- a/tutorials-and-examples/all/ota.md +++ b/tutorials-and-examples/all/ota.md @@ -1,4 +1,4 @@ -# 4.2.15 OTA update +# OTA update ## Overview diff --git a/tutorials-and-examples/all/owd.md b/tutorials-and-examples/all/owd.md index 7f2f463..5f89d21 100644 --- a/tutorials-and-examples/all/owd.md +++ b/tutorials-and-examples/all/owd.md @@ -1,4 +1,4 @@ -# 4.2.9 Onewire Driver +# Onewire Driver This tutorial explains how to connect and read data from a DS18x20 temperature sensor. The onewire library is also available at the [pycom-libraries](https://github.com/pycom/pycom-libraries/tree/master/lib/onewire) GitHub Repository. diff --git a/tutorials-and-examples/all/pir.md b/tutorials-and-examples/all/pir.md index 54c6487..4dc7d88 100644 --- a/tutorials-and-examples/all/pir.md +++ b/tutorials-and-examples/all/pir.md @@ -1,4 +1,4 @@ -# 4.2.13 PIR Sensor +# PIR Sensor This code reads PIR sensor triggers from this simple [PIR sensor](https://www.kiwi-electronics.nl/PIR-Motion-Sensor) and sends an HTTP request for every trigger, in this case to a [Domoticz](https://domoticz.com/) installation. When motion is constantly detected, this PIR sensor keeps the pin high, in which case this code will keep sending HTTP requests every 10 seconds \(configurable with the hold\_time variable\). diff --git a/tutorials-and-examples/all/repl.md b/tutorials-and-examples/all/repl.md index c9e9eb2..75ec25d 100644 --- a/tutorials-and-examples/all/repl.md +++ b/tutorials-and-examples/all/repl.md @@ -1,4 +1,4 @@ -# 4.2.1 REPL +# REPL Using the Pymakr Plugin, open and connect a device or use serial terminal \(PuTTY, screen, picocom, etc\). Upon connecting, there should be a blank screen with a flashing cursor. Press Enter and a MicroPython prompt should appear, i.e. `>>>`. Let’s make sure it is working with the obligatory test: diff --git a/tutorials-and-examples/all/rgbled.md b/tutorials-and-examples/all/rgbled.md index 4b61621..12f934b 100644 --- a/tutorials-and-examples/all/rgbled.md +++ b/tutorials-and-examples/all/rgbled.md @@ -1,4 +1,4 @@ -# 4.2.11 RGB LED +# RGB LED By default the heartbeat LED flashes in blue colour once every 4s to signal that the system is alive. This can be overridden through the `pycom` module. diff --git a/tutorials-and-examples/all/rmt.md b/tutorials-and-examples/all/rmt.md index c6ace0e..b92af88 100644 --- a/tutorials-and-examples/all/rmt.md +++ b/tutorials-and-examples/all/rmt.md @@ -1,4 +1,4 @@ -# 4.2.16 RMT +# RMT Detailed information about this class can be found in [`RMT`](../../firmware-and-api-reference/pycom/machine/rmt.md). diff --git a/tutorials-and-examples/all/threading.md b/tutorials-and-examples/all/threading.md index 29696c3..ccf249b 100644 --- a/tutorials-and-examples/all/threading.md +++ b/tutorials-and-examples/all/threading.md @@ -1,4 +1,4 @@ -# 4.2.10 Threading +# Threading MicroPython supports spawning threads by the `_thread` module. The following example demonstrates the use of this module. A thread is simply defined as a function that can receive any number of parameters. Below 3 threads are started, each one perform a print at a different interval. diff --git a/tutorials-and-examples/all/timers.md b/tutorials-and-examples/all/timers.md index 2d53fb6..cbeb345 100644 --- a/tutorials-and-examples/all/timers.md +++ b/tutorials-and-examples/all/timers.md @@ -1,4 +1,4 @@ -# 4.2.12 Timers +# Timers Detailed information about this class can be found in [`Timer`](../../firmware-and-api-reference/pycom/machine/timer.md). diff --git a/tutorials-and-examples/all/wlan.md b/tutorials-and-examples/all/wlan.md index 9a7232d..556d74c 100644 --- a/tutorials-and-examples/all/wlan.md +++ b/tutorials-and-examples/all/wlan.md @@ -1,4 +1,4 @@ -# 4.2.2 WLAN +# WLAN The WLAN is a system feature of all Pycom devices, therefore it is enabled by default. diff --git a/tutorials-and-examples/introduction.md b/tutorials-and-examples/introduction.md index 4ccd92d..07533bd 100644 --- a/tutorials-and-examples/introduction.md +++ b/tutorials-and-examples/introduction.md @@ -1,4 +1,4 @@ -# 4.1 Introduction +# Introduction ![](../.gitbook/assets/tutorialsicon.png) diff --git a/tutorials-and-examples/lora/README.md b/tutorials-and-examples/lora/README.md index ef1da67..593f7a4 100644 --- a/tutorials-and-examples/lora/README.md +++ b/tutorials-and-examples/lora/README.md @@ -1,4 +1,4 @@ -# 4.3 LoRa Examples +# LoRa Examples The following tutorials demonstrate the use of the LoRa functionality on the LoPy. LoRa can work in 2 different modes; **LoRa-MAC** \(which we also call Raw-LoRa\) and **LoRaWAN** mode. diff --git a/tutorials-and-examples/lora/lora-mac-nano-gateway.md b/tutorials-and-examples/lora/lora-mac-nano-gateway.md index 262dbab..3daad50 100644 --- a/tutorials-and-examples/lora/lora-mac-nano-gateway.md +++ b/tutorials-and-examples/lora/lora-mac-nano-gateway.md @@ -1,4 +1,4 @@ -# 4.3.4 LoRa-MAC Nano-Gateway +# LoRa-MAC Nano-Gateway This example allows a raw LoRa connection between two LoPys \(nodes\) to a single LoPy acting as a Nano-Gateway. diff --git a/tutorials-and-examples/lora/lora-mac.md b/tutorials-and-examples/lora/lora-mac.md index ab749a7..3973f8d 100644 --- a/tutorials-and-examples/lora/lora-mac.md +++ b/tutorials-and-examples/lora/lora-mac.md @@ -1,4 +1,4 @@ -# 4.3.1 LoRa-MAC \(Raw LoRa\) +# LoRa-MAC \(Raw LoRa\) Basic LoRa connection example, sending and receiving data. In LoRa-MAC mode the LoRaWAN layer is bypassed and the radio is used directly. The data sent is not formatted or encrypted in any way, and no addressing information is added to the frame. diff --git a/tutorials-and-examples/lora/lorawan-abp.md b/tutorials-and-examples/lora/lorawan-abp.md index e486088..15317e4 100644 --- a/tutorials-and-examples/lora/lorawan-abp.md +++ b/tutorials-and-examples/lora/lorawan-abp.md @@ -1,4 +1,4 @@ -# 4.3.3 LoRaWAN with ABP +# LoRaWAN with ABP ABP stands for Authentication By Personalisation. It means that the encryption keys are configured manually on the device and can start sending frames to the Gateway without needing a 'handshake' procedure to exchange the keys \(such as the one performed during an OTAA join procedure\). diff --git a/tutorials-and-examples/lora/lorawan-nano-gateway.md b/tutorials-and-examples/lora/lorawan-nano-gateway.md index 736ea1b..ab58c82 100644 --- a/tutorials-and-examples/lora/lorawan-nano-gateway.md +++ b/tutorials-and-examples/lora/lorawan-nano-gateway.md @@ -1,4 +1,4 @@ -# 4.3.6 LoRaWAN Nano-Gateway +# LoRaWAN Nano-Gateway This example allows to connect a LoPy to a LoRaWAN network such as The Things Network \(TTN\) or Loriot to be used as a nano-gateway. diff --git a/tutorials-and-examples/lora/lorawan-otaa.md b/tutorials-and-examples/lora/lorawan-otaa.md index 03c45ea..182d319 100644 --- a/tutorials-and-examples/lora/lorawan-otaa.md +++ b/tutorials-and-examples/lora/lorawan-otaa.md @@ -1,4 +1,4 @@ -# 4.3.2 LoRaWAN with OTAA +# LoRaWAN with OTAA OTAA stands for Over The Air Authentication. With this method the LoPy sends a Join request to the LoRaWAN Gateway using the `APPEUI` and `APPKEY` provided. If the keys are correct the Gateway will reply to the LoPy with a join accept message and from that point on the LoPy is able to send and receive packets to/from the Gateway. If the keys are incorrect no response will be received and the `has_joined()` method will always return `False`. diff --git a/tutorials-and-examples/lora/module-module.md b/tutorials-and-examples/lora/module-module.md index 77dc99e..a97e1de 100644 --- a/tutorials-and-examples/lora/module-module.md +++ b/tutorials-and-examples/lora/module-module.md @@ -1,4 +1,4 @@ -# 4.3.5 LoPy to LoPy +# LoPy to LoPy This example shows how to connect two Pycode LoRa capable modules \(nodes\) via raw LoRa. diff --git a/tutorials-and-examples/lora/rn2483-to-lopy.md b/tutorials-and-examples/lora/rn2483-to-lopy.md index c4f369d..6d14620 100644 --- a/tutorials-and-examples/lora/rn2483-to-lopy.md +++ b/tutorials-and-examples/lora/rn2483-to-lopy.md @@ -1,4 +1,4 @@ -# 4.3.7 RN2483 to LoPy +# RN2483 to LoPy This example shows how to send data between a Microchip RN2483 and a LoPy via raw LoRa. diff --git a/tutorials-and-examples/lte/README.md b/tutorials-and-examples/lte/README.md index 14aac18..c572242 100644 --- a/tutorials-and-examples/lte/README.md +++ b/tutorials-and-examples/lte/README.md @@ -1,4 +1,4 @@ -# 4.5 LTE Examples +# LTE Examples The following tutorials demonstrate the use of the LTE CAT-M1 and NB-IoT functionality on cellular enabled Pycom modules. diff --git a/tutorials-and-examples/lte/cat-m1.md b/tutorials-and-examples/lte/cat-m1.md index 3026e90..b56c677 100644 --- a/tutorials-and-examples/lte/cat-m1.md +++ b/tutorials-and-examples/lte/cat-m1.md @@ -1,4 +1,4 @@ -# 4.5.1 CAT-M1 +# CAT-M1 {% hint style="info" %} Please ensure you have the latest Sequans modem firmware for the best network compatibility. Instructions for this can be found [here](firmware.md). diff --git a/tutorials-and-examples/lte/firmware.md b/tutorials-and-examples/lte/firmware.md index f0c1442..5e82528 100644 --- a/tutorials-and-examples/lte/firmware.md +++ b/tutorials-and-examples/lte/firmware.md @@ -1,4 +1,4 @@ -# 4.5.4 Modem Firmware Update +# Modem Firmware Update ## Description diff --git a/tutorials-and-examples/lte/imei.md b/tutorials-and-examples/lte/imei.md index f14da4e..dff1d81 100644 --- a/tutorials-and-examples/lte/imei.md +++ b/tutorials-and-examples/lte/imei.md @@ -1,4 +1,4 @@ -# 4.5.3 Module IMEI +# Module IMEI In order to retrieve the IMEI of your cellular enabled Pycom module you will firstly need to make sure you are on firmware version `1.17.0.b1` or higher. You can check your firmware version by running the following code on you device via the interactive REPL. diff --git a/tutorials-and-examples/lte/nb-iot.md b/tutorials-and-examples/lte/nb-iot.md index e7b77e2..e728968 100644 --- a/tutorials-and-examples/lte/nb-iot.md +++ b/tutorials-and-examples/lte/nb-iot.md @@ -1,4 +1,4 @@ -# 4.5.2 NB-IoT +# NB-IoT ## LTE class for Narrow Band IoT diff --git a/tutorials-and-examples/pyscan.md b/tutorials-and-examples/pyscan.md index e9f320e..b77f3dc 100644 --- a/tutorials-and-examples/pyscan.md +++ b/tutorials-and-examples/pyscan.md @@ -1,4 +1,4 @@ -# 4.8 Pyscan Examples +# Pyscan Examples This basic example shows how to read an NFC card and authenticate it using a pre-defined access list. diff --git a/tutorials-and-examples/pysense.md b/tutorials-and-examples/pysense.md index c064bd1..d369456 100644 --- a/tutorials-and-examples/pysense.md +++ b/tutorials-and-examples/pysense.md @@ -1,4 +1,4 @@ -# 4.7 Pysense Examples +# Pysense Examples ## Accelerometer diff --git a/tutorials-and-examples/pytrack.md b/tutorials-and-examples/pytrack.md index 40427c0..3d00fec 100644 --- a/tutorials-and-examples/pytrack.md +++ b/tutorials-and-examples/pytrack.md @@ -1,4 +1,4 @@ -# 4.6 Pytrack Examples +# Pytrack Examples Both the Pysense and Pytrack use the same accelerometer. Please see the [Pysense Examples](pysense.md) to see how to use the accelerometer. diff --git a/tutorials-and-examples/sigfox.md b/tutorials-and-examples/sigfox.md index 7b5b500..7290ef1 100644 --- a/tutorials-and-examples/sigfox.md +++ b/tutorials-and-examples/sigfox.md @@ -1,4 +1,4 @@ -# 4.4 Sigfox Examples +# Sigfox Examples Before you start, make sure that your device was registered with [Sigfox](../getting-started/registration/sigfox.md).