mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-21 04:06:11 +01:00
initial commit
This commit is contained in:
@@ -70,7 +70,7 @@ optional arguments:
|
|||||||
|
|
||||||
## How to use the Parameters
|
## 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.
|
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]`
|
`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]
|
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.
|
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.
|
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
|
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`).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ You can obtain previous firmware versions here:
|
|||||||
* [FiPy](https://software.pycom.io/downloads/FiPy.html)
|
* [FiPy](https://software.pycom.io/downloads/FiPy.html)
|
||||||
* [LoPy4](https://software.pycom.io/downloads/LoPy4.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)).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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_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`)
|
* `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: on MicroPython interface, the method `pycom.ota_slot()` responds with the address of the next OTA partition available (either `0x10000` or `0x1A0000`).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -2,23 +2,22 @@
|
|||||||
title: ""
|
title: ""
|
||||||
aliases:
|
aliases:
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# datasheets
|
||||||
|
|
||||||
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
|
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
|
||||||
|
|
||||||
## Development Modules
|
## 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
|
## OEM modules
|
||||||
|
|
||||||
@@ -45,4 +44,3 @@ The follow pages contain all information relating to each product, for examples:
|
|||||||
{{% refname "boards/expansion2.md" %}}
|
{{% refname "boards/expansion2.md" %}}
|
||||||
|
|
||||||
{{% refname "boards/deepsleep/" %}}
|
{{% refname "boards/deepsleep/" %}}
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The pinout of the Expansion Board is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The pinout of the Expansion Board is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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)
|
* 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)
|
* 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the FiPy is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ aliases:
|
|||||||
- datasheets/development/gpy.html
|
- datasheets/development/gpy.html
|
||||||
- datasheets/development/gpy.md
|
- datasheets/development/gpy.md
|
||||||
- product-info/development/gpy
|
- product-info/development/gpy
|
||||||
|
- datasheets/development/gpy
|
||||||
- chapter/datasheets/development/gpy
|
- chapter/datasheets/development/gpy
|
||||||
---
|
---
|
||||||

|

|
||||||
@@ -20,7 +21,7 @@ The pinout of the GPy is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /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)
|
* [LTE CAT-M1](/../tutorials/lte/cat-m1)
|
||||||
* [NB-IoT](/../tutorials/lte/nb-iot)
|
* [NB-IoT](/../tutorials/lte/nb-iot)
|
||||||
* [BLE](/../tutorials/all/ble)
|
* [BLE](/../tutorials/all/ble)
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the LoPy is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the LoPy4 is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the SiPy is available as a PDF File
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the WiPy2 is available as a PDF File.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The pinout of the WiPy3 is available as a PDF File.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
---
|
---
|
||||||
title: "Introduction"
|
title: "Datasheets"
|
||||||
aliases:
|
aliases:
|
||||||
- datasheets/introduction.html
|
- datasheets/introduction.html
|
||||||
- datasheets/introduction.md
|
- datasheets/introduction.md
|
||||||
- product-info
|
- product-info
|
||||||
- chapter/datasheets
|
- chapter/datasheets
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
|
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
|
||||||
|
|
||||||
## Development Modules
|
## Development Modules
|
||||||
@@ -20,7 +22,7 @@ The follow pages contain all information relating to each product, for examples:
|
|||||||
|
|
||||||
{{% refname "development/sipy.md" %}}
|
{{% refname "development/sipy.md" %}}
|
||||||
|
|
||||||
{{% refname "development/gpy.md" %}}
|
{{% refname "development/gpy/" %}}
|
||||||
|
|
||||||
{{% refname "development/fipy.md" %}}
|
{{% 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/expansion2.md" %}}
|
||||||
|
|
||||||
{{% refname "boards/deepsleep/" %}}
|
{{% refname "boards/deepsleep/" %}}
|
||||||
|
|
||||||
|
|||||||
@@ -16,17 +16,17 @@ When powering via `VIN`:
|
|||||||
|
|
||||||
* The input voltage must be between `3.4V` and `5.5V`.
|
* 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.
|
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 >}}
|
{{< /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.
|
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.
|
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 >}}
|
||||||
|
|
||||||
{{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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" %}
|
{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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" %}
|
{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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" %}
|
{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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" %}
|
{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -94,7 +94,7 @@ The `constants` section of a library within the docs refers to specific values f
|
|||||||
I2C.MASTER()
|
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.
|
Be aware that you can only reference these constants upon importing and constructing a object from a library.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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).
|
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**
|
**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`.
|
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).
|
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**
|
**Difference to CPython**
|
||||||
|
|
||||||
CPython mandates more attributes for this object, but the actual useful bare minimum is implemented in MicroPython.
|
CPython mandates more attributes for this object, but the actual useful bare minimum is implemented in MicroPython.
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ This module implements conversions between binary data and various encodings of
|
|||||||
|
|
||||||
Convert binary data to hexadecimal representation. Returns bytes string.
|
Convert binary data to hexadecimal representation. Returns bytes string.
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
**Difference to CPython**
|
**Difference to CPython**
|
||||||
|
|
||||||
If additional argument, `sep` is supplied, it is used as a separator between hexadecimal values.
|
If additional argument, `sep` is supplied, it is used as a separator between hexadecimal values.
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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).
|
Module ustruct Standard Python way to access binary data structures (doesn't scale well to large and complex structures).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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)`
|
In the case of LoRa sockets, the address parameter is simply an integer with the port number, for instance: `s.bind(1)`
|
||||||
{{< /hint >}}
|
{{< /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.
|
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**
|
**Difference to CPython**
|
||||||
|
|
||||||
Closing the file object returned by `makefile()` **WILL** close the original socket as well.
|
Closing the file object returned by `makefile()` **WILL** close the original socket as well.
|
||||||
|
|||||||
@@ -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.
|
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`.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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**
|
**Difference to CPython**
|
||||||
|
|
||||||
This class is MicroPython extension. It's included on provisional basis and may be changed considerably or removed in later versions.
|
This class is MicroPython extension. It's included on provisional basis and may be changed considerably or removed in later versions.
|
||||||
|
|||||||
@@ -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.
|
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**.
|
Currently the interrupt system can queue up to **16 interrupts**.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
AES is implemented using the ESP32 hardware module.
|
||||||
{{< /hint >}}
|
{{< /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.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`
|
* `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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
Use `ubinascii.hexlify()` to convert the byte string to hexadecimal form for ease of manipulation and use elsewhere.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
Use `ubinascii.hexlify()` to convert the byte string to hexadecimal form for ease of manipulation and use elsewhere.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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)
|
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).
|
For more information on how Pycom's products handle interrupts, see [here](/../notes.md#interrupt-handling).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ The `tx_carrier` parameter is a tuple with the following structure:
|
|||||||
|
|
||||||
Deinitialise the RMT object.
|
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.
|
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 >}}
|
{{< /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.
|
* `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.
|
* `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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ For example:
|
|||||||
rtc.init((2017, 2, 28, 10, 30, 0, 0, 0))
|
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.
|
`tzinfo` is ignored by this method. Use `time.timezone` to achieve similar results.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
Make sure your SD card is formatted either as FAT16 or FAT32.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Enable the SD card.
|
|||||||
|
|
||||||
Disable 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
`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.
|
You can create as many of these objects as needed.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ class Clock:
|
|||||||
clock = 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).
|
For more information on how Pycom's products handle interrupts, see [notes](/../notes.md#interrupt-handling).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
On the GPy/FiPy UART2 is unavailable because it is used to communicate with the cellular radio.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ data = s.recv(64)
|
|||||||
print(data)
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ The arguments are:
|
|||||||
* `tx_retries` sets the number of TX retries in `LoRa.LORAWAN` mode.
|
* `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`.
|
* `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.
|
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 >}}
|
{{< /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).
|
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()`.
|
The LoRa-Mesh socket supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -451,7 +451,7 @@ Usage:
|
|||||||
s.bind(1)
|
s.bind(1)
|
||||||
```
|
```
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode.
|
The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -512,7 +512,7 @@ s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, False)
|
|||||||
s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, True)
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ data = s.recv(64)
|
|||||||
print(data)
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ The arguments are:
|
|||||||
* `tx_retries` sets the number of TX retries in `LoRa.LORAWAN` mode.
|
* `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`.
|
* `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.
|
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 >}}
|
{{< /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).
|
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()`.
|
The LoRa-Mesh socket supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -451,7 +451,7 @@ Usage:
|
|||||||
s.bind(1)
|
s.bind(1)
|
||||||
```
|
```
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode.
|
The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -512,7 +512,7 @@ s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, False)
|
|||||||
s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, True)
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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).
|
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()`.
|
The Pymesh sockets supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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-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.
|
* **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.
|
**Please note:** The GPy and FiPy only support the two protocols above and are not compatible with older LTE standards.
|
||||||
{{< /hint >}}
|
{{< /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).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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:
|
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]))
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -63,7 +63,7 @@ sigfox = Sigfox(mode=Sigfox.SIGFOX, rcz=Sigfox.RCZ1)
|
|||||||
sigfox = Sigfox(mode=Sigfox.FSK, frequency=912000000)
|
sigfox = Sigfox(mode=Sigfox.FSK, frequency=912000000)
|
||||||
```
|
```
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
`Sigfox.FSK` mode is not supported on LoPy 4 and FiPy.
|
`Sigfox.FSK` mode is not supported on LoPy 4 and FiPy.
|
||||||
{{< /hint >}}
|
{{< /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`.
|
* `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.
|
* `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`.
|
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 >}}
|
{{< /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.
|
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:
|
To return human-readable values you should import `ubinascii` and convert binary values to hexidecimal representation. For example:
|
||||||
|
|
||||||
```python
|
```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.
|
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.
|
`Sigfox.FSK` mode is not supported on LoPy 4 and FiPy.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -278,7 +278,7 @@ while True:
|
|||||||
print(s.recv(64))
|
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.)
|
Remember to use the correct frequency for your region (868 MHz for Europe, 912 MHz for USA, etc.)
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /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.
|
* `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
|
* `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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -40,13 +40,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -75,11 +75,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora/Sigfox
|
### 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.
|
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 >}}
|
||||||
|
|
||||||
{{{% 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.
|
The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
|
||||||
{{< /hint >}}
|
{{< /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
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /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
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do _not_ feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora
|
### 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.
|
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 >}}
|
||||||
|
|
||||||
{{{% 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.
|
The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora/Sigfox
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Sigfox
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
You can navigate through this guide using the arrow buttons at the bottom of the page.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora/Sigfox
|
### 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.
|
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 >}}
|
||||||
|
|
||||||
{{{% 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.
|
The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
|
||||||
{{< /hint >}}
|
{{< /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
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,13 +36,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /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
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -73,11 +73,11 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora
|
### 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.
|
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 >}}
|
||||||
|
|
||||||
{{{% 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.
|
The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,13 +36,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Lora/Sigfox
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,13 +36,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before
|
|||||||
|
|
||||||
### Sigfox
|
### 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,13 +36,13 @@ aliases:
|
|||||||
{% tab title="USB UART Adapter" %}
|
{% 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.
|
* 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.
|
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively.
|
* 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.
|
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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)
|
* [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)
|
* [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).
|
Previous versions of firmware are available for download [**here**](/../advance/downgrade).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ If you are having any issues, make sure the **TX and RX jumpers** are present on
|
|||||||
{% endtab %}
|
{% endtab %}
|
||||||
|
|
||||||
{% tab title=" Pysense/Pytrack/Pyscan/Expansion Board 3.0" %}
|
{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
You can navigate through this guide using the arrow buttons at the bottom of the page.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ pycom_devices = ('wipy', 'lopy', 'sipy', 'gpy', 'fipy')
|
|||||||
print(pycom_devices[0]) # expect 'wipy'
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
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:
|
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:
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -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.
|
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.
|
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.
|
The number of spaces in the indentation is variable but all statements within a block must be indented the same amount.
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ The REPL includes the following features:
|
|||||||
* Halt any executing code: with `Ctrl-C`
|
* Halt any executing code: with `Ctrl-C`
|
||||||
* Copy/paste code or output: `Ctrl-C` and `Ctrl-V`
|
* 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;
|
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.
|
* `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.
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ The REPL includes the following features:
|
|||||||
* Halt any executing code: with `Ctrl-C`
|
* Halt any executing code: with `Ctrl-C`
|
||||||
* Copy/paste code or output: `Ctrl-C` and `Ctrl-V`
|
* 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;
|
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.
|
* `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.
|
||||||
|
|||||||
@@ -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`.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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`)
|
2. Next enter the IP address of the Pycom device (e.g. `192.168.4.1`)
|
||||||
3. Finally click `Open`
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ If problems occur within the filesystem or you wish to factory reset your module
|
|||||||
>>> os.mkfs('/flash')
|
>>> 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Some of our devices require registration before you can utilise specific feature
|
|||||||
|
|
||||||
[](cellular)
|
[](cellular)
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
**Not all Pycom devices require activation**; most features work immediately out of the box!
|
**Not all Pycom devices require activation**; most features work immediately out of the box!
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ Some of our devices require registration before you can utilise specific feature
|
|||||||
|
|
||||||
[](cellular)
|
[](cellular)
|
||||||
|
|
||||||
{{{% hint style="info" %}}}
|
{{% hint style="info" %}}
|
||||||
**Not all Pycom devices require activation**; most features work immediately out of the box!
|
**Not all Pycom devices require activation**; most features work immediately out of the box!
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ With ABP the encryption keys enabling communication with the network are preconf
|
|||||||
|
|
||||||
[](objenious)
|
[](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).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ With ABP the encryption keys enabling communication with the network are preconf
|
|||||||
|
|
||||||
[](objenious)
|
[](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).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ Select how you would like to connect your device to Pybytes:
|
|||||||
|
|
||||||
{{% refname "flash.md" %}}
|
{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ Select how you would like to connect your device to Pybytes:
|
|||||||
|
|
||||||
{{% refname "flash.md" %}}
|
{{% 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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ You can also download _Pybytes library_ at the device's settings page:
|
|||||||
|
|
||||||
### Step 2. Flash your device with Pymakr
|
### 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).
|
In case you haven't installed Pymakr plugin, follow [these instructions](/../pymakr/installation/atom).
|
||||||
{{< /hint >}}
|
{{< /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.
|
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.
|
Pybytes library is written to `/flash` folder and will take precedence over build in firmware libraries in `/frozen` folder.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ aliases:
|
|||||||
|
|
||||||
In this section, we explain to you how to connect your device to Pybytes quickly using the Firmware Updater.
|
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)
|
In case you want to extend Pybytes library you can flash Pybytes library manually. [Click here for more information.](flash)
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: "Add Sigfox device"
|
|||||||
aliases:
|
aliases:
|
||||||
- chapter/pybytes/connect/sigfox/sigfox
|
- 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).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: "Add Sigfox device"
|
title: "Add Sigfox device"
|
||||||
aliases:
|
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).
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ and select Sigfox device type which is associated with Sigfox custom contract.
|
|||||||
1. Select Pybytes firmware
|
1. Select Pybytes firmware
|
||||||
2. Paste your device token to firmware updater
|
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).
|
Detailed steps which are same for all devices are [**described here**](/quick).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ After you add your Sigfox credentials to Pybytes you can see DevKit contract typ
|
|||||||
1. Select Pybytes firmware
|
1. Select Pybytes firmware
|
||||||
2. Paste your device token to firmware updater
|
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).
|
Detailed steps which are same for all devices are [**described here**](/quick).
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /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.
|
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`.
|
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.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{{{% 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 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`);
|
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`);
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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).
|
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.
|
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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -144,7 +144,7 @@ Prints the bytes in `data` array in hexadecimal format, separated by spaces usin
|
|||||||
* `data` The array to be printed
|
* `data` The array to be printed
|
||||||
* `len` The number of bytes to print
|
* `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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ The following arguments may be passed into the constructor.
|
|||||||
|
|
||||||
* mode: `PRESSURE`, `ALTITUDE`
|
* 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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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)
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -107,7 +107,7 @@ To enter update mode follow these steps:
|
|||||||
$ dfu-util -D pytrack_0.0.8.dfu
|
$ 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.
|
You might need to run `dfu-util` as `sudo`. In that case, you will need to enter your password.
|
||||||
{{< /hint >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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.
|
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 >}}
|
{{< /hint >}}
|
||||||
|
|
||||||
|
|||||||
49
content/search.md
Normal file
49
content/search.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
### Search results
|
||||||
|
|
||||||
|
{{ results.searchInformation.totalResults }} results in {{ results.searchInformation.formattedSearchTime }} ms.
|
||||||
|
|
||||||
|
<template v-if="results == null" >
|
||||||
|
<v-alert color="blue lighten-3" value=true icon="rowing">
|
||||||
|
no results.
|
||||||
|
</v-alert>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<template v-for="(item, index) in results.items">
|
||||||
|
<v-card class="ma-3" @click="navResult(item.formattedUrl)">
|
||||||
|
<v-card-title class="beba mb-0 pb-0">
|
||||||
|
<v-icon left>search</v-icon>
|
||||||
|
<span class="beba"> {{ item.title }}</span>
|
||||||
|
</v-card-title>
|
||||||
|
<v-card-text class=" pt-0 mt-0">
|
||||||
|
<p class="ppurple text--lighten-3 mt-0 pt-0" style="text-decoration: underline;">{{ item.formattedUrl }}</p>
|
||||||
|
<v-layout>
|
||||||
|
<v-flex v-if="item.pagemap.cse_image">
|
||||||
|
<v-img
|
||||||
|
ma-4
|
||||||
|
contain
|
||||||
|
aspect-ratio=1
|
||||||
|
v-if="item.pagemap.cse_image"
|
||||||
|
:src="item.pagemap.cse_image && item.pagemap.cse_image[0].src">
|
||||||
|
</v-img>
|
||||||
|
</v-flex>
|
||||||
|
<v-flex class="pl-4">
|
||||||
|
<span v-html="item.htmlSnippet"></span>
|
||||||
|
</v-flex>
|
||||||
|
</v-layout>
|
||||||
|
</v-card-text>
|
||||||
|
</v-card>
|
||||||
|
|
||||||
|
|
||||||
|
</template>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="text-xs-center">
|
||||||
|
<v-pagination
|
||||||
|
v-model="page"
|
||||||
|
color="#1E1E3C"
|
||||||
|
@input="pageClicked"
|
||||||
|
@previous="pageClicked($event)"
|
||||||
|
@next="pageClicked($event)"
|
||||||
|
:length="pageCount"
|
||||||
|
></v-pagination>
|
||||||
|
</div>
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user