mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-21 06:06:03 +01:00
GitBook: [master] 23 pages modified
This commit is contained in:
Daniel Spindelbauer
committed by
gitbook-bot
gitbook-bot
parent
b9d6f7bce3
commit
dc208278d5
12
SUMMARY.md
12
SUMMARY.md
@@ -35,11 +35,11 @@
|
||||
|
||||
## Pymakr Plugin
|
||||
|
||||
* [Installation](pymakr/installation/README.md)
|
||||
* [Atom](pymakr/installation/atom.md)
|
||||
* [Visual Studio Code](pymakr/installation/vscode.md)
|
||||
* [Tools/Features](pymakr/features.md)
|
||||
* [Settings](pymakr/settings.md)
|
||||
* [Installation](pymakr-plugin/installation/README.md)
|
||||
* [Atom](pymakr-plugin/installation/atom.md)
|
||||
* [Visual Studio Code](pymakr-plugin/installation/vscode.md)
|
||||
* [Tools/Features](pymakr-plugin/features.md)
|
||||
* [Settings](pymakr-plugin/settings.md)
|
||||
|
||||
## Pytrack, Pysense, Pyscan
|
||||
|
||||
@@ -204,5 +204,5 @@
|
||||
## Have a question?
|
||||
|
||||
* [Ask on the Forum](https://forum.pycom.io)
|
||||
* [License](license.md)
|
||||
* [License](have-a-question/license.md)
|
||||
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
description: Available from 1.19.0.b4
|
||||
---
|
||||
|
||||
# Mesh Networks
|
||||
|
||||
Mesh Networking is currently under development. Please click [here](https://docs.pycom.io/v/development_release/chapter/tutorials/lora/lora-mesh.html) for the documentation. Please keep in mind that this document is still only informational.
|
||||
|
||||
@@ -36,7 +36,7 @@ print(wlan.ifconfig())
|
||||
|
||||
### class network.WLAN\(id=0, ...\)
|
||||
|
||||
Create a WLAN object, and optionally configure it. See init 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" %}
|
||||
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.
|
||||
@@ -52,15 +52,10 @@ Arguments are:
|
||||
|
||||
* `mode` can be either `WLAN.STA`, `WLAN.AP`, or `WLAN.STA_AP`.
|
||||
* `ssid` is a string with the SSID name. Only needed when mode is `WLAN.AP`.
|
||||
* `auth` is a tuple with \(sec, key\). Security can be `None`, `WLAN.WEP`, `WLAN.WPA`, or `WLAN.WPA2`. The key is a string with the network password. If `sec` is `WLAN.WEP` the key must be a string representing hexadecimal values \(e.g. `ABC1DE45BF`\). Only needed when mode is `WLAN.AP`.
|
||||
* `auth` is a tuple with \(sec, key\). Security can be `None`, `WLAN.WEP`, `WLAN.WPA`, or `WLAN.WPA2`. The key is a string with the network password.
|
||||
* If `sec` is `WLAN.WEP` the key must be a string representing hexadecimal values \(e.g. `ABC1DE45BF`\). Only needed when mode is `WLAN.AP`.
|
||||
* `channel` a number in the range 1-11. Only needed when mode is `WLAN.AP`.
|
||||
* `antenna` selects between the internal and the external antenna. Can be either
|
||||
|
||||
`WLAN.INT_ANT`, `WLAN.EXT_ANT`.
|
||||
|
||||
With our development boards it defaults to using the internal antenna, but in
|
||||
|
||||
the case of an OEM module, the antenna pin \(`P12`\) is not used, so it’s free to be
|
||||
* `antenna` selects between the internal and the external antenna. Can be either `WLAN.INT_ANT`, `WLAN.EXT_ANT`. With our development boards it defaults to using the internal antenna, but in the case of an OEM module, the antenna pin \(`P12`\) is not used, so it’s free to be
|
||||
|
||||
used for other things.
|
||||
|
||||
@@ -89,15 +84,19 @@ Disables the WiFi radio.
|
||||
|
||||
Connect to a wifi access point using the given SSID, and other security parameters.
|
||||
|
||||
* `auth` is a tuple with `(sec, key)`. Security can be `None`, `WLAN.WEP`, `WLAN.WPA`, `WLAN.WPA2` or `WLAN.WPA2_ENT`. The key is a string with the network password. If `sec` is `WLAN.WEP` the key must be a string representing hexadecimal values \(e.g. `ABC1DE45BF`\). If `sec` is `WLAN.WPA2_ENT` then the `auth` tuple can have either 3 elements: `(sec, username, password)`, or just 1: `(sec,)`. When passing the 3 element tuple, the`keyfile` and `certifle` arguments must not be given.
|
||||
* `auth` is a tuple with `(sec, key)`. Security can be `None`, `WLAN.WEP`, `WLAN.WPA`, `WLAN.WPA2` or `WLAN.WPA2_ENT`. The key is a string with the network password.
|
||||
* If `sec` is `WLAN.WEP` the key must be a string representing hexadecimal values \(e.g. `ABC1DE45BF`\).
|
||||
* If `sec` is `WLAN.WPA2_ENT` then the `auth` tuple can have either 3 elements: `(sec, username, password)`, or just 1: `(sec,)`. When passing the 3 element tuple, the`keyfile` and `certifle` arguments must not be given.
|
||||
* `bssid` is the MAC address of the AP to connect to. Useful when there are several APs with the same SSID.
|
||||
* `timeout` is the maximum time in milliseconds to wait for the connection to succeed.
|
||||
* `ca_certs` is the path to the CA certificate. This argument is not mandatory.
|
||||
|
||||
`keyfile` is the path to the client key. Only used if `username` and `password` are not part of the `auth` tuple.
|
||||
|
||||
* `keyfile` is the path to the client key. Only used if `username` and `password` are not part of the `auth` tuple.
|
||||
* `certfile` is the path to the client certificate. Only used if `username` and `password` are not part of the `auth` tuple.
|
||||
* `identity` is only used in case of `WLAN.WPA2_ENT` security.
|
||||
* `identity` is only used in case of `WLAN.WPA2_ENT` security. Needed by the server.
|
||||
|
||||
{% 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.
|
||||
{% endhint %}
|
||||
|
||||
### wlan.scan\(\)
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ RGB-Blink
|
||||
|
||||
For this example, you will just need to create a `main.py` file.
|
||||
|
||||
Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr/settings.md).
|
||||
Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr-plugin/settings.md).
|
||||
|
||||
## Controlling the on-board LED
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ In order to connect to the REPL over USB serial, there are multiple methods. Det
|
||||
|
||||
## All platforms
|
||||
|
||||
By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/).
|
||||
By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/).
|
||||
|
||||
## macOS and Linux
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ See [network.server](../../../firmware-and-api-reference/pycom/network/server.md
|
||||
|
||||
## All platforms
|
||||
|
||||
By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/).
|
||||
By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/).
|
||||
|
||||
## macOS and Linux
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms:
|
||||
|
||||
{% page-ref page="../../pymakr/installation/atom.md" %}
|
||||
{% page-ref page="../../pymakr-plugin/installation/atom.md" %}
|
||||
|
||||
{% page-ref page="../../pymakr/installation/vscode.md" %}
|
||||
{% page-ref page="../../pymakr-plugin/installation/vscode.md" %}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -38,3 +38,7 @@ The specsheet of the Expansion Board is available as a PDF File.
|
||||
|
||||
a Pycom module, the module will enter safe boot.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
* If PIC stays in bootloader mode, the [`dfu-util` update](../../pytrack-pysense-pyscan/installation/firmware.md) should be performed
|
||||
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
# Pycom Products
|
||||
|
||||
## Pycom Products
|
||||
|
||||
Below you will find tables of all Pycom products. These tables illustrate the functionality of our various products, their compatibility with each other, as well as what accessories are required to utilise certain functionality.
|
||||
|
||||
## Development Boards
|
||||
|
||||
| Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1NB-IoT |
|
||||
| :--- | :--- | :--- | :--- | :--- | :--- |
|
||||
| [WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | |
|
||||
| [ WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | |
|
||||
| [SiPy](product-info/development/sipy.md) | ✔ | ✔ | | ✔ | |
|
||||
| [GPy](product-info/development/gpy.md) | ✔ | ✔ | | | ✔ |
|
||||
| [LoPy](product-info/development/lopy.md) | ✔ | ✔ | ✔ | | |
|
||||
| [LoPy4](product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | |
|
||||
| [FiPy](product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ |
|
||||
| Antennas | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) |
|
||||
| Antennas | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) |
|
||||
|
||||
## Accessories
|
||||
|
||||
@@ -35,5 +37,3 @@ Below you will find tables of all Pycom products. These tables illustrate the fu
|
||||
| [L04](product-info/oem/l04.md) | | ✔ |
|
||||
| [G01](product-info/oem/g01.md) | | ✔ |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ You can also download _Pybytes library_ at the device's settings page:
|
||||
### Step 2. Flash your device with Pymakr
|
||||
|
||||
{% hint style="info" %}
|
||||
In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr/installation/atom.md).
|
||||
In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr-plugin/installation/atom.md).
|
||||
{% endhint %}
|
||||
|
||||
1. Connect your device to your computer with USB cable.
|
||||
|
||||
@@ -20,7 +20,7 @@ Before proceeding you will need:
|
||||
If your module is running the factory LTE chip firmware, you **MUST** first perform an update to the latest CAT-M1 firmware before trying to upgrade to the NB-IoT firmware. Skipping this step will cause your radio to become unresponsive and it will require access to the test points in order to re-flash the firmware.
|
||||
{% endhint %}
|
||||
|
||||
Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr/installation/)
|
||||
Firstly, you will need to download the required library files from [here](https://github.com/pycom/pycom-libraries/tree/master/lib/sqnsupgrade). You will need to place these in a directory called "lib" just like any other libraries. This can be done using either [FTP](../../getting-started/programming/ftp.md) or [Pymakr](../../pymakr-plugin/installation/)
|
||||
|
||||
Next you need to download the firmware file from [here](https://software.pycom.io/downloads/sequans.html). You will need to place the firmware on a FAT32 formatted microSD card, then insert the SD card into a Expansion Board, Pytrack, Pysense or Pyscan. Power-up the system and connect to the interactive REPL and run the following code:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user