GitBook: [master] 324 pages modified

This commit is contained in:
Daniel Spindelbauer
2018-08-22 10:27:19 +00:00
committed by gitbook-bot
parent 13e99f7fde
commit a986dbba9b
164 changed files with 274 additions and 274 deletions

View File

@@ -5,9 +5,9 @@ Welcome to the Pycom documentation site. We recommend reading through all the se
To get started, read through the Getting Started Guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects. To get started, read through the Getting Started Guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects.
* [Products](products.md) * [Products](products.md)
* [Getting Started](getting-started/introduction.md) * [Getting Started](gettingstarted/introduction.md)
* [Tutorials](tutorials-and-examples/introduction.md) * [Tutorials](tutorials/introduction.md)
* [Product Info](product-info/introduction.md) * [Product Info](datasheets/introduction.md)
* [API Documentation](firmware-and-api-reference/introduction.md) * [API Documentation](firmwareapi/introduction.md)
* [Pybytes](pybytes/introduction.md) * [Pybytes](pybytes/introduction.md)

View File

@@ -5,41 +5,41 @@
## Getting Started ## Getting Started
* [Introduction](getting-started/introduction.md) * [Introduction](gettingstarted/introduction.md)
* [Hardware Setup](getting-started/hardware/README.md) * [Hardware Setup](gettingstarted/connection/README.md)
* [LoPy](getting-started/hardware/lopy.md) * [LoPy](gettingstarted/connection/lopy.md)
* [LoPy 4](getting-started/hardware/lopy4.md) * [LoPy 4](gettingstarted/connection/lopy4.md)
* [SiPy](getting-started/hardware/sipy.md) * [SiPy](gettingstarted/connection/sipy.md)
* [GPy](getting-started/hardware/gpy.md) * [GPy](gettingstarted/connection/gpy.md)
* [FiPy](getting-started/hardware/fipy.md) * [FiPy](gettingstarted/connection/fipy.md)
* [WiPy](getting-started/hardware/wipy.md) * [WiPy](gettingstarted/connection/wipy.md)
* [Software](getting-started/software/README.md) * [Software](gettingstarted/installation/README.md)
* [Drivers](getting-started/software/drivers.md) * [Drivers](gettingstarted/installation/drivers.md)
* [Updating Firmware](getting-started/software/firmwaretool.md) * [Updating Firmware](gettingstarted/installation/firmwaretool.md)
* [Pymakr](getting-started/software/pymakr.md) * [Pymakr](gettingstarted/installation/pymakr.md)
* [Programming the modules](getting-started/programming/README.md) * [Programming the modules](gettingstarted/programming/README.md)
* [Introduction to MicroPython](getting-started/programming/micropython.md) * [Introduction to MicroPython](gettingstarted/programming/micropython.md)
* [MicroPython Examples](getting-started/programming/examples.md) * [MicroPython Examples](gettingstarted/programming/examples.md)
* [Your first Pymakr project](getting-started/programming/first-project.md) * [Your first Pymakr project](gettingstarted/programming/first-project.md)
* [REPL](getting-started/programming/repl/README.md) * [REPL](gettingstarted/programming/repl/README.md)
* [Serial USB \(UART\)](getting-started/programming/repl/serial.md) * [Serial USB \(UART\)](gettingstarted/programming/repl/serial.md)
* [Telnet REPL](getting-started/programming/repl/telnet.md) * [Telnet REPL](gettingstarted/programming/repl/telnet.md)
* [FTP](getting-started/programming/ftp.md) * [FTP](gettingstarted/programming/ftp.md)
* [Safe boot](getting-started/programming/safeboot.md) * [Safe boot](gettingstarted/programming/safeboot.md)
* [Device Registration](getting-started/registration/README.md) * [Device Registration](gettingstarted/registration/README.md)
* [Sigfox](getting-started/registration/sigfox.md) * [Sigfox](gettingstarted/registration/sigfox.md)
* [Cellular](getting-started/registration/cellular.md) * [Cellular](gettingstarted/registration/cellular.md)
* [LoRaWAN](getting-started/registration/lora/README.md) * [LoRaWAN](gettingstarted/registration/lora/README.md)
* [The Things Network](getting-started/registration/lora/ttn.md) * [The Things Network](gettingstarted/registration/lora/ttn.md)
* [Objenious](getting-started/registration/lora/objenious.md) * [Objenious](gettingstarted/registration/lora/objenious.md)
## Pymakr Plugin ## Pymakr Plugin
* [Installation](pymakr-plugin/installation/README.md) * [Installation](pymakr/installation/README.md)
* [Atom](pymakr-plugin/installation/atom.md) * [Atom](pymakr/installation/atom.md)
* [Visual Studio Code](pymakr-plugin/installation/vscode.md) * [Visual Studio Code](pymakr/installation/vscode.md)
* [Tools/Features](pymakr-plugin/features.md) * [Tools/Features](pymakr/toolsfeatures.md)
* [Settings](pymakr-plugin/settings.md) * [Settings](pymakr/settings.md)
## Pytrack, Pysense, Pyscan ## Pytrack, Pysense, Pyscan
@@ -56,150 +56,150 @@
## Tutorials & Examples ## Tutorials & Examples
* [Introduction](tutorials-and-examples/introduction.md) * [Introduction](tutorials/introduction.md)
* [All Pycom Device Examples](tutorials-and-examples/all/README.md) * [All Pycom Device Examples](tutorials/all/README.md)
* [REPL](tutorials-and-examples/all/repl.md) * [REPL](tutorials/all/repl.md)
* [WLAN](tutorials-and-examples/all/wlan.md) * [WLAN](tutorials/all/wlan.md)
* [Bluetooth](tutorials-and-examples/all/ble.md) * [Bluetooth](tutorials/all/ble.md)
* [HTTPS](tutorials-and-examples/all/https.md) * [HTTPS](tutorials/all/https.md)
* [MQTT](tutorials-and-examples/all/mqtt.md) * [MQTT](tutorials/all/mqtt.md)
* [AWS](tutorials-and-examples/all/aws.md) * [AWS](tutorials/all/aws.md)
* [ADC](tutorials-and-examples/all/adc.md) * [ADC](tutorials/all/adc.md)
* [I2C](tutorials-and-examples/all/i2c.md) * [I2C](tutorials/all/i2c.md)
* [Onewire Driver](tutorials-and-examples/all/owd.md) * [Onewire Driver](tutorials/all/owd.md)
* [Threading](tutorials-and-examples/all/threading.md) * [Threading](tutorials/all/threading.md)
* [RGB LED](tutorials-and-examples/all/rgbled.md) * [RGB LED](tutorials/all/rgbled.md)
* [Timers](tutorials-and-examples/all/timers.md) * [Timers](tutorials/all/timers.md)
* [PIR Sensor](tutorials-and-examples/all/pir.md) * [PIR Sensor](tutorials/all/pir.md)
* [Modbus](tutorials-and-examples/all/modbus.md) * [Modbus](tutorials/all/modbus.md)
* [OTA update](tutorials-and-examples/all/ota.md) * [OTA update](tutorials/all/ota.md)
* [RMT](tutorials-and-examples/all/rmt.md) * [RMT](tutorials/all/rmt.md)
* [LoRa Examples](tutorials-and-examples/lora/README.md) * [LoRa Examples](tutorials/lora/README.md)
* [LoRa-MAC \(Raw LoRa\)](tutorials-and-examples/lora/lora-mac.md) * [LoRa-MAC \(Raw LoRa\)](tutorials/lora/lora-mac.md)
* [LoRaWAN with OTAA](tutorials-and-examples/lora/lorawan-otaa.md) * [LoRaWAN with OTAA](tutorials/lora/lorawan-otaa.md)
* [LoRaWAN with ABP](tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN with ABP](tutorials/lora/lorawan-abp.md)
* [LoRa-MAC Nano-Gateway](tutorials-and-examples/lora/lora-mac-nano-gateway.md) * [LoRa-MAC Nano-Gateway](tutorials/lora/lora-mac-nano-gateway.md)
* [LoPy to LoPy](tutorials-and-examples/lora/module-module.md) * [LoPy to LoPy](tutorials/lora/module-module.md)
* [LoRaWAN Nano-Gateway](tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN Nano-Gateway](tutorials/lora/lorawan-nano-gateway.md)
* [RN2483 to LoPy](tutorials-and-examples/lora/rn2483-to-lopy.md) * [RN2483 to LoPy](tutorials/lora/rn2483-to-lopy.md)
* [Sigfox Examples](tutorials-and-examples/sigfox.md) * [Sigfox Examples](tutorials/sigfox.md)
* [LTE Examples](tutorials-and-examples/lte/README.md) * [LTE Examples](tutorials/lte/README.md)
* [CAT-M1](tutorials-and-examples/lte/cat-m1.md) * [CAT-M1](tutorials/lte/cat-m1.md)
* [NB-IoT](tutorials-and-examples/lte/nb-iot.md) * [NB-IoT](tutorials/lte/nb-iot.md)
* [Module IMEI](tutorials-and-examples/lte/imei.md) * [Module IMEI](tutorials/lte/imei.md)
* [Modem Firmware Update](tutorials-and-examples/lte/firmware.md) * [Modem Firmware Update](tutorials/lte/firmware.md)
* [Pytrack Examples](tutorials-and-examples/pytrack.md) * [Pytrack Examples](tutorials/pytrack.md)
* [Pysense Examples](tutorials-and-examples/pysense.md) * [Pysense Examples](tutorials/pysense.md)
* [Pyscan Examples](tutorials-and-examples/pyscan.md) * [Pyscan Examples](tutorials/pyscan.md)
## Firmware & API Reference ## Firmware & API Reference
* [Introduction](firmware-and-api-reference/introduction.md) * [Introduction](firmwareapi/introduction.md)
* [Pycom Modules](firmware-and-api-reference/pycom/README.md) * [Pycom Modules](firmwareapi/pycom/README.md)
* [machine](firmware-and-api-reference/pycom/machine/README.md) * [machine](firmwareapi/pycom/machine/README.md)
* [ADC](firmware-and-api-reference/pycom/machine/adc.md) * [ADC](firmwareapi/pycom/machine/adc.md)
* [DAC](firmware-and-api-reference/pycom/machine/dac.md) * [DAC](firmwareapi/pycom/machine/dac.md)
* [I2C](firmware-and-api-reference/pycom/machine/i2c.md) * [I2C](firmwareapi/pycom/machine/i2c.md)
* [Pin](firmware-and-api-reference/pycom/machine/pin.md) * [Pin](firmwareapi/pycom/machine/pin.md)
* [PWM](firmware-and-api-reference/pycom/machine/pwm.md) * [PWM](firmwareapi/pycom/machine/pwm.md)
* [RTC](firmware-and-api-reference/pycom/machine/rtc.md) * [RTC](firmwareapi/pycom/machine/rtc.md)
* [SPI](firmware-and-api-reference/pycom/machine/spi.md) * [SPI](firmwareapi/pycom/machine/spi.md)
* [UART](firmware-and-api-reference/pycom/machine/uart.md) * [UART](firmwareapi/pycom/machine/uart.md)
* [WDT](firmware-and-api-reference/pycom/machine/wdt.md) * [WDT](firmwareapi/pycom/machine/wdt.md)
* [Timer](firmware-and-api-reference/pycom/machine/timer.md) * [Timer](firmwareapi/pycom/machine/timer.md)
* [SD](firmware-and-api-reference/pycom/machine/sd.md) * [SD](firmwareapi/pycom/machine/sd.md)
* [CAN](firmware-and-api-reference/pycom/machine/can.md) * [CAN](firmwareapi/pycom/machine/can.md)
* [RMT](firmware-and-api-reference/pycom/machine/rmt.md) * [RMT](firmwareapi/pycom/machine/rmt.md)
* [network](firmware-and-api-reference/pycom/network/README.md) * [network](firmwareapi/pycom/network/README.md)
* [WLAN](firmware-and-api-reference/pycom/network/wlan.md) * [WLAN](firmwareapi/pycom/network/wlan.md)
* [Server](firmware-and-api-reference/pycom/network/server.md) * [Server](firmwareapi/pycom/network/server.md)
* [Bluetooth](firmware-and-api-reference/pycom/network/bluetooth/README.md) * [Bluetooth](firmwareapi/pycom/network/bluetooth/README.md)
* [GATT](firmware-and-api-reference/pycom/network/bluetooth/gatt.md) * [GATT](firmwareapi/pycom/network/bluetooth/gatt.md)
* [GATTCConnection](firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) * [GATTCConnection](firmwareapi/pycom/network/bluetooth/gattcconnection.md)
* [GATTCService](firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) * [GATTCService](firmwareapi/pycom/network/bluetooth/gattccservice.md)
* [GATTCCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) * [GATTCCharacteristic](firmwareapi/pycom/network/bluetooth/gattccharacteristic.md)
* [GATTSService](firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) * [GATTSService](firmwareapi/pycom/network/bluetooth/gattsservice.md)
* [GATTSCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) * [GATTSCharacteristic](firmwareapi/pycom/network/bluetooth/gattscharacteristic.md)
* [LoRa](firmware-and-api-reference/pycom/network/lora.md) * [LoRa](firmwareapi/pycom/network/lora.md)
* [Sigfox](firmware-and-api-reference/pycom/network/sigfox.md) * [Sigfox](firmwareapi/pycom/network/sigfox.md)
* [LTE](firmware-and-api-reference/pycom/network/lte.md) * [LTE](firmwareapi/pycom/network/lte.md)
* [AES](firmware-and-api-reference/pycom/aes.md) * [AES](firmwareapi/pycom/aes.md)
* [pycom](firmware-and-api-reference/pycom/pycom.md) * [pycom](firmwareapi/pycom/pycom.md)
* [MicroPython Modules](firmware-and-api-reference/micropython/README.md) * [MicroPython Modules](firmwareapi/micropython/README.md)
* [micropython](firmware-and-api-reference/micropython/micropython.md) * [micropython](firmwareapi/micropython/micropython.md)
* [uctypes](firmware-and-api-reference/micropython/uctypes.md) * [uctypes](firmwareapi/micropython/uctypes.md)
* [sys](firmware-and-api-reference/micropython/sys.md) * [sys](firmwareapi/micropython/sys.md)
* [uos](firmware-and-api-reference/micropython/uos.md) * [uos](firmwareapi/micropython/uos.md)
* [array](firmware-and-api-reference/micropython/array.md) * [array](firmwareapi/micropython/array.md)
* [cmath](firmware-and-api-reference/micropython/cmath.md) * [cmath](firmwareapi/micropython/cmath.md)
* [math](firmware-and-api-reference/micropython/math.md) * [math](firmwareapi/micropython/math.md)
* [gc](firmware-and-api-reference/micropython/gc.md) * [gc](firmwareapi/micropython/gc.md)
* [ubinascii](firmware-and-api-reference/micropython/ubinascii.md) * [ubinascii](firmwareapi/micropython/ubinascii.md)
* [ujson](firmware-and-api-reference/micropython/ujson.md) * [ujson](firmwareapi/micropython/ujson.md)
* [ure](firmware-and-api-reference/micropython/ure.md) * [ure](firmwareapi/micropython/ure.md)
* [usocket](firmware-and-api-reference/micropython/usocket.md) * [usocket](firmwareapi/micropython/usocket.md)
* [select](firmware-and-api-reference/micropython/select.md) * [select](firmwareapi/micropython/select.md)
* [utime](firmware-and-api-reference/micropython/utime.md) * [utime](firmwareapi/micropython/utime.md)
* [uhashlib](firmware-and-api-reference/micropython/uhashlib.md) * [uhashlib](firmwareapi/micropython/uhashlib.md)
* [ussl](firmware-and-api-reference/micropython/ussl.md) * [ussl](firmwareapi/micropython/ussl.md)
* [ucrypto](firmware-and-api-reference/micropython/ucrypto.md) * [ucrypto](firmwareapi/micropython/ucrypto.md)
* [ustruct](firmware-and-api-reference/micropython/ustruct.md) * [ustruct](firmwareapi/micropython/ustruct.md)
* [\_thread](firmware-and-api-reference/micropython/_thread.md) * [\_thread](firmwareapi/micropython/_thread.md)
* [Builtin](firmware-and-api-reference/micropython/builtin.md) * [Builtin](firmwareapi/micropython/builtin.md)
* [Notes](firmware-and-api-reference/notes.md) * [Notes](firmwareapi/notes.md)
## Product Info ## Product Info
* [Introduction](product-info/introduction.md) * [Introduction](datasheets/introduction.md)
* [Development Modules](product-info/development/README.md) * [Development Modules](datasheets/development/README.md)
* [WiPy 2.0](product-info/development/wipy2.md) * [WiPy 2.0](datasheets/development/wipy2.md)
* [WiPy 3.0](product-info/development/wipy3.md) * [WiPy 3.0](datasheets/development/wipy3.md)
* [LoPy](product-info/development/lopy.md) * [LoPy](datasheets/development/lopy.md)
* [LoPy 4](product-info/development/lopy4.md) * [LoPy 4](datasheets/development/lopy4.md)
* [SiPy](product-info/development/sipy.md) * [SiPy](datasheets/development/sipy.md)
* [GPy](product-info/development/gpy.md) * [GPy](datasheets/development/gpy.md)
* [FiPy](product-info/development/fipy.md) * [FiPy](datasheets/development/fipy.md)
* [OEM Modules](product-info/oem/README.md) * [OEM Modules](datasheets/oem/README.md)
* [W01](product-info/oem/w01.md) * [W01](datasheets/oem/w01.md)
* [L01](product-info/oem/l01.md) * [L01](datasheets/oem/l01.md)
* [L04](product-info/oem/l04.md) * [L04](datasheets/oem/l04.md)
* [G01](product-info/oem/g01.md) * [G01](datasheets/oem/g01.md)
* [L01 OEM Baseboard Reference](product-info/oem/l01_reference.md) * [L01 OEM Baseboard Reference](datasheets/oem/l01_reference.md)
* [Universal OEM Baseboard Reference](product-info/oem/universal_reference.md) * [Universal OEM Baseboard Reference](datasheets/oem/universal_reference.md)
* [Expansion Boards and Shields](product-info/boards/README.md) * [Expansion Boards and Shields](datasheets/boards/README.md)
* [Expansion Board 3.0](product-info/boards/expansion3.md) * [Expansion Board 3.0](datasheets/boards/expansion3.md)
* [Pytrack](product-info/boards/pytrack.md) * [Pytrack](datasheets/boards/pytrack.md)
* [Pysense](product-info/boards/pysense.md) * [Pysense](datasheets/boards/pysense.md)
* [Pyscan](product-info/boards/pyscan.md) * [Pyscan](datasheets/boards/pyscan.md)
* [Expansion Board 2.0](product-info/boards/expansion2.md) * [Expansion Board 2.0](datasheets/boards/expansion2.md)
* [Deep Sleep Shield](product-info/boards/deepsleep/README.md) * [Deep Sleep Shield](datasheets/boards/deepsleep/README.md)
* [Deep Sleep API](product-info/boards/deepsleep/api.md) * [Deep Sleep API](datasheets/boards/deepsleep/api.md)
* [Notes](product-info/notes.md) * [Notes](datasheets/notes.md)
## Pybytes ## Pybytes
* [Introduction](pybytes/introduction.md) * [Introduction](pybytes/introduction.md)
* [Getting Started with Pybytes](pybytes/getting-started.md) * [Getting Started with Pybytes](pybytes/getstarted.md)
* [Add a device to Pybytes](pybytes/add-device/README.md) * [Add a device to Pybytes](pybytes/connect/README.md)
* [Connect to Pybytes: Quick Add](pybytes/add-device/quick.md) * [Connect to Pybytes: Quick Add](pybytes/connect/quick.md)
* [Connect to Pybytes: Flash Pybytes library manually](pybytes/add-device/flash.md) * [Connect to Pybytes: Flash Pybytes library manually](pybytes/connect/flash.md)
* [Add Sigfox device](pybytes/add-device/sigfox/README.md) * [Add Sigfox device](pybytes/connect/sigfox/README.md)
* [DevKit contract](pybytes/add-device/sigfox/devkit.md) * [DevKit contract](pybytes/connect/sigfox/devkit.md)
* [Custom contract](pybytes/add-device/sigfox/custom.md) * [Custom contract](pybytes/connect/sigfox/custom.md)
* [Visualise data from your device](pybytes/visualise-data.md) * [Visualise data from your device](pybytes/dashboard.md)
## Documentation Notes ## Documentation Notes
* [Introduction](documentation-notes/introduction.md) * [Introduction](docnotes/introduction.md)
* [Syntax](documentation-notes/syntax.md) * [Syntax](docnotes/syntax.md)
* [REPL vs Scripts](documentation-notes/replscript.md) * [REPL vs Scripts](docnotes/replscript.md)
* [Mesh Networks](documentation-notes/mesh-networks.md) * [Mesh Networks](docnotes/mesh-networks.md)
## Advanced Topics ## Advanced Topics
* [Firmware Downgrade](advanced-topics/downgrade.md) * [Firmware Downgrade](advance/downgrade.md)
* [CLI Updater](advanced-topics/cli.md) * [CLI Updater](advance/cli.md)
* [SecureBoot and Encryption](advanced-topics/encryption.md) * [SecureBoot and Encryption](advance/encryption.md)
* [License](license.md) * [License](license.md)
## Have a question? ## Have a question?

