mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-21 04:06:11 +01:00
GitBook: [master] 173 pages modified
This commit is contained in:
Daniel Spindelbauer
committed by
gitbook-bot
gitbook-bot
parent
f07b7256fd
commit
78cc91b995
@@ -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)
|
||||
|
||||
|
||||
|
||||
|
||||
364
SUMMARY.md
364
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?
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 9.2 CLI Updater
|
||||
# CLI Updater
|
||||
|
||||
## Command Line Update Utility
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 9.3 SecureBoot and Encryption
|
||||
# SecureBoot and Encryption
|
||||
|
||||
## Summary
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.5 array
|
||||
# array
|
||||
|
||||
See [Python array](https://docs.python.org/3/library/array.html) for more information.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.20 Builtin
|
||||
# Builtin
|
||||
|
||||
All builtin functions are described here. They are also available via [builtins](builtin.md) module.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.8 gc
|
||||
# gc
|
||||
|
||||
## Functions
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.1 micropython
|
||||
# micropython
|
||||
|
||||
## Functions
|
||||
|
||||
|
||||
@@ -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\).
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.3 sys
|
||||
# sys
|
||||
|
||||
## Functions
|
||||
|
||||
|
||||
@@ -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\).
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.17 ucrypto
|
||||
# ucrypto
|
||||
|
||||
This module provides native support for cryptographic algorithms. It’s loosely based on PyCrypto.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.10 ujson
|
||||
# ujson
|
||||
|
||||
This modules allows to convert between Python objects and the JSON data format.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.4 uos
|
||||
# uos
|
||||
|
||||
The `uos` module contains functions for filesystem access and `urandom` function.
|
||||
|
||||
|
||||
@@ -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\).
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.12 usocket
|
||||
# usocket
|
||||
|
||||
This module provides access to the BSD socket interface.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.3.18 ustruct
|
||||
# ustruct
|
||||
|
||||
See Python [struct](https://docs.python.org/3/library/struct.html) for more information.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.4 Notes
|
||||
# Notes
|
||||
|
||||
## Interrupt Handling
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.2.1 machine
|
||||
# machine
|
||||
|
||||
The `machine` module contains specific functions related to the board.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ search:
|
||||
- ADCChannel
|
||||
---
|
||||
|
||||
# 5.2.1.1 ADC
|
||||
# ADC
|
||||
|
||||
## class ADC – Analog to Digital Conversion
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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`.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.2.1.5 PWM
|
||||
# PWM
|
||||
|
||||
## class PWM – Pulse Width Modulation
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.2.1.6 RTC
|
||||
# RTC
|
||||
|
||||
The RTC is used to keep track of the date and time.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 5.2.1.10 Timer
|
||||
# Timer
|
||||
|
||||
## class Timer – Measure Time and Set Alarms
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.\).
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.\).
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.5 FiPy
|
||||
# FiPy
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.4 GPy
|
||||
# GPy
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.1 LoPy
|
||||
# LoPy
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.2 LoPy4
|
||||
# LoPy 4
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.3 SiPy
|
||||
# SiPy
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.1.6 WiPy
|
||||
# WiPy
|
||||
|
||||
## Basic connection
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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`.
|
||||
|
||||
|
||||
@@ -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\).
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.4.3 LoRaWAN
|
||||
# LoRaWAN
|
||||
|
||||
## Raw LoRa
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.4.3.2 Objenious
|
||||
# Objenious
|
||||
|
||||
## Identifiers
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.2.1 Drivers
|
||||
# Drivers
|
||||
|
||||
## Linux
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 1.2.3 Pymakr
|
||||
# Pymakr
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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/" %}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.3.5 Expansion Board 2.0
|
||||
# Expansion Board 2.0
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.3.1 Expansion Board 3.0
|
||||
# Expansion Board 3.0
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.3.4 Pyscan
|
||||
# Pyscan
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.3.3 Pysense
|
||||
# Pysense
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.3.2 Pytrack
|
||||
# Pytrack
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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" %}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.1.7 FiPy
|
||||
# FiPy
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# 6.1.6 GPy
|
||||
# GPy
|
||||
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user