diff --git a/README.md b/README.md index 2918311..3aa63c5 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Welcome to the Pycom documentation site. The documentation is split into 5 secti 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](about/products.md) -* [Getting Started](1.-getting-started/gettingstarted.md) -* [Tutorials](4.-tutorials-and-examples/tutorials.md) -* [Product Info](6.-product-info/datasheets.md) -* [API Documentation](5.-firmware-and-api-reference/firmwareapi.md) -* [Pybytes](8.-pybytes/pybytes.md) +* [Getting Started](getting-started/gettingstarted.md) +* [Tutorials](tutorials-and-examples/tutorials.md) +* [Product Info](product-info/datasheets.md) +* [API Documentation](firmware-and-api-reference/firmwareapi.md) +* [Pybytes](pybytes/pybytes.md) diff --git a/SUMMARY.md b/SUMMARY.md index 37c9975..eff80ef 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -8,208 +8,208 @@ ## 1. Getting Started -* [1.0 Introduction](1.-getting-started/gettingstarted.md) -* [1.1 Hardware Setup](1.-getting-started/hardwaresetup/README.md) - * [1.1.1 LoPy](1.-getting-started/hardwaresetup/lopy.md) - * [1.1.2 LoPy4](1.-getting-started/hardwaresetup/lopy4.md) - * [1.1.3 SiPy](1.-getting-started/hardwaresetup/sipy.md) - * [1.1.4 GPy](1.-getting-started/hardwaresetup/gpy.md) - * [1.1.5 FiPy](1.-getting-started/hardwaresetup/fipy.md) - * [1.1.6 WiPy](1.-getting-started/hardwaresetup/wipy.md) -* [1.2 Software](1.-getting-started/installingsoftware/README.md) - * [1.2.1 Drivers](1.-getting-started/installingsoftware/drivers.md) - * [1.2.2 Updating Firmware](1.-getting-started/installingsoftware/firmwaretool.md) - * [1.2.3 Pymakr](1.-getting-started/installingsoftware/pymakr.md) -* [1.3 Programming the modules](1.-getting-started/programming/README.md) - * [1.3.1 Introduction to MicroPython](1.-getting-started/programming/micropython.md) - * [1.3.2 MicroPython Examples](1.-getting-started/programming/examples.md) - * [1.3.3 Your first Pymakr project](1.-getting-started/programming/first_project.md) - * [1.3.4 REPL](1.-getting-started/programming/repl/README.md) - * [1.3.4.1 Serial USB \(UART\)](1.-getting-started/programming/repl/serial.md) - * [1.3.4.2 Telnet REPL](1.-getting-started/programming/repl/telnet.md) - * [1.3.5 FTP](1.-getting-started/programming/ftp.md) - * [1.3.6 Safe boot](1.-getting-started/programming/safeboot.md) -* [1.4 Device Registration](1.-getting-started/registration/README.md) - * [1.4.1 Sigfox](1.-getting-started/registration/sigfox.md) - * [1.4.2 Cellular](1.-getting-started/registration/cellular.md) - * [1.4.3 LoRaWAN](1.-getting-started/registration/lora/README.md) - * [1.4.3.1 The Things Network](1.-getting-started/registration/lora/ttn.md) - * [1.4.3.2 Objenious](1.-getting-started/registration/lora/objenious.md) +* [1.0 Introduction](getting-started/gettingstarted.md) +* [1.1 Hardware Setup](getting-started/hardwaresetup/README.md) + * [1.1.1 LoPy](getting-started/hardwaresetup/lopy.md) + * [1.1.2 LoPy4](getting-started/hardwaresetup/lopy4.md) + * [1.1.3 SiPy](getting-started/hardwaresetup/sipy.md) + * [1.1.4 GPy](getting-started/hardwaresetup/gpy.md) + * [1.1.5 FiPy](getting-started/hardwaresetup/fipy.md) + * [1.1.6 WiPy](getting-started/hardwaresetup/wipy.md) +* [1.2 Software](getting-started/installingsoftware/README.md) + * [1.2.1 Drivers](getting-started/installingsoftware/drivers.md) + * [1.2.2 Updating Firmware](getting-started/installingsoftware/firmwaretool.md) + * [1.2.3 Pymakr](getting-started/installingsoftware/pymakr.md) +* [1.3 Programming the modules](getting-started/programming/README.md) + * [1.3.1 Introduction to MicroPython](getting-started/programming/micropython.md) + * [1.3.2 MicroPython Examples](getting-started/programming/examples.md) + * [1.3.3 Your first Pymakr project](getting-started/programming/first_project.md) + * [1.3.4 REPL](getting-started/programming/repl/README.md) + * [1.3.4.1 Serial USB \(UART\)](getting-started/programming/repl/serial.md) + * [1.3.4.2 Telnet REPL](getting-started/programming/repl/telnet.md) + * [1.3.5 FTP](getting-started/programming/ftp.md) + * [1.3.6 Safe boot](getting-started/programming/safeboot.md) +* [1.4 Device Registration](getting-started/registration/README.md) + * [1.4.1 Sigfox](getting-started/registration/sigfox.md) + * [1.4.2 Cellular](getting-started/registration/cellular.md) + * [1.4.3 LoRaWAN](getting-started/registration/lora/README.md) + * [1.4.3.1 The Things Network](getting-started/registration/lora/ttn.md) + * [1.4.3.2 Objenious](getting-started/registration/lora/objenious.md) ## 2. Pymakr Plugin -* [2.1 Installation](2.-pymakr-plugin/installation/README.md) - * [2.1.1 Atom](2.-pymakr-plugin/installation/atom.md) - * [2.1.2 Visual Studio Code](2.-pymakr-plugin/installation/vscode.md) -* [2.2 Tools/Features](2.-pymakr-plugin/toolsfeatures.md) -* [2.3 Settings](2.-pymakr-plugin/settings.md) +* [2.1 Installation](pymakr-plugin/installation/README.md) + * [2.1.1 Atom](pymakr-plugin/installation/atom.md) + * [2.1.2 Visual Studio Code](pymakr-plugin/installation/vscode.md) +* [2.2 Tools/Features](pymakr-plugin/toolsfeatures.md) +* [2.3 Settings](pymakr-plugin/settings.md) ## 3. Pytrack, Pysense, Pyscan -* [3.1 Introduction](3.-pytrack-pysense-pyscan/pytrackpysense.md) -* [3.2 Installing Software](3.-pytrack-pysense-pyscan/installation/README.md) - * [3.2.1 Updating Firmware](3.-pytrack-pysense-pyscan/installation/firmware.md) - * [3.2.2 Installing Drivers - Windows 7](3.-pytrack-pysense-pyscan/installation/drivers.md) - * [3.2.3 Installing Libraries](3.-pytrack-pysense-pyscan/installation/libraries.md) -* [3.3 API Reference](3.-pytrack-pysense-pyscan/apireference/README.md) - * [3.3.1 Pytrack](3.-pytrack-pysense-pyscan/apireference/pytrack.md) - * [3.3.2 Pysense](3.-pytrack-pysense-pyscan/apireference/pysense.md) - * [3.3.4 Pyscan](3.-pytrack-pysense-pyscan/apireference/pyscan.md) - * [3.3.5 Sleep](3.-pytrack-pysense-pyscan/apireference/sleep.md) +* [3.1 Introduction](pytrack-pysense-pyscan/pytrackpysense.md) +* [3.2 Installing Software](pytrack-pysense-pyscan/installation/README.md) + * [3.2.1 Updating Firmware](pytrack-pysense-pyscan/installation/firmware.md) + * [3.2.2 Installing Drivers - Windows 7](pytrack-pysense-pyscan/installation/drivers.md) + * [3.2.3 Installing Libraries](pytrack-pysense-pyscan/installation/libraries.md) +* [3.3 API Reference](pytrack-pysense-pyscan/apireference/README.md) + * [3.3.1 Pytrack](pytrack-pysense-pyscan/apireference/pytrack.md) + * [3.3.2 Pysense](pytrack-pysense-pyscan/apireference/pysense.md) + * [3.3.4 Pyscan](pytrack-pysense-pyscan/apireference/pyscan.md) + * [3.3.5 Sleep](pytrack-pysense-pyscan/apireference/sleep.md) ## 4. Tutorials & Examples -* [4.1 Introduction](4.-tutorials-and-examples/tutorials.md) -* [4.2 All Pycom Device Examples](4.-tutorials-and-examples/all/README.md) - * [4.2.1 REPL](4.-tutorials-and-examples/all/repl.md) - * [4.2.2 WLAN](4.-tutorials-and-examples/all/wlan.md) - * [4.2.3 Bluetooth](4.-tutorials-and-examples/all/ble.md) - * [4.2.4 HTTPS](4.-tutorials-and-examples/all/https.md) - * [4.2.5 MQTT](4.-tutorials-and-examples/all/mqtt.md) - * [4.2.6 AWS](4.-tutorials-and-examples/all/aws.md) - * [4.2.7 ADC](4.-tutorials-and-examples/all/adc.md) - * [4.2.8 I2C](4.-tutorials-and-examples/all/i2c.md) - * [4.2.9 Onewire Driver](4.-tutorials-and-examples/all/owd.md) - * [4.2.10 Threading](4.-tutorials-and-examples/all/threading.md) - * [4.2.11 RGB LED](4.-tutorials-and-examples/all/rgbled.md) - * [4.2.12 Timers](4.-tutorials-and-examples/all/timers.md) - * [4.2.13 PIR Sensor](4.-tutorials-and-examples/all/pir.md) - * [4.2.14 Modbus](4.-tutorials-and-examples/all/modbus.md) - * [4.2.15 OTA update](4.-tutorials-and-examples/all/ota.md) - * [4.2.16 RMT](4.-tutorials-and-examples/all/rmt.md) -* [4.3 LoRa Examples](4.-tutorials-and-examples/lora/README.md) - * [4.3.1 LoRa-MAC \(Raw LoRa\)](4.-tutorials-and-examples/lora/lora-mac.md) - * [4.3.2 LoRaWAN with OTAA](4.-tutorials-and-examples/lora/lorawan-otaa.md) - * [4.3.3 LoRaWAN with ABP](4.-tutorials-and-examples/lora/lorawan-abp.md) - * [4.3.4 LoRa-MAC Nano-Gateway](4.-tutorials-and-examples/lora/lora-mac-nano-gateway.md) - * [4.3.5 LoPy to LoPy](4.-tutorials-and-examples/lora/module-module.md) - * [4.3.6 LoRaWAN Nano-Gateway](4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) - * [4.3.7 RN2483 to LoPy](4.-tutorials-and-examples/lora/537-rn2483-to-lopy.md) -* [4.4 Sigfox Examples](4.-tutorials-and-examples/sigfox.md) -* [4.5 LTE Examples](4.-tutorials-and-examples/lte/README.md) - * [4.5.1 CAT-M1](4.-tutorials-and-examples/lte/cat_m1.md) - * [4.5.2 NB-IoT](4.-tutorials-and-examples/lte/nb_iot.md) - * [4.5.3 Module IMEI](4.-tutorials-and-examples/lte/imei.md) - * [4.5.4 Modem Firmware Update](4.-tutorials-and-examples/lte/firmware.md) -* [4.6 Pytrack Examples](4.-tutorials-and-examples/pytrack.md) -* [4.7 Pysense Examples](4.-tutorials-and-examples/pysense.md) -* [4.8 Pyscan Examples](4.-tutorials-and-examples/pyscan.md) +* [4.1 Introduction](tutorials-and-examples/tutorials.md) +* [4.2 All Pycom Device Examples](tutorials-and-examples/all/README.md) + * [4.2.1 REPL](tutorials-and-examples/all/repl.md) + * [4.2.2 WLAN](tutorials-and-examples/all/wlan.md) + * [4.2.3 Bluetooth](tutorials-and-examples/all/ble.md) + * [4.2.4 HTTPS](tutorials-and-examples/all/https.md) + * [4.2.5 MQTT](tutorials-and-examples/all/mqtt.md) + * [4.2.6 AWS](tutorials-and-examples/all/aws.md) + * [4.2.7 ADC](tutorials-and-examples/all/adc.md) + * [4.2.8 I2C](tutorials-and-examples/all/i2c.md) + * [4.2.9 Onewire Driver](tutorials-and-examples/all/owd.md) + * [4.2.10 Threading](tutorials-and-examples/all/threading.md) + * [4.2.11 RGB LED](tutorials-and-examples/all/rgbled.md) + * [4.2.12 Timers](tutorials-and-examples/all/timers.md) + * [4.2.13 PIR Sensor](tutorials-and-examples/all/pir.md) + * [4.2.14 Modbus](tutorials-and-examples/all/modbus.md) + * [4.2.15 OTA update](tutorials-and-examples/all/ota.md) + * [4.2.16 RMT](tutorials-and-examples/all/rmt.md) +* [4.3 LoRa Examples](tutorials-and-examples/lora/README.md) + * [4.3.1 LoRa-MAC \(Raw LoRa\)](tutorials-and-examples/lora/lora-mac.md) + * [4.3.2 LoRaWAN with OTAA](tutorials-and-examples/lora/lorawan-otaa.md) + * [4.3.3 LoRaWAN with ABP](tutorials-and-examples/lora/lorawan-abp.md) + * [4.3.4 LoRa-MAC Nano-Gateway](tutorials-and-examples/lora/lora-mac-nano-gateway.md) + * [4.3.5 LoPy to LoPy](tutorials-and-examples/lora/module-module.md) + * [4.3.6 LoRaWAN Nano-Gateway](tutorials-and-examples/lora/lorawan-nano-gateway.md) + * [4.3.7 RN2483 to LoPy](tutorials-and-examples/lora/537-rn2483-to-lopy.md) +* [4.4 Sigfox Examples](tutorials-and-examples/sigfox.md) +* [4.5 LTE Examples](tutorials-and-examples/lte/README.md) + * [4.5.1 CAT-M1](tutorials-and-examples/lte/cat_m1.md) + * [4.5.2 NB-IoT](tutorials-and-examples/lte/nb_iot.md) + * [4.5.3 Module IMEI](tutorials-and-examples/lte/imei.md) + * [4.5.4 Modem Firmware Update](tutorials-and-examples/lte/firmware.md) +* [4.6 Pytrack Examples](tutorials-and-examples/pytrack.md) +* [4.7 Pysense Examples](tutorials-and-examples/pysense.md) +* [4.8 Pyscan Examples](tutorials-and-examples/pyscan.md) ## 5. Firmware & API Reference -* [5.1 Introduction](5.-firmware-and-api-reference/firmwareapi.md) -* [5.2 Pycom Modules](5.-firmware-and-api-reference/pycom/README.md) - * [5.2.1 machine](5.-firmware-and-api-reference/pycom/machine/README.md) - * [5.2.1.1 ADC](5.-firmware-and-api-reference/pycom/machine/adc.md) - * [5.2.1.2 DAC](5.-firmware-and-api-reference/pycom/machine/dac.md) - * [5.2.1.3 I2C](5.-firmware-and-api-reference/pycom/machine/i2c.md) - * [5.2.1.4 Pin](5.-firmware-and-api-reference/pycom/machine/pin.md) - * [5.2.1.5 PWM](5.-firmware-and-api-reference/pycom/machine/pwm.md) - * [5.2.1.6 RTC](5.-firmware-and-api-reference/pycom/machine/rtc.md) - * [5.2.1.7 SPI](5.-firmware-and-api-reference/pycom/machine/spi.md) - * [5.2.1.8 UART](5.-firmware-and-api-reference/pycom/machine/uart.md) - * [5.2.1.9 WDT](5.-firmware-and-api-reference/pycom/machine/wdt.md) - * [5.2.1.10 Timer](5.-firmware-and-api-reference/pycom/machine/timer.md) - * [5.2.1.11 SD](5.-firmware-and-api-reference/pycom/machine/sd.md) - * [5.2.1.12 CAN](5.-firmware-and-api-reference/pycom/machine/can.md) - * [5.2.1.13 RMT](5.-firmware-and-api-reference/pycom/machine/rmt.md) - * [5.2.2 network](5.-firmware-and-api-reference/pycom/network/README.md) - * [5.2.2.1 WLAN](5.-firmware-and-api-reference/pycom/network/wlan.md) - * [5.2.2.2 Server](5.-firmware-and-api-reference/pycom/network/server.md) - * [5.2.2.3 Bluetooth](5.-firmware-and-api-reference/pycom/network/bluetooth/README.md) - * [5.2.2.3.1 GATT](5.-firmware-and-api-reference/pycom/network/bluetooth/gatt.md) - * [5.2.2.3.2 GATTCConnection](5.-firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) - * [5.2.2.3.3 GATTCService](5.-firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) - * [5.2.2.3.4 GATTCCharacteristic](5.-firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) - * [5.2.2.3.5 GATTSService](5.-firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) - * [5.2.2.3.6 GATTSCharacteristic](5.-firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) - * [5.2.2.4 LoRa](5.-firmware-and-api-reference/pycom/network/lora.md) - * [5.2.2.5 Sigfox](5.-firmware-and-api-reference/pycom/network/sigfox.md) - * [5.2.2.6 LTE](5.-firmware-and-api-reference/pycom/network/lte.md) - * [5.2.3 AES](5.-firmware-and-api-reference/pycom/aes.md) - * [5.2.4 pycom](5.-firmware-and-api-reference/pycom/pycom.md) -* [5.3 MicroPython Modules](5.-firmware-and-api-reference/micropython/README.md) - * [5.3.1 micropython](5.-firmware-and-api-reference/micropython/micropython.md) - * [5.3.2 uctypes](5.-firmware-and-api-reference/micropython/uctypes.md) - * [5.3.3 sys](5.-firmware-and-api-reference/micropython/sys.md) - * [5.3.4 uos](5.-firmware-and-api-reference/micropython/uos.md) - * [5.3.5 array](5.-firmware-and-api-reference/micropython/array.md) - * [5.3.6 cmath](5.-firmware-and-api-reference/micropython/cmath.md) - * [5.3.7 math](5.-firmware-and-api-reference/micropython/math.md) - * [5.3.8 gc](5.-firmware-and-api-reference/micropython/gc.md) - * [5.3.9 ubinascii](5.-firmware-and-api-reference/micropython/ubinascii.md) - * [5.3.10 ujson](5.-firmware-and-api-reference/micropython/ujson.md) - * [5.3.11 ure](5.-firmware-and-api-reference/micropython/ure.md) - * [5.3.12 usocket](5.-firmware-and-api-reference/micropython/usocket.md) - * [5.3.13 select](5.-firmware-and-api-reference/micropython/select.md) - * [5.3.14 utime](5.-firmware-and-api-reference/micropython/utime.md) - * [5.3.15 uhashlib](5.-firmware-and-api-reference/micropython/uhashlib.md) - * [5.3.16 ussl](5.-firmware-and-api-reference/micropython/ussl.md) - * [5.3.17 ucrypto](5.-firmware-and-api-reference/micropython/ucrypto.md) - * [5.3.18 ustruct](5.-firmware-and-api-reference/micropython/ustruct.md) - * [5.3.19 \_thread](5.-firmware-and-api-reference/micropython/_thread.md) - * [5.3.20 Builtin](5.-firmware-and-api-reference/micropython/builtin.md) +* [5.1 Introduction](firmware-and-api-reference/firmwareapi.md) +* [5.2 Pycom Modules](firmware-and-api-reference/pycom/README.md) + * [5.2.1 machine](firmware-and-api-reference/pycom/machine/README.md) + * [5.2.1.1 ADC](firmware-and-api-reference/pycom/machine/adc.md) + * [5.2.1.2 DAC](firmware-and-api-reference/pycom/machine/dac.md) + * [5.2.1.3 I2C](firmware-and-api-reference/pycom/machine/i2c.md) + * [5.2.1.4 Pin](firmware-and-api-reference/pycom/machine/pin.md) + * [5.2.1.5 PWM](firmware-and-api-reference/pycom/machine/pwm.md) + * [5.2.1.6 RTC](firmware-and-api-reference/pycom/machine/rtc.md) + * [5.2.1.7 SPI](firmware-and-api-reference/pycom/machine/spi.md) + * [5.2.1.8 UART](firmware-and-api-reference/pycom/machine/uart.md) + * [5.2.1.9 WDT](firmware-and-api-reference/pycom/machine/wdt.md) + * [5.2.1.10 Timer](firmware-and-api-reference/pycom/machine/timer.md) + * [5.2.1.11 SD](firmware-and-api-reference/pycom/machine/sd.md) + * [5.2.1.12 CAN](firmware-and-api-reference/pycom/machine/can.md) + * [5.2.1.13 RMT](firmware-and-api-reference/pycom/machine/rmt.md) + * [5.2.2 network](firmware-and-api-reference/pycom/network/README.md) + * [5.2.2.1 WLAN](firmware-and-api-reference/pycom/network/wlan.md) + * [5.2.2.2 Server](firmware-and-api-reference/pycom/network/server.md) + * [5.2.2.3 Bluetooth](firmware-and-api-reference/pycom/network/bluetooth/README.md) + * [5.2.2.3.1 GATT](firmware-and-api-reference/pycom/network/bluetooth/gatt.md) + * [5.2.2.3.2 GATTCConnection](firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) + * [5.2.2.3.3 GATTCService](firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) + * [5.2.2.3.4 GATTCCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) + * [5.2.2.3.5 GATTSService](firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) + * [5.2.2.3.6 GATTSCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) + * [5.2.2.4 LoRa](firmware-and-api-reference/pycom/network/lora.md) + * [5.2.2.5 Sigfox](firmware-and-api-reference/pycom/network/sigfox.md) + * [5.2.2.6 LTE](firmware-and-api-reference/pycom/network/lte.md) + * [5.2.3 AES](firmware-and-api-reference/pycom/aes.md) + * [5.2.4 pycom](firmware-and-api-reference/pycom/pycom.md) +* [5.3 MicroPython Modules](firmware-and-api-reference/micropython/README.md) + * [5.3.1 micropython](firmware-and-api-reference/micropython/micropython.md) + * [5.3.2 uctypes](firmware-and-api-reference/micropython/uctypes.md) + * [5.3.3 sys](firmware-and-api-reference/micropython/sys.md) + * [5.3.4 uos](firmware-and-api-reference/micropython/uos.md) + * [5.3.5 array](firmware-and-api-reference/micropython/array.md) + * [5.3.6 cmath](firmware-and-api-reference/micropython/cmath.md) + * [5.3.7 math](firmware-and-api-reference/micropython/math.md) + * [5.3.8 gc](firmware-and-api-reference/micropython/gc.md) + * [5.3.9 ubinascii](firmware-and-api-reference/micropython/ubinascii.md) + * [5.3.10 ujson](firmware-and-api-reference/micropython/ujson.md) + * [5.3.11 ure](firmware-and-api-reference/micropython/ure.md) + * [5.3.12 usocket](firmware-and-api-reference/micropython/usocket.md) + * [5.3.13 select](firmware-and-api-reference/micropython/select.md) + * [5.3.14 utime](firmware-and-api-reference/micropython/utime.md) + * [5.3.15 uhashlib](firmware-and-api-reference/micropython/uhashlib.md) + * [5.3.16 ussl](firmware-and-api-reference/micropython/ussl.md) + * [5.3.17 ucrypto](firmware-and-api-reference/micropython/ucrypto.md) + * [5.3.18 ustruct](firmware-and-api-reference/micropython/ustruct.md) + * [5.3.19 \_thread](firmware-and-api-reference/micropython/_thread.md) + * [5.3.20 Builtin](firmware-and-api-reference/micropython/builtin.md) ## 6. Product Info -* [6.0 Introduction](6.-product-info/datasheets.md) -* [6.1 Development Modules](6.-product-info/development/README.md) - * [6.1.1 WiPy 2.0](6.-product-info/development/wipy2.md) - * [6.1.2 WiPy 3.0](6.-product-info/development/wipy3.md) - * [6.1.3 LoPy](6.-product-info/development/lopy.md) - * [6.1.4 LoPy 4](6.-product-info/development/lopy4.md) - * [6.1.5 SiPy](6.-product-info/development/sipy.md) - * [6.1.6 GPy](6.-product-info/development/gpy.md) - * [6.1.7 FiPy](6.-product-info/development/fipy.md) -* [6.2 OEM Modules](6.-product-info/oem/README.md) - * [6.2.1 W01](6.-product-info/oem/w01.md) - * [6.2.2 L01](6.-product-info/oem/l01.md) - * [6.2.3 L04](6.-product-info/oem/l04.md) - * [6.2.4 G01](6.-product-info/oem/g01.md) - * [6.2.5 L01 OEM Baseboard Reference](6.-product-info/oem/l01_reference.md) - * [6.2.6 Universal OEM Baseboard Reference](6.-product-info/oem/universal_reference.md) -* [6.3 Expansion Boards and Shields](6.-product-info/boards/README.md) - * [6.3.1 Expansion Board 3.0](6.-product-info/boards/expansion3.md) - * [6.3.2 Pytrack](6.-product-info/boards/pytrack.md) - * [6.3.3 Pysense](6.-product-info/boards/pysense.md) - * [6.3.4 Pyscan](6.-product-info/boards/pyscan.md) - * [6.3.5 Expansion Board 2.0](6.-product-info/boards/expansion2.md) - * [6.3.6 Deep Sleep Shield](6.-product-info/boards/deepsleep/README.md) - * [6.3.6.1 Deep Sleep API](6.-product-info/boards/deepsleep/api.md) -* [6.4 Notes](6.-product-info/notes.md) +* [6.0 Introduction](product-info/datasheets.md) +* [6.1 Development Modules](product-info/development/README.md) + * [6.1.1 WiPy 2.0](product-info/development/wipy2.md) + * [6.1.2 WiPy 3.0](product-info/development/wipy3.md) + * [6.1.3 LoPy](product-info/development/lopy.md) + * [6.1.4 LoPy 4](product-info/development/lopy4.md) + * [6.1.5 SiPy](product-info/development/sipy.md) + * [6.1.6 GPy](product-info/development/gpy.md) + * [6.1.7 FiPy](product-info/development/fipy.md) +* [6.2 OEM Modules](product-info/oem/README.md) + * [6.2.1 W01](product-info/oem/w01.md) + * [6.2.2 L01](product-info/oem/l01.md) + * [6.2.3 L04](product-info/oem/l04.md) + * [6.2.4 G01](product-info/oem/g01.md) + * [6.2.5 L01 OEM Baseboard Reference](product-info/oem/l01_reference.md) + * [6.2.6 Universal OEM Baseboard Reference](product-info/oem/universal_reference.md) +* [6.3 Expansion Boards and Shields](product-info/boards/README.md) + * [6.3.1 Expansion Board 3.0](product-info/boards/expansion3.md) + * [6.3.2 Pytrack](product-info/boards/pytrack.md) + * [6.3.3 Pysense](product-info/boards/pysense.md) + * [6.3.4 Pyscan](product-info/boards/pyscan.md) + * [6.3.5 Expansion Board 2.0](product-info/boards/expansion2.md) + * [6.3.6 Deep Sleep Shield](product-info/boards/deepsleep/README.md) + * [6.3.6.1 Deep Sleep API](product-info/boards/deepsleep/api.md) +* [6.4 Notes](product-info/notes.md) ## 7. Datasheets -* [7.1 Development Modules](7.-datasheets/modules.md) -* [7.2 OEM Modules](7.-datasheets/oem.md) -* [7.3 Expansion Boards and Shields](7.-datasheets/boards.md) +* [7.1 Development Modules](datasheets/modules.md) +* [7.2 OEM Modules](datasheets/oem.md) +* [7.3 Expansion Boards and Shields](datasheets/boards.md) ## 8. Pybytes -* [8.1 Introduction](8.-pybytes/pybytes.md) -* [8.2 Getting Started with Pybytes](8.-pybytes/intro.md) -* [8.3 Add a device to Pybytes](8.-pybytes/intro-1/README.md) - * [8.3.1 Connect to Pybytes: Quick Add](8.-pybytes/intro-1/quick.md) - * [8.3.2 Connect to Pybytes: Flash Pybytes library manually](8.-pybytes/intro-1/flash.md) - * [8.3.3 Add Sigfox device](8.-pybytes/intro-1/sigfox/README.md) - * [8.3.3.1 DevKit contract](8.-pybytes/intro-1/sigfox/sigfoxdevkit.md) - * [8.3.3.2 Custom contract](8.-pybytes/intro-1/sigfox/sigfoxcustomcontract.md) -* [8.4 Visualise data from your device](8.-pybytes/intro-2.md) +* [8.1 Introduction](pybytes/pybytes.md) +* [8.2 Getting Started with Pybytes](pybytes/intro.md) +* [8.3 Add a device to Pybytes](pybytes/intro-1/README.md) + * [8.3.1 Connect to Pybytes: Quick Add](pybytes/intro-1/quick.md) + * [8.3.2 Connect to Pybytes: Flash Pybytes library manually](pybytes/intro-1/flash.md) + * [8.3.3 Add Sigfox device](pybytes/intro-1/sigfox/README.md) + * [8.3.3.1 DevKit contract](pybytes/intro-1/sigfox/sigfoxdevkit.md) + * [8.3.3.2 Custom contract](pybytes/intro-1/sigfox/sigfoxcustomcontract.md) +* [8.4 Visualise data from your device](pybytes/intro-2.md) ## 9. Documentation Notes -* [9.1 Introduction](9.-documentation-notes/docnotes.md) -* [9.2 Syntax](9.-documentation-notes/syntax.md) -* [9.3 REPL vs Scripts](9.-documentation-notes/replscript.md) -* [9.4 Mesh Networks](9.-documentation-notes/mesh-networks.md) +* [9.1 Introduction](documentation-notes/docnotes.md) +* [9.2 Syntax](documentation-notes/syntax.md) +* [9.3 REPL vs Scripts](documentation-notes/replscript.md) +* [9.4 Mesh Networks](documentation-notes/mesh-networks.md) ## 10. Advanced Topics -* [10.1 Firmware Downgrade](10.-advanced-topics/downgrade.md) -* [10.2 CLI Updater](10.-advanced-topics/cli.md) -* [10.3 SecureBoot and Encryption](10.-advanced-topics/encryption.md) +* [10.1 Firmware Downgrade](advanced-topics/downgrade.md) +* [10.2 CLI Updater](advanced-topics/cli.md) +* [10.3 SecureBoot and Encryption](advanced-topics/encryption.md) ## 11. License -* [11.1 License](11.-license/license.md) +* [11.1 License](license/license.md) diff --git a/about/products.md b/about/products.md index 15319e0..0705e15 100644 --- a/about/products.md +++ b/about/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-M1 NB-IoT | | :--- | :--- | :--- | :--- | :--- | :--- | -| [![](../.gitbook/assets/wipy2.png) WiPy 3.0](../6.-product-info/development/wipy3.md) | ✔ | ✔ | | | | -| [![](../.gitbook/assets/sipy%20%281%29.png) SiPy](../6.-product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | -| [![](../.gitbook/assets/gpy.png) GPy](../6.-product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | -| [![](../.gitbook/assets/lopy.png) LoPy](../6.-product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | -| [![](../.gitbook/assets/lopy4%20%282%29.png) LoPy4](../6.-product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | -| [![](../.gitbook/assets/fipy%20%282%29.png) FiPy](../6.-product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | +| [![](../.gitbook/assets/wipy2.png) WiPy 3.0](../product-info/development/wipy3.md) | ✔ | ✔ | | | | +| [![](../.gitbook/assets/sipy%20%281%29.png) SiPy](../product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | +| [![](../.gitbook/assets/gpy.png) GPy](../product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | +| [![](../.gitbook/assets/lopy.png) LoPy](../product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | +| [![](../.gitbook/assets/lopy4%20%282%29.png) LoPy4](../product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | +| [![](../.gitbook/assets/fipy%20%282%29.png) FiPy](../product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | | Antennas [![](../.gitbook/assets/wifi_ant.png) External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/)[![](../.gitbook/assets/lora_ant.png) LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [![](../.gitbook/assets/lte_ant.png) LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) | | | | | ## Accessories -| Accessory | [![](../.gitbook/assets/expansion3.png) Expansion Board](../6.-product-info/boards/expansion3.md) | [![](../.gitbook/assets/pysense_new.png) Pysense](../6.-product-info/boards/pysense.md) | [![](../.gitbook/assets/pytrack_new.png) Pytrack](../6.-product-info/boards/pytrack.md) | [![](../.gitbook/assets/pyscan.png) Pyscan](../6.-product-info/boards/pyscan.md) | +| Accessory | [![](../.gitbook/assets/expansion3.png) Expansion Board](../product-info/boards/expansion3.md) | [![](../.gitbook/assets/pysense_new.png) Pysense](../product-info/boards/pysense.md) | [![](../.gitbook/assets/pytrack_new.png) Pytrack](../product-info/boards/pytrack.md) | [![](../.gitbook/assets/pyscan.png) Pyscan](../product-info/boards/pyscan.md) | | :--- | :--- | :--- | :--- | :--- | | [![](../.gitbook/assets/pycase.png) PyCase](https://pycom.io/product/pycase/) | ✔ | | | | | [![](../.gitbook/assets/ip67_case_exp.png) 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 | [![](../.gitbook/assets/oem_l01_ref.png) L01/W01 Reference Board](../6.-product-info/oem/l01_reference.md) | [![](../.gitbook/assets/oem_universal_ref.png) Universal Reference Board](../6.-product-info/oem/universal_reference.md) | +| OEM Module | [![](../.gitbook/assets/oem_l01_ref.png) L01/W01 Reference Board](../product-info/oem/l01_reference.md) | [![](../.gitbook/assets/oem_universal_ref.png) Universal Reference Board](../product-info/oem/universal_reference.md) | | :--- | :--- | :--- | -| [![](../.gitbook/assets/w01%20%281%29.png) W01](../6.-product-info/oem/w01.md) | ✔ | ✔ | -| [![](../.gitbook/assets/l01.png) L01](../6.-product-info/oem/l01.md) | ✔ | ✔ | -| [![](../.gitbook/assets/l04.png) L04](../6.-product-info/oem/l04.md) | | ✔ | -| [![](../.gitbook/assets/g01.png) G01](../6.-product-info/oem/g01.md) | | ✔ | +| [![](../.gitbook/assets/w01%20%281%29.png) W01](../product-info/oem/w01.md) | ✔ | ✔ | +| [![](../.gitbook/assets/l01.png) L01](../product-info/oem/l01.md) | ✔ | ✔ | +| [![](../.gitbook/assets/l04.png) L04](../product-info/oem/l04.md) | | ✔ | +| [![](../.gitbook/assets/g01.png) G01](../product-info/oem/g01.md) | | ✔ | diff --git a/10.-advanced-topics/cli.md b/advanced-topics/cli.md similarity index 99% rename from 10.-advanced-topics/cli.md rename to advanced-topics/cli.md index f740998..2fa868f 100644 --- a/10.-advanced-topics/cli.md +++ b/advanced-topics/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](../5.-firmware-and-api-reference/pycom/network/lora.md##loranvramsave) for more details. +Get/Set LPWAN parameters saved to non-volatile storage. Please see [here](../firmware-and-api-reference/pycom/network/lora.md##loranvramsave) for more details. ```text usage: pycom-fwtool-cli -p PORT lpwan [-h] [--region REGION] diff --git a/10.-advanced-topics/downgrade.md b/advanced-topics/downgrade.md similarity index 100% rename from 10.-advanced-topics/downgrade.md rename to advanced-topics/downgrade.md diff --git a/10.-advanced-topics/encryption.md b/advanced-topics/encryption.md similarity index 100% rename from 10.-advanced-topics/encryption.md rename to advanced-topics/encryption.md diff --git a/7.-datasheets/boards.md b/datasheets/boards.md similarity index 100% rename from 7.-datasheets/boards.md rename to datasheets/boards.md diff --git a/7.-datasheets/modules.md b/datasheets/modules.md similarity index 100% rename from 7.-datasheets/modules.md rename to datasheets/modules.md diff --git a/7.-datasheets/oem.md b/datasheets/oem.md similarity index 100% rename from 7.-datasheets/oem.md rename to datasheets/oem.md diff --git a/9.-documentation-notes/docnotes.md b/documentation-notes/docnotes.md similarity index 100% rename from 9.-documentation-notes/docnotes.md rename to documentation-notes/docnotes.md diff --git a/9.-documentation-notes/mesh-networks.md b/documentation-notes/mesh-networks.md similarity index 100% rename from 9.-documentation-notes/mesh-networks.md rename to documentation-notes/mesh-networks.md diff --git a/9.-documentation-notes/replscript.md b/documentation-notes/replscript.md similarity index 100% rename from 9.-documentation-notes/replscript.md rename to documentation-notes/replscript.md diff --git a/9.-documentation-notes/syntax.md b/documentation-notes/syntax.md similarity index 100% rename from 9.-documentation-notes/syntax.md rename to documentation-notes/syntax.md diff --git a/5.-firmware-and-api-reference/firmwareapi.md b/firmware-and-api-reference/firmwareapi.md similarity index 100% rename from 5.-firmware-and-api-reference/firmwareapi.md rename to firmware-and-api-reference/firmwareapi.md diff --git a/5.-firmware-and-api-reference/micropython/README.md b/firmware-and-api-reference/micropython/README.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/README.md rename to firmware-and-api-reference/micropython/README.md diff --git a/5.-firmware-and-api-reference/micropython/_thread.md b/firmware-and-api-reference/micropython/_thread.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/_thread.md rename to firmware-and-api-reference/micropython/_thread.md diff --git a/5.-firmware-and-api-reference/micropython/array.md b/firmware-and-api-reference/micropython/array.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/array.md rename to firmware-and-api-reference/micropython/array.md diff --git a/5.-firmware-and-api-reference/micropython/builtin.md b/firmware-and-api-reference/micropython/builtin.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/builtin.md rename to firmware-and-api-reference/micropython/builtin.md diff --git a/5.-firmware-and-api-reference/micropython/cmath.md b/firmware-and-api-reference/micropython/cmath.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/cmath.md rename to firmware-and-api-reference/micropython/cmath.md diff --git a/5.-firmware-and-api-reference/micropython/gc.md b/firmware-and-api-reference/micropython/gc.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/gc.md rename to firmware-and-api-reference/micropython/gc.md diff --git a/5.-firmware-and-api-reference/micropython/math.md b/firmware-and-api-reference/micropython/math.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/math.md rename to firmware-and-api-reference/micropython/math.md diff --git a/5.-firmware-and-api-reference/micropython/micropython.md b/firmware-and-api-reference/micropython/micropython.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/micropython.md rename to firmware-and-api-reference/micropython/micropython.md diff --git a/5.-firmware-and-api-reference/micropython/select.md b/firmware-and-api-reference/micropython/select.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/select.md rename to firmware-and-api-reference/micropython/select.md diff --git a/5.-firmware-and-api-reference/micropython/sys.md b/firmware-and-api-reference/micropython/sys.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/sys.md rename to firmware-and-api-reference/micropython/sys.md diff --git a/5.-firmware-and-api-reference/micropython/ubinascii.md b/firmware-and-api-reference/micropython/ubinascii.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ubinascii.md rename to firmware-and-api-reference/micropython/ubinascii.md diff --git a/5.-firmware-and-api-reference/micropython/ucrypto.md b/firmware-and-api-reference/micropython/ucrypto.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ucrypto.md rename to firmware-and-api-reference/micropython/ucrypto.md diff --git a/5.-firmware-and-api-reference/micropython/uctypes.md b/firmware-and-api-reference/micropython/uctypes.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/uctypes.md rename to firmware-and-api-reference/micropython/uctypes.md diff --git a/5.-firmware-and-api-reference/micropython/uhashlib.md b/firmware-and-api-reference/micropython/uhashlib.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/uhashlib.md rename to firmware-and-api-reference/micropython/uhashlib.md diff --git a/5.-firmware-and-api-reference/micropython/ujson.md b/firmware-and-api-reference/micropython/ujson.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ujson.md rename to firmware-and-api-reference/micropython/ujson.md diff --git a/5.-firmware-and-api-reference/micropython/uos.md b/firmware-and-api-reference/micropython/uos.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/uos.md rename to firmware-and-api-reference/micropython/uos.md diff --git a/5.-firmware-and-api-reference/micropython/ure.md b/firmware-and-api-reference/micropython/ure.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ure.md rename to firmware-and-api-reference/micropython/ure.md diff --git a/5.-firmware-and-api-reference/micropython/usocket.md b/firmware-and-api-reference/micropython/usocket.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/usocket.md rename to firmware-and-api-reference/micropython/usocket.md diff --git a/5.-firmware-and-api-reference/micropython/ussl.md b/firmware-and-api-reference/micropython/ussl.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ussl.md rename to firmware-and-api-reference/micropython/ussl.md diff --git a/5.-firmware-and-api-reference/micropython/ustruct.md b/firmware-and-api-reference/micropython/ustruct.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/ustruct.md rename to firmware-and-api-reference/micropython/ustruct.md diff --git a/5.-firmware-and-api-reference/micropython/utime.md b/firmware-and-api-reference/micropython/utime.md similarity index 100% rename from 5.-firmware-and-api-reference/micropython/utime.md rename to firmware-and-api-reference/micropython/utime.md diff --git a/5.-firmware-and-api-reference/pycom/README.md b/firmware-and-api-reference/pycom/README.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/README.md rename to firmware-and-api-reference/pycom/README.md diff --git a/5.-firmware-and-api-reference/pycom/aes.md b/firmware-and-api-reference/pycom/aes.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/aes.md rename to firmware-and-api-reference/pycom/aes.md diff --git a/5.-firmware-and-api-reference/pycom/machine/README.md b/firmware-and-api-reference/pycom/machine/README.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/README.md rename to firmware-and-api-reference/pycom/machine/README.md diff --git a/5.-firmware-and-api-reference/pycom/machine/adc.md b/firmware-and-api-reference/pycom/machine/adc.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/adc.md rename to firmware-and-api-reference/pycom/machine/adc.md diff --git a/5.-firmware-and-api-reference/pycom/machine/can.md b/firmware-and-api-reference/pycom/machine/can.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/can.md rename to firmware-and-api-reference/pycom/machine/can.md diff --git a/5.-firmware-and-api-reference/pycom/machine/dac.md b/firmware-and-api-reference/pycom/machine/dac.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/dac.md rename to firmware-and-api-reference/pycom/machine/dac.md diff --git a/5.-firmware-and-api-reference/pycom/machine/i2c.md b/firmware-and-api-reference/pycom/machine/i2c.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/i2c.md rename to firmware-and-api-reference/pycom/machine/i2c.md diff --git a/5.-firmware-and-api-reference/pycom/machine/pin.md b/firmware-and-api-reference/pycom/machine/pin.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/pin.md rename to firmware-and-api-reference/pycom/machine/pin.md diff --git a/5.-firmware-and-api-reference/pycom/machine/pwm.md b/firmware-and-api-reference/pycom/machine/pwm.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/pwm.md rename to firmware-and-api-reference/pycom/machine/pwm.md diff --git a/5.-firmware-and-api-reference/pycom/machine/rmt.md b/firmware-and-api-reference/pycom/machine/rmt.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/rmt.md rename to firmware-and-api-reference/pycom/machine/rmt.md diff --git a/5.-firmware-and-api-reference/pycom/machine/rtc.md b/firmware-and-api-reference/pycom/machine/rtc.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/rtc.md rename to firmware-and-api-reference/pycom/machine/rtc.md diff --git a/5.-firmware-and-api-reference/pycom/machine/sd.md b/firmware-and-api-reference/pycom/machine/sd.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/sd.md rename to firmware-and-api-reference/pycom/machine/sd.md diff --git a/5.-firmware-and-api-reference/pycom/machine/spi.md b/firmware-and-api-reference/pycom/machine/spi.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/spi.md rename to firmware-and-api-reference/pycom/machine/spi.md diff --git a/5.-firmware-and-api-reference/pycom/machine/timer.md b/firmware-and-api-reference/pycom/machine/timer.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/timer.md rename to firmware-and-api-reference/pycom/machine/timer.md diff --git a/5.-firmware-and-api-reference/pycom/machine/uart.md b/firmware-and-api-reference/pycom/machine/uart.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/uart.md rename to firmware-and-api-reference/pycom/machine/uart.md diff --git a/5.-firmware-and-api-reference/pycom/machine/wdt.md b/firmware-and-api-reference/pycom/machine/wdt.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/machine/wdt.md rename to firmware-and-api-reference/pycom/machine/wdt.md diff --git a/5.-firmware-and-api-reference/pycom/network/README.md b/firmware-and-api-reference/pycom/network/README.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/README.md rename to firmware-and-api-reference/pycom/network/README.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/README.md b/firmware-and-api-reference/pycom/network/bluetooth/README.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/README.md rename to firmware-and-api-reference/pycom/network/bluetooth/README.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gatt.md b/firmware-and-api-reference/pycom/network/bluetooth/gatt.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gatt.md rename to firmware-and-api-reference/pycom/network/bluetooth/gatt.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md b/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md diff --git a/5.-firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md diff --git a/5.-firmware-and-api-reference/pycom/network/lora.md b/firmware-and-api-reference/pycom/network/lora.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/lora.md rename to firmware-and-api-reference/pycom/network/lora.md diff --git a/5.-firmware-and-api-reference/pycom/network/lte.md b/firmware-and-api-reference/pycom/network/lte.md similarity index 99% rename from 5.-firmware-and-api-reference/pycom/network/lte.md rename to firmware-and-api-reference/pycom/network/lte.md index e941e66..0ac55bb 100644 --- a/5.-firmware-and-api-reference/pycom/network/lte.md +++ b/firmware-and-api-reference/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](../../../4.-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-and-examples/lte/firmware.md). {% endhint %} ## AT Commands diff --git a/5.-firmware-and-api-reference/pycom/network/server.md b/firmware-and-api-reference/pycom/network/server.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/server.md rename to firmware-and-api-reference/pycom/network/server.md diff --git a/5.-firmware-and-api-reference/pycom/network/sigfox.md b/firmware-and-api-reference/pycom/network/sigfox.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/sigfox.md rename to firmware-and-api-reference/pycom/network/sigfox.md diff --git a/5.-firmware-and-api-reference/pycom/network/wlan.md b/firmware-and-api-reference/pycom/network/wlan.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/network/wlan.md rename to firmware-and-api-reference/pycom/network/wlan.md diff --git a/5.-firmware-and-api-reference/pycom/pycom.md b/firmware-and-api-reference/pycom/pycom.md similarity index 100% rename from 5.-firmware-and-api-reference/pycom/pycom.md rename to firmware-and-api-reference/pycom/pycom.md diff --git a/1.-getting-started/gettingstarted.md b/getting-started/gettingstarted.md similarity index 100% rename from 1.-getting-started/gettingstarted.md rename to getting-started/gettingstarted.md diff --git a/1.-getting-started/hardwaresetup/README.md b/getting-started/hardwaresetup/README.md similarity index 100% rename from 1.-getting-started/hardwaresetup/README.md rename to getting-started/hardwaresetup/README.md diff --git a/1.-getting-started/hardwaresetup/fipy.md b/getting-started/hardwaresetup/fipy.md similarity index 100% rename from 1.-getting-started/hardwaresetup/fipy.md rename to getting-started/hardwaresetup/fipy.md diff --git a/1.-getting-started/hardwaresetup/gpy.md b/getting-started/hardwaresetup/gpy.md similarity index 100% rename from 1.-getting-started/hardwaresetup/gpy.md rename to getting-started/hardwaresetup/gpy.md diff --git a/1.-getting-started/hardwaresetup/lopy.md b/getting-started/hardwaresetup/lopy.md similarity index 100% rename from 1.-getting-started/hardwaresetup/lopy.md rename to getting-started/hardwaresetup/lopy.md diff --git a/1.-getting-started/hardwaresetup/lopy4.md b/getting-started/hardwaresetup/lopy4.md similarity index 100% rename from 1.-getting-started/hardwaresetup/lopy4.md rename to getting-started/hardwaresetup/lopy4.md diff --git a/1.-getting-started/hardwaresetup/sipy.md b/getting-started/hardwaresetup/sipy.md similarity index 100% rename from 1.-getting-started/hardwaresetup/sipy.md rename to getting-started/hardwaresetup/sipy.md diff --git a/1.-getting-started/hardwaresetup/wipy.md b/getting-started/hardwaresetup/wipy.md similarity index 100% rename from 1.-getting-started/hardwaresetup/wipy.md rename to getting-started/hardwaresetup/wipy.md diff --git a/1.-getting-started/installingsoftware/README.md b/getting-started/installingsoftware/README.md similarity index 100% rename from 1.-getting-started/installingsoftware/README.md rename to getting-started/installingsoftware/README.md diff --git a/1.-getting-started/installingsoftware/drivers.md b/getting-started/installingsoftware/drivers.md similarity index 100% rename from 1.-getting-started/installingsoftware/drivers.md rename to getting-started/installingsoftware/drivers.md diff --git a/1.-getting-started/installingsoftware/firmwaretool.md b/getting-started/installingsoftware/firmwaretool.md similarity index 95% rename from 1.-getting-started/installingsoftware/firmwaretool.md rename to getting-started/installingsoftware/firmwaretool.md index 74e541a..092906a 100644 --- a/1.-getting-started/installingsoftware/firmwaretool.md +++ b/getting-started/installingsoftware/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**](../../10.-advanced-topics/downgrade.md). +Previous versions of firmware are available for download [**here**](../../advanced-topics/downgrade.md). {% endhint %} ## Updating Device Firmware @@ -40,7 +40,7 @@ If you are having any issues, make sure the **TX and RX jumpers** are present on When using a Pysense/Pytrack/Pyscan/Expansion Board 3.0 to update your module you are not required to make a connection between `G23` and `GND`, the Pysense/Pytrack/Pyscan/Expansion Board 3.0 will do this automatically. {% endhint %} -1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](../../3.-pytrack-pysense-pyscan/installation/firmware.md). +1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). 2. Disconnect your device from your computer 3. Insert module into Expansion Board 4. Reconnect the board via USB to your computer diff --git a/1.-getting-started/installingsoftware/pymakr.md b/getting-started/installingsoftware/pymakr.md similarity index 68% rename from 1.-getting-started/installingsoftware/pymakr.md rename to getting-started/installingsoftware/pymakr.md index cec4a80..455d50a 100644 --- a/1.-getting-started/installingsoftware/pymakr.md +++ b/getting-started/installingsoftware/pymakr.md @@ -6,9 +6,9 @@ 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="../../2.-pymakr-plugin/installation/atom.md" %} +{% page-ref page="../../pymakr-plugin/installation/atom.md" %} -{% page-ref page="../../2.-pymakr-plugin/installation/vscode.md" %} +{% page-ref page="../../pymakr-plugin/installation/vscode.md" %} diff --git a/1.-getting-started/programming/README.md b/getting-started/programming/README.md similarity index 100% rename from 1.-getting-started/programming/README.md rename to getting-started/programming/README.md diff --git a/1.-getting-started/programming/examples.md b/getting-started/programming/examples.md similarity index 100% rename from 1.-getting-started/programming/examples.md rename to getting-started/programming/examples.md diff --git a/1.-getting-started/programming/first_project.md b/getting-started/programming/first_project.md similarity index 95% rename from 1.-getting-started/programming/first_project.md rename to getting-started/programming/first_project.md index 5346c42..e21bfda 100644 --- a/1.-getting-started/programming/first_project.md +++ b/getting-started/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](../../2.-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-plugin/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](../../5.-firmware-and-api-reference/firmwareapi.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](../../firmware-and-api-reference/firmwareapi.md). For this example you will need to open the `main.py` file and add the following code: ```python import pycom diff --git a/1.-getting-started/programming/ftp.md b/getting-started/programming/ftp.md similarity index 91% rename from 1.-getting-started/programming/ftp.md rename to getting-started/programming/ftp.md index bd92cf6..8a03c7a 100644 --- a/1.-getting-started/programming/ftp.md +++ b/getting-started/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](../../5.-firmware-and-api-reference/pycom/network/server.md) for information on how to change the defaults. The recommended clients are: +See [network.server](../../firmware-and-api-reference/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/1.-getting-started/programming/micropython.md b/getting-started/programming/micropython.md similarity index 100% rename from 1.-getting-started/programming/micropython.md rename to getting-started/programming/micropython.md diff --git a/1.-getting-started/programming/repl/README.md b/getting-started/programming/repl/README.md similarity index 100% rename from 1.-getting-started/programming/repl/README.md rename to getting-started/programming/repl/README.md diff --git a/1.-getting-started/programming/repl/serial.md b/getting-started/programming/repl/serial.md similarity index 88% rename from 1.-getting-started/programming/repl/serial.md rename to getting-started/programming/repl/serial.md index 4b7815f..4dc4211 100644 --- a/1.-getting-started/programming/repl/serial.md +++ b/getting-started/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](../../../2.-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](../../../2.-pymakr-plugin/installation/). +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/). ## macOS and Linux diff --git a/1.-getting-started/programming/repl/telnet.md b/getting-started/programming/repl/telnet.md similarity index 74% rename from 1.-getting-started/programming/repl/telnet.md rename to getting-started/programming/repl/telnet.md index 8bc8667..81b46fe 100644 --- a/1.-getting-started/programming/repl/telnet.md +++ b/getting-started/programming/repl/telnet.md @@ -1,6 +1,6 @@ # 1.3.4.2 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](../../../5.-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](../../../firmware-and-api-reference/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](../../../5.-firmware-and-api-reference/pycom/network/server.md) for info on how to change the default authentication. +See [network.server](../../../firmware-and-api-reference/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](../../../2.-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](../../../2.-pymakr-plugin/installation/). +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/). ## macOS and Linux diff --git a/1.-getting-started/programming/safeboot.md b/getting-started/programming/safeboot.md similarity index 100% rename from 1.-getting-started/programming/safeboot.md rename to getting-started/programming/safeboot.md diff --git a/1.-getting-started/registration/README.md b/getting-started/registration/README.md similarity index 100% rename from 1.-getting-started/registration/README.md rename to getting-started/registration/README.md diff --git a/1.-getting-started/registration/cellular.md b/getting-started/registration/cellular.md similarity index 100% rename from 1.-getting-started/registration/cellular.md rename to getting-started/registration/cellular.md diff --git a/1.-getting-started/registration/lora/README.md b/getting-started/registration/lora/README.md similarity index 90% rename from 1.-getting-started/registration/lora/README.md rename to getting-started/registration/lora/README.md index 5084359..20bdb82 100644 --- a/1.-getting-started/registration/lora/README.md +++ b/getting-started/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](../../../4.-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-and-examples/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](../../../4.-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-and-examples/lora/lorawan-abp.md) code to connect to the network. ### Networks diff --git a/1.-getting-started/registration/lora/objenious.md b/getting-started/registration/lora/objenious.md similarity index 100% rename from 1.-getting-started/registration/lora/objenious.md rename to getting-started/registration/lora/objenious.md diff --git a/1.-getting-started/registration/lora/ttn.md b/getting-started/registration/lora/ttn.md similarity index 98% rename from 1.-getting-started/registration/lora/ttn.md rename to getting-started/registration/lora/ttn.md index eab3f43..6f81d70 100644 --- a/1.-getting-started/registration/lora/ttn.md +++ b/getting-started/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](../../../4.-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-and-examples/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/1.-getting-started/registration/sigfox.md b/getting-started/registration/sigfox.md similarity index 100% rename from 1.-getting-started/registration/sigfox.md rename to getting-started/registration/sigfox.md diff --git a/11.-license/license.md b/license/license.md similarity index 100% rename from 11.-license/license.md rename to license/license.md diff --git a/6.-product-info/boards/README.md b/product-info/boards/README.md similarity index 100% rename from 6.-product-info/boards/README.md rename to product-info/boards/README.md diff --git a/6.-product-info/boards/deepsleep/README.md b/product-info/boards/deepsleep/README.md similarity index 100% rename from 6.-product-info/boards/deepsleep/README.md rename to product-info/boards/deepsleep/README.md diff --git a/6.-product-info/boards/deepsleep/api.md b/product-info/boards/deepsleep/api.md similarity index 100% rename from 6.-product-info/boards/deepsleep/api.md rename to product-info/boards/deepsleep/api.md diff --git a/6.-product-info/boards/expansion2.md b/product-info/boards/expansion2.md similarity index 100% rename from 6.-product-info/boards/expansion2.md rename to product-info/boards/expansion2.md diff --git a/6.-product-info/boards/expansion3.md b/product-info/boards/expansion3.md similarity index 100% rename from 6.-product-info/boards/expansion3.md rename to product-info/boards/expansion3.md diff --git a/6.-product-info/boards/pyscan.md b/product-info/boards/pyscan.md similarity index 92% rename from 6.-product-info/boards/pyscan.md rename to product-info/boards/pyscan.md index fdf0146..21effa7 100644 --- a/6.-product-info/boards/pyscan.md +++ b/product-info/boards/pyscan.md @@ -21,7 +21,7 @@ Libraries for the rest of the components will be added soon. ## Driver -The Windows 7 driver for Pyscan is located [here](../../3.-pytrack-pysense-pyscan/installation/firmware.md). +The Windows 7 driver for Pyscan is located [here](../../pytrack-pysense-pyscan/installation/firmware.md). For other Operating Systems there's no driver required. diff --git a/6.-product-info/boards/pysense.md b/product-info/boards/pysense.md similarity index 100% rename from 6.-product-info/boards/pysense.md rename to product-info/boards/pysense.md diff --git a/6.-product-info/boards/pytrack.md b/product-info/boards/pytrack.md similarity index 100% rename from 6.-product-info/boards/pytrack.md rename to product-info/boards/pytrack.md diff --git a/6.-product-info/datasheets.md b/product-info/datasheets.md similarity index 100% rename from 6.-product-info/datasheets.md rename to product-info/datasheets.md diff --git a/6.-product-info/development/README.md b/product-info/development/README.md similarity index 100% rename from 6.-product-info/development/README.md rename to product-info/development/README.md diff --git a/6.-product-info/development/fipy.md b/product-info/development/fipy.md similarity index 75% rename from 6.-product-info/development/fipy.md rename to product-info/development/fipy.md index 1e1d5f2..bb32d10 100644 --- a/6.-product-info/development/fipy.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LoRaWAN node](../../4.-tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../4.-tutorials-and-examples/sigfox.md) -* [LTE CAT-M1](../../4.-tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../4.-tutorials-and-examples/lte/nb_iot.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/development/gpy.md b/product-info/development/gpy.md similarity index 83% rename from 6.-product-info/development/gpy.md rename to product-info/development/gpy.md index 5ae707c..5a1afd7 100644 --- a/6.-product-info/development/gpy.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the GPy: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LTE CAT-M1](../../4.-tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../4.-tutorials-and-examples/lte/nb_iot.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/development/lopy.md b/product-info/development/lopy.md similarity index 85% rename from 6.-product-info/development/lopy.md rename to product-info/development/lopy.md index 7b78bdf..dea8fb2 100644 --- a/6.-product-info/development/lopy.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LoRaWAN node](../../4.-tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/development/lopy4.md b/product-info/development/lopy4.md similarity index 75% rename from 6.-product-info/development/lopy4.md rename to product-info/development/lopy4.md index b474efc..1afacca 100644 --- a/6.-product-info/development/lopy4.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LoRaWAN node](../../4.-tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../4.-tutorials-and-examples/sigfox.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/development/sipy.md b/product-info/development/sipy.md similarity index 88% rename from 6.-product-info/development/sipy.md rename to product-info/development/sipy.md index b6e85f4..49c7487 100644 --- a/6.-product-info/development/sipy.md +++ b/product-info/development/sipy.md @@ -40,11 +40,11 @@ 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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [Sigfox](../../4.-tutorials-and-examples/sigfox.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [Sigfox](../../tutorials-and-examples/sigfox.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/6.-product-info/development/wipy2.md b/product-info/development/wipy2.md similarity index 90% rename from 6.-product-info/development/wipy2.md rename to product-info/development/wipy2.md index c316808..53a3e9b 100644 --- a/6.-product-info/development/wipy2.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/6.-product-info/development/wipy3.md b/product-info/development/wipy3.md similarity index 86% rename from 6.-product-info/development/wipy3.md rename to product-info/development/wipy3.md index 9613667..cb4f24a 100644 --- a/6.-product-info/development/wipy3.md +++ b/product-info/development/wipy3.md @@ -47,8 +47,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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/6.-product-info/notes.md b/product-info/notes.md similarity index 100% rename from 6.-product-info/notes.md rename to product-info/notes.md diff --git a/6.-product-info/oem/README.md b/product-info/oem/README.md similarity index 100% rename from 6.-product-info/oem/README.md rename to product-info/oem/README.md diff --git a/6.-product-info/oem/g01.md b/product-info/oem/g01.md similarity index 73% rename from 6.-product-info/oem/g01.md rename to product-info/oem/g01.md index c5ca1df..7a1b37b 100644 --- a/6.-product-info/oem/g01.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the G01: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LTE CAT-M1](../../4.-tutorials-and-examples/lte/cat_m1.md) -* [NB-IoT](../../4.-tutorials-and-examples/lte/nb_iot.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/oem/l01.md b/product-info/oem/l01.md similarity index 65% rename from 6.-product-info/oem/l01.md rename to product-info/oem/l01.md index 8420ad1..a8fcad6 100644 --- a/6.-product-info/oem/l01.md +++ b/product-info/oem/l01.md @@ -28,12 +28,12 @@ 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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the L01: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LoRaWAN node](../../4.-tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/oem/l01_reference.md b/product-info/oem/l01_reference.md similarity index 100% rename from 6.-product-info/oem/l01_reference.md rename to product-info/oem/l01_reference.md diff --git a/6.-product-info/oem/l04.md b/product-info/oem/l04.md similarity index 62% rename from 6.-product-info/oem/l04.md rename to product-info/oem/l04.md index 1f9c711..e0ef048 100644 --- a/6.-product-info/oem/l04.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the L04: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [LoRaWAN node](../../4.-tutorials-and-examples/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../4.-tutorials-and-examples/lora/lorawan-nano-gateway.md) -* [Sigfox](../../4.-tutorials-and-examples/sigfox.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [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) diff --git a/6.-product-info/oem/universal_reference.md b/product-info/oem/universal_reference.md similarity index 100% rename from 6.-product-info/oem/universal_reference.md rename to product-info/oem/universal_reference.md diff --git a/6.-product-info/oem/w01.md b/product-info/oem/w01.md similarity index 75% rename from 6.-product-info/oem/w01.md rename to product-info/oem/w01.md index 43ace77..5931b80 100644 --- a/6.-product-info/oem/w01.md +++ b/product-info/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](../../4.-tutorials-and-examples/tutorials.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-and-examples/tutorials.md) section of this documentation. The following tutorials might be of specific interest for the W01: -* [WiFi connection](../../4.-tutorials-and-examples/all/wlan.md) -* [BLE](../../4.-tutorials-and-examples/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/8.-pybytes/intro-1/README.md b/pybytes/intro-1/README.md similarity index 100% rename from 8.-pybytes/intro-1/README.md rename to pybytes/intro-1/README.md diff --git a/8.-pybytes/intro-1/flash.md b/pybytes/intro-1/flash.md similarity index 94% rename from 8.-pybytes/intro-1/flash.md rename to pybytes/intro-1/flash.md index 351a6ef..29328f3 100644 --- a/8.-pybytes/intro-1/flash.md +++ b/pybytes/intro-1/flash.md @@ -29,7 +29,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](../../2.-pymakr-plugin/installation/atom.md). +In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr-plugin/installation/atom.md). {% endhint %} 1. Connect your device to your computer with USB cable. @@ -50,7 +50,7 @@ In case you haven't installed Pymakr plugin, follow [these instructions](../../2 Like deviceToken or WiFi credentials. You can change e.g. your WiFy password here. -6. Put your device in [safe boot mode](../../1.-getting-started/programming/safeboot.md). +6. Put your device in [safe boot mode](../../getting-started/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. diff --git a/8.-pybytes/intro-1/quick.md b/pybytes/intro-1/quick.md similarity index 100% rename from 8.-pybytes/intro-1/quick.md rename to pybytes/intro-1/quick.md diff --git a/8.-pybytes/intro-1/sigfox/README.md b/pybytes/intro-1/sigfox/README.md similarity index 94% rename from 8.-pybytes/intro-1/sigfox/README.md rename to pybytes/intro-1/sigfox/README.md index 7554522..c90a535 100644 --- a/8.-pybytes/intro-1/sigfox/README.md +++ b/pybytes/intro-1/sigfox/README.md @@ -1,7 +1,7 @@ # 8.3.3 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**](../../../1.-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**](../../../getting-started/registration/sigfox.md). {% endhint %} ## Create Sigfox API credentials diff --git a/8.-pybytes/intro-1/sigfox/sigfoxcustomcontract.md b/pybytes/intro-1/sigfox/sigfoxcustomcontract.md similarity index 92% rename from 8.-pybytes/intro-1/sigfox/sigfoxcustomcontract.md rename to pybytes/intro-1/sigfox/sigfoxcustomcontract.md index 0d97c5e..229e9d3 100644 --- a/8.-pybytes/intro-1/sigfox/sigfoxcustomcontract.md +++ b/pybytes/intro-1/sigfox/sigfoxcustomcontract.md @@ -33,5 +33,5 @@ After your device was flashed with Pybytes firmware in automatically start addin ## Troubleshooting -[Disengage Sigfox sequence number](../../../4.-tutorials-and-examples/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) diff --git a/8.-pybytes/intro-1/sigfox/sigfoxdevkit.md b/pybytes/intro-1/sigfox/sigfoxdevkit.md similarity index 92% rename from 8.-pybytes/intro-1/sigfox/sigfoxdevkit.md rename to pybytes/intro-1/sigfox/sigfoxdevkit.md index 9237a3f..c7e2686 100644 --- a/8.-pybytes/intro-1/sigfox/sigfoxdevkit.md +++ b/pybytes/intro-1/sigfox/sigfoxdevkit.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](../../../1.-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](../../../getting-started/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](../../../4.-tutorials-and-examples/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) diff --git a/8.-pybytes/intro-2.md b/pybytes/intro-2.md similarity index 100% rename from 8.-pybytes/intro-2.md rename to pybytes/intro-2.md diff --git a/8.-pybytes/intro.md b/pybytes/intro.md similarity index 100% rename from 8.-pybytes/intro.md rename to pybytes/intro.md diff --git a/8.-pybytes/pybytes.md b/pybytes/pybytes.md similarity index 100% rename from 8.-pybytes/pybytes.md rename to pybytes/pybytes.md diff --git a/2.-pymakr-plugin/installation/README.md b/pymakr-plugin/installation/README.md similarity index 100% rename from 2.-pymakr-plugin/installation/README.md rename to pymakr-plugin/installation/README.md diff --git a/2.-pymakr-plugin/installation/atom.md b/pymakr-plugin/installation/atom.md similarity index 100% rename from 2.-pymakr-plugin/installation/atom.md rename to pymakr-plugin/installation/atom.md diff --git a/2.-pymakr-plugin/installation/vscode.md b/pymakr-plugin/installation/vscode.md similarity index 100% rename from 2.-pymakr-plugin/installation/vscode.md rename to pymakr-plugin/installation/vscode.md diff --git a/2.-pymakr-plugin/settings.md b/pymakr-plugin/settings.md similarity index 100% rename from 2.-pymakr-plugin/settings.md rename to pymakr-plugin/settings.md diff --git a/2.-pymakr-plugin/toolsfeatures.md b/pymakr-plugin/toolsfeatures.md similarity index 100% rename from 2.-pymakr-plugin/toolsfeatures.md rename to pymakr-plugin/toolsfeatures.md diff --git a/3.-pytrack-pysense-pyscan/apireference/README.md b/pytrack-pysense-pyscan/apireference/README.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/apireference/README.md rename to pytrack-pysense-pyscan/apireference/README.md diff --git a/3.-pytrack-pysense-pyscan/apireference/pyscan.md b/pytrack-pysense-pyscan/apireference/pyscan.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/apireference/pyscan.md rename to pytrack-pysense-pyscan/apireference/pyscan.md diff --git a/3.-pytrack-pysense-pyscan/apireference/pysense.md b/pytrack-pysense-pyscan/apireference/pysense.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/apireference/pysense.md rename to pytrack-pysense-pyscan/apireference/pysense.md diff --git a/3.-pytrack-pysense-pyscan/apireference/pytrack.md b/pytrack-pysense-pyscan/apireference/pytrack.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/apireference/pytrack.md rename to pytrack-pysense-pyscan/apireference/pytrack.md diff --git a/3.-pytrack-pysense-pyscan/apireference/sleep.md b/pytrack-pysense-pyscan/apireference/sleep.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/apireference/sleep.md rename to pytrack-pysense-pyscan/apireference/sleep.md diff --git a/3.-pytrack-pysense-pyscan/installation/README.md b/pytrack-pysense-pyscan/installation/README.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/installation/README.md rename to pytrack-pysense-pyscan/installation/README.md diff --git a/3.-pytrack-pysense-pyscan/installation/drivers.md b/pytrack-pysense-pyscan/installation/drivers.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/installation/drivers.md rename to pytrack-pysense-pyscan/installation/drivers.md diff --git a/3.-pytrack-pysense-pyscan/installation/firmware.md b/pytrack-pysense-pyscan/installation/firmware.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/installation/firmware.md rename to pytrack-pysense-pyscan/installation/firmware.md diff --git a/3.-pytrack-pysense-pyscan/installation/libraries.md b/pytrack-pysense-pyscan/installation/libraries.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/installation/libraries.md rename to pytrack-pysense-pyscan/installation/libraries.md diff --git a/3.-pytrack-pysense-pyscan/pytrackpysense.md b/pytrack-pysense-pyscan/pytrackpysense.md similarity index 100% rename from 3.-pytrack-pysense-pyscan/pytrackpysense.md rename to pytrack-pysense-pyscan/pytrackpysense.md diff --git a/4.-tutorials-and-examples/all/README.md b/tutorials-and-examples/all/README.md similarity index 100% rename from 4.-tutorials-and-examples/all/README.md rename to tutorials-and-examples/all/README.md diff --git a/4.-tutorials-and-examples/all/adc.md b/tutorials-and-examples/all/adc.md similarity index 94% rename from 4.-tutorials-and-examples/all/adc.md rename to tutorials-and-examples/all/adc.md index 5a68849..762aab6 100644 --- a/4.-tutorials-and-examples/all/adc.md +++ b/tutorials-and-examples/all/adc.md @@ -1,6 +1,6 @@ # 4.2.7 ADC -This example is a simple ADC sample. For more information please see [`ADC`](../../5.-firmware-and-api-reference/pycom/machine/adc.md). +This example is a simple ADC sample. For more information please see [`ADC`](../../firmware-and-api-reference/pycom/machine/adc.md). ```python from machine import ADC diff --git a/4.-tutorials-and-examples/all/aws.md b/tutorials-and-examples/all/aws.md similarity index 100% rename from 4.-tutorials-and-examples/all/aws.md rename to tutorials-and-examples/all/aws.md diff --git a/4.-tutorials-and-examples/all/ble.md b/tutorials-and-examples/all/ble.md similarity index 97% rename from 4.-tutorials-and-examples/all/ble.md rename to tutorials-and-examples/all/ble.md index 112f160..1f2f03f 100644 --- a/4.-tutorials-and-examples/all/ble.md +++ b/tutorials-and-examples/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](../../5.-firmware-and-api-reference/pycom/network/bluetooth/) of the Firmware API Reference. +Full info on `bluetooth` can be found within [Bluetooth page](../../firmware-and-api-reference/pycom/network/bluetooth/) of the Firmware API Reference. ## Scan for BLE Devices diff --git a/4.-tutorials-and-examples/all/https.md b/tutorials-and-examples/all/https.md similarity index 84% rename from 4.-tutorials-and-examples/all/https.md rename to tutorials-and-examples/all/https.md index 74ae767..ff0845e 100644 --- a/4.-tutorials-and-examples/all/https.md +++ b/tutorials-and-examples/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`](../../5.-firmware-and-api-reference/micropython/ussl.md) module in the API reference. +For more info, check the [`ssl`](../../firmware-and-api-reference/micropython/ussl.md) module in the API reference. diff --git a/4.-tutorials-and-examples/all/i2c.md b/tutorials-and-examples/all/i2c.md similarity index 100% rename from 4.-tutorials-and-examples/all/i2c.md rename to tutorials-and-examples/all/i2c.md diff --git a/4.-tutorials-and-examples/all/modbus.md b/tutorials-and-examples/all/modbus.md similarity index 100% rename from 4.-tutorials-and-examples/all/modbus.md rename to tutorials-and-examples/all/modbus.md diff --git a/4.-tutorials-and-examples/all/mqtt.md b/tutorials-and-examples/all/mqtt.md similarity index 100% rename from 4.-tutorials-and-examples/all/mqtt.md rename to tutorials-and-examples/all/mqtt.md diff --git a/4.-tutorials-and-examples/all/ota.md b/tutorials-and-examples/all/ota.md similarity index 96% rename from 4.-tutorials-and-examples/all/ota.md rename to tutorials-and-examples/all/ota.md index 8ffb0e2..7864499 100644 --- a/4.-tutorials-and-examples/all/ota.md +++ b/tutorials-and-examples/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`](../../5.-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`](../../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). ## Method diff --git a/4.-tutorials-and-examples/all/owd.md b/tutorials-and-examples/all/owd.md similarity index 100% rename from 4.-tutorials-and-examples/all/owd.md rename to tutorials-and-examples/all/owd.md diff --git a/4.-tutorials-and-examples/all/pir.md b/tutorials-and-examples/all/pir.md similarity index 100% rename from 4.-tutorials-and-examples/all/pir.md rename to tutorials-and-examples/all/pir.md diff --git a/4.-tutorials-and-examples/all/repl.md b/tutorials-and-examples/all/repl.md similarity index 100% rename from 4.-tutorials-and-examples/all/repl.md rename to tutorials-and-examples/all/repl.md diff --git a/4.-tutorials-and-examples/all/rgbled.md b/tutorials-and-examples/all/rgbled.md similarity index 100% rename from 4.-tutorials-and-examples/all/rgbled.md rename to tutorials-and-examples/all/rgbled.md diff --git a/4.-tutorials-and-examples/all/rmt.md b/tutorials-and-examples/all/rmt.md similarity index 98% rename from 4.-tutorials-and-examples/all/rmt.md rename to tutorials-and-examples/all/rmt.md index 10ffd11..c6ace0e 100644 --- a/4.-tutorials-and-examples/all/rmt.md +++ b/tutorials-and-examples/all/rmt.md @@ -1,6 +1,6 @@ # 4.2.16 RMT -Detailed information about this class can be found in [`RMT`](../../5.-firmware-and-api-reference/pycom/machine/rmt.md). +Detailed information about this class can be found in [`RMT`](../../firmware-and-api-reference/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/4.-tutorials-and-examples/all/threading.md b/tutorials-and-examples/all/threading.md similarity index 100% rename from 4.-tutorials-and-examples/all/threading.md rename to tutorials-and-examples/all/threading.md diff --git a/4.-tutorials-and-examples/all/timers.md b/tutorials-and-examples/all/timers.md similarity index 100% rename from 4.-tutorials-and-examples/all/timers.md rename to tutorials-and-examples/all/timers.md diff --git a/4.-tutorials-and-examples/all/wlan.md b/tutorials-and-examples/all/wlan.md similarity index 100% rename from 4.-tutorials-and-examples/all/wlan.md rename to tutorials-and-examples/all/wlan.md diff --git a/4.-tutorials-and-examples/lora/537-rn2483-to-lopy.md b/tutorials-and-examples/lora/537-rn2483-to-lopy.md similarity index 100% rename from 4.-tutorials-and-examples/lora/537-rn2483-to-lopy.md rename to tutorials-and-examples/lora/537-rn2483-to-lopy.md diff --git a/4.-tutorials-and-examples/lora/README.md b/tutorials-and-examples/lora/README.md similarity index 100% rename from 4.-tutorials-and-examples/lora/README.md rename to tutorials-and-examples/lora/README.md diff --git a/4.-tutorials-and-examples/lora/lora-mac-nano-gateway.md b/tutorials-and-examples/lora/lora-mac-nano-gateway.md similarity index 100% rename from 4.-tutorials-and-examples/lora/lora-mac-nano-gateway.md rename to tutorials-and-examples/lora/lora-mac-nano-gateway.md diff --git a/4.-tutorials-and-examples/lora/lora-mac.md b/tutorials-and-examples/lora/lora-mac.md similarity index 100% rename from 4.-tutorials-and-examples/lora/lora-mac.md rename to tutorials-and-examples/lora/lora-mac.md diff --git a/4.-tutorials-and-examples/lora/lorawan-abp.md b/tutorials-and-examples/lora/lorawan-abp.md similarity index 100% rename from 4.-tutorials-and-examples/lora/lorawan-abp.md rename to tutorials-and-examples/lora/lorawan-abp.md diff --git a/4.-tutorials-and-examples/lora/lorawan-nano-gateway.md b/tutorials-and-examples/lora/lorawan-nano-gateway.md similarity index 100% rename from 4.-tutorials-and-examples/lora/lorawan-nano-gateway.md rename to tutorials-and-examples/lora/lorawan-nano-gateway.md diff --git a/4.-tutorials-and-examples/lora/lorawan-otaa.md b/tutorials-and-examples/lora/lorawan-otaa.md similarity index 100% rename from 4.-tutorials-and-examples/lora/lorawan-otaa.md rename to tutorials-and-examples/lora/lorawan-otaa.md diff --git a/4.-tutorials-and-examples/lora/module-module.md b/tutorials-and-examples/lora/module-module.md similarity index 100% rename from 4.-tutorials-and-examples/lora/module-module.md rename to tutorials-and-examples/lora/module-module.md diff --git a/4.-tutorials-and-examples/lte/README.md b/tutorials-and-examples/lte/README.md similarity index 100% rename from 4.-tutorials-and-examples/lte/README.md rename to tutorials-and-examples/lte/README.md diff --git a/4.-tutorials-and-examples/lte/cat_m1.md b/tutorials-and-examples/lte/cat_m1.md similarity index 100% rename from 4.-tutorials-and-examples/lte/cat_m1.md rename to tutorials-and-examples/lte/cat_m1.md diff --git a/4.-tutorials-and-examples/lte/firmware.md b/tutorials-and-examples/lte/firmware.md similarity index 96% rename from 4.-tutorials-and-examples/lte/firmware.md rename to tutorials-and-examples/lte/firmware.md index 4c4a69a..bfca3c8 100644 --- a/4.-tutorials-and-examples/lte/firmware.md +++ b/tutorials-and-examples/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](../../1.-getting-started/programming/ftp.md) or [Pymakr](../../2.-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](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr-plugin/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/4.-tutorials-and-examples/lte/imei.md b/tutorials-and-examples/lte/imei.md similarity index 100% rename from 4.-tutorials-and-examples/lte/imei.md rename to tutorials-and-examples/lte/imei.md diff --git a/4.-tutorials-and-examples/lte/nb_iot.md b/tutorials-and-examples/lte/nb_iot.md similarity index 100% rename from 4.-tutorials-and-examples/lte/nb_iot.md rename to tutorials-and-examples/lte/nb_iot.md diff --git a/4.-tutorials-and-examples/pyscan.md b/tutorials-and-examples/pyscan.md similarity index 100% rename from 4.-tutorials-and-examples/pyscan.md rename to tutorials-and-examples/pyscan.md diff --git a/4.-tutorials-and-examples/pysense.md b/tutorials-and-examples/pysense.md similarity index 100% rename from 4.-tutorials-and-examples/pysense.md rename to tutorials-and-examples/pysense.md diff --git a/4.-tutorials-and-examples/pytrack.md b/tutorials-and-examples/pytrack.md similarity index 100% rename from 4.-tutorials-and-examples/pytrack.md rename to tutorials-and-examples/pytrack.md diff --git a/4.-tutorials-and-examples/sigfox.md b/tutorials-and-examples/sigfox.md similarity index 96% rename from 4.-tutorials-and-examples/sigfox.md rename to tutorials-and-examples/sigfox.md index 4066dd9..7b5b500 100644 --- a/4.-tutorials-and-examples/sigfox.md +++ b/tutorials-and-examples/sigfox.md @@ -1,6 +1,6 @@ # 4.4 Sigfox Examples -Before you start, make sure that your device was registered with [Sigfox](../1.-getting-started/registration/sigfox.md). +Before you start, make sure that your device was registered with [Sigfox](../getting-started/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`. diff --git a/4.-tutorials-and-examples/tutorials.md b/tutorials-and-examples/tutorials.md similarity index 87% rename from 4.-tutorials-and-examples/tutorials.md rename to tutorials-and-examples/tutorials.md index 7f876f8..c06ce6c 100644 --- a/4.-tutorials-and-examples/tutorials.md +++ b/tutorials-and-examples/tutorials.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](../1.-getting-started/installingsoftware/firmwaretool.md). +Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../getting-started/installingsoftware/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.