diff --git a/README.md b/README.md index d7a3e50..0c35b96 100644 --- a/README.md +++ b/README.md @@ -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. * [Products](products.md) -* [Getting Started](getting-started/introduction.md) -* [Tutorials](tutorials-and-examples/introduction.md) -* [Product Info](product-info/introduction.md) -* [API Documentation](firmware-and-api-reference/introduction.md) +* [Getting Started](gettingstarted/introduction.md) +* [Tutorials](tutorials/introduction.md) +* [Product Info](datasheets/introduction.md) +* [API Documentation](firmwareapi/introduction.md) * [Pybytes](pybytes/introduction.md) diff --git a/SUMMARY.md b/SUMMARY.md index eadc4e2..148e4f1 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,41 +5,41 @@ ## Getting Started -* [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) +* [Introduction](gettingstarted/introduction.md) +* [Hardware Setup](gettingstarted/connection/README.md) + * [LoPy](gettingstarted/connection/lopy.md) + * [LoPy 4](gettingstarted/connection/lopy4.md) + * [SiPy](gettingstarted/connection/sipy.md) + * [GPy](gettingstarted/connection/gpy.md) + * [FiPy](gettingstarted/connection/fipy.md) + * [WiPy](gettingstarted/connection/wipy.md) +* [Software](gettingstarted/installation/README.md) + * [Drivers](gettingstarted/installation/drivers.md) + * [Updating Firmware](gettingstarted/installation/firmwaretool.md) + * [Pymakr](gettingstarted/installation/pymakr.md) +* [Programming the modules](gettingstarted/programming/README.md) + * [Introduction to MicroPython](gettingstarted/programming/micropython.md) + * [MicroPython Examples](gettingstarted/programming/examples.md) + * [Your first Pymakr project](gettingstarted/programming/first-project.md) + * [REPL](gettingstarted/programming/repl/README.md) + * [Serial USB \(UART\)](gettingstarted/programming/repl/serial.md) + * [Telnet REPL](gettingstarted/programming/repl/telnet.md) + * [FTP](gettingstarted/programming/ftp.md) + * [Safe boot](gettingstarted/programming/safeboot.md) +* [Device Registration](gettingstarted/registration/README.md) + * [Sigfox](gettingstarted/registration/sigfox.md) + * [Cellular](gettingstarted/registration/cellular.md) + * [LoRaWAN](gettingstarted/registration/lora/README.md) + * [The Things Network](gettingstarted/registration/lora/ttn.md) + * [Objenious](gettingstarted/registration/lora/objenious.md) ## Pymakr Plugin -* [Installation](pymakr-plugin/installation/README.md) - * [Atom](pymakr-plugin/installation/atom.md) - * [Visual Studio Code](pymakr-plugin/installation/vscode.md) -* [Tools/Features](pymakr-plugin/features.md) -* [Settings](pymakr-plugin/settings.md) +* [Installation](pymakr/installation/README.md) + * [Atom](pymakr/installation/atom.md) + * [Visual Studio Code](pymakr/installation/vscode.md) +* [Tools/Features](pymakr/toolsfeatures.md) +* [Settings](pymakr/settings.md) ## Pytrack, Pysense, Pyscan @@ -56,150 +56,150 @@ ## Tutorials & Examples -* [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) +* [Introduction](tutorials/introduction.md) +* [All Pycom Device Examples](tutorials/all/README.md) + * [REPL](tutorials/all/repl.md) + * [WLAN](tutorials/all/wlan.md) + * [Bluetooth](tutorials/all/ble.md) + * [HTTPS](tutorials/all/https.md) + * [MQTT](tutorials/all/mqtt.md) + * [AWS](tutorials/all/aws.md) + * [ADC](tutorials/all/adc.md) + * [I2C](tutorials/all/i2c.md) + * [Onewire Driver](tutorials/all/owd.md) + * [Threading](tutorials/all/threading.md) + * [RGB LED](tutorials/all/rgbled.md) + * [Timers](tutorials/all/timers.md) + * [PIR Sensor](tutorials/all/pir.md) + * [Modbus](tutorials/all/modbus.md) + * [OTA update](tutorials/all/ota.md) + * [RMT](tutorials/all/rmt.md) +* [LoRa Examples](tutorials/lora/README.md) + * [LoRa-MAC \(Raw LoRa\)](tutorials/lora/lora-mac.md) + * [LoRaWAN with OTAA](tutorials/lora/lorawan-otaa.md) + * [LoRaWAN with ABP](tutorials/lora/lorawan-abp.md) + * [LoRa-MAC Nano-Gateway](tutorials/lora/lora-mac-nano-gateway.md) + * [LoPy to LoPy](tutorials/lora/module-module.md) + * [LoRaWAN Nano-Gateway](tutorials/lora/lorawan-nano-gateway.md) + * [RN2483 to LoPy](tutorials/lora/rn2483-to-lopy.md) +* [Sigfox Examples](tutorials/sigfox.md) +* [LTE Examples](tutorials/lte/README.md) + * [CAT-M1](tutorials/lte/cat-m1.md) + * [NB-IoT](tutorials/lte/nb-iot.md) + * [Module IMEI](tutorials/lte/imei.md) + * [Modem Firmware Update](tutorials/lte/firmware.md) +* [Pytrack Examples](tutorials/pytrack.md) +* [Pysense Examples](tutorials/pysense.md) +* [Pyscan Examples](tutorials/pyscan.md) ## Firmware & API Reference -* [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) +* [Introduction](firmwareapi/introduction.md) +* [Pycom Modules](firmwareapi/pycom/README.md) + * [machine](firmwareapi/pycom/machine/README.md) + * [ADC](firmwareapi/pycom/machine/adc.md) + * [DAC](firmwareapi/pycom/machine/dac.md) + * [I2C](firmwareapi/pycom/machine/i2c.md) + * [Pin](firmwareapi/pycom/machine/pin.md) + * [PWM](firmwareapi/pycom/machine/pwm.md) + * [RTC](firmwareapi/pycom/machine/rtc.md) + * [SPI](firmwareapi/pycom/machine/spi.md) + * [UART](firmwareapi/pycom/machine/uart.md) + * [WDT](firmwareapi/pycom/machine/wdt.md) + * [Timer](firmwareapi/pycom/machine/timer.md) + * [SD](firmwareapi/pycom/machine/sd.md) + * [CAN](firmwareapi/pycom/machine/can.md) + * [RMT](firmwareapi/pycom/machine/rmt.md) + * [network](firmwareapi/pycom/network/README.md) + * [WLAN](firmwareapi/pycom/network/wlan.md) + * [Server](firmwareapi/pycom/network/server.md) + * [Bluetooth](firmwareapi/pycom/network/bluetooth/README.md) + * [GATT](firmwareapi/pycom/network/bluetooth/gatt.md) + * [GATTCConnection](firmwareapi/pycom/network/bluetooth/gattcconnection.md) + * [GATTCService](firmwareapi/pycom/network/bluetooth/gattccservice.md) + * [GATTCCharacteristic](firmwareapi/pycom/network/bluetooth/gattccharacteristic.md) + * [GATTSService](firmwareapi/pycom/network/bluetooth/gattsservice.md) + * [GATTSCharacteristic](firmwareapi/pycom/network/bluetooth/gattscharacteristic.md) + * [LoRa](firmwareapi/pycom/network/lora.md) + * [Sigfox](firmwareapi/pycom/network/sigfox.md) + * [LTE](firmwareapi/pycom/network/lte.md) + * [AES](firmwareapi/pycom/aes.md) + * [pycom](firmwareapi/pycom/pycom.md) +* [MicroPython Modules](firmwareapi/micropython/README.md) + * [micropython](firmwareapi/micropython/micropython.md) + * [uctypes](firmwareapi/micropython/uctypes.md) + * [sys](firmwareapi/micropython/sys.md) + * [uos](firmwareapi/micropython/uos.md) + * [array](firmwareapi/micropython/array.md) + * [cmath](firmwareapi/micropython/cmath.md) + * [math](firmwareapi/micropython/math.md) + * [gc](firmwareapi/micropython/gc.md) + * [ubinascii](firmwareapi/micropython/ubinascii.md) + * [ujson](firmwareapi/micropython/ujson.md) + * [ure](firmwareapi/micropython/ure.md) + * [usocket](firmwareapi/micropython/usocket.md) + * [select](firmwareapi/micropython/select.md) + * [utime](firmwareapi/micropython/utime.md) + * [uhashlib](firmwareapi/micropython/uhashlib.md) + * [ussl](firmwareapi/micropython/ussl.md) + * [ucrypto](firmwareapi/micropython/ucrypto.md) + * [ustruct](firmwareapi/micropython/ustruct.md) + * [\_thread](firmwareapi/micropython/_thread.md) + * [Builtin](firmwareapi/micropython/builtin.md) +* [Notes](firmwareapi/notes.md) ## Product Info -* [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) +* [Introduction](datasheets/introduction.md) +* [Development Modules](datasheets/development/README.md) + * [WiPy 2.0](datasheets/development/wipy2.md) + * [WiPy 3.0](datasheets/development/wipy3.md) + * [LoPy](datasheets/development/lopy.md) + * [LoPy 4](datasheets/development/lopy4.md) + * [SiPy](datasheets/development/sipy.md) + * [GPy](datasheets/development/gpy.md) + * [FiPy](datasheets/development/fipy.md) +* [OEM Modules](datasheets/oem/README.md) + * [W01](datasheets/oem/w01.md) + * [L01](datasheets/oem/l01.md) + * [L04](datasheets/oem/l04.md) + * [G01](datasheets/oem/g01.md) + * [L01 OEM Baseboard Reference](datasheets/oem/l01_reference.md) + * [Universal OEM Baseboard Reference](datasheets/oem/universal_reference.md) +* [Expansion Boards and Shields](datasheets/boards/README.md) + * [Expansion Board 3.0](datasheets/boards/expansion3.md) + * [Pytrack](datasheets/boards/pytrack.md) + * [Pysense](datasheets/boards/pysense.md) + * [Pyscan](datasheets/boards/pyscan.md) + * [Expansion Board 2.0](datasheets/boards/expansion2.md) + * [Deep Sleep Shield](datasheets/boards/deepsleep/README.md) + * [Deep Sleep API](datasheets/boards/deepsleep/api.md) +* [Notes](datasheets/notes.md) ## Pybytes * [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) +* [Getting Started with Pybytes](pybytes/getstarted.md) +* [Add a device to Pybytes](pybytes/connect/README.md) + * [Connect to Pybytes: Quick Add](pybytes/connect/quick.md) + * [Connect to Pybytes: Flash Pybytes library manually](pybytes/connect/flash.md) + * [Add Sigfox device](pybytes/connect/sigfox/README.md) + * [DevKit contract](pybytes/connect/sigfox/devkit.md) + * [Custom contract](pybytes/connect/sigfox/custom.md) +* [Visualise data from your device](pybytes/dashboard.md) ## Documentation Notes -* [Introduction](documentation-notes/introduction.md) -* [Syntax](documentation-notes/syntax.md) -* [REPL vs Scripts](documentation-notes/replscript.md) -* [Mesh Networks](documentation-notes/mesh-networks.md) +* [Introduction](docnotes/introduction.md) +* [Syntax](docnotes/syntax.md) +* [REPL vs Scripts](docnotes/replscript.md) +* [Mesh Networks](docnotes/mesh-networks.md) ## Advanced Topics -* [Firmware Downgrade](advanced-topics/downgrade.md) -* [CLI Updater](advanced-topics/cli.md) -* [SecureBoot and Encryption](advanced-topics/encryption.md) +* [Firmware Downgrade](advance/downgrade.md) +* [CLI Updater](advance/cli.md) +* [SecureBoot and Encryption](advance/encryption.md) * [License](license.md) ## Have a question? diff --git a/advanced-topics/cli.md b/advance/cli.md similarity index 99% rename from advanced-topics/cli.md rename to advance/cli.md index e367c85..75aaafd 100644 --- a/advanced-topics/cli.md +++ b/advance/cli.md @@ -325,7 +325,7 @@ To restore your OTA block: `$pycom-fwtool-cli -p PORT ota -r -f backup.ota` #### 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 usage: pycom-fwtool-cli -p PORT lpwan [-h] [--region REGION] diff --git a/advanced-topics/downgrade.md b/advance/downgrade.md similarity index 100% rename from advanced-topics/downgrade.md rename to advance/downgrade.md diff --git a/advanced-topics/encryption.md b/advance/encryption.md similarity index 100% rename from advanced-topics/encryption.md rename to advance/encryption.md diff --git a/product-info/boards/README.md b/datasheets/boards/README.md similarity index 100% rename from product-info/boards/README.md rename to datasheets/boards/README.md diff --git a/product-info/boards/deepsleep/README.md b/datasheets/boards/deepsleep/README.md similarity index 100% rename from product-info/boards/deepsleep/README.md rename to datasheets/boards/deepsleep/README.md diff --git a/product-info/boards/deepsleep/api.md b/datasheets/boards/deepsleep/api.md similarity index 100% rename from product-info/boards/deepsleep/api.md rename to datasheets/boards/deepsleep/api.md diff --git a/product-info/boards/expansion2.md b/datasheets/boards/expansion2.md similarity index 100% rename from product-info/boards/expansion2.md rename to datasheets/boards/expansion2.md diff --git a/product-info/boards/expansion3.md b/datasheets/boards/expansion3.md similarity index 100% rename from product-info/boards/expansion3.md rename to datasheets/boards/expansion3.md diff --git a/product-info/boards/pyscan.md b/datasheets/boards/pyscan.md similarity index 100% rename from product-info/boards/pyscan.md rename to datasheets/boards/pyscan.md diff --git a/product-info/boards/pysense.md b/datasheets/boards/pysense.md similarity index 100% rename from product-info/boards/pysense.md rename to datasheets/boards/pysense.md diff --git a/product-info/boards/pytrack.md b/datasheets/boards/pytrack.md similarity index 100% rename from product-info/boards/pytrack.md rename to datasheets/boards/pytrack.md diff --git a/product-info/development/README.md b/datasheets/development/README.md similarity index 100% rename from product-info/development/README.md rename to datasheets/development/README.md diff --git a/product-info/development/fipy.md b/datasheets/development/fipy.md similarity index 76% rename from product-info/development/fipy.md rename to datasheets/development/fipy.md index 46e40bf..b925254 100644 --- a/product-info/development/fipy.md +++ b/datasheets/development/fipy.md @@ -48,13 +48,13 @@ The AT commands for the Sequans Monarch modem on the FiPy are available in a PDF ## 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) -* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials-and-examples/sigfox.md) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials/sigfox.md) +* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) +* [NB-IoT](../../tutorials/lte/nb-iot.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/gpy.md b/datasheets/development/gpy.md similarity index 84% rename from product-info/development/gpy.md rename to datasheets/development/gpy.md index d0ee326..53f4fa6 100644 --- a/product-info/development/gpy.md +++ b/datasheets/development/gpy.md @@ -48,10 +48,10 @@ The AT commands for the Sequans Monarch modem on the GPy are available in a [PDF ## 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) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) +* [NB-IoT](../../tutorials/lte/nb-iot.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/lopy.md b/datasheets/development/lopy.md similarity index 85% rename from product-info/development/lopy.md rename to datasheets/development/lopy.md index 545e364..7912b46 100644 --- a/product-info/development/lopy.md +++ b/datasheets/development/lopy.md @@ -40,10 +40,10 @@ Due to a couple issues with the LoPy design the module draws more current than i ## 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) -* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/lopy4.md b/datasheets/development/lopy4.md similarity index 75% rename from product-info/development/lopy4.md rename to datasheets/development/lopy4.md index af5cb44..ee1ae40 100644 --- a/product-info/development/lopy4.md +++ b/datasheets/development/lopy4.md @@ -38,11 +38,11 @@ The `Vin` pin on the LoPy4 can be supplied with a voltage ranging from `3.5v` to ## 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) -* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials-and-examples/sigfox.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials/sigfox.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/sipy.md b/datasheets/development/sipy.md similarity index 88% rename from product-info/development/sipy.md rename to datasheets/development/sipy.md index fa1bdcb..7f161ec 100644 --- a/product-info/development/sipy.md +++ b/datasheets/development/sipy.md @@ -40,9 +40,9 @@ Due to a couple issues with the SiPy design the module draws more current than i ## 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) -* [Sigfox](../../tutorials-and-examples/sigfox.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [Sigfox](../../tutorials/sigfox.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/wipy2.md b/datasheets/development/wipy2.md similarity index 90% rename from product-info/development/wipy2.md rename to datasheets/development/wipy2.md index 1c0fd83..1da6a1a 100644 --- a/product-info/development/wipy2.md +++ b/datasheets/development/wipy2.md @@ -40,8 +40,8 @@ Due to a couple issues with the WiPy2 design the module draws more current than ## 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) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/development/wipy3.md b/datasheets/development/wipy3.md similarity index 86% rename from product-info/development/wipy3.md rename to datasheets/development/wipy3.md index 4c4ba26..3e0f10f 100644 --- a/product-info/development/wipy3.md +++ b/datasheets/development/wipy3.md @@ -45,8 +45,8 @@ The `Vin` pin on the WiPy3 can be supplied with a voltage ranging from `3.5v` to ## 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) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/introduction.md b/datasheets/introduction.md similarity index 100% rename from product-info/introduction.md rename to datasheets/introduction.md diff --git a/product-info/notes.md b/datasheets/notes.md similarity index 100% rename from product-info/notes.md rename to datasheets/notes.md diff --git a/product-info/oem/README.md b/datasheets/oem/README.md similarity index 100% rename from product-info/oem/README.md rename to datasheets/oem/README.md diff --git a/product-info/oem/g01.md b/datasheets/oem/g01.md similarity index 73% rename from product-info/oem/g01.md rename to datasheets/oem/g01.md index 7d64d47..e7b1154 100644 --- a/product-info/oem/g01.md +++ b/datasheets/oem/g01.md @@ -34,10 +34,10 @@ The AT commands for the Sequans Monarch modem on the G01 are available in a PDF ## 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) -* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) -* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) +* [NB-IoT](../../tutorials/lte/nb-iot.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/oem/l01.md b/datasheets/oem/l01.md similarity index 66% rename from product-info/oem/l01.md rename to datasheets/oem/l01.md index 1ba0003..b05797b 100644 --- a/product-info/oem/l01.md +++ b/datasheets/oem/l01.md @@ -28,10 +28,10 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## 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) -* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/oem/l01_reference.md b/datasheets/oem/l01_reference.md similarity index 100% rename from product-info/oem/l01_reference.md rename to datasheets/oem/l01_reference.md diff --git a/product-info/oem/l04.md b/datasheets/oem/l04.md similarity index 63% rename from product-info/oem/l04.md rename to datasheets/oem/l04.md index 6013844..6327180 100644 --- a/product-info/oem/l04.md +++ b/datasheets/oem/l04.md @@ -28,11 +28,11 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## 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) -* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials-and-examples/sigfox.md) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials/sigfox.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/product-info/oem/universal_reference.md b/datasheets/oem/universal_reference.md similarity index 100% rename from product-info/oem/universal_reference.md rename to datasheets/oem/universal_reference.md diff --git a/product-info/oem/w01.md b/datasheets/oem/w01.md similarity index 75% rename from product-info/oem/w01.md rename to datasheets/oem/w01.md index 6548e2d..f83cb48 100644 --- a/product-info/oem/w01.md +++ b/datasheets/oem/w01.md @@ -28,8 +28,8 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## 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) -* [BLE](../../tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials/all/wlan.md) +* [BLE](../../tutorials/all/ble.md) diff --git a/documentation-notes/introduction.md b/docnotes/introduction.md similarity index 100% rename from documentation-notes/introduction.md rename to docnotes/introduction.md diff --git a/documentation-notes/mesh-networks.md b/docnotes/mesh-networks.md similarity index 100% rename from documentation-notes/mesh-networks.md rename to docnotes/mesh-networks.md diff --git a/documentation-notes/replscript.md b/docnotes/replscript.md similarity index 100% rename from documentation-notes/replscript.md rename to docnotes/replscript.md diff --git a/documentation-notes/syntax.md b/docnotes/syntax.md similarity index 100% rename from documentation-notes/syntax.md rename to docnotes/syntax.md diff --git a/firmware-and-api-reference/introduction.md b/firmwareapi/introduction.md similarity index 100% rename from firmware-and-api-reference/introduction.md rename to firmwareapi/introduction.md diff --git a/firmware-and-api-reference/micropython/README.md b/firmwareapi/micropython/README.md similarity index 100% rename from firmware-and-api-reference/micropython/README.md rename to firmwareapi/micropython/README.md diff --git a/firmware-and-api-reference/micropython/_thread.md b/firmwareapi/micropython/_thread.md similarity index 100% rename from firmware-and-api-reference/micropython/_thread.md rename to firmwareapi/micropython/_thread.md diff --git a/firmware-and-api-reference/micropython/array.md b/firmwareapi/micropython/array.md similarity index 100% rename from firmware-and-api-reference/micropython/array.md rename to firmwareapi/micropython/array.md diff --git a/firmware-and-api-reference/micropython/builtin.md b/firmwareapi/micropython/builtin.md similarity index 100% rename from firmware-and-api-reference/micropython/builtin.md rename to firmwareapi/micropython/builtin.md diff --git a/firmware-and-api-reference/micropython/cmath.md b/firmwareapi/micropython/cmath.md similarity index 100% rename from firmware-and-api-reference/micropython/cmath.md rename to firmwareapi/micropython/cmath.md diff --git a/firmware-and-api-reference/micropython/gc.md b/firmwareapi/micropython/gc.md similarity index 100% rename from firmware-and-api-reference/micropython/gc.md rename to firmwareapi/micropython/gc.md diff --git a/firmware-and-api-reference/micropython/math.md b/firmwareapi/micropython/math.md similarity index 100% rename from firmware-and-api-reference/micropython/math.md rename to firmwareapi/micropython/math.md diff --git a/firmware-and-api-reference/micropython/micropython.md b/firmwareapi/micropython/micropython.md similarity index 100% rename from firmware-and-api-reference/micropython/micropython.md rename to firmwareapi/micropython/micropython.md diff --git a/firmware-and-api-reference/micropython/select.md b/firmwareapi/micropython/select.md similarity index 100% rename from firmware-and-api-reference/micropython/select.md rename to firmwareapi/micropython/select.md diff --git a/firmware-and-api-reference/micropython/sys.md b/firmwareapi/micropython/sys.md similarity index 100% rename from firmware-and-api-reference/micropython/sys.md rename to firmwareapi/micropython/sys.md diff --git a/firmware-and-api-reference/micropython/ubinascii.md b/firmwareapi/micropython/ubinascii.md similarity index 100% rename from firmware-and-api-reference/micropython/ubinascii.md rename to firmwareapi/micropython/ubinascii.md diff --git a/firmware-and-api-reference/micropython/ucrypto.md b/firmwareapi/micropython/ucrypto.md similarity index 100% rename from firmware-and-api-reference/micropython/ucrypto.md rename to firmwareapi/micropython/ucrypto.md diff --git a/firmware-and-api-reference/micropython/uctypes.md b/firmwareapi/micropython/uctypes.md similarity index 100% rename from firmware-and-api-reference/micropython/uctypes.md rename to firmwareapi/micropython/uctypes.md diff --git a/firmware-and-api-reference/micropython/uhashlib.md b/firmwareapi/micropython/uhashlib.md similarity index 100% rename from firmware-and-api-reference/micropython/uhashlib.md rename to firmwareapi/micropython/uhashlib.md diff --git a/firmware-and-api-reference/micropython/ujson.md b/firmwareapi/micropython/ujson.md similarity index 100% rename from firmware-and-api-reference/micropython/ujson.md rename to firmwareapi/micropython/ujson.md diff --git a/firmware-and-api-reference/micropython/uos.md b/firmwareapi/micropython/uos.md similarity index 100% rename from firmware-and-api-reference/micropython/uos.md rename to firmwareapi/micropython/uos.md diff --git a/firmware-and-api-reference/micropython/ure.md b/firmwareapi/micropython/ure.md similarity index 100% rename from firmware-and-api-reference/micropython/ure.md rename to firmwareapi/micropython/ure.md diff --git a/firmware-and-api-reference/micropython/usocket.md b/firmwareapi/micropython/usocket.md similarity index 100% rename from firmware-and-api-reference/micropython/usocket.md rename to firmwareapi/micropython/usocket.md diff --git a/firmware-and-api-reference/micropython/ussl.md b/firmwareapi/micropython/ussl.md similarity index 100% rename from firmware-and-api-reference/micropython/ussl.md rename to firmwareapi/micropython/ussl.md diff --git a/firmware-and-api-reference/micropython/ustruct.md b/firmwareapi/micropython/ustruct.md similarity index 100% rename from firmware-and-api-reference/micropython/ustruct.md rename to firmwareapi/micropython/ustruct.md diff --git a/firmware-and-api-reference/micropython/utime.md b/firmwareapi/micropython/utime.md similarity index 100% rename from firmware-and-api-reference/micropython/utime.md rename to firmwareapi/micropython/utime.md diff --git a/firmware-and-api-reference/notes.md b/firmwareapi/notes.md similarity index 100% rename from firmware-and-api-reference/notes.md rename to firmwareapi/notes.md diff --git a/firmware-and-api-reference/pycom/README.md b/firmwareapi/pycom/README.md similarity index 100% rename from firmware-and-api-reference/pycom/README.md rename to firmwareapi/pycom/README.md diff --git a/firmware-and-api-reference/pycom/aes.md b/firmwareapi/pycom/aes.md similarity index 100% rename from firmware-and-api-reference/pycom/aes.md rename to firmwareapi/pycom/aes.md diff --git a/firmware-and-api-reference/pycom/machine/README.md b/firmwareapi/pycom/machine/README.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/README.md rename to firmwareapi/pycom/machine/README.md diff --git a/firmware-and-api-reference/pycom/machine/adc.md b/firmwareapi/pycom/machine/adc.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/adc.md rename to firmwareapi/pycom/machine/adc.md diff --git a/firmware-and-api-reference/pycom/machine/can.md b/firmwareapi/pycom/machine/can.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/can.md rename to firmwareapi/pycom/machine/can.md diff --git a/firmware-and-api-reference/pycom/machine/dac.md b/firmwareapi/pycom/machine/dac.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/dac.md rename to firmwareapi/pycom/machine/dac.md diff --git a/firmware-and-api-reference/pycom/machine/i2c.md b/firmwareapi/pycom/machine/i2c.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/i2c.md rename to firmwareapi/pycom/machine/i2c.md diff --git a/firmware-and-api-reference/pycom/machine/pin.md b/firmwareapi/pycom/machine/pin.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/pin.md rename to firmwareapi/pycom/machine/pin.md diff --git a/firmware-and-api-reference/pycom/machine/pwm.md b/firmwareapi/pycom/machine/pwm.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/pwm.md rename to firmwareapi/pycom/machine/pwm.md diff --git a/firmware-and-api-reference/pycom/machine/rmt.md b/firmwareapi/pycom/machine/rmt.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/rmt.md rename to firmwareapi/pycom/machine/rmt.md diff --git a/firmware-and-api-reference/pycom/machine/rtc.md b/firmwareapi/pycom/machine/rtc.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/rtc.md rename to firmwareapi/pycom/machine/rtc.md diff --git a/firmware-and-api-reference/pycom/machine/sd.md b/firmwareapi/pycom/machine/sd.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/sd.md rename to firmwareapi/pycom/machine/sd.md diff --git a/firmware-and-api-reference/pycom/machine/spi.md b/firmwareapi/pycom/machine/spi.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/spi.md rename to firmwareapi/pycom/machine/spi.md diff --git a/firmware-and-api-reference/pycom/machine/timer.md b/firmwareapi/pycom/machine/timer.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/timer.md rename to firmwareapi/pycom/machine/timer.md diff --git a/firmware-and-api-reference/pycom/machine/uart.md b/firmwareapi/pycom/machine/uart.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/uart.md rename to firmwareapi/pycom/machine/uart.md diff --git a/firmware-and-api-reference/pycom/machine/wdt.md b/firmwareapi/pycom/machine/wdt.md similarity index 100% rename from firmware-and-api-reference/pycom/machine/wdt.md rename to firmwareapi/pycom/machine/wdt.md diff --git a/firmware-and-api-reference/pycom/network/README.md b/firmwareapi/pycom/network/README.md similarity index 100% rename from firmware-and-api-reference/pycom/network/README.md rename to firmwareapi/pycom/network/README.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/README.md b/firmwareapi/pycom/network/bluetooth/README.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/README.md rename to firmwareapi/pycom/network/bluetooth/README.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gatt.md b/firmwareapi/pycom/network/bluetooth/gatt.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gatt.md rename to firmwareapi/pycom/network/bluetooth/gatt.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md b/firmwareapi/pycom/network/bluetooth/gattccharacteristic.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md rename to firmwareapi/pycom/network/bluetooth/gattccharacteristic.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md b/firmwareapi/pycom/network/bluetooth/gattcconnection.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md rename to firmwareapi/pycom/network/bluetooth/gattcconnection.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md b/firmwareapi/pycom/network/bluetooth/gattccservice.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md rename to firmwareapi/pycom/network/bluetooth/gattccservice.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md b/firmwareapi/pycom/network/bluetooth/gattscharacteristic.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md rename to firmwareapi/pycom/network/bluetooth/gattscharacteristic.md diff --git a/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md b/firmwareapi/pycom/network/bluetooth/gattsservice.md similarity index 100% rename from firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md rename to firmwareapi/pycom/network/bluetooth/gattsservice.md diff --git a/firmware-and-api-reference/pycom/network/lora.md b/firmwareapi/pycom/network/lora.md similarity index 100% rename from firmware-and-api-reference/pycom/network/lora.md rename to firmwareapi/pycom/network/lora.md diff --git a/firmware-and-api-reference/pycom/network/lte.md b/firmwareapi/pycom/network/lte.md similarity index 99% rename from firmware-and-api-reference/pycom/network/lte.md rename to firmwareapi/pycom/network/lte.md index 460b521..1a07057 100644 --- a/firmware-and-api-reference/pycom/network/lte.md +++ b/firmwareapi/pycom/network/lte.md @@ -12,7 +12,7 @@ The GPy and FiPy support both new LTE-M protocols: {% endhint %} {% 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 %} ## AT Commands diff --git a/firmware-and-api-reference/pycom/network/server.md b/firmwareapi/pycom/network/server.md similarity index 100% rename from firmware-and-api-reference/pycom/network/server.md rename to firmwareapi/pycom/network/server.md diff --git a/firmware-and-api-reference/pycom/network/sigfox.md b/firmwareapi/pycom/network/sigfox.md similarity index 100% rename from firmware-and-api-reference/pycom/network/sigfox.md rename to firmwareapi/pycom/network/sigfox.md diff --git a/firmware-and-api-reference/pycom/network/wlan.md b/firmwareapi/pycom/network/wlan.md similarity index 100% rename from firmware-and-api-reference/pycom/network/wlan.md rename to firmwareapi/pycom/network/wlan.md diff --git a/firmware-and-api-reference/pycom/pycom.md b/firmwareapi/pycom/pycom.md similarity index 100% rename from firmware-and-api-reference/pycom/pycom.md rename to firmwareapi/pycom/pycom.md diff --git a/getting-started/hardware/README.md b/gettingstarted/connection/README.md similarity index 100% rename from getting-started/hardware/README.md rename to gettingstarted/connection/README.md diff --git a/getting-started/hardware/fipy.md b/gettingstarted/connection/fipy.md similarity index 99% rename from getting-started/hardware/fipy.md rename to gettingstarted/connection/fipy.md index aa368b4..57cc4c9 100644 --- a/getting-started/hardware/fipy.md +++ b/gettingstarted/connection/fipy.md @@ -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\) -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) diff --git a/getting-started/hardware/gpy.md b/gettingstarted/connection/gpy.md similarity index 99% rename from getting-started/hardware/gpy.md rename to gettingstarted/connection/gpy.md index 3df96b8..4346eea 100644 --- a/getting-started/hardware/gpy.md +++ b/gettingstarted/connection/gpy.md @@ -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\) -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) diff --git a/getting-started/hardware/lopy.md b/gettingstarted/connection/lopy.md similarity index 99% rename from getting-started/hardware/lopy.md rename to gettingstarted/connection/lopy.md index 7d07644..974b5dc 100644 --- a/getting-started/hardware/lopy.md +++ b/gettingstarted/connection/lopy.md @@ -84,7 +84,7 @@ The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4 ### 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) diff --git a/getting-started/hardware/lopy4.md b/gettingstarted/connection/lopy4.md similarity index 100% rename from getting-started/hardware/lopy4.md rename to gettingstarted/connection/lopy4.md diff --git a/getting-started/hardware/sipy.md b/gettingstarted/connection/sipy.md similarity index 99% rename from getting-started/hardware/sipy.md rename to gettingstarted/connection/sipy.md index a122cd3..a4444c0 100644 --- a/getting-started/hardware/sipy.md +++ b/gettingstarted/connection/sipy.md @@ -80,7 +80,7 @@ If you intend on using the Sigfox connectivity of the SiPy you **must** connect ### 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) diff --git a/getting-started/hardware/wipy.md b/gettingstarted/connection/wipy.md similarity index 99% rename from getting-started/hardware/wipy.md rename to gettingstarted/connection/wipy.md index b094b37..e4635ea 100644 --- a/getting-started/hardware/wipy.md +++ b/gettingstarted/connection/wipy.md @@ -65,7 +65,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### 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) diff --git a/getting-started/software/README.md b/gettingstarted/installation/README.md similarity index 100% rename from getting-started/software/README.md rename to gettingstarted/installation/README.md diff --git a/getting-started/software/drivers.md b/gettingstarted/installation/drivers.md similarity index 100% rename from getting-started/software/drivers.md rename to gettingstarted/installation/drivers.md diff --git a/getting-started/software/firmwaretool.md b/gettingstarted/installation/firmwaretool.md similarity index 98% rename from getting-started/software/firmwaretool.md rename to gettingstarted/installation/firmwaretool.md index eaea79a..1cb8fef 100644 --- a/getting-started/software/firmwaretool.md +++ b/gettingstarted/installation/firmwaretool.md @@ -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\) {% 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 %} ## Updating Device Firmware diff --git a/getting-started/software/pymakr.md b/gettingstarted/installation/pymakr.md similarity index 69% rename from getting-started/software/pymakr.md rename to gettingstarted/installation/pymakr.md index a3cdb9c..9c575af 100644 --- a/getting-started/software/pymakr.md +++ b/gettingstarted/installation/pymakr.md @@ -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: -{% 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" %} diff --git a/getting-started/introduction.md b/gettingstarted/introduction.md similarity index 94% rename from getting-started/introduction.md rename to gettingstarted/introduction.md index 80d8fa0..066678c 100644 --- a/getting-started/introduction.md +++ b/gettingstarted/introduction.md @@ -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) -## [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. -## [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. diff --git a/getting-started/programming/README.md b/gettingstarted/programming/README.md similarity index 100% rename from getting-started/programming/README.md rename to gettingstarted/programming/README.md diff --git a/getting-started/programming/examples.md b/gettingstarted/programming/examples.md similarity index 100% rename from getting-started/programming/examples.md rename to gettingstarted/programming/examples.md diff --git a/getting-started/programming/first-project.md b/gettingstarted/programming/first-project.md similarity index 95% rename from getting-started/programming/first-project.md rename to gettingstarted/programming/first-project.md index a606085..442ceea 100644 --- a/getting-started/programming/first-project.md +++ b/gettingstarted/programming/first-project.md @@ -60,11 +60,11 @@ RGB-Blink For this example, you will just need to create a `main.py` file. -Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr-plugin/settings.md). +Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr/settings.md). ## Controlling the on-board LED -Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmware-and-api-reference/introduction.md). For this example you will need to open the `main.py` file and add the following code: +Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmwareapi/introduction.md). For this example you will need to open the `main.py` file and add the following code: ```python import pycom diff --git a/getting-started/programming/ftp.md b/gettingstarted/programming/ftp.md similarity index 91% rename from getting-started/programming/ftp.md rename to gettingstarted/programming/ftp.md index 3b01383..97094b5 100644 --- a/getting-started/programming/ftp.md +++ b/gettingstarted/programming/ftp.md @@ -8,7 +8,7 @@ The file system is accessible via the native FTP server running on each Pycom de * username: `micro` * password: `python` -See [network.server](../../firmware-and-api-reference/pycom/network/server.md) for information on how to change the defaults. The recommended clients are: +See [network.server](../../firmwareapi/pycom/network/server.md) for information on how to change the defaults. The recommended clients are: * macOS/Linux: default FTP client * Windows: Filezilla and FireFTP diff --git a/getting-started/programming/micropython.md b/gettingstarted/programming/micropython.md similarity index 100% rename from getting-started/programming/micropython.md rename to gettingstarted/programming/micropython.md diff --git a/getting-started/programming/repl/README.md b/gettingstarted/programming/repl/README.md similarity index 100% rename from getting-started/programming/repl/README.md rename to gettingstarted/programming/repl/README.md diff --git a/getting-started/programming/repl/serial.md b/gettingstarted/programming/repl/serial.md similarity index 88% rename from getting-started/programming/repl/serial.md rename to gettingstarted/programming/repl/serial.md index d8fd494..0a06e6b 100644 --- a/getting-started/programming/repl/serial.md +++ b/gettingstarted/programming/repl/serial.md @@ -6,7 +6,7 @@ In order to connect to the REPL over USB serial, there are multiple methods. Det ## All platforms -By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). +By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). ## macOS and Linux diff --git a/getting-started/programming/repl/telnet.md b/gettingstarted/programming/repl/telnet.md similarity index 74% rename from getting-started/programming/repl/telnet.md rename to gettingstarted/programming/repl/telnet.md index 2f4d986..0252655 100644 --- a/getting-started/programming/repl/telnet.md +++ b/gettingstarted/programming/repl/telnet.md @@ -1,6 +1,6 @@ # 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). +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](../../../firmwareapi/pycom/network/wlan.md). * password: `www.pycom.io` @@ -11,11 +11,11 @@ Additionally, to use the MircoPython REPL over telnet, further authentication is * username: `micro` * password: `python` -See [network.server](../../../firmware-and-api-reference/pycom/network/server.md) for info on how to change the default authentication. +See [network.server](../../../firmwareapi/pycom/network/server.md) for info on how to change the default authentication. ## All platforms -By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). +By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). ## macOS and Linux diff --git a/getting-started/programming/safeboot.md b/gettingstarted/programming/safeboot.md similarity index 100% rename from getting-started/programming/safeboot.md rename to gettingstarted/programming/safeboot.md diff --git a/getting-started/registration/README.md b/gettingstarted/registration/README.md similarity index 100% rename from getting-started/registration/README.md rename to gettingstarted/registration/README.md diff --git a/getting-started/registration/cellular.md b/gettingstarted/registration/cellular.md similarity index 100% rename from getting-started/registration/cellular.md rename to gettingstarted/registration/cellular.md diff --git a/getting-started/registration/lora/README.md b/gettingstarted/registration/lora/README.md similarity index 91% rename from getting-started/registration/lora/README.md rename to gettingstarted/registration/lora/README.md index f963141..74a5473 100644 --- a/getting-started/registration/lora/README.md +++ b/gettingstarted/registration/lora/README.md @@ -24,11 +24,11 @@ The output will be a hex string like: `70B3D5499585FCA1`. Once you have this you #### OTAA -If you wish to connect via OTAA \(which is the recommended method\) the network will provide you with an `Application EUI` and `Application Key`. The former identifies what application your device is connecting to, the latter is a shared secret key unique to your device to generate the session keys that prove its identity to the network. Once you have these you can use the [LoRaWAN OTAA example](../../../tutorials-and-examples/lora/lorawan-otaa.md) code to connect to the network. +If you wish to connect via OTAA \(which is the recommended method\) the network will provide you with an `Application EUI` and `Application Key`. The former identifies what application your device is connecting to, the latter is a shared secret key unique to your device to generate the session keys that prove its identity to the network. Once you have these you can use the [LoRaWAN OTAA example](../../../tutorials/lora/lorawan-otaa.md) code to connect to the network. #### ABP -With ABP the encryption keys enabling communication with the network are preconfigured in the device. The network will need to provide you with a `Device Address`, `Network Session Key` and `Application Session Key`. Once you have these you can use the [LoRaWAN ABP example](../../../tutorials-and-examples/lora/lorawan-abp.md) code to connect to the network. +With ABP the encryption keys enabling communication with the network are preconfigured in the device. The network will need to provide you with a `Device Address`, `Network Session Key` and `Application Session Key`. Once you have these you can use the [LoRaWAN ABP example](../../../tutorials/lora/lorawan-abp.md) code to connect to the network. ### Networks diff --git a/getting-started/registration/lora/objenious.md b/gettingstarted/registration/lora/objenious.md similarity index 100% rename from getting-started/registration/lora/objenious.md rename to gettingstarted/registration/lora/objenious.md diff --git a/getting-started/registration/lora/ttn.md b/gettingstarted/registration/lora/ttn.md similarity index 98% rename from getting-started/registration/lora/ttn.md rename to gettingstarted/registration/lora/ttn.md index 18e1271..c11198a 100644 --- a/getting-started/registration/lora/ttn.md +++ b/gettingstarted/registration/lora/ttn.md @@ -38,7 +38,7 @@ Once the device has been added, change the `Activation Method` between `OTAA` an ## Register a Nano-Gateway -You can also setup your Pycom module to act as a gateway with The Things Network. The code required to do this can be found [here](../../../tutorials-and-examples/lora/lorawan-nano-gateway.md). +You can also setup your Pycom module to act as a gateway with The Things Network. The code required to do this can be found [here](../../../tutorials/lora/lorawan-nano-gateway.md). Inside the TTN Console, there are two options, `Applications` and `Gateways`. Select `Gateways` and then click on `register Gateway`. This will allow for the set up and registration of a new nano-gateway. diff --git a/getting-started/registration/sigfox.md b/gettingstarted/registration/sigfox.md similarity index 100% rename from getting-started/registration/sigfox.md rename to gettingstarted/registration/sigfox.md diff --git a/products.md b/products.md index 4aca0f6..f69407c 100644 --- a/products.md +++ b/products.md @@ -8,17 +8,17 @@ Below you will find tables of all Pycom products. These tables illustrate the fu | Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1NB-IoT | | :--- | :--- | :--- | :--- | :--- | :--- | -| [ WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | | -| [SiPy](product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | -| [GPy](product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | -| [LoPy](product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | -| [LoPy4](product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | -| [FiPy](product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | +| [ WiPy 3.0](datasheets/development/wipy3.md) | ✔ | ✔ | | | | +| [SiPy](datasheets/development/sipy.md) | ✔ | ✔ | | ✔ | | +| [GPy](datasheets/development/gpy.md) | ✔ | ✔ | | | ✔ | +| [LoPy](datasheets/development/lopy.md) | ✔ | ✔ | ✔ | | | +| [LoPy4](datasheets/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | +| [FiPy](datasheets/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | | Antennas | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) | ## Accessories -| Accessory | [Expansion Board](product-info/boards/expansion3.md) | [Pysense](product-info/boards/pysense.md) | [Pytrack](product-info/boards/pytrack.md) | [Pyscan](product-info/boards/pyscan.md) | +| Accessory | [Expansion Board](datasheets/boards/expansion3.md) | [Pysense](datasheets/boards/pysense.md) | [Pytrack](datasheets/boards/pytrack.md) | [Pyscan](datasheets/boards/pyscan.md) | | :--- | :--- | :--- | :--- | :--- | | [PyCase](https://pycom.io/product/pycase/) | ✔ | | | | | [IP67 Case for Expansion Board](https://pycom.io/product/ip67-expansion-board-case/) | ✔ | | | | @@ -30,10 +30,10 @@ Below you will find tables of all Pycom products. These tables illustrate the fu ## OEM Modules -| OEM Module | [L01/W01 Reference Board](product-info/oem/l01_reference.md) | [Universal Reference Board](product-info/oem/universal_reference.md) | +| OEM Module | [L01/W01 Reference Board](datasheets/oem/l01_reference.md) | [Universal Reference Board](datasheets/oem/universal_reference.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) | | ✔ | +| [W01](datasheets/oem/w01.md) | ✔ | ✔ | +| [L01](datasheets/oem/l01.md) | ✔ | ✔ | +| [L04](datasheets/oem/l04.md) | | ✔ | +| [G01](datasheets/oem/g01.md) | | ✔ | diff --git a/pybytes/add-device/README.md b/pybytes/connect/README.md similarity index 100% rename from pybytes/add-device/README.md rename to pybytes/connect/README.md diff --git a/pybytes/add-device/flash.md b/pybytes/connect/flash.md similarity index 92% rename from pybytes/add-device/flash.md rename to pybytes/connect/flash.md index 5c636cb..f1b5b2d 100644 --- a/pybytes/add-device/flash.md +++ b/pybytes/connect/flash.md @@ -31,7 +31,7 @@ You can also download _Pybytes library_ at the device's settings page: ### Step 2. Flash your device with Pymakr {% hint style="info" %} -In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr-plugin/installation/atom.md). +In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr/installation/atom.md). {% endhint %} 1. Connect your device to your computer with USB cable. @@ -52,7 +52,7 @@ In case you haven't installed Pymakr plugin, follow [these instructions](../../p Like deviceToken or WiFi credentials. You can change e.g. your WiFy password here. -6. Put your device in [safe boot mode](../../getting-started/programming/safeboot.md). +6. Put your device in [safe boot mode](../../gettingstarted/programming/safeboot.md). 7. Upload code to your device by clicking on _Upload_ button in Pymakr. After all Pybytes library files are uploaded to device, device will restart and will connect to Pybytes. @@ -65,5 +65,5 @@ Pybytes library is written to `/flash` folder and will take precedence over buil Now it's time to display data from your device into Pybytes dashboard. -{% page-ref page="../visualise-data.md" %} +{% page-ref page="../dashboard.md" %} diff --git a/pybytes/add-device/quick.md b/pybytes/connect/quick.md similarity index 97% rename from pybytes/add-device/quick.md rename to pybytes/connect/quick.md index 1dfe8eb..c1abdeb 100644 --- a/pybytes/add-device/quick.md +++ b/pybytes/connect/quick.md @@ -50,5 +50,5 @@ Install the Firmware updater on your computer. Now it's time to display data from your device into Pybytes dashboard. -{% page-ref page="../visualise-data.md" %} +{% page-ref page="../dashboard.md" %} diff --git a/pybytes/add-device/sigfox/README.md b/pybytes/connect/sigfox/README.md similarity index 94% rename from pybytes/add-device/sigfox/README.md rename to pybytes/connect/sigfox/README.md index 1f2078d..b6c1eeb 100644 --- a/pybytes/add-device/sigfox/README.md +++ b/pybytes/connect/sigfox/README.md @@ -1,7 +1,7 @@ # Add Sigfox device {% hint style="danger" %} -Before you start you need to create Sigfox account. You need Pycom device with Sigfox to get your Sigfox account. [**Follow these instructions**](../../../getting-started/registration/sigfox.md). +Before you start you need to create Sigfox account. You need Pycom device with Sigfox to get your Sigfox account. [**Follow these instructions**](../../../gettingstarted/registration/sigfox.md). {% endhint %} ## Create Sigfox API credentials diff --git a/pybytes/add-device/sigfox/custom.md b/pybytes/connect/sigfox/custom.md similarity index 92% rename from pybytes/add-device/sigfox/custom.md rename to pybytes/connect/sigfox/custom.md index fb072a5..d0abe06 100644 --- a/pybytes/add-device/sigfox/custom.md +++ b/pybytes/connect/sigfox/custom.md @@ -33,5 +33,5 @@ After your device was flashed with Pybytes firmware in automatically start addin ## Troubleshooting -[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials/sigfox.md#disengage-sequence-number) diff --git a/pybytes/add-device/sigfox/devkit.md b/pybytes/connect/sigfox/devkit.md similarity index 92% rename from pybytes/add-device/sigfox/devkit.md rename to pybytes/connect/sigfox/devkit.md index 6040f49..3323200 100644 --- a/pybytes/add-device/sigfox/devkit.md +++ b/pybytes/connect/sigfox/devkit.md @@ -2,7 +2,7 @@ Every Sigfox Pycom device comes with free Sigfox connectivity - Sigfox DevKit contract. It provides one year of Sigfox connectivity. This is great for prototyping. -But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](../../../getting-started/registration/sigfox.md). +But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](../../../gettingstarted/registration/sigfox.md). After you add your Sigfox credentials to Pybytes you can see DevKit contract type is selected as default \(on page Settings → Sigfox API\). @@ -41,5 +41,5 @@ This is not an issue with Custom contract, where _device type_ on Sigfox backend ## Troubleshooting -[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials/sigfox.md#disengage-sequence-number) diff --git a/pybytes/visualise-data.md b/pybytes/dashboard.md similarity index 97% rename from pybytes/visualise-data.md rename to pybytes/dashboard.md index 58dcc8f..0ae3165 100644 --- a/pybytes/visualise-data.md +++ b/pybytes/dashboard.md @@ -3,7 +3,7 @@ In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes. {% hint style="info" %} -We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](add-device/). After your done with that, you can proceed to the next example. +We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](connect/). After your done with that, you can proceed to the next example. {% endhint %} ## Step 1: Set up your application \(`main.py`\) diff --git a/pybytes/getting-started.md b/pybytes/getstarted.md similarity index 93% rename from pybytes/getting-started.md rename to pybytes/getstarted.md index a7fe4d1..2802109 100644 --- a/pybytes/getting-started.md +++ b/pybytes/getstarted.md @@ -13,5 +13,5 @@ Follow these steps to create a Pybytes account: Now it's time to explore Pybytes. You can start by connecting your Pycom board to Pybytes. -{% page-ref page="add-device/" %} +{% page-ref page="connect/" %} diff --git a/pybytes/introduction.md b/pybytes/introduction.md index ed4cfc9..2bbc112 100644 --- a/pybytes/introduction.md +++ b/pybytes/introduction.md @@ -25,7 +25,7 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati ## Let's get started! -* [Getting started with Pybytes](getting-started.md) -* [Connect your Pycom module to Pybytes](add-device/) -* [Visualise data from your device](visualise-data.md) +* [Getting started with Pybytes](getstarted.md) +* [Connect your Pycom module to Pybytes](connect/) +* [Visualise data from your device](dashboard.md) diff --git a/pymakr-plugin/installation/README.md b/pymakr/installation/README.md similarity index 100% rename from pymakr-plugin/installation/README.md rename to pymakr/installation/README.md diff --git a/pymakr-plugin/installation/atom.md b/pymakr/installation/atom.md similarity index 100% rename from pymakr-plugin/installation/atom.md rename to pymakr/installation/atom.md diff --git a/pymakr-plugin/installation/vscode.md b/pymakr/installation/vscode.md similarity index 100% rename from pymakr-plugin/installation/vscode.md rename to pymakr/installation/vscode.md diff --git a/pymakr-plugin/settings.md b/pymakr/settings.md similarity index 100% rename from pymakr-plugin/settings.md rename to pymakr/settings.md diff --git a/pymakr-plugin/features.md b/pymakr/toolsfeatures.md similarity index 100% rename from pymakr-plugin/features.md rename to pymakr/toolsfeatures.md diff --git a/tutorials-and-examples/all/README.md b/tutorials/all/README.md similarity index 100% rename from tutorials-and-examples/all/README.md rename to tutorials/all/README.md diff --git a/tutorials-and-examples/all/adc.md b/tutorials/all/adc.md similarity index 94% rename from tutorials-and-examples/all/adc.md rename to tutorials/all/adc.md index 8a86ac4..acbc3a8 100644 --- a/tutorials-and-examples/all/adc.md +++ b/tutorials/all/adc.md @@ -1,6 +1,6 @@ # ADC -This example is a simple ADC sample. For more information please see [`ADC`](../../firmware-and-api-reference/pycom/machine/adc.md). +This example is a simple ADC sample. For more information please see [`ADC`](../../firmwareapi/pycom/machine/adc.md). ```python from machine import ADC diff --git a/tutorials-and-examples/all/aws.md b/tutorials/all/aws.md similarity index 100% rename from tutorials-and-examples/all/aws.md rename to tutorials/all/aws.md diff --git a/tutorials-and-examples/all/ble.md b/tutorials/all/ble.md similarity index 97% rename from tutorials-and-examples/all/ble.md rename to tutorials/all/ble.md index b056ed1..26f4cea 100644 --- a/tutorials-and-examples/all/ble.md +++ b/tutorials/all/ble.md @@ -2,7 +2,7 @@ At present, basic BLE functionality is available. More features will be implemented in the near future, such as pairing. This page will be updated in line with these features. -Full info on `bluetooth` can be found within [Bluetooth page](../../firmware-and-api-reference/pycom/network/bluetooth/) of the Firmware API Reference. +Full info on `bluetooth` can be found within [Bluetooth page](../../firmwareapi/pycom/network/bluetooth/) of the Firmware API Reference. ## Scan for BLE Devices diff --git a/tutorials-and-examples/all/https.md b/tutorials/all/https.md similarity index 84% rename from tutorials-and-examples/all/https.md rename to tutorials/all/https.md index 59bcfaa..417a3ed 100644 --- a/tutorials-and-examples/all/https.md +++ b/tutorials/all/https.md @@ -24,5 +24,5 @@ ss = ssl.wrap_socket(s, cert_reqs=ssl.CERT_REQUIRED, ca_certs='/flash/cert/ca.pe ss.connect(socket.getaddrinfo('cloud.blynk.cc', 8441)[0][-1]) ``` -For more info, check the [`ssl`](../../firmware-and-api-reference/micropython/ussl.md) module in the API reference. +For more info, check the [`ssl`](../../firmwareapi/micropython/ussl.md) module in the API reference. diff --git a/tutorials-and-examples/all/i2c.md b/tutorials/all/i2c.md similarity index 100% rename from tutorials-and-examples/all/i2c.md rename to tutorials/all/i2c.md diff --git a/tutorials-and-examples/all/modbus.md b/tutorials/all/modbus.md similarity index 100% rename from tutorials-and-examples/all/modbus.md rename to tutorials/all/modbus.md diff --git a/tutorials-and-examples/all/mqtt.md b/tutorials/all/mqtt.md similarity index 100% rename from tutorials-and-examples/all/mqtt.md rename to tutorials/all/mqtt.md diff --git a/tutorials-and-examples/all/ota.md b/tutorials/all/ota.md similarity index 96% rename from tutorials-and-examples/all/ota.md rename to tutorials/all/ota.md index 9e353c4..9ee71c7 100644 --- a/tutorials-and-examples/all/ota.md +++ b/tutorials/all/ota.md @@ -2,7 +2,7 @@ ## Overview -Pycom modules come with the ability to update the devices firmware, while it is still running, we call this an "over the air" \(OTA\) update. The [`pycom`](../../firmware-and-api-reference/pycom/pycom.md) library provides several functions to achieve this. This example will demonstrate how you could potentially use this functionality to update deployed devices. The full source code of this example can be found [here](https://github.com/pycom/pycom-libraries/tree/master/examples/OTA). +Pycom modules come with the ability to update the devices firmware, while it is still running, we call this an "over the air" \(OTA\) update. The [`pycom`](../../firmwareapi/pycom/pycom.md) library provides several functions to achieve this. This example will demonstrate how you could potentially use this functionality to update deployed devices. The full source code of this example can be found [here](https://github.com/pycom/pycom-libraries/tree/master/examples/OTA). ## Method diff --git a/tutorials-and-examples/all/owd.md b/tutorials/all/owd.md similarity index 100% rename from tutorials-and-examples/all/owd.md rename to tutorials/all/owd.md diff --git a/tutorials-and-examples/all/pir.md b/tutorials/all/pir.md similarity index 100% rename from tutorials-and-examples/all/pir.md rename to tutorials/all/pir.md diff --git a/tutorials-and-examples/all/repl.md b/tutorials/all/repl.md similarity index 100% rename from tutorials-and-examples/all/repl.md rename to tutorials/all/repl.md diff --git a/tutorials-and-examples/all/rgbled.md b/tutorials/all/rgbled.md similarity index 100% rename from tutorials-and-examples/all/rgbled.md rename to tutorials/all/rgbled.md diff --git a/tutorials-and-examples/all/rmt.md b/tutorials/all/rmt.md similarity index 99% rename from tutorials-and-examples/all/rmt.md rename to tutorials/all/rmt.md index 008cca5..3f09559 100644 --- a/tutorials-and-examples/all/rmt.md +++ b/tutorials/all/rmt.md @@ -1,6 +1,6 @@ # RMT -Detailed information about this class can be found in [`RMT`](../../firmware-and-api-reference/pycom/machine/rmt.md). +Detailed information about this class can be found in [`RMT`](../../firmwareapi/pycom/machine/rmt.md). The RMT \(Remote Control\) peripheral of the ESP32 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, this class will allow you to do this. diff --git a/tutorials-and-examples/all/threading.md b/tutorials/all/threading.md similarity index 100% rename from tutorials-and-examples/all/threading.md rename to tutorials/all/threading.md diff --git a/tutorials-and-examples/all/timers.md b/tutorials/all/timers.md similarity index 92% rename from tutorials-and-examples/all/timers.md rename to tutorials/all/timers.md index cbeb345..ae1378e 100644 --- a/tutorials-and-examples/all/timers.md +++ b/tutorials/all/timers.md @@ -1,6 +1,6 @@ # Timers -Detailed information about this class can be found in [`Timer`](../../firmware-and-api-reference/pycom/machine/timer.md). +Detailed information about this class can be found in [`Timer`](../../firmwareapi/pycom/machine/timer.md). ## Chronometer @@ -48,6 +48,6 @@ clock = Clock() ``` {% hint style="info" %} -There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](../../firmware-and-api-reference/notes.md#interrupt-handling). +There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](../../firmwareapi/notes.md#interrupt-handling). {% endhint %} diff --git a/tutorials-and-examples/all/wlan.md b/tutorials/all/wlan.md similarity index 100% rename from tutorials-and-examples/all/wlan.md rename to tutorials/all/wlan.md diff --git a/tutorials-and-examples/introduction.md b/tutorials/introduction.md similarity index 95% rename from tutorials-and-examples/introduction.md rename to tutorials/introduction.md index de7c4d0..752925d 100644 --- a/tutorials-and-examples/introduction.md +++ b/tutorials/introduction.md @@ -8,7 +8,7 @@ This section contains tutorials and examples for use with Pycom modules and Expa General Pycom tutorials contains tutorials that may be run on any Pycom device, such as connecting to a WiFi network, Bluetooth, controlling I/O pins etc. Later sections are specific to the LoPy and SiPy devices such as setting up a LoRa node or connecting to the Sigfox network. The final sections are related to examples using the Pytrack and Pysense. -Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../getting-started/software/firmwaretool.md). +Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../gettingstarted/installation/firmwaretool.md). The source code for these tutorials, along with the required libraries can be found in in the [pycom-libraries](https://github.com/pycom/pycom-libraries) repository. diff --git a/tutorials-and-examples/lora/README.md b/tutorials/lora/README.md similarity index 100% rename from tutorials-and-examples/lora/README.md rename to tutorials/lora/README.md diff --git a/tutorials-and-examples/lora/lora-mac-nano-gateway.md b/tutorials/lora/lora-mac-nano-gateway.md similarity index 100% rename from tutorials-and-examples/lora/lora-mac-nano-gateway.md rename to tutorials/lora/lora-mac-nano-gateway.md diff --git a/tutorials-and-examples/lora/lora-mac.md b/tutorials/lora/lora-mac.md similarity index 100% rename from tutorials-and-examples/lora/lora-mac.md rename to tutorials/lora/lora-mac.md diff --git a/tutorials-and-examples/lora/lorawan-abp.md b/tutorials/lora/lorawan-abp.md similarity index 100% rename from tutorials-and-examples/lora/lorawan-abp.md rename to tutorials/lora/lorawan-abp.md diff --git a/tutorials-and-examples/lora/lorawan-nano-gateway.md b/tutorials/lora/lorawan-nano-gateway.md similarity index 100% rename from tutorials-and-examples/lora/lorawan-nano-gateway.md rename to tutorials/lora/lorawan-nano-gateway.md diff --git a/tutorials-and-examples/lora/lorawan-otaa.md b/tutorials/lora/lorawan-otaa.md similarity index 100% rename from tutorials-and-examples/lora/lorawan-otaa.md rename to tutorials/lora/lorawan-otaa.md diff --git a/tutorials-and-examples/lora/module-module.md b/tutorials/lora/module-module.md similarity index 100% rename from tutorials-and-examples/lora/module-module.md rename to tutorials/lora/module-module.md diff --git a/tutorials-and-examples/lora/rn2483-to-lopy.md b/tutorials/lora/rn2483-to-lopy.md similarity index 100% rename from tutorials-and-examples/lora/rn2483-to-lopy.md rename to tutorials/lora/rn2483-to-lopy.md diff --git a/tutorials-and-examples/lte/README.md b/tutorials/lte/README.md similarity index 100% rename from tutorials-and-examples/lte/README.md rename to tutorials/lte/README.md diff --git a/tutorials-and-examples/lte/cat-m1.md b/tutorials/lte/cat-m1.md similarity index 100% rename from tutorials-and-examples/lte/cat-m1.md rename to tutorials/lte/cat-m1.md diff --git a/tutorials-and-examples/lte/firmware.md b/tutorials/lte/firmware.md similarity index 96% rename from tutorials-and-examples/lte/firmware.md rename to tutorials/lte/firmware.md index 003a80f..c04b585 100644 --- a/tutorials-and-examples/lte/firmware.md +++ b/tutorials/lte/firmware.md @@ -20,7 +20,7 @@ Before proceeding you will need: If your module is running the factory LTE chip firmware, you **MUST** first perform an update to the latest CAT-M1 firmware before trying to upgrade to the NB-IoT firmware. Skipping this step will cause your radio to become unresponsive and it will require access to the test points in order to re-flash the firmware. {% endhint %} -Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr-plugin/installation/) +Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../gettingstarted/programming/ftp.md) or [Pymakr](../../pymakr/installation/) Next you need to download the firmware file from [here](https://software.pycom.io/downloads/sequans.html). You will need to place the firmware on a FAT32 formatted microSD card, then insert the SD card into a Expansion Board, Pytrack, Pysense or Pyscan. Power-up the system and connect to the interactive REPL and run the following code: diff --git a/tutorials-and-examples/lte/imei.md b/tutorials/lte/imei.md similarity index 100% rename from tutorials-and-examples/lte/imei.md rename to tutorials/lte/imei.md diff --git a/tutorials-and-examples/lte/nb-iot.md b/tutorials/lte/nb-iot.md similarity index 100% rename from tutorials-and-examples/lte/nb-iot.md rename to tutorials/lte/nb-iot.md diff --git a/tutorials-and-examples/pyscan.md b/tutorials/pyscan.md similarity index 100% rename from tutorials-and-examples/pyscan.md rename to tutorials/pyscan.md diff --git a/tutorials-and-examples/pysense.md b/tutorials/pysense.md similarity index 100% rename from tutorials-and-examples/pysense.md rename to tutorials/pysense.md diff --git a/tutorials-and-examples/pytrack.md b/tutorials/pytrack.md similarity index 100% rename from tutorials-and-examples/pytrack.md rename to tutorials/pytrack.md diff --git a/tutorials-and-examples/sigfox.md b/tutorials/sigfox.md similarity index 97% rename from tutorials-and-examples/sigfox.md rename to tutorials/sigfox.md index d7d5aa0..4c789cb 100644 --- a/tutorials-and-examples/sigfox.md +++ b/tutorials/sigfox.md @@ -1,6 +1,6 @@ # Sigfox Examples -Before you start, make sure that your device was registered with [Sigfox](../getting-started/registration/sigfox.md). +Before you start, make sure that your device was registered with [Sigfox](../gettingstarted/registration/sigfox.md). The following tutorials demonstrate how to register and get started with the SiPy. The SiPy can be configured for operation in various countries based upon specified RCZ zones \(see the `Sigfox` class for more info\). The SiPy supports both uplink and downlink `Sigfox` messages as well as device to device communication via its FSK Mode `Sigfox`.