View File

@@ -325,7 +325,7 @@ To restore your OTA block: `$pycom-fwtool-cli -p PORT ota -r -f backup.ota`
#### lpwan #### lpwan
Get/Set LPWAN parameters saved to non-volatile storage. Please see [here](../firmware-and-api-reference/pycom/network/lora.md##loranvramsave) for more details. Get/Set LPWAN parameters saved to non-volatile storage. Please see [here](../firmwareapi/pycom/network/lora.md##loranvramsave) for more details.
```text ```text
usage: pycom-fwtool-cli -p PORT lpwan [-h] [--region REGION] usage: pycom-fwtool-cli -p PORT lpwan [-h] [--region REGION]

View File

@@ -48,13 +48,13 @@ The AT commands for the Sequans Monarch modem on the FiPy are available in a PDF
## Tutorials ## Tutorials
Tutorials on how to the FiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: Tutorials on how to the FiPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the FiPy:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN node](../../tutorials/lora/lorawan-abp.md)
* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
* [Sigfox](../../tutorials-and-examples/sigfox.md) * [Sigfox](../../tutorials/sigfox.md)
* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) * [LTE CAT-M1](../../tutorials/lte/cat-m1.md)
* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [NB-IoT](../../tutorials/lte/nb-iot.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -48,10 +48,10 @@ The AT commands for the Sequans Monarch modem on the GPy are available in a [PDF
## Tutorials ## Tutorials
Tutorials on how to the GPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the GPy: Tutorials on how to the GPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the GPy:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) * [LTE CAT-M1](../../tutorials/lte/cat-m1.md)
* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [NB-IoT](../../tutorials/lte/nb-iot.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -40,10 +40,10 @@ Due to a couple issues with the LoPy design the module draws more current than i
## Tutorials ## Tutorials
Tutorials on how to the LoPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: Tutorials on how to the LoPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN node](../../tutorials/lora/lorawan-abp.md)
* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -38,11 +38,11 @@ The `Vin` pin on the LoPy4 can be supplied with a voltage ranging from `3.5v` to
## Tutorials ## Tutorials
Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN node](../../tutorials/lora/lorawan-abp.md)
* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
* [Sigfox](../../tutorials-and-examples/sigfox.md) * [Sigfox](../../tutorials/sigfox.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -40,9 +40,9 @@ Due to a couple issues with the SiPy design the module draws more current than i
## Tutorials ## Tutorials
Tutorials on how to the SiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: Tutorials on how to the SiPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the SiPy:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [Sigfox](../../tutorials-and-examples/sigfox.md) * [Sigfox](../../tutorials/sigfox.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -40,8 +40,8 @@ Due to a couple issues with the WiPy2 design the module draws more current than
## Tutorials ## Tutorials
Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -45,8 +45,8 @@ The `Vin` pin on the WiPy3 can be supplied with a voltage ranging from `3.5v` to
## Tutorials ## Tutorials
Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -34,10 +34,10 @@ The AT commands for the Sequans Monarch modem on the G01 are available in a PDF
## Tutorials ## Tutorials
Tutorials on how to the G01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the G01: Tutorials on how to the G01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the G01:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) * [LTE CAT-M1](../../tutorials/lte/cat-m1.md)
* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) * [NB-IoT](../../tutorials/lte/nb-iot.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -28,10 +28,10 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS
## Tutorials ## Tutorials
Tutorials on how to the L01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L01: Tutorials on how to the L01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L01:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN node](../../tutorials/lora/lorawan-abp.md)
* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -28,11 +28,11 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS
## Tutorials ## Tutorials
Tutorials on how to the L04 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L04: Tutorials on how to the L04 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L04:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) * [LoRaWAN node](../../tutorials/lora/lorawan-abp.md)
* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) * [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
* [Sigfox](../../tutorials-and-examples/sigfox.md) * [Sigfox](../../tutorials/sigfox.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -28,8 +28,8 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS
## Tutorials ## Tutorials
Tutorials on how to the W01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the W01: Tutorials on how to the W01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the W01:
* [WiFi connection](../../tutorials-and-examples/all/wlan.md) * [WiFi connection](../../tutorials/all/wlan.md)
* [BLE](../../tutorials-and-examples/all/ble.md) * [BLE](../../tutorials/all/ble.md)

View File

@@ -12,7 +12,7 @@ The GPy and FiPy support both new LTE-M protocols:
{% endhint %} {% endhint %}
{% hint style="info" %} {% hint style="info" %}
The Sequans modem used on Pycom's cellular enabled modules can only work in one of these modes at a time. In order to switch between the two protocols you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](../../../tutorials-and-examples/lte/firmware.md). The Sequans modem used on Pycom's cellular enabled modules can only work in one of these modes at a time. In order to switch between the two protocols you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](../../../tutorials/lte/firmware.md).
{% endhint %} {% endhint %}
## AT Commands ## AT Commands

View File

@@ -96,7 +96,7 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **m
### WiFi/Bluetooth \(optional\) ### WiFi/Bluetooth \(optional\)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmware-and-api-reference/pycom/network/wlan.md) All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md)
![](../../.gitbook/assets/wifi_pigtail_ant_fipy.png) ![](../../.gitbook/assets/wifi_pigtail_ant_fipy.png)

View File

@@ -73,7 +73,7 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **mu
### WiFi/Bluetooth \(optional\) ### WiFi/Bluetooth \(optional\)
All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmware-and-api-reference/pycom/network/wlan.md) All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md)
![](../../.gitbook/assets/wifi_pigtail_ant_gpy.png) ![](../../.gitbook/assets/wifi_pigtail_ant_gpy.png)

View File

@@ -84,7 +84,7 @@ The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4
### WiFi/Bluetooth \(optional\) ### WiFi/Bluetooth \(optional\)
All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmware-and-api-reference/pycom/network/wlan.md) All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md)
![](../../.gitbook/assets/wifi_pigtail_ant_lopy.png) ![](../../.gitbook/assets/wifi_pigtail_ant_lopy.png)

View File

@@ -80,7 +80,7 @@ If you intend on using the Sigfox connectivity of the SiPy you **must** connect
### WiFi/Bluetooth \(optional\) ### WiFi/Bluetooth \(optional\)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmware-and-api-reference/pycom/network/wlan.md) All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md)
![](../../.gitbook/assets/wifi_pigtail_ant_sipy.png) ![](../../.gitbook/assets/wifi_pigtail_ant_sipy.png)

View File

@@ -65,7 +65,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
### WiFi/Bluetooth \(optional\) ### WiFi/Bluetooth \(optional\)
All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmware-and-api-reference/pycom/network/wlan.md) All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md)
![](../../.gitbook/assets/wifi_pigtail_ant_wipy.png) ![](../../.gitbook/assets/wifi_pigtail_ant_wipy.png)

View File

@@ -9,7 +9,7 @@ Here are the download links to the update tool. Please download the appropriate
* [Linux](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=unix&redirect=true) \(requires `dialog` and `python-serial` package\) * [Linux](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=unix&redirect=true) \(requires `dialog` and `python-serial` package\)
{% hint style="info" %} {% hint style="info" %}
Previous versions of firmware are available for download [**here**](../../advanced-topics/downgrade.md). Previous versions of firmware are available for download [**here**](../../advance/downgrade.md).
{% endhint %} {% endhint %}
## Updating Device Firmware ## Updating Device Firmware

View File

@@ -6,7 +6,7 @@
To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms: To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms:
{% page-ref page="../../pymakr-plugin/installation/atom.md" %} {% page-ref page="../../pymakr/installation/atom.md" %}
{% page-ref page="../../pymakr-plugin/installation/vscode.md" %} {% page-ref page="../../pymakr/installation/vscode.md" %}

View File

@@ -4,11 +4,11 @@ So, you've decided to order a Pycom development module. Firstly we would like to
![](../.gitbook/assets/getting_started%20%281%29.png) ![](../.gitbook/assets/getting_started%20%281%29.png)
## [Step 1: Setting up the hardware](hardware/) ## [Step 1: Setting up the hardware](connection/)
In the first part of this getting started guide, we will take you through setting up your device. Firstly we will cover how to connect the module to your computer either via USB or WiFi. Secondly we will explain how to connect various accessories such as antennas or SIM cards to your module. In the first part of this getting started guide, we will take you through setting up your device. Firstly we will cover how to connect the module to your computer either via USB or WiFi. Secondly we will explain how to connect various accessories such as antennas or SIM cards to your module.
## [Step 2: Setting up your computer](software/) ## [Step 2: Setting up your computer](installation/)
Now that your module is successfully connected, you will need to install some software on your computer to interface with it. The second part of this guide will guide you through installing drivers; performing firmware updates for your module/accessories to ensure you have the most stable and feature packed version; and how to setup the software use to program the device. Now that your module is successfully connected, you will need to install some software on your computer to interface with it. The second part of this guide will guide you through installing drivers; performing firmware updates for your module/accessories to ensure you have the most stable and feature packed version; and how to setup the software use to program the device.

Some files were not shown because too many files have changed in this diff Show More