pycom-documentation/SUMMARY.md

Table of contents

• Introduction

1. Getting Started

• 1.0 Introduction
• 1.1 Hardware Setup
  • 1.1.1 LoPy
  • 1.1.2 LoPy4
  • 1.1.3 SiPy
  • 1.1.4 GPy
  • 1.1.5 FiPy
  • 1.1.6 WiPy
• 1.2 Software
  • 1.2.1 Drivers
  • 1.2.2 Updating Firmware
  • 1.2.3 Pymakr
• 1.3 Programming the modules
  • 1.3.1 Introduction to MicroPython
  • 1.3.2 MicroPython Examples
  • 1.3.3 Your first Pymakr project
  • 1.3.4 REPL
    • 1.3.4.1 Serial USB (UART)
    • 1.3.4.2 Telnet REPL
  • 1.3.5 FTP
  • 1.3.6 Safe boot
• 1.4 Device Registration
  • 1.4.1 Sigfox
  • 1.4.2 Cellular
  • 1.4.3 LoRaWAN
    • 1.4.3.1 The Things Network
    • 1.4.3.2 Objenious
• Pycom Products

2. Pymakr Plugin

• 2.1 Installation
  • 2.1.1 Atom
  • 2.1.2 Visual Studio Code
• 2.2 Tools/Features
• 2.3 Settings

3. Pytrack, Pysense, Pyscan

• 3.1 Introduction
• 3.2 Installing Software
  • 3.2.1 Updating Firmware
  • 3.2.2 Installing Drivers - Windows 7
  • 3.2.3 Installing Libraries
• 3.3 API Reference
  • 3.3.1 Pytrack
  • 3.3.2 Pysense
  • 3.3.4 Pyscan
  • 3.3.5 Sleep

4. Tutorials & Examples

• 4.1 Introduction
• 4.2 All Pycom Device Examples
  • 4.2.1 REPL
  • 4.2.2 WLAN
  • 4.2.3 Bluetooth
  • 4.2.4 HTTPS
  • 4.2.5 MQTT
  • 4.2.6 AWS
  • 4.2.7 ADC
  • 4.2.8 I2C
  • 4.2.9 Onewire Driver
  • 4.2.10 Threading
  • 4.2.11 RGB LED
  • 4.2.12 Timers
  • 4.2.13 PIR Sensor
  • 4.2.14 Modbus
  • 4.2.15 OTA update
  • 4.2.16 RMT
• 4.3 LoRa Examples
  • 4.3.1 LoRa-MAC (Raw LoRa)
  • 4.3.2 LoRaWAN with OTAA
  • 4.3.3 LoRaWAN with ABP
  • 4.3.4 LoRa-MAC Nano-Gateway
  • 4.3.5 LoPy to LoPy
  • 4.3.6 LoRaWAN Nano-Gateway
  • 4.3.7 RN2483 to LoPy
• 4.4 Sigfox Examples
• 4.5 LTE Examples
  • 4.5.1 CAT-M1
  • 4.5.2 NB-IoT
  • 4.5.3 Module IMEI
  • 4.5.4 Modem Firmware Update
• 4.6 Pytrack Examples
• 4.7 Pysense Examples
• 4.8 Pyscan Examples

5. Firmware & API Reference

• 5.1 Introduction
• 5.2 Pycom Modules
  • 5.2.1 machine
    • 5.2.1.1 ADC
    • 5.2.1.2 DAC
    • 5.2.1.3 I2C
    • 5.2.1.4 Pin
    • 5.2.1.5 PWM
    • 5.2.1.6 RTC
    • 5.2.1.7 SPI
    • 5.2.1.8 UART
    • 5.2.1.9 WDT
    • 5.2.1.10 Timer
    • 5.2.1.11 SD
    • 5.2.1.12 CAN
    • 5.2.1.13 RMT
  • 5.2.2 network
    • 5.2.2.1 WLAN
    • 5.2.2.2 Server
    • 5.2.2.3 Bluetooth
      • 5.2.2.3.1 GATT
      • 5.2.2.3.2 GATTCConnection
      • 5.2.2.3.3 GATTCService
      • 5.2.2.3.4 GATTCCharacteristic
      • 5.2.2.3.5 GATTSService
      • 5.2.2.3.6 GATTSCharacteristic
    • 5.2.2.4 LoRa
    • 5.2.2.5 Sigfox
    • 5.2.2.6 LTE
  • 5.2.3 AES
  • 5.2.4 pycom
• 5.3 MicroPython Modules
  • 5.3.1 micropython
  • 5.3.2 uctypes
  • 5.3.3 sys
  • 5.3.4 uos
  • 5.3.5 array
  • 5.3.6 cmath
  • 5.3.7 math
  • 5.3.8 gc
  • 5.3.9 ubinascii
  • 5.3.10 ujson
  • 5.3.11 ure
  • 5.3.12 usocket
  • 5.3.13 select
  • 5.3.14 utime
  • 5.3.15 uhashlib
  • 5.3.16 ussl
  • 5.3.17 ucrypto
  • 5.3.18 ustruct
  • 5.3.19 _thread
  • 5.3.20 Builtin
• 5.4 Notes

6. Product Info

• 6.0 Introduction
• 6.1 Development Modules
  • 6.1.1 WiPy 2.0
  • 6.1.2 WiPy 3.0
  • 6.1.3 LoPy
  • 6.1.4 LoPy 4
  • 6.1.5 SiPy
  • 6.1.6 GPy
  • 6.1.7 FiPy
• 6.2 OEM Modules
  • 6.2.1 W01
  • 6.2.2 L01
  • 6.2.3 L04
  • 6.2.4 G01
  • 6.2.5 L01 OEM Baseboard Reference
  • 6.2.6 Universal OEM Baseboard Reference
• 6.3 Expansion Boards and Shields
  • 6.3.1 Expansion Board 3.0
  • 6.3.2 Pytrack
  • 6.3.3 Pysense
  • 6.3.4 Pyscan
  • 6.3.5 Expansion Board 2.0
  • 6.3.6 Deep Sleep Shield
    • 6.3.6.1 Deep Sleep API
• 6.4 Notes

7. Pybytes

• 7.1 Introduction
• 7.2 Getting Started with Pybytes
• 7.3 Add a device to Pybytes
  • 7.3.1 Connect to Pybytes: Quick Add
  • 7.3.2 Connect to Pybytes: Flash Pybytes library manually
  • 7.3.3 Add Sigfox device
    • 7.3.3.1 DevKit contract
    • 7.3.3.2 Custom contract
• 7.4 Visualise data from your device

8. Documentation Notes

• 8.1 Introduction
• 8.2 Syntax
• 8.3 REPL vs Scripts
• 8.4 Mesh Networks

9. Advanced Topics

• 9.1 Firmware Downgrade
• 9.2 CLI Updater
• 9.3 SecureBoot and Encryption

Have a question?

• Ask on the Forum
• License