diff --git a/.DS_Store b/.DS_Store index 0d447d5..13f745a 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/content/advance/cli.md b/content/advance/cli.md index 91297cf..41d55a4 100644 --- a/content/advance/cli.md +++ b/content/advance/cli.md @@ -70,7 +70,7 @@ optional arguments: ## How to use the Parameters -{{{% hint style="info" %}}} +{{% hint style="info" %}} The CLI tool uses a combination of global and command specific parameters. The **order of parameters** is **important** to avoid ambiguity. `pycom-fwtool-cli [global parameters] [command] [command parameters]` @@ -123,7 +123,7 @@ On Windows: COM6 [Pytrack] [USB VID:PID=04D8:F013 SER=Py343434 LOCATION=20-2] ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} This is the only command that does not require any additional parameters. All other commands require that **the serial port is specified either through the** `-p` **/** `--port` **option or through environment variable** `ESPPORT` You can optionally specify the speed either through `-s` / `--speed` or via environment variable `ESPBAUD`. The default speed is `921600`. The maximum speed for read operations on PIC based expansion boards & shields is `230400`. The speed will be reduced automatically if necessary. @@ -264,7 +264,7 @@ optional arguments: Set extra preferences ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Note: The local `pybytes_config.json` file is overwritten when making any modifications using this command (requires Pybytes firmware `1.17.5.b6` or higher and Firmware updater `1.14.3`). {{< /hint >}} diff --git a/content/advance/downgrade.md b/content/advance/downgrade.md index 0ffddfd..f1473e6 100644 --- a/content/advance/downgrade.md +++ b/content/advance/downgrade.md @@ -7,7 +7,7 @@ aliases: --- The firmware upgrade tool usually updates your device to the latest available firmware version. If you require to downgrade your device to a previous firmware there are two methods to achieve this. -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you are using an Expansion Board 1.0 or 2.0, you will need to have a jumper connected between `G23` and `GND` to use either procedure below. You will also need to press the reset button before beginning. {{< /hint >}} @@ -20,7 +20,7 @@ You can obtain previous firmware versions here: * [FiPy](https://software.pycom.io/downloads/FiPy.html) * [LoPy4](https://software.pycom.io/downloads/LoPy4.html) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Prior to version `1.16.0.b1` the firmware for modules with LoRa functionality was frequency specific. From `1.16.0.b1` and onward, the firmware is region agnostic and this can either be set programatically or via the config block (see [here](cli.md#lpwan)). {{< /hint >}} diff --git a/content/advance/encryption.md b/content/advance/encryption.md index c1737e6..885f631 100644 --- a/content/advance/encryption.md +++ b/content/advance/encryption.md @@ -102,7 +102,7 @@ Because the encryption is done based on the physical flash address, there are 2 * `gpy.bin_enc_0x10000` which has to be written at default factory address: `0x10000` * `gpy.bin_enc_0x1A0000` which has to be written at the `ota_0` partition address (`0x1A0000`) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Hint: on MicroPython interface, the method `pycom.ota_slot()` responds with the address of the next OTA partition available (either `0x10000` or `0x1A0000`). {{< /hint >}} diff --git a/content/datasheets/_index.md b/content/datasheets/_index.md index 2b96c53..705476f 100644 --- a/content/datasheets/_index.md +++ b/content/datasheets/_index.md @@ -2,23 +2,22 @@ title: "" aliases: --- + +# datasheets + The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes. ## Development Modules -{{% refname "development/wipy2.md" %}} + {{% refname "/datasheets/development/wipy2" %}} + {{% refname "/datasheets/development/wipy3" %}} + {{% refname "/datasheets/development/lopy" %}} + {{% refname "/datasheets/development/lopy4" %}} + {{% refname "/datasheets/development/sipy" %}} + {{% refname "/datasheets/development/gpy" %}} -{{% refname "development/wipy3.md" %}} -{{% refname "development/lopy.md" %}} -{{% refname "development/lopy4.md" %}} - -{{% refname "development/sipy.md" %}} - -{{% refname "development/gpy.md" %}} - -{{% refname "development/fipy.md" %}} ## OEM modules @@ -45,4 +44,3 @@ The follow pages contain all information relating to each product, for examples: {{% refname "boards/expansion2.md" %}} {{% refname "boards/deepsleep/" %}} - diff --git a/content/datasheets/boards/deepsleep/README.md b/content/datasheets/boards/deepsleep/README.md index 837adde..28015d2 100644 --- a/content/datasheets/boards/deepsleep/README.md +++ b/content/datasheets/boards/deepsleep/README.md @@ -16,7 +16,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File ![](//gitbook/assets/deepsleep-pinout%20%281%29.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} To correctly connect a WiPy 2.0, LoPy or SiPy to the Deep Sleep Shield, align the white triangle on the Shield with the LED of the Pycom Device. Once the Pycom Device is seated onto the Deep Sleep Shield, this can then be connected to the Expansion Board {{< /hint >}} diff --git a/content/datasheets/boards/deepsleep/_index.md b/content/datasheets/boards/deepsleep/_index.md index 787b08a..75990c1 100644 --- a/content/datasheets/boards/deepsleep/_index.md +++ b/content/datasheets/boards/deepsleep/_index.md @@ -14,7 +14,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File ![](//gitbook/assets/deepsleep-pinout%20%281%29.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} To correctly connect a WiPy 2.0, LoPy or SiPy to the Deep Sleep Shield, align the white triangle on the Shield with the LED of the Pycom Device. Once the Pycom Device is seated onto the Deep Sleep Shield, this can then be connected to the Expansion Board {{< /hint >}} diff --git a/content/datasheets/boards/deepsleep/api.md b/content/datasheets/boards/deepsleep/api.md index 0981278..38a4c32 100644 --- a/content/datasheets/boards/deepsleep/api.md +++ b/content/datasheets/boards/deepsleep/api.md @@ -95,7 +95,7 @@ This method sends the board into deep sleep for a period of `seconds` or until a This method resets the PIC controller and resets it to the state previous to the pins/min-voltage being set. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Pycom Libraries](https://github.com/pycom/pycom-libraries) GitHub repository. {{< /hint >}} diff --git a/content/datasheets/boards/expansion2.md b/content/datasheets/boards/expansion2.md index 82daf1d..81b45bd 100644 --- a/content/datasheets/boards/expansion2.md +++ b/content/datasheets/boards/expansion2.md @@ -16,7 +16,7 @@ The pinout of the Expansion Board is available as a PDF File ![](/gitbook/assets/expansion2-pinout-1.png) -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Be gentle when plugging/unplugging from the USB connector. Whilst the USB connector is soldered and is relatively strong, if it breaks off it can be very difficult to fix. {{< /hint >}} diff --git a/content/datasheets/boards/expansion3.md b/content/datasheets/boards/expansion3.md index 9906e63..0277d27 100644 --- a/content/datasheets/boards/expansion3.md +++ b/content/datasheets/boards/expansion3.md @@ -16,7 +16,7 @@ The pinout of the Expansion Board is available as a PDF File ![](/gitbook/assets/expansion3-pinout-1.png) -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Be gentle when plugging/unplugging from the USB connector. Whilst the USB connector is soldered and is relatively strong, if it breaks off it can be very difficult to fix. {{< /hint >}} diff --git a/content/datasheets/boards/pyscan.md b/content/datasheets/boards/pyscan.md index 699234d..1778b24 100644 --- a/content/datasheets/boards/pyscan.md +++ b/content/datasheets/boards/pyscan.md @@ -13,7 +13,7 @@ aliases: * Pyscan libraries to use the RFID/NFC reader are located [here](https://github.com/pycom/pycom-libraries/tree/master/pyscan) * The accelerometer library is [here](https://github.com/pycom/pycom-libraries/blob/master/pytrack/lib/LIS2HH12.py) -{{{% hint style="info" %}}} +{{% hint style="info" %}} For the time being, we recommend to upload the `MFRC630.mpy` file via FTP due to current limitations of Pymakr that will be fixed shortly. {{< /hint >}} diff --git a/content/datasheets/development/fipy.md b/content/datasheets/development/fipy.md index 4e77d2c..975201e 100644 --- a/content/datasheets/development/fipy.md +++ b/content/datasheets/development/fipy.md @@ -20,7 +20,7 @@ The pinout of the FiPy is available as a PDF File ![](/gitbook/assets/fipy-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/development/gpy.md b/content/datasheets/development/gpy.md index 3c83b2f..47d5450 100644 --- a/content/datasheets/development/gpy.md +++ b/content/datasheets/development/gpy.md @@ -4,6 +4,7 @@ aliases: - datasheets/development/gpy.html - datasheets/development/gpy.md - product-info/development/gpy + - datasheets/development/gpy - chapter/datasheets/development/gpy --- ![](/gitbook/assets/gpy-1.png) @@ -20,7 +21,7 @@ The pinout of the GPy is available as a PDF File ![](/gitbook/assets/gpy-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} @@ -60,4 +61,3 @@ Tutorials on how to the GPy module can be found in the [examples](/../tutorials/ * [LTE CAT-M1](/../tutorials/lte/cat-m1) * [NB-IoT](/../tutorials/lte/nb-iot) * [BLE](/../tutorials/all/ble) - diff --git a/content/datasheets/development/lopy.md b/content/datasheets/development/lopy.md index b057e11..3ef1981 100644 --- a/content/datasheets/development/lopy.md +++ b/content/datasheets/development/lopy.md @@ -20,7 +20,7 @@ The pinout of the LoPy is available as a PDF File ![](/gitbook/assets/lopy-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/development/lopy4.md b/content/datasheets/development/lopy4.md index 8479dd9..d049f10 100644 --- a/content/datasheets/development/lopy4.md +++ b/content/datasheets/development/lopy4.md @@ -20,7 +20,7 @@ The pinout of the LoPy4 is available as a PDF File ![](/gitbook/assets/lopy4-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/development/sipy.md b/content/datasheets/development/sipy.md index e2cb39b..0424102 100644 --- a/content/datasheets/development/sipy.md +++ b/content/datasheets/development/sipy.md @@ -20,7 +20,7 @@ The pinout of the SiPy is available as a PDF File ![](/gitbook/assets/sipy-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/development/wipy2.md b/content/datasheets/development/wipy2.md index ca5a72d..d914f19 100644 --- a/content/datasheets/development/wipy2.md +++ b/content/datasheets/development/wipy2.md @@ -20,7 +20,7 @@ The pinout of the WiPy2 is available as a PDF File. ![](/gitbook/assets/wipy2-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/development/wipy3.md b/content/datasheets/development/wipy3.md index e37f0fd..70c1b95 100644 --- a/content/datasheets/development/wipy3.md +++ b/content/datasheets/development/wipy3.md @@ -20,7 +20,7 @@ The pinout of the WiPy3 is available as a PDF File. ![](/gitbook/assets/wipy3-pinout.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/introduction.md b/content/datasheets/introduction.md index 7bbaca6..23c9597 100644 --- a/content/datasheets/introduction.md +++ b/content/datasheets/introduction.md @@ -1,11 +1,13 @@ --- -title: "Introduction" +title: "Datasheets" aliases: - datasheets/introduction.html - datasheets/introduction.md - product-info - chapter/datasheets --- + + The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes. ## Development Modules @@ -20,7 +22,7 @@ The follow pages contain all information relating to each product, for examples: {{% refname "development/sipy.md" %}} -{{% refname "development/gpy.md" %}} +{{% refname "development/gpy/" %}} {{% refname "development/fipy.md" %}} @@ -49,4 +51,3 @@ The follow pages contain all information relating to each product, for examples: {{% refname "boards/expansion2.md" %}} {{% refname "boards/deepsleep/" %}} - diff --git a/content/datasheets/notes.md b/content/datasheets/notes.md index f2ad78b..b4d0463 100644 --- a/content/datasheets/notes.md +++ b/content/datasheets/notes.md @@ -16,17 +16,17 @@ When powering via `VIN`: * The input voltage must be between `3.4V` and `5.5V`. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Please **DO NOT** power the board via the `3.3V` pin as this may damage the device. ONLY use the `VIN` pin for powering Pycom devices. {{< /hint >}} The battery connector for the Expansion Board is a **JST PHR-2** variant. The Expansion Board exposes the male connector and an external battery should use a female adapter in order to connect and power the expansion board. The polarity of the battery should be checked before being plugged into the expansion board, the cables may require swapping. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} The `GPIO` pins of the modules are **NOT** `5V` tolerant, connecting them to voltages higher than `3.3V` might cause irreparable damage to the device. {{< /hint >}} -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Static electricity can damage components on the device and may destroy them. If there is a lot of static electricity in the area (e.g. dry and cold climates), take extra care not to shock the device. If the device came in a ESD bag (Silver packaging), the best way to store and carry the device is inside this bag as it will be protected against static discharges. {{< /hint >}} diff --git a/content/datasheets/oem/g01.md b/content/datasheets/oem/g01.md index 14266b5..c3eb40d 100644 --- a/content/datasheets/oem/g01.md +++ b/content/datasheets/oem/g01.md @@ -28,7 +28,7 @@ The drawings for the G01 is available as a PDF File. {% file src="/gitbook/assets/g01-drawing.pdf" caption="G01 Drawings" %} -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/oem/l01.md b/content/datasheets/oem/l01.md index 5c918d9..3a8049f 100644 --- a/content/datasheets/oem/l01.md +++ b/content/datasheets/oem/l01.md @@ -28,7 +28,7 @@ The drawings for the L01 is available as a PDF File. {% file src="/gitbook/assets/l01-drawing.pdf" caption="L01 Drawing" %} -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/oem/l01_reference.md b/content/datasheets/oem/l01_reference.md index a2fef46..38adc0d 100644 --- a/content/datasheets/oem/l01_reference.md +++ b/content/datasheets/oem/l01_reference.md @@ -10,7 +10,7 @@ aliases: The L01 OEM reference board is a reference design suitable L01 as well as W01 making it possible to have a single PCB design that can accommodate both OEM modules. -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you require a reference board for the L04 or G01, this design is **not** suitable as it does not feature a SIM slot or the double antenna connection. For the G01 or L04 please use the [Universal OEM Baseboard Reference](universal_reference) {{< /hint >}} diff --git a/content/datasheets/oem/l04.md b/content/datasheets/oem/l04.md index da0dec3..4930683 100644 --- a/content/datasheets/oem/l04.md +++ b/content/datasheets/oem/l04.md @@ -28,7 +28,7 @@ The drawings for the L04 is available as a PDF File. {% file src="/gitbook/assets/l04-drawing.pdf" caption="L04 Drawings" %} -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/datasheets/oem/universal_reference.md b/content/datasheets/oem/universal_reference.md index b421a4b..5c2c3a4 100644 --- a/content/datasheets/oem/universal_reference.md +++ b/content/datasheets/oem/universal_reference.md @@ -10,7 +10,7 @@ aliases: The universal OEM reference board is a reference design suitable W01, L01, L04 and G01 OEM modules, making it possible to have a single PCB design that can accommodate all our OEM modules. -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you require a reference board for the G01, only this design is suitable. The L01 reference board does not contain the necessary SIM slot. {{< /hint >}} diff --git a/content/datasheets/oem/w01.md b/content/datasheets/oem/w01.md index a775646..730cdfc 100644 --- a/content/datasheets/oem/w01.md +++ b/content/datasheets/oem/w01.md @@ -28,7 +28,7 @@ The drawings for the W01 is available as a PDF File. {% file src="/gitbook/assets/w01-drawing.pdf" caption="W01 Drawings" %} -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software. {{< /hint >}} diff --git a/content/docnotes/syntax.md b/content/docnotes/syntax.md index 9806f73..b47d86a 100644 --- a/content/docnotes/syntax.md +++ b/content/docnotes/syntax.md @@ -94,7 +94,7 @@ The `constants` section of a library within the docs refers to specific values f I2C.MASTER() ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Be aware that you can only reference these constants upon importing and constructing a object from a library. {{< /hint >}} diff --git a/content/firmwareapi/micropython/README.md b/content/firmwareapi/micropython/README.md index b366e1d..f2ee756 100644 --- a/content/firmwareapi/micropython/README.md +++ b/content/firmwareapi/micropython/README.md @@ -7,7 +7,7 @@ The following list contains the standard Python libraries, MicroPython-specific The standard Python libraries have been "micro-ified" to fit in with the philosophy of MicroPython. They provide the core functionality of that module and are intended to be a drop-in replacement for the standard Python library. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Some modules are available by an u-name, and also by their non-u-name. The non-u-name can be overridden by a file of that name in your package path. For example, `import json` will first search for a file `json.py` or directory `json` and load that package if it's found. If nothing is found, it will fallback to loading the built-in `ujson` module. {{< /hint >}} diff --git a/content/firmwareapi/micropython/_index.md b/content/firmwareapi/micropython/_index.md index 36aa7a7..ed523ff 100644 --- a/content/firmwareapi/micropython/_index.md +++ b/content/firmwareapi/micropython/_index.md @@ -6,7 +6,7 @@ The following list contains the standard Python libraries, MicroPython-specific The standard Python libraries have been "micro-ified" to fit in with the philosophy of MicroPython. They provide the core functionality of that module and are intended to be a drop-in replacement for the standard Python library. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Some modules are available by an u-name, and also by their non-u-name. The non-u-name can be overridden by a file of that name in your package path. For example, `import json` will first search for a file `json.py` or directory `json` and load that package if it's found. If nothing is found, it will fallback to loading the built-in `ujson` module. {{< /hint >}} diff --git a/content/firmwareapi/micropython/sys.md b/content/firmwareapi/micropython/sys.md index 7594ab0..bcae70c 100644 --- a/content/firmwareapi/micropython/sys.md +++ b/content/firmwareapi/micropython/sys.md @@ -15,7 +15,7 @@ Terminate current program with a given exit code. Underlyingly, this function ra Print exception with a traceback to a file-like object file (or `sys.stdout` by default). -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Difference to CPython** This is simplified version of a function which appears in the traceback module in CPython. Unlike `traceback.print_exception()`, this function takes just exception value instead of exception type, exception value, and traceback object; file argument should be positional; further arguments are not supported. CPython-compatible traceback module can be found in `micropython-lib`. @@ -31,7 +31,7 @@ This is simplified version of a function which appears in the traceback module i This object is the recommended way to distinguish MicroPython from other Python implementations (note that it still may not exist in the very minimal ports). -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Difference to CPython** CPython mandates more attributes for this object, but the actual useful bare minimum is implemented in MicroPython. diff --git a/content/firmwareapi/micropython/ubinascii.md b/content/firmwareapi/micropython/ubinascii.md index 4b6ad1a..9ea2622 100644 --- a/content/firmwareapi/micropython/ubinascii.md +++ b/content/firmwareapi/micropython/ubinascii.md @@ -13,7 +13,7 @@ This module implements conversions between binary data and various encodings of Convert binary data to hexadecimal representation. Returns bytes string. -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Difference to CPython** If additional argument, `sep` is supplied, it is used as a separator between hexadecimal values. diff --git a/content/firmwareapi/micropython/ucrypto.md b/content/firmwareapi/micropython/ucrypto.md index 5f6c238..7cd3b40 100644 --- a/content/firmwareapi/micropython/ucrypto.md +++ b/content/firmwareapi/micropython/ucrypto.md @@ -21,7 +21,7 @@ According to the **ESP32 Technical Reference Manual**, such bits "... can be use The parameter `bits` is rounded upwards to the nearest multiple of 32 bits. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Cryptography is not a trivial business. Doing things the wrong way could quickly result in decreased or no security. Please document yourself in the subject if you are depending on encryption to secure important information. {{< /hint >}} diff --git a/content/firmwareapi/micropython/uctypes.md b/content/firmwareapi/micropython/uctypes.md index 1421f49..ce3951b 100644 --- a/content/firmwareapi/micropython/uctypes.md +++ b/content/firmwareapi/micropython/uctypes.md @@ -7,7 +7,7 @@ aliases: --- This module implements "foreign data interface" for MicroPython. The idea behind it is similar to CPython's `ctypes` modules, but the actual API is different, streamlined and optimised for small size. The basic idea of the module is to define data structure layout with about the same power as the C language allows, and the access it using familiar dot-syntax to reference sub-fields. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Module ustruct Standard Python way to access binary data structures (doesn't scale well to large and complex structures). {{< /hint >}} diff --git a/content/firmwareapi/micropython/usocket.md b/content/firmwareapi/micropython/usocket.md index e260f39..66f5770 100644 --- a/content/firmwareapi/micropython/usocket.md +++ b/content/firmwareapi/micropython/usocket.md @@ -58,7 +58,7 @@ Sockets are automatically closed when they are garbage-collected, but it is reco Bind the `socket` to `address`. The socket must not already be bound. The `address` parameter must be a tuple containing the IP address and the port. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In the case of LoRa sockets, the address parameter is simply an integer with the port number, for instance: `s.bind(1)` {{< /hint >}} @@ -119,7 +119,7 @@ Return a file object associated with the socket. The exact returned type depends The socket must be in blocking mode; it can have a timeout, but the file object's internal buffer may end up in a inconsistent state if a timeout occurs. -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Difference to CPython** Closing the file object returned by `makefile()` **WILL** close the original socket as well. diff --git a/content/firmwareapi/micropython/utime.md b/content/firmwareapi/micropython/utime.md index 831d1b5..2db8865 100644 --- a/content/firmwareapi/micropython/utime.md +++ b/content/firmwareapi/micropython/utime.md @@ -86,7 +86,7 @@ Returns the number of seconds, as an integer, since the Epoch, assuming that und Set or get the timezone offset, in seconds. If `secs` is not provided, it returns the current value. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In MicroPython, `time.timezone` works the opposite way to Python. In [Python](https://docs.python.org/3/library/time.html#time.timezone), to get the local time, you write `local_time = utc - timezone`, while in MicroPython it is `local_time = utc + timezone`. {{< /hint >}} diff --git a/content/firmwareapi/micropython/uzlib.md b/content/firmwareapi/micropython/uzlib.md index c1556d3..c86f060 100644 --- a/content/firmwareapi/micropython/uzlib.md +++ b/content/firmwareapi/micropython/uzlib.md @@ -19,7 +19,7 @@ Return decompressed data as bytes. wbits is DEFLATE dictionary window size used Create a `stream` wrapper which allows transparent decompression of compressed data in another stream. This allows to process compressed streams with data larger than available heap size. In addition to values described in `decompress()`, wbits may take values 24..31 (16 + 8..15), meaning that input stream has gzip header. -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Difference to CPython** This class is MicroPython extension. It's included on provisional basis and may be changed considerably or removed in later versions. diff --git a/content/firmwareapi/notes.md b/content/firmwareapi/notes.md index 536eda5..654baa3 100644 --- a/content/firmwareapi/notes.md +++ b/content/firmwareapi/notes.md @@ -15,7 +15,7 @@ The user can do whatever is required inside of the callback, such as creating ne Currently, there are 2 classes that support interrupts; the [`Alarm`](pycom/machine/timer.md#class-timer-alarm-handler-none-s-ms-us-arg-none-periodic-false) and [`Pin`](pycom/machine/pin) classes. Both classes provide the `.callback()` method that enables the interrupt and registers the given handler. For more details about interrupt usage along with examples, please visit their respective sections. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Currently the interrupt system can queue up to **16 interrupts**. {{< /hint >}} diff --git a/content/firmwareapi/pycom/aes.md b/content/firmwareapi/pycom/aes.md index 9932369..9767a04 100644 --- a/content/firmwareapi/pycom/aes.md +++ b/content/firmwareapi/pycom/aes.md @@ -7,7 +7,7 @@ aliases: --- AES (Advanced Encryption Standard) is a symmetric block cipher standardised by NIST. It has a fixed data block size of 16 bytes. Its keys can be 128, 192, or 256 bits long. -{{{% hint style="info" %}}} +{{% hint style="info" %}} AES is implemented using the ESP32 hardware module. {{< /hint >}} @@ -61,7 +61,7 @@ Decrypt data with the key and the parameters set at initialisation. * `AES.MODE_CTR`: Counter mode. Each message block is associated to a counter which must be unique across all messages that get encrypted with the same key. * `AES.SEGMENT_8`, `AES.SEGMENT_128`: Length of the segment for `AES.MODE_CFB` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} To avoid security issues, IV should always be a random number and should never be reused to encrypt two different messages. The same applies to the counter in CTR mode. You can use `crypto.getrandbits()` for this purpose. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/README.md b/content/firmwareapi/pycom/machine/README.md index 3e73dbb..866021b 100644 --- a/content/firmwareapi/pycom/machine/README.md +++ b/content/firmwareapi/pycom/machine/README.md @@ -96,7 +96,7 @@ Return a 24-bit software generated random number. Returns a byte string with a unique identifier of a board/SoC. It will vary from a board/SoC instance to another, if underlying hardware allows. Length varies by hardware (so use substring of a full value if you expect a short ID). In some MicroPython ports, ID corresponds to the network MAC address. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Use `ubinascii.hexlify()` to convert the byte string to hexadecimal form for ease of manipulation and use elsewhere. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/_index.md b/content/firmwareapi/pycom/machine/_index.md index 12cafe7..8b5faae 100644 --- a/content/firmwareapi/pycom/machine/_index.md +++ b/content/firmwareapi/pycom/machine/_index.md @@ -95,7 +95,7 @@ Return a 24-bit software generated random number. Returns a byte string with a unique identifier of a board/SoC. It will vary from a board/SoC instance to another, if underlying hardware allows. Length varies by hardware (so use substring of a full value if you expect a short ID). In some MicroPython ports, ID corresponds to the network MAC address. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Use `ubinascii.hexlify()` to convert the byte string to hexadecimal form for ease of manipulation and use elsewhere. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/adc.md b/content/firmwareapi/pycom/machine/adc.md index b3d5c29..c853acb 100644 --- a/content/firmwareapi/pycom/machine/adc.md +++ b/content/firmwareapi/pycom/machine/adc.md @@ -99,7 +99,7 @@ Reads the channels value and converts it into a voltage (in millivolts) Converts the provided value into a voltage (in millivolts) in the same way voltage does. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} ADC pin input range is `0-1.1V`. This maximum value can be increased up to `3.3V` using the highest attenuation of `11dB`. **Do not exceed the maximum of 3.3V**, to avoid damaging the device. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/pin.md b/content/firmwareapi/pycom/machine/pin.md index 04ba30f..a2837ee 100644 --- a/content/firmwareapi/pycom/machine/pin.md +++ b/content/firmwareapi/pycom/machine/pin.md @@ -123,7 +123,7 @@ p_in = Pin('P10', mode=Pin.IN, pull=Pin.PULL_UP) p_in.callback(Pin.IRQ_FALLING | Pin.IRQ_RISING, pin_handler) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} For more information on how Pycom's products handle interrupts, see [here](/../notes.md#interrupt-handling). {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/rmt.md b/content/firmwareapi/pycom/machine/rmt.md index 73a897e..107769a 100644 --- a/content/firmwareapi/pycom/machine/rmt.md +++ b/content/firmwareapi/pycom/machine/rmt.md @@ -84,7 +84,7 @@ The `tx_carrier` parameter is a tuple with the following structure: Deinitialise the RMT object. -{{{% hint style="info" %}}} +{{% hint style="info" %}} If an RMT object needs to be reconfigured from RX/TX to TX/RX, then either first `deinit()` must be called or the `init()` again with the desired configuration. {{< /hint >}} @@ -111,7 +111,7 @@ Return value: Tuple of items with the following structure: `(level, duration)`: * `level` represents the level of the received bit/pulse, can be 0 or 1. * `duration` represents the duration of the received pulse, the time unit (resolution) depends on the selected channel. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Maximum of 128 pulses can be received in a row without receiving "idle" signal. If the incoming pulse sequence contains more than 128 pulses the rest is dropped and the receiver waits for another sequence of pulses. The `pulses_get` function can be called to receive more than 128 pulses, however the above mentioned limitation should be kept in mind when evaluating the received data. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/rtc.md b/content/firmwareapi/pycom/machine/rtc.md index 251df5c..f3d46aa 100644 --- a/content/firmwareapi/pycom/machine/rtc.md +++ b/content/firmwareapi/pycom/machine/rtc.md @@ -44,7 +44,7 @@ For example: rtc.init((2017, 2, 28, 10, 30, 0, 0, 0)) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} `tzinfo` is ignored by this method. Use `time.timezone` to achieve similar results. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/sd.md b/content/firmwareapi/pycom/machine/sd.md index 35682ad..7dc9e5a 100644 --- a/content/firmwareapi/pycom/machine/sd.md +++ b/content/firmwareapi/pycom/machine/sd.md @@ -11,7 +11,7 @@ The SD card class allows to configure and enable the memory card module of your If you have one of the Pycom expansion boards, then simply insert the card into the micro SD socket and run your script. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Make sure your SD card is formatted either as FAT16 or FAT32. {{< /hint >}} @@ -52,7 +52,7 @@ Enable the SD card. Disable the SD card. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that the SD card library currently supports FAT16/32 formatted SD cards up to 32 GB. Future firmware updates will increase compatibility with additional formats and sizes. {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/timer.md b/content/firmwareapi/pycom/machine/timer.md index f959fc3..304df87 100644 --- a/content/firmwareapi/pycom/machine/timer.md +++ b/content/firmwareapi/pycom/machine/timer.md @@ -13,7 +13,7 @@ These two concepts are grouped into two different subclasses: `Chrono`: used to measure time spans. `Alarm`: to get interrupted after a specific interval. -{{{% hint style="info" %}}} +{{% hint style="info" %}} You can create as many of these objects as needed. {{< /hint >}} @@ -126,7 +126,7 @@ class Clock: clock = Clock() ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} For more information on how Pycom's products handle interrupts, see [notes](/../notes.md#interrupt-handling). {{< /hint >}} diff --git a/content/firmwareapi/pycom/machine/uart.md b/content/firmwareapi/pycom/machine/uart.md index 16b635b..5312f3e 100644 --- a/content/firmwareapi/pycom/machine/uart.md +++ b/content/firmwareapi/pycom/machine/uart.md @@ -70,7 +70,7 @@ uart.read(5) # read up to 5 bytes Construct a UART object on the given `bus`. `bus` can be `0, 1 or 2`. If the `bus` is not given, the default one will be selected (`0`) or the selection will be made based on the given pins. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} On the GPy/FiPy UART2 is unavailable because it is used to communicate with the cellular radio. {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/lora/README.md b/content/firmwareapi/pycom/network/lora/README.md index 9610c27..b1946b7 100644 --- a/content/firmwareapi/pycom/network/lora/README.md +++ b/content/firmwareapi/pycom/network/lora/README.md @@ -43,7 +43,7 @@ data = s.recv(64) print(data) ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Please ensure that there is an antenna connected to your device before sending/receiving LoRa messages as improper use (e.g. without an antenna), may damage the device. {{< /hint >}} @@ -85,7 +85,7 @@ The arguments are: * `tx_retries` sets the number of TX retries in `LoRa.LORAWAN` mode. * `device_class` sets the LoRaWAN device class. Can be either `LoRa.CLASS_A` or `LoRa.CLASS_C`. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In `LoRa.LORAWAN` mode, only `adr`, `public`, `tx_retries` and `device_class` are used. All the other params will be ignored as they are handled by the LoRaWAN stack directly. On the other hand, in `LoRa.LORA` mode from those 4 arguments, only the public one is important in order to program the sync word. In `LoRa.LORA` mode `adr`, `tx_retries` and `device_class` are ignored since they are only relevant to the LoRaWAN stack. {{< /hint >}} @@ -429,7 +429,7 @@ And they must be created after initialising the LoRa network card. LoRa-Mesh socket is created, if the Mesh was enabled before (`lora.mesh()` was called). -{{{% hint style="info" %}}} +{{% hint style="info" %}} The LoRa-Mesh socket supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`. {{< /hint >}} @@ -451,7 +451,7 @@ Usage: s.bind(1) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode. {{< /hint >}} @@ -512,7 +512,7 @@ s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, False) s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, True) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Socket options are only applicable when the LoRa radio is used in LoRa.LORAWAN mode. When using the radio in LoRa.LORA mode, use the class methods to change the spreading factor, bandwidth and coding rate to the desired values. {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/lora/_index.md b/content/firmwareapi/pycom/network/lora/_index.md index 9610c27..b1946b7 100644 --- a/content/firmwareapi/pycom/network/lora/_index.md +++ b/content/firmwareapi/pycom/network/lora/_index.md @@ -43,7 +43,7 @@ data = s.recv(64) print(data) ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Please ensure that there is an antenna connected to your device before sending/receiving LoRa messages as improper use (e.g. without an antenna), may damage the device. {{< /hint >}} @@ -85,7 +85,7 @@ The arguments are: * `tx_retries` sets the number of TX retries in `LoRa.LORAWAN` mode. * `device_class` sets the LoRaWAN device class. Can be either `LoRa.CLASS_A` or `LoRa.CLASS_C`. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In `LoRa.LORAWAN` mode, only `adr`, `public`, `tx_retries` and `device_class` are used. All the other params will be ignored as they are handled by the LoRaWAN stack directly. On the other hand, in `LoRa.LORA` mode from those 4 arguments, only the public one is important in order to program the sync word. In `LoRa.LORA` mode `adr`, `tx_retries` and `device_class` are ignored since they are only relevant to the LoRaWAN stack. {{< /hint >}} @@ -429,7 +429,7 @@ And they must be created after initialising the LoRa network card. LoRa-Mesh socket is created, if the Mesh was enabled before (`lora.mesh()` was called). -{{{% hint style="info" %}}} +{{% hint style="info" %}} The LoRa-Mesh socket supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`. {{< /hint >}} @@ -451,7 +451,7 @@ Usage: s.bind(1) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode. {{< /hint >}} @@ -512,7 +512,7 @@ s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, False) s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, True) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Socket options are only applicable when the LoRa radio is used in LoRa.LORAWAN mode. When using the radio in LoRa.LORA mode, use the class methods to change the spreading factor, bandwidth and coding rate to the desired values. {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/lora/pymesh.md b/content/firmwareapi/pycom/network/lora/pymesh.md index 99aaf98..55f0ebf 100644 --- a/content/firmwareapi/pycom/network/lora/pymesh.md +++ b/content/firmwareapi/pycom/network/lora/pymesh.md @@ -315,7 +315,7 @@ Multiple sockets (maximum 3) can be created, being bind on a certain IPv6 unicas Pymesh sockets is created, if the Mesh was enabled before (`lora.Mesh()` was called). -{{{% hint style="info" %}}} +{{% hint style="info" %}} The Pymesh sockets supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`. {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/lte.md b/content/firmwareapi/pycom/network/lte.md index e0bb967..742d0c7 100644 --- a/content/firmwareapi/pycom/network/lte.md +++ b/content/firmwareapi/pycom/network/lte.md @@ -12,11 +12,11 @@ The GPy and FiPy support both new LTE-M protocols: * **Cat-M1**: also known as **LTE-M** defines a 1.4 MHz radio channel size and about 375 kbps of throughput. It is optimised for coverage and long battery life, outperforming 2G/GPRS, while being similar to previous LTE standards. * **Cat-NB1** also known as **NB-IoT**, defines a 200 kHz radio channel size and around 60 kbps of uplink speed. It's optimised for ultra low throughput and specifically designed for IoT devices with a very long battery life. NB-IoT shares some features with LTE such as operating in licensed spectrum, but it's a very different protocol. It should be noted that NB-IoT has many restrictions as does not offer full IP connectivity and does not support mobility. When moving between cells, you will need to reconnect. -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Please note:** The GPy and FiPy only support the two protocols above and are not compatible with older LTE standards. {{< /hint >}} -{{{% hint style="info" %}}} +{{% hint style="info" %}} The Sequans modem used on Pycom's cellular enabled modules can only work in one of these modes at a time. In order to switch between the two protocols you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](/../../tutorials/lte/firmware). {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/sigfox.md b/content/firmwareapi/pycom/network/sigfox.md index e6be706..991b281 100644 --- a/content/firmwareapi/pycom/network/sigfox.md +++ b/content/firmwareapi/pycom/network/sigfox.md @@ -7,7 +7,7 @@ aliases: --- Sigfox is a Low Power Wide Area Network protocol that enables remote devices to connect using ultra-narrow band, UNB technology. The protocol is bi-directional, messages can both be sent up to and down from the Sigfox servers. -{{{% hint style="info" %}}} +{{% hint style="info" %}} When operating in `RCZ2` and `RCZ4` the module can only send messages on the default macro-channel (this is due to Sigfox network limitations). Therefore, the device needs to reset automatically to the default macro-channel after every 2 transmissions. However, due to FCC duty cycle limitations, there must a minimum of a 20s delay after resetting to the default macro-channel. Our API takes care of this, (and in real life applications you should not be in the need to send Sigfox messages that often), so it will wait for the necessary amount of time to make sure that the duty cycle restrictions are fulfilled. This means that if you run a piece of test code like: @@ -45,7 +45,7 @@ s.setsockopt(socket.SOL_SIGFOX, socket.SO_RX, False) s.send(bytes([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12])) ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Please ensure that there is an antenna connected to your device before sending/receiving Sigfox messages as in proper use (e.g. without an antenna), may damage the device. {{< /hint >}} @@ -63,7 +63,7 @@ sigfox = Sigfox(mode=Sigfox.SIGFOX, rcz=Sigfox.RCZ1) sigfox = Sigfox(mode=Sigfox.FSK, frequency=912000000) ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} `Sigfox.FSK` mode is not supported on LoPy 4 and FiPy. {{< /hint >}} @@ -79,7 +79,7 @@ The arguments are: * `rcz` takes the following values: `Sigfox.RCZ1`, `Sigfox.RCZ2`, `Sigfox.RCZ3`, `Sigfox.RCZ4`. The `rcz` argument is only required if the mode is `Sigfox.SIGFOX`. * `frequency` sets the frequency value in `FSK` mode. Can take values between 863 and 928 MHz. -{{{% hint style="info" %}}} +{{% hint style="info" %}} The SiPy comes in 2 different hardware flavours: a +14dBm Tx power version which can only work with `RCZ1` and `RCZ3` and a +22dBm version which works exclusively on `RCZ2` and `RCZ4`. {{< /hint >}} @@ -99,7 +99,7 @@ Returns a signed integer with indicating the signal strength value of the last r Returns a byte object with the 8-Byte bytes object with the Sigfox PAC. -{{{% hint style="info" %}}} +{{% hint style="info" %}} To return human-readable values you should import `ubinascii` and convert binary values to hexidecimal representation. For example: ```python @@ -246,7 +246,7 @@ s.recv(32) To communicate between two Sigfox capable devices, it may be used in FSK mode. Two devices are required to be set to the same frequency, both using FSK. -{{{% hint style="info" %}}} +{{% hint style="info" %}} `Sigfox.FSK` mode is not supported on LoPy 4 and FiPy. {{< /hint >}} @@ -278,7 +278,7 @@ while True: print(s.recv(64)) ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Remember to use the correct frequency for your region (868 MHz for Europe, 912 MHz for USA, etc.) {{< /hint >}} diff --git a/content/firmwareapi/pycom/network/wlan.md b/content/firmwareapi/pycom/network/wlan.md index b4e00ab..770750e 100644 --- a/content/firmwareapi/pycom/network/wlan.md +++ b/content/firmwareapi/pycom/network/wlan.md @@ -43,7 +43,7 @@ print(wlan.ifconfig()) Create a WLAN object, and optionally configure it. See [`init`](wlan.md#wlan-init-mode-ssid-none-auth-none-channel-1-antenna-none-power_save-false-hidden-false) for params of configuration. -{{{% hint style="info" %}}} +{{% hint style="info" %}} The WLAN constructor is special in the sense that if no arguments besides the `id` are given, it will return the already existing WLAN instance without re-configuring it. This is because WLAN is a system feature of the WiPy. If the already existing instance is not initialised it will do the same as the other constructors an will initialise it with default values. {{< /hint >}} @@ -103,7 +103,7 @@ Connect to a wifi access point using the given SSID, and other security paramete * `identity` is only used in case of `WLAN.WPA2_ENT` security. Needed by the server. * `hostname` is the name of the host connecting to the AP. Max length of name string is 32 Bytes -{{{% hint style="info" %}}} +{{% hint style="info" %}} The ESP32 only handles certificates with `pkcs8` format (but not the "Traditional SSLeay RSAPrivateKey" format). The private key should be RSA coded with 2048 bits at maximum. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/fipy.md b/content/getting-started/hardwaresetup/fipy.md index b0aa00a..c19e84e 100644 --- a/content/getting-started/hardwaresetup/fipy.md +++ b/content/getting-started/hardwaresetup/fipy.md @@ -40,13 +40,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your FiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -75,11 +75,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora/Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa/Sigfox connectivity of the FiPy you **must** connect a LoRa/Sigfox antenna to your FiPy before trying to use LoRa/Sigfox otherwise you risk damaging the device. {{< /hint >}} -{{{% hint style="info" %}}} +{{% hint style="info" %}} The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. {{< /hint >}} @@ -94,7 +94,7 @@ The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4 ### LTE Cat-M1/NB-IoT -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your FiPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/gpy.md b/content/getting-started/hardwaresetup/gpy.md index 562aec5..5902417 100644 --- a/content/getting-started/hardwaresetup/gpy.md +++ b/content/getting-started/hardwaresetup/gpy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your GPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,7 +73,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### LTE Cat-M1/NB-IoT -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your GPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/lopy.md b/content/getting-started/hardwaresetup/lopy.md index c39f3c7..a9153d3 100644 --- a/content/getting-started/hardwaresetup/lopy.md +++ b/content/getting-started/hardwaresetup/lopy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your LoPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do _not_ feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa connectivity of the LoPy you **must** connect a LoRa antenna to your LoPy before trying to use LoRa otherwise you risk damaging the device. {{< /hint >}} -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/lopy4.md b/content/getting-started/hardwaresetup/lopy4.md index 1b27f54..189bb90 100644 --- a/content/getting-started/hardwaresetup/lopy4.md +++ b/content/getting-started/hardwaresetup/lopy4.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your LoPy4. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,7 +73,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora/Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** connect a LoRa/Sigfox antenna to your LoPy4 before trying to use LoRa/Sigfox otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/sipy.md b/content/getting-started/hardwaresetup/sipy.md index 2a1a642..dce2c43 100644 --- a/content/getting-started/hardwaresetup/sipy.md +++ b/content/getting-started/hardwaresetup/sipy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your SiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,7 +73,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the Sigfox connectivity of the SiPy you **must** connect a Sigfox antenna to your SiPy before trying to use Sigfox otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/getting-started/hardwaresetup/wipy.md b/content/getting-started/hardwaresetup/wipy.md index 492f12a..559d3d7 100644 --- a/content/getting-started/hardwaresetup/wipy.md +++ b/content/getting-started/hardwaresetup/wipy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your WiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} diff --git a/content/gettingstarted/_index.md b/content/gettingstarted/_index.md index d20b28c..1b4cc3c 100644 --- a/content/gettingstarted/_index.md +++ b/content/gettingstarted/_index.md @@ -22,7 +22,6 @@ Now that you have a connected module and all the required software installed it Now that you familiar with programming your device you will no doubt be keen to get it connected to one of the advertised wireless networks. This usually requires some registration. This step will detail how to get registered and connected to various wireless networks. -{{{% hint style="info" %}}} +{{% hint style="info" %}} You can navigate through this guide using the arrow buttons at the bottom of the page. {{< /hint >}} - diff --git a/content/gettingstarted/connection/fipy.md b/content/gettingstarted/connection/fipy.md index 9950060..2e9cff6 100644 --- a/content/gettingstarted/connection/fipy.md +++ b/content/gettingstarted/connection/fipy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your FiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora/Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa/Sigfox connectivity of the FiPy you **must** connect a LoRa/Sigfox antenna to your FiPy before trying to use LoRa/Sigfox otherwise you risk damaging the device. {{< /hint >}} -{{{% hint style="info" %}}} +{{% hint style="info" %}} The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. {{< /hint >}} @@ -92,7 +92,7 @@ The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4 ### LTE Cat-M1/NB-IoT -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your FiPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/gettingstarted/connection/gpy.md b/content/gettingstarted/connection/gpy.md index 3daba65..fe1868e 100644 --- a/content/gettingstarted/connection/gpy.md +++ b/content/gettingstarted/connection/gpy.md @@ -36,13 +36,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your GPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -71,7 +71,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### LTE Cat-M1/NB-IoT -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your GPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/gettingstarted/connection/lopy.md b/content/gettingstarted/connection/lopy.md index d2035de..820f50d 100644 --- a/content/gettingstarted/connection/lopy.md +++ b/content/gettingstarted/connection/lopy.md @@ -38,13 +38,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your LoPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa connectivity of the LoPy you **must** connect a LoRa antenna to your LoPy before trying to use LoRa otherwise you risk damaging the device. {{< /hint >}} -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. {{< /hint >}} diff --git a/content/gettingstarted/connection/lopy4.md b/content/gettingstarted/connection/lopy4.md index 5db3089..bfd67d6 100644 --- a/content/gettingstarted/connection/lopy4.md +++ b/content/gettingstarted/connection/lopy4.md @@ -36,13 +36,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your LoPy4. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -71,7 +71,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Lora/Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** connect a LoRa/Sigfox antenna to your LoPy4 before trying to use LoRa/Sigfox otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/gettingstarted/connection/sipy.md b/content/gettingstarted/connection/sipy.md index b442f0d..8f28624 100644 --- a/content/gettingstarted/connection/sipy.md +++ b/content/gettingstarted/connection/sipy.md @@ -36,13 +36,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your SiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} @@ -71,7 +71,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### Sigfox -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If you intend on using the Sigfox connectivity of the SiPy you **must** connect a Sigfox antenna to your SiPy before trying to use Sigfox otherwise you risk damaging the device. {{< /hint >}} diff --git a/content/gettingstarted/connection/wipy.md b/content/gettingstarted/connection/wipy.md index 0b9260d..cf13afc 100644 --- a/content/gettingstarted/connection/wipy.md +++ b/content/gettingstarted/connection/wipy.md @@ -36,13 +36,13 @@ aliases: {% tab title="USB UART Adapter" %} * Firstly you will need to connect power to your WiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator. {{< /hint >}} * The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively. -{{{% hint style="warning" %}}} +{{% hint style="warning" %}} Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it. {{< /hint >}} diff --git a/content/gettingstarted/installation/firmwaretool.md b/content/gettingstarted/installation/firmwaretool.md index 0e960a1..8b1b895 100644 --- a/content/gettingstarted/installation/firmwaretool.md +++ b/content/gettingstarted/installation/firmwaretool.md @@ -13,7 +13,7 @@ Here are the download links to the update tool. Please download the appropriate * [macOS](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=macos&redirect=true) (10.11 or Higher) * [Linux](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=unix&redirect=true) (requires `dialog` and `python-serial` package) -{{{% hint style="info" %}}} +{{% hint style="info" %}} Previous versions of firmware are available for download [**here**](/../advance/downgrade). {{< /hint >}} @@ -41,7 +41,7 @@ If you are having any issues, make sure the **TX and RX jumpers** are present on {% endtab %} {% tab title=" Pysense/Pytrack/Pyscan/Expansion Board 3.0" %} -{{{% hint style="info" %}}} +{{% hint style="info" %}} 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. {{< /hint >}} diff --git a/content/gettingstarted/introduction.md b/content/gettingstarted/introduction.md index 47edc50..8fce754 100644 --- a/content/gettingstarted/introduction.md +++ b/content/gettingstarted/introduction.md @@ -28,7 +28,7 @@ Now that you have a connected module and all the required software installed it Now that you familiar with programming your device you will no doubt be keen to get it connected to one of the advertised wireless networks. This usually requires some registration. This step will detail how to get registered and connected to various wireless networks. -{{{% hint style="info" %}}} +{{% hint style="info" %}} You can navigate through this guide using the arrow buttons at the bottom of the page. {{< /hint >}} diff --git a/content/gettingstarted/programming/examples.md b/content/gettingstarted/programming/examples.md index e0156b5..479592d 100644 --- a/content/gettingstarted/programming/examples.md +++ b/content/gettingstarted/programming/examples.md @@ -107,7 +107,7 @@ pycom_devices = ('wipy', 'lopy', 'sipy', 'gpy', 'fipy') print(pycom_devices[0]) # expect 'wipy' ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} For more Python examples, check out these [tutorials](https://www.tutorialspoint.com/python3/). Be aware of the implementation differences between MicroPython and Python 3.5. {{< /hint >}} diff --git a/content/gettingstarted/programming/first-project.md b/content/gettingstarted/programming/first-project.md index dad7dce..40ece37 100644 --- a/content/gettingstarted/programming/first-project.md +++ b/content/gettingstarted/programming/first-project.md @@ -19,7 +19,7 @@ This guide will take you through how to setup your first project with Pymakr and 3. Once the text editor has loaded you will need to click `File` > `Open`, and open the directory you created in step 1 -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you are using Atom, it is important to check at this point that Atom has successfully identified the project. The name of the directory you created in step 1 (`RGB-Blink` in this case) should be shown in the Pymakr pane like so: ![](/gitbook/assets/atom_project.png) diff --git a/content/gettingstarted/programming/micropython.md b/content/gettingstarted/programming/micropython.md index 2d9ab7d..eec943f 100644 --- a/content/gettingstarted/programming/micropython.md +++ b/content/gettingstarted/programming/micropython.md @@ -23,7 +23,7 @@ Micropython shares majority of the same syntax as Python 3.5. The intention of t Micropython also has a number of Micropython specific libraries for accessing hardware level features. Specifics relating to those libraries can be found in the Firmware API Reference section of this documentation. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Micropython, unlike C/C++ or Arduino, **does not use braces {} to indicate blocks of code** specified for class and function definitions or flow control. Blocks of code are denoted by line indentation, which is strictly enforced. The number of spaces in the indentation is variable but all statements within a block must be indented the same amount. diff --git a/content/gettingstarted/programming/repl/README.md b/content/gettingstarted/programming/repl/README.md index 5ee4f44..c18668e 100644 --- a/content/gettingstarted/programming/repl/README.md +++ b/content/gettingstarted/programming/repl/README.md @@ -14,7 +14,7 @@ The REPL includes the following features: * Halt any executing code: with `Ctrl-C` * Copy/paste code or output: `Ctrl-C` and `Ctrl-V` -{{{% hint style="info" %}}} +{{% hint style="info" %}} There are a number of useful shortcuts for interacting with the MicroPython REPL. See below for the key combinations; * `Ctrl-A` on a blank line will enter raw REPL mode. This is similar to permanent paste mode, except that characters are not echoed back. diff --git a/content/gettingstarted/programming/repl/_index.md b/content/gettingstarted/programming/repl/_index.md index 22db3b7..bf88ccb 100644 --- a/content/gettingstarted/programming/repl/_index.md +++ b/content/gettingstarted/programming/repl/_index.md @@ -13,7 +13,7 @@ The REPL includes the following features: * Halt any executing code: with `Ctrl-C` * Copy/paste code or output: `Ctrl-C` and `Ctrl-V` -{{{% hint style="info" %}}} +{{% hint style="info" %}} There are a number of useful shortcuts for interacting with the MicroPython REPL. See below for the key combinations; * `Ctrl-A` on a blank line will enter raw REPL mode. This is similar to permanent paste mode, except that characters are not echoed back. diff --git a/content/gettingstarted/programming/repl/serial.md b/content/gettingstarted/programming/repl/serial.md index b577cfc..d51ef5a 100644 --- a/content/gettingstarted/programming/repl/serial.md +++ b/content/gettingstarted/programming/repl/serial.md @@ -30,7 +30,7 @@ Upon exiting `screen`, press `CTRL-A CTRL-\`. If the keyboard does not support t This will allow screen to exited by pressing `CTRL-A Q`. -{{{% hint style="info" %}}} +{{% hint style="info" %}} On Linux, `picocom` or `minicom` may be used instead of `screen`. The usb serial address might also be listed as `/dev/ttyUSB01` or a higher increment for `ttyUSB`. Additionally, the elevated permissions to access the device (e.g. group uucp/dialout or use `sudo`) may be required. {{< /hint >}} diff --git a/content/gettingstarted/programming/repl/telnet.md b/content/gettingstarted/programming/repl/telnet.md index 810e807..8b9dc8b 100644 --- a/content/gettingstarted/programming/repl/telnet.md +++ b/content/gettingstarted/programming/repl/telnet.md @@ -40,7 +40,7 @@ A terminal emulator is needed to open a telnet connection from Windows; the easi 2. Next enter the IP address of the Pycom device (e.g. `192.168.4.1`) 3. Finally click `Open` -{{{% hint style="info" %}}} +{{% hint style="info" %}} When using a Pycom device with a personal, home or office WiFi access point, the telnet connection may still be used. In this instance, the user will need to determine the Pycom device's local IP address and substitute this for `192.168.4.1`, referred to in the earlier sections. {{< /hint >}} diff --git a/content/gettingstarted/programming/safeboot.md b/content/gettingstarted/programming/safeboot.md index 8a27cf3..3b0116b 100644 --- a/content/gettingstarted/programming/safeboot.md +++ b/content/gettingstarted/programming/safeboot.md @@ -36,7 +36,7 @@ If problems occur within the filesystem or you wish to factory reset your module >>> os.mkfs('/flash') ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Be aware, resetting the flash filesystem will delete all files inside the internal device storage (not the SD card) and they cannot be recovered. {{< /hint >}} diff --git a/content/gettingstarted/registration/README.md b/content/gettingstarted/registration/README.md index 934f4c7..092807c 100644 --- a/content/gettingstarted/registration/README.md +++ b/content/gettingstarted/registration/README.md @@ -13,7 +13,7 @@ Some of our devices require registration before you can utilise specific feature [![](/gitbook/assets/image-1.png)](cellular) -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Not all Pycom devices require activation**; most features work immediately out of the box! {{< /hint >}} diff --git a/content/gettingstarted/registration/_index.md b/content/gettingstarted/registration/_index.md index f083320..aad0d36 100644 --- a/content/gettingstarted/registration/_index.md +++ b/content/gettingstarted/registration/_index.md @@ -12,7 +12,7 @@ Some of our devices require registration before you can utilise specific feature [![](/gitbook/assets/image-1.png)](cellular) -{{{% hint style="info" %}}} +{{% hint style="info" %}} **Not all Pycom devices require activation**; most features work immediately out of the box! {{< /hint >}} diff --git a/content/gettingstarted/registration/lora/README.md b/content/gettingstarted/registration/lora/README.md index 8284f44..1dc1a63 100644 --- a/content/gettingstarted/registration/lora/README.md +++ b/content/gettingstarted/registration/lora/README.md @@ -39,7 +39,7 @@ With ABP the encryption keys enabling communication with the network are preconf [![](//gitbook/assets/image-3.png)](objenious) -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you cannot find your favourite LoRaWAN network in the list above, please consider writing a tutorial for how to connect a Pycom module with it and contribute it to this documentation via a [GitHub pull request](https://github.com/pycom/pycom-documentation). {{< /hint >}} diff --git a/content/gettingstarted/registration/lora/_index.md b/content/gettingstarted/registration/lora/_index.md index a6fca13..497c89d 100644 --- a/content/gettingstarted/registration/lora/_index.md +++ b/content/gettingstarted/registration/lora/_index.md @@ -38,7 +38,7 @@ With ABP the encryption keys enabling communication with the network are preconf [![](//gitbook/assets/image-3.png)](objenious) -{{{% hint style="info" %}}} +{{% hint style="info" %}} If you cannot find your favourite LoRaWAN network in the list above, please consider writing a tutorial for how to connect a Pycom module with it and contribute it to this documentation via a [GitHub pull request](https://github.com/pycom/pycom-documentation). {{< /hint >}} diff --git a/content/gettingstarted/registration/sigfox.md b/content/gettingstarted/registration/sigfox.md index 7afe9c7..73c53a6 100644 --- a/content/gettingstarted/registration/sigfox.md +++ b/content/gettingstarted/registration/sigfox.md @@ -43,7 +43,7 @@ You should see green microchip if you entered correct _Sigfox ID_ and _Sigfox PA Then provide the required information including email address and complete registration. -{{{% hint style="info" %}}} +{{% hint style="info" %}} When registering your other devices (not your first device), you already have created Sigfox Account before. Be sure you are login with your Sigfox account. In that way all of your devices will be added to same Sigfox Account. {{< /hint >}} diff --git a/content/pybytes/connect/README.md b/content/pybytes/connect/README.md index ed28e12..4d64bcf 100644 --- a/content/pybytes/connect/README.md +++ b/content/pybytes/connect/README.md @@ -45,7 +45,7 @@ Select how you would like to connect your device to Pybytes: {{% refname "flash.md" %}} -{{{% hint style="info" %}}} +{{% hint style="info" %}} From firmware 1.16.x onwards all Pycom devices come with Pybytes library built-in `/frozen` folder. That means that you can choose between adding your device quickly with the firmware updater or you can flash Pybytes library manually. {{< /hint >}} diff --git a/content/pybytes/connect/_index.md b/content/pybytes/connect/_index.md index 409e3a6..44dc82f 100644 --- a/content/pybytes/connect/_index.md +++ b/content/pybytes/connect/_index.md @@ -44,7 +44,7 @@ Select how you would like to connect your device to Pybytes: {{% refname "flash.md" %}} -{{{% hint style="info" %}}} +{{% hint style="info" %}} From firmware 1.16.x onwards all Pycom devices come with Pybytes library built-in `/frozen` folder. That means that you can choose between adding your device quickly with the firmware updater or you can flash Pybytes library manually. {{< /hint >}} diff --git a/content/pybytes/connect/flash.md b/content/pybytes/connect/flash.md index 8994f84..3979452 100644 --- a/content/pybytes/connect/flash.md +++ b/content/pybytes/connect/flash.md @@ -9,7 +9,7 @@ aliases: In this section, we will explain to you how to connect your device to Pybytes by flashing Pybytes library manually. -{{{% hint style="info" %}}} +{{% hint style="info" %}} From firmware 1.16.x onwards all Pycom devices come with Pybytes library build-in `/frozen` folder. That means that you can add your device quickly without the need of flashing Pybytes library manually. [Click here for more information.](quick) {{< /hint >}} @@ -35,7 +35,7 @@ You can also download _Pybytes library_ at the device's settings page: ### Step 2. Flash your device with Pymakr -{{{% hint style="info" %}}} +{{% hint style="info" %}} In case you haven't installed Pymakr plugin, follow [these instructions](/../pymakr/installation/atom). {{< /hint >}} @@ -62,7 +62,7 @@ In case you haven't installed Pymakr plugin, follow [these instructions](/../pym After all Pybytes library files are uploaded to device, device will restart and will connect to Pybytes. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Pybytes library is written to `/flash` folder and will take precedence over build in firmware libraries in `/frozen` folder. {{< /hint >}} diff --git a/content/pybytes/connect/quick.md b/content/pybytes/connect/quick.md index f2d182e..fbd0a40 100644 --- a/content/pybytes/connect/quick.md +++ b/content/pybytes/connect/quick.md @@ -9,7 +9,7 @@ aliases: In this section, we explain to you how to connect your device to Pybytes quickly using the Firmware Updater. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In case you want to extend Pybytes library you can flash Pybytes library manually. [Click here for more information.](flash) {{< /hint >}} diff --git a/content/pybytes/connect/sigfox/README.md b/content/pybytes/connect/sigfox/README.md index 7b387c0..f53980a 100644 --- a/content/pybytes/connect/sigfox/README.md +++ b/content/pybytes/connect/sigfox/README.md @@ -3,7 +3,7 @@ title: "Add Sigfox device" aliases: - chapter/pybytes/connect/sigfox/sigfox --- -{{{% hint style="danger" %}}} +{{% 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**](/../../gettingstarted/registration/sigfox). {{< /hint >}} diff --git a/content/pybytes/connect/sigfox/_index.md b/content/pybytes/connect/sigfox/_index.md index 41f5ae1..532f81f 100644 --- a/content/pybytes/connect/sigfox/_index.md +++ b/content/pybytes/connect/sigfox/_index.md @@ -2,7 +2,7 @@ title: "Add Sigfox device" aliases: --- -{{{% hint style="danger" %}}} +{{% 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**](/../../gettingstarted/registration/sigfox). {{< /hint >}} diff --git a/content/pybytes/connect/sigfox/custom.md b/content/pybytes/connect/sigfox/custom.md index 0bc71d5..5292f6d 100644 --- a/content/pybytes/connect/sigfox/custom.md +++ b/content/pybytes/connect/sigfox/custom.md @@ -28,7 +28,7 @@ and select Sigfox device type which is associated with Sigfox custom contract. 1. Select Pybytes firmware 2. Paste your device token to firmware updater -{{{% hint style="info" %}}} +{{% hint style="info" %}} Detailed steps which are same for all devices are [**described here**](/quick). {{< /hint >}} diff --git a/content/pybytes/connect/sigfox/devkit.md b/content/pybytes/connect/sigfox/devkit.md index 2f2d3d9..33b3000 100644 --- a/content/pybytes/connect/sigfox/devkit.md +++ b/content/pybytes/connect/sigfox/devkit.md @@ -20,7 +20,7 @@ After you add your Sigfox credentials to Pybytes you can see DevKit contract typ 1. Select Pybytes firmware 2. Paste your device token to firmware updater -{{{% hint style="info" %}}} +{{% hint style="info" %}} Detailed steps which are same for all devices are [**described here**](/quick). {{< /hint >}} diff --git a/content/pybytes/dashboard.md b/content/pybytes/dashboard.md index 89c8c72..f21450b 100644 --- a/content/pybytes/dashboard.md +++ b/content/pybytes/dashboard.md @@ -7,7 +7,7 @@ aliases: --- In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes. -{{{% hint style="info" %}}} +{{% hint style="info" %}} We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](connect/). After your done with that, you can proceed to the next example. {{< /hint >}} @@ -46,7 +46,7 @@ _thread.start_new_thread(send_env_data, ()) 3. Upload the code into your device. Now your device is sending data to Pybytes. -{{{% hint style="info" %}}} +{{% hint style="info" %}} In this code, we're calling the function `pybytes.send_virtual_pin_value(persistent, pin, value))` to communicate with Pybytes. This function is part of the Pybytes library, and it has three arguments: `persistent`, `pin` and `value`. @@ -78,7 +78,7 @@ Go to Pybytes. ![](/gitbook/assets/05%20%281%29.png) -{{{% hint style="info" %}}} +{{% hint style="info" %}} The name and unit are labels used to identify your signal inside Pybytes (In this example we defined `Sinwave` as the name of the signal and `Rad` as the unit). The signal number has to match the pin number that you defined on `pybytes.send_virtual_pin_value` function call, inside your `main.py` code (In this example we defined `pin = 1`); diff --git a/content/pymakr/installation/atom.md b/content/pymakr/installation/atom.md index 0e75b72..639c763 100644 --- a/content/pymakr/installation/atom.md +++ b/content/pymakr/installation/atom.md @@ -63,7 +63,7 @@ After installing the Pymakr Plugin, you need to take a few seconds to configure These settings can also be applied on a per project basis by clicking `Settings` then `Project Settings`. This will open a JSON file which you can edit to enter your desired settings. -{{{% hint style="info" %}}} +{{% hint style="info" %}} This process is easiest with either a Pycom Expansion Board or a Pytrack/Pysense as the addresses are automatically selected. For external products such as FTDI USB Serial Cables, the serial address may need to be copied manually. Additionally, the reset button on the device may also need to be pressed before a connection message appears. {{< /hint >}} diff --git a/content/pymakr/installation/vscode.md b/content/pymakr/installation/vscode.md index 031481e..84fc217 100644 --- a/content/pymakr/installation/vscode.md +++ b/content/pymakr/installation/vscode.md @@ -67,7 +67,7 @@ After installing the Pymakr Plugin, you need to take a few seconds to configure These settings can also be applied on a per project basis by clicking `All commands` then `Pymakr > Project Settings`. This will open a JSON file which you can edit to enter your desired settings for the currently open project. -{{{% hint style="info" %}}} +{{% hint style="info" %}} This process is easiest with either a Pycom Expansion Board or a Pytrack/Pysense as the addresses are automatically selected. For external products such as FTDI USB Serial Cables, the serial address may need to be copied manually. Additionally, the reset button on the device may also need to be pressed before a connection message appears. {{< /hint >}} diff --git a/content/pymakr/toolsfeatures.md b/content/pymakr/toolsfeatures.md index 55dc614..8b1245c 100644 --- a/content/pymakr/toolsfeatures.md +++ b/content/pymakr/toolsfeatures.md @@ -26,7 +26,7 @@ The console can be used to run any python code, also functions or loops. Use `print()` to output contents of variables to the console for you to read. Returned values from functions will also be displayed if they are not caught in a variable. This will not happen for code running from the main or boot files. Here you need to use `print()` to output to the console. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Note that after writing or pasting any indented code like a function or a while loop, the user will have to press enter up to three times to tell MicroPython the code is to be closed (this is standard MicroPython & Python behaviour). Also be aware that code written into the REPL is not saved after the device is powered off/on again. @@ -36,7 +36,7 @@ Also be aware that code written into the REPL is not saved after the device is p To test code on a device, create a new `.py` file or open an existing one, type the desired code, save the file and then press the `Run` button. This will run the code directly onto the Pycom board and output the results of the script to the REPL. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Changes made to files won't be automatically uploaded to the board upon restarting or exiting the `Run` feature, as the Pycom board will not store this code. In order to push the code permanently to a device, use the `Upload` feature. {{< /hint >}} diff --git a/content/pytrackpysense/apireference/pyscan.md b/content/pytrackpysense/apireference/pyscan.md index 4106a13..2b5cd93 100644 --- a/content/pytrackpysense/apireference/pyscan.md +++ b/content/pytrackpysense/apireference/pyscan.md @@ -144,7 +144,7 @@ Prints the bytes in `data` array in hexadecimal format, separated by spaces usin * `data` The array to be printed * `len` The number of bytes to print -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Libraries GitHub repository](https://github.com/pycom/pycom-libraries) {{< /hint >}} diff --git a/content/pytrackpysense/apireference/pysense.md b/content/pytrackpysense/apireference/pysense.md index 4500aa2..e5170ae 100644 --- a/content/pytrackpysense/apireference/pysense.md +++ b/content/pytrackpysense/apireference/pysense.md @@ -105,7 +105,7 @@ The following arguments may be passed into the constructor. * mode: `PRESSURE`, `ALTITUDE` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Libraries GitHub repository](https://github.com/pycom/pycom-libraries) {{< /hint >}} diff --git a/content/pytrackpysense/apireference/pytrack.md b/content/pytrackpysense/apireference/pytrack.md index 604f834..023df3e 100644 --- a/content/pytrackpysense/apireference/pytrack.md +++ b/content/pytrackpysense/apireference/pytrack.md @@ -47,7 +47,7 @@ Creates a `L76GNSS` object, that will return values for longitude and latitude. Read the longitude and latitude from the `L76GNSS`. Returns a **tuple** with the longitude and latitude. With `debug` set to `True` the output from the GPS is verbose. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Libraries GitHub repository](https://github.com/pycom/pycom-libraries) {{< /hint >}} diff --git a/content/pytrackpysense/apireference/sleep.md b/content/pytrackpysense/apireference/sleep.md index 765f9e2..7946ee1 100644 --- a/content/pytrackpysense/apireference/sleep.md +++ b/content/pytrackpysense/apireference/sleep.md @@ -102,7 +102,7 @@ Enables as wakeup source, the INT pic (PIC - RC1, pin\#6 on External IO Header). Sets the sleep interval, specified in seconds. The actual sleep will be started by calling `go_to_sleep()` method. -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Libraries GitHub repository](https://github.com/pycom/pycom-libraries) {{< /hint >}} diff --git a/content/pytrackpysense/installation/firmware.md b/content/pytrackpysense/installation/firmware.md index 5d3d3b3..3360e24 100644 --- a/content/pytrackpysense/installation/firmware.md +++ b/content/pytrackpysense/installation/firmware.md @@ -107,7 +107,7 @@ To enter update mode follow these steps: $ dfu-util -D pytrack_0.0.8.dfu ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} You might need to run `dfu-util` as `sudo`. In that case, you will need to enter your password. {{< /hint >}} diff --git a/content/pytrackpysense/installation/libraries.md b/content/pytrackpysense/installation/libraries.md index 8fb534e..8a19b81 100644 --- a/content/pytrackpysense/installation/libraries.md +++ b/content/pytrackpysense/installation/libraries.md @@ -25,7 +25,7 @@ Add as many or as few of the libraries that are required. In addition to the Pysense or Pytrack specific libraries, you also need to upload the `pycoproc.py` file from the `_lib/pycoproc_` folder inside the libraries archive. -{{{% hint style="info" %}}} +{{% hint style="info" %}} The Pytrack and Pysense boards behave the same as the Expansion Board. `Upload`, `Run` and upload code to Pycom modules via the Pymakr Plugin, in exactly the same process. {{< /hint >}} diff --git a/content/search.md b/content/search.md new file mode 100644 index 0000000..cc3eeaa --- /dev/null +++ b/content/search.md @@ -0,0 +1,49 @@ +### Search results + +{{ results.searchInformation.totalResults }} results in {{ results.searchInformation.formattedSearchTime }} ms. + + + + + + +
+ +
diff --git a/content/tutorials/all/ota.md b/content/tutorials/all/ota.md index b22571a..f0f0b85 100644 --- a/content/tutorials/all/ota.md +++ b/content/tutorials/all/ota.md @@ -128,7 +128,7 @@ A MicroPyton library for interfacing with the server described above is availabl This library is split into two layers. The top level `OTA` class implements all the high level functionality such as parsing the JSON file, making back copies of files being updated incase the update fails, etc. The layer of the library is agnostic to your chosen transport method. Below this is the `WiFiOTA` class. This class implements the actual transport mechanism of how the device fetches the files and update manifest (via WiFi as the class name suggests). The reason for this split is so that the high level functionality can be reused regardless of what transport mechanism you end up using. This could be implemented on top of Bluetooth for example, or the sever changed from HTTP to FTP. -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} Although the above code is functional, it is provided only as an example of how an end user might implement a OTA update mechanism. It is not 100% feature complete e.g. even though it does backup previous versions of files, the roll back procedure is not implemented. This is left of the end user to do. {{< /hint >}} @@ -136,7 +136,7 @@ Although the above code is functional, it is provided only as an example of how Below is am example implementing the methodology previously explained in this tutorial to initiate an OTA update. -{{{% hint style="info" %}}} +{{% hint style="info" %}} The example below will only work on a Pycom device with LoRa capabilities. If want to test it out on a device without LoRa functionality then simply comment out any code relating to LoRa. Leaving just the `WiFiOTA` initialisation and they `ota.connect()` and `ota.update()` {{< /hint >}} diff --git a/content/tutorials/all/rmt.md b/content/tutorials/all/rmt.md index 61c6d58..64ed668 100644 --- a/content/tutorials/all/rmt.md +++ b/content/tutorials/all/rmt.md @@ -103,7 +103,7 @@ rmt.init(gpio="P21", rx_idle_threshold=1000) data = rmt.pulses_get() ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} If `tx_idle_level` is not set to the opposite of the third value in the `tx_carrier` tuple, the carrier wave will continue to be generated when the RMT channel is idle. {{< /hint >}} diff --git a/content/tutorials/all/timers.md b/content/tutorials/all/timers.md index 6a5f69b..edc7b3f 100644 --- a/content/tutorials/all/timers.md +++ b/content/tutorials/all/timers.md @@ -52,7 +52,7 @@ class Clock: clock = Clock() ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it's good practice to keep them short. More information can be found in [`Interrupt Handling`](/../firmwareapi/notes.md#interrupt-handling). {{< /hint >}} diff --git a/content/tutorials/all/wlan.md b/content/tutorials/all/wlan.md index 33c5247..53e187f 100644 --- a/content/tutorials/all/wlan.md +++ b/content/tutorials/all/wlan.md @@ -20,7 +20,7 @@ The current mode (`WLAN.AP` after power up) may be checked by running: >>> wlan.mode() ``` -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} When changing the WLAN mode, if following the instructions below, the WLAN connection to the Pycom device will be broken. This means commands will not run interactively over WiFi. @@ -73,7 +73,7 @@ if not wlan.isconnected(): machine.idle() # save power while waiting ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} Notice how we check for the reset cause and the connection status, this is crucial in order to be able to soft reset the LoPy during a telnet session without breaking the connection. {{< /hint >}} diff --git a/content/tutorials/lora/lora-mac-nano-gateway.md b/content/tutorials/lora/lora-mac-nano-gateway.md index d3ddfe8..82a5d2f 100644 --- a/content/tutorials/lora/lora-mac-nano-gateway.md +++ b/content/tutorials/lora/lora-mac-nano-gateway.md @@ -100,7 +100,7 @@ while(True): The node is always sending packages and waiting for the `ack` from the gateway. -{{{% hint style="info" %}}} +{{% hint style="info" %}} To adapt this code to user specific needs: * Put a max waiting time for the `ack` to arrive and resend the package or mark it as invalid diff --git a/content/tutorials/lora/lora-mesh.md b/content/tutorials/lora/lora-mesh.md index acca3a5..80c3f8f 100644 --- a/content/tutorials/lora/lora-mesh.md +++ b/content/tutorials/lora/lora-mesh.md @@ -28,7 +28,7 @@ This example shows how to: * sending packets to all neighbors * toggle LED as packet/ping is received. -{{{% hint style="info" %}}} +{{% hint style="info" %}} The LoRa-Mesh socket supports only the following socket methods: `close()`, `bind()`, `sendto()`, and `recvfrom()`. {{< /hint >}} diff --git a/content/tutorials/lora/lorawan-nano-gateway.md b/content/tutorials/lora/lorawan-nano-gateway.md index feb4456..f3a2c35 100644 --- a/content/tutorials/lora/lorawan-nano-gateway.md +++ b/content/tutorials/lora/lorawan-nano-gateway.md @@ -383,7 +383,7 @@ The `Gateway` should now be configured. Next, one or more nodes can now be confi There are two methods of connecting LoPy devices to the nano-gateway, Over the Air Activation (OTAA) and Activation By Personalisation (ABP). The code and instructions for registering these methods are shown below, followed by instruction for how to connect them to an application on TTN. -{{{% hint style="info" %}}} +{{% hint style="info" %}} It's important that the following code examples (also on GitHub) are used to connect to the nano-gateway as it only supports single channel connections. {{< /hint >}} diff --git a/content/tutorials/lte/cat-m1.md b/content/tutorials/lte/cat-m1.md index 2426be0..f15a050 100644 --- a/content/tutorials/lte/cat-m1.md +++ b/content/tutorials/lte/cat-m1.md @@ -5,7 +5,7 @@ aliases: - tutorials/lte/cat-m1.md - chapter/tutorials/lte/cat-m1 --- -{{{% hint style="info" %}}} +{{% hint style="info" %}} Please ensure you have the latest Sequans modem firmware for the best network compatibility. Instructions for this can be found [here](firmware). {{< /hint >}} diff --git a/content/tutorials/lte/firmware.md b/content/tutorials/lte/firmware.md index c22729e..51ba1c5 100644 --- a/content/tutorials/lte/firmware.md +++ b/content/tutorials/lte/firmware.md @@ -5,11 +5,11 @@ aliases: - tutorials/lte/firmware.md - chapter/tutorials/lte/firmware --- -{{{% hint style="info" %}}} +{{% hint style="info" %}} This article is only related to GPy, FiPy, and G01 boards {{< /hint >}} -{{{% hint style="danger" %}}} +{{% hint style="danger" %}} **Important**: When upgrading your modem for the first time, even if you have updated it in the past with the old firmware update method, you **MUST** use the "recovery" upgrade method described below. Otherwise you will risk breaking your module {{< /hint >}} @@ -104,7 +104,7 @@ SYSTEM VERSION ZSP1 : 1.0.99-12341 ``` -{{{% hint style="info" %}}} +{{% hint style="info" %}} After you have updated your modem once using the recovery method, you can now flash your modem again using just the `CATM1-38638.dup` or `NB1-37781.dup` file without specifying the `updater.elf` file. However, should the upgrade fail, your modem may end up in recovery mode and you will need the `updater.elf` file again. The updater will check for this and prompt you if using the `updater.elf` file is necessary. diff --git a/content/tutorials/lte/nb-iot.md b/content/tutorials/lte/nb-iot.md index f1e1499..41cdc5a 100644 --- a/content/tutorials/lte/nb-iot.md +++ b/content/tutorials/lte/nb-iot.md @@ -7,7 +7,7 @@ aliases: --- ## LTE class for Narrow Band IoT -{{{% hint style="info" %}}} +{{% hint style="info" %}} As shipped, Pycom modules only support CAT-M1, in order to use NB-IoT you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](firmware). {{< /hint >}} diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index eaa7021..6f7c323 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -63,8 +63,8 @@ drawer2: true, toc: 0, branches: [ - { value: 'https://docs.pycom.io', text: 'version stable', } , - { value: 'https://development.pycom.io', text: 'version development'} + { value: 'https://development.pycom.io', text: 'development version'}, + { value: 'https://docs.pycom.io', text: 'version stable', } ], branch: "" }, @@ -102,7 +102,7 @@ fetchResults (kw, start) { if (!start) { start = 1 } let key = "AIzaSyD4-MGytNzTCZpTH6UYk1mfOxZkt74T5MI"; - let cx = "004592132197158309932:anluf60c9w8"; + let cx = "004592132197158309932:jleutbge8gs"; let url = "https://www.googleapis.com/customsearch/v1"; url = url + "?cx=" + cx + "&key=" + key + "&q=" + encodeURI(kw) + "&start=" + start diff --git a/layouts/_default/list.html b/layouts/_default/list.html index e87d193..3469cf6 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -2,7 +2,7 @@ {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} -

{{- .Title -}}

+ {{ if .Title }}

{{- .Title -}}

{{ end }} {{- .Content -}} diff --git a/themes/doc-theme/layouts/partials/menu.html b/themes/doc-theme/layouts/partials/menu.html index 7a736f9..43bc128 100644 --- a/themes/doc-theme/layouts/partials/menu.html +++ b/themes/doc-theme/layouts/partials/menu.html @@ -5,7 +5,7 @@ class="lighten-4 pt-0" style="overflow-y: hidden; overflow-x: hidden;" > - + @@ -33,23 +33,10 @@ - -

- home Table of content + + home Table of content

{{ partial "menu_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} diff --git a/themes/doc-theme/layouts/partials/toolbar.html b/themes/doc-theme/layouts/partials/toolbar.html index 31faadb..5ebeba2 100644 --- a/themes/doc-theme/layouts/partials/toolbar.html +++ b/themes/doc-theme/layouts/partials/toolbar.html @@ -21,8 +21,8 @@ -

- +
+
{{- if gt .WordCount 400 -}} diff --git a/themes/doc-theme/static/css/doc-theme.css b/themes/doc-theme/static/css/doc-theme.css index dcf8559..3b4a7d5 100644 --- a/themes/doc-theme/static/css/doc-theme.css +++ b/themes/doc-theme/static/css/doc-theme.css @@ -88,16 +88,14 @@ p { .theme--dark.v-navigation-drawer:not(.v-navigation-drawer--floating) .v-navigation-drawer__border { background-color: transparent; } -/** this gives correct offset when link to anchors */ +/** this gives correct offset when link to anchors *[id]:before { display: block; content: " "; - margin-top: -75px; - height: 75px; visibility: hidden; + z-index: 0; } - - +*/ a, li.lefttree > a { text-decoration: none;