sascha_hemi/pycom-documentation
1
0
Fork 0
mirror of https://github.com/sascha-hemi/pycom-documentation.git synced 2026-03-21 04:06:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

manual rework

Browse Source
This commit is contained in:
Emmanuel Florent
2019-06-25 17:22:42 +02:00
parent 6fa6c1c675
commit b192705aee
351 changed files with 1062567 additions and 7169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.DS_Store vendored
View File

Binary file not shown.

220
.gitbook.yaml
View File

@@ -1,220 +0,0 @@
root: ./
structure:
readme: README.md
summary: SUMMARY.md
redirects:
chapter/products: ./products.md
chapter/gettingstarted: ./gettingstarted/introduction.md
getting-started: ./gettingstarted/introduction.md
getting-started/introduction: ./gettingstarted/introduction.md
chapter/gettingstarted/introduction: ./gettingstarted/introduction.md
chapter/gettingstarted/hardwaresetup: ./gettingstarted/connection/README.md
chapter/gettingstarted/connection/lopy: ./gettingstarted/connection/lopy.md
chapter/gettingstarted/connection/lopy4: ./gettingstarted/connection/lopy4.md
chapter/gettingstarted/connection/sipy: ./gettingstarted/connection/sipy.md
chapter/gettingstarted/connection/gpy: ./gettingstarted/connection/gpy.md
chapter/gettingstarted/connection/fipy: ./gettingstarted/connection/fipy.md
chapter/gettingstarted/connection/wipy: ./gettingstarted/connection/wipy.md
chapter/gettingstarted/installation/installingsoftware: ./gettingstarted/installation/README.md
chapter/gettingstarted/installation/drivers: ./gettingstarted/installation/drivers.md
chapter/gettingstarted/installation/firmwaretool: ./gettingstarted/installation/firmwaretool.md
chapter/gettingstarted/installation/pymakr: ./gettingstarted/installation/pymakr.md
chapter/gettingstarted/programming: ./gettingstarted/programming/README.md
chapter/gettingstarted/programming/micropython: ./gettingstarted/programming/micropython.md
chapter/gettingstarted/programming/examples: ./gettingstarted/programming/examples.md
chapter/gettingstarted/programming/first-project: ./gettingstarted/programming/first-project.md
chapter/gettingstarted/programming/repl: ./gettingstarted/programming/repl/README.md
chapter/gettingstarted/programming/repl/serial: ./gettingstarted/programming/repl/serial.md
chapter/gettingstarted/programming/repl/telnet: ./gettingstarted/programming/repl/telnet.md
chapter/gettingstarted/programming/ftp: ./gettingstarted/programming/ftp.md
chapter/gettingstarted/programming/safeboot: ./gettingstarted/programming/safeboot.md
chapter/gettingstarted/registration/README: ./gettingstarted/registration/README.md
chapter/gettingstarted/registration/sigfox: ./gettingstarted/registration/sigfox.md
chapter/gettingstarted/registration/cellular: ./gettingstarted/registration/cellular.md
chapter/gettingstarted/registration/lora: ./gettingstarted/registration/lora/README.md
chapter/gettingstarted/registration/lora/ttn: ./gettingstarted/registration/lora/ttn.md
chapter/gettingstarted/registration/lora/objenious: ./gettingstarted/registration/lora/objenious.md
chapter/pymakr/installation: ./pymakr/installation/README.md
chapter/pymakr/installation/atom: ./pymakr/installation/atom.md
chapter/pymakr/installation/vscode: ./pymakr/installation/vscode.md
chapter/pymakr/toolsfeatures: ./pymakr/toolsfeatures.md
chapter/pymakr/settings: ./pymakr/settings.md
chapter/pytrackpysense: ./pytrackpysense/introduction.md
chapter/pytrackpysense/installation: ./pytrackpysense/installation/README.md
chapter/pytrackpysense/installation/firmware: ./pytrackpysense/installation/firmware.md
chapter/pytrackpysense/installation/drivers: ./pytrackpysense/installation/drivers.md
chapter/pytrackpysense/installation/libraries: ./pytrackpysense/installation/libraries.md
chapter/pytrackpysense/apireference: ./pytrackpysense/apireference/README.md
chapter/pytrackpysense/apireference/pytrack: ./pytrackpysense/apireference/pytrack.md
chapter/pytrackpysense/apireference/pysense: ./pytrackpysense/apireference/pysense.md
chapter/pytrackpysense/apireference/pyscan: ./pytrackpysense/apireference/pyscan.md
chapter/pytrackpysense/apireference/sleep: ./pytrackpysense/apireference/sleep.md
chapter/tutorials: ./tutorials/introduction.md
chapter/tutorials/all: ./tutorials/all/README.md
chapter/tutorials/all/repl: ./tutorials/all/repl.md
chapter/tutorials/all/wlan: ./tutorials/all/wlan.md
chapter/tutorials/all/ble: ./tutorials/all/ble.md
chapter/tutorials/all/https: ./tutorials/all/https.md
chapter/tutorials/all/mqtt: ./tutorials/all/mqtt.md
chapter/tutorials/all/aws: ./tutorials/all/aws.md
chapter/tutorials/all/adc: ./tutorials/all/adc.md
chapter/tutorials/all/i2c: ./tutorials/all/i2c.md
chapter/tutorials/all/owd: ./tutorials/all/owd.md
chapter/tutorials/all/threading: ./tutorials/all/threading.md
chapter/tutorials/all/rgbled: ./tutorials/all/rgbled.md
chapter/tutorials/all/timers: ./tutorials/all/timers.md
chapter/tutorials/all/pir: ./tutorials/all/pir.md
chapter/tutorials/all/modbus: ./tutorials/all/modbus.md
chapter/tutorials/all/ota: ./tutorials/all/ota.md
chapter/tutorials/all/rmt: ./tutorials/all/rmt.md
chapter/tutorials/all/socket: ./tutorials/all/socket.md
chapter/tutorials/lora: ./tutorials/lora/README.md
chapter/tutorials/lora/lora-mac: ./tutorials/lora/lora-mac.md
chapter/tutorials/lora/lorawan-otaa: ./tutorials/lora/lorawan-otaa.md
chapter/tutorials/lora/lorawan-abp: ./tutorials/lora/lorawan-abp.md
chapter/tutorials/lora/lora-mac-nano-gateway: ./tutorials/lora/lora-mac-nano-gateway.md
chapter/tutorials/lora/module-module: ./tutorials/lora/module-module.md
chapter/tutorials/lora/lorawan-nano-gateway: ./tutorials/lora/lorawan-nano-gateway.md
chapter/tutorials/lora/rn2483-to-lopy: ./tutorials/lora/rn2483-to-lopy.md
chapter/tutorials/lora/lora-mesh: ./tutorials/lora/lora-mesh.md
chapter/tutorials/sigfox: ./tutorials/sigfox.md
chapter/tutorials/lte: ./tutorials/lte/README.md
chapter/tutorials/lte/cat-m1: ./tutorials/lte/cat-m1.md
chapter/tutorials/lte/nb-iot: ./tutorials/lte/nb-iot.md
chapter/tutorials/lte/imei: ./tutorials/lte/imei.md
chapter/tutorials/lte/firmware: ./tutorials/lte/firmware.md
chapter/tutorials/pytrack: ./tutorials/pytrack.md
chapter/tutorials/pysense: ./tutorials/pysense.md
chapter/tutorials/pyscan: ./tutorials/pyscan.md
chapter/firmwareapi: ./firmwareapi/introduction.md
chapter/firmwareapi/pycom: ./firmwareapi/pycom/README.md
chapter/firmwareapi/pycom/machine: ./firmwareapi/pycom/machine/README.md
chapter/firmwareapi/pycom/machine/adc: ./firmwareapi/pycom/machine/adc.md
chapter/firmwareapi/pycom/machine/dac: ./firmwareapi/pycom/machine/dac.md
chapter/firmwareapi/pycom/machine/i2c: ./firmwareapi/pycom/machine/i2c.md
chapter/firmwareapi/pycom/machine/pin: ./firmwareapi/pycom/machine/pin.md
chapter/firmwareapi/pycom/machine/pwm: ./firmwareapi/pycom/machine/pwm.md
chapter/firmwareapi/pycom/machine/rtc: ./firmwareapi/pycom/machine/rtc.md
chapter/firmwareapi/pycom/machine/spi: ./firmwareapi/pycom/machine/spi.md
chapter/firmwareapi/pycom/machine/uart: ./firmwareapi/pycom/machine/uart.md
chapter/firmwareapi/pycom/machine/wdt: ./firmwareapi/pycom/machine/wdt.md
chapter/firmwareapi/pycom/machine/timer: ./firmwareapi/pycom/machine/timer.md
chapter/firmwareapi/pycom/machine/sd: ./firmwareapi/pycom/machine/sd.md
chapter/firmwareapi/pycom/machine/can: ./firmwareapi/pycom/machine/can.md
chapter/firmwareapi/pycom/machine/rmt: ./firmwareapi/pycom/machine/rmt.md
chapter/firmwareapi/pycom/network: ./firmwareapi/pycom/network/README.md
chapter/firmwareapi/pycom/network/wlan: ./firmwareapi/pycom/network/wlan.md
chapter/firmwareapi/pycom/network/server: ./firmwareapi/pycom/network/server.md
chapter/firmwareapi/pycom/network/bluetooth: ./firmwareapi/pycom/network/bluetooth/README.md
chapter/firmwareapi/pycom/network/bluetooth/gatt: ./firmwareapi/pycom/network/bluetooth/gatt.md
chapter/firmwareapi/pycom/network/bluetooth/gattcconnection: ./firmwareapi/pycom/network/bluetooth/gattcconnection.md
chapter/firmwareapi/pycom/network/bluetooth/gattccservice: ./firmwareapi/pycom/network/bluetooth/gattccservice.md
chapter/firmwareapi/pycom/network/bluetooth/gattccharacteristic: ./firmwareapi/pycom/network/bluetooth/gattccharacteristic.md
chapter/firmwareapi/pycom/network/bluetooth/gattsservice: ./firmwareapi/pycom/network/bluetooth/gattsservice.md
chapter/firmwareapi/pycom/network/bluetooth/gattscharacteristic: ./firmwareapi/pycom/network/bluetooth/gattscharacteristic.md
chapter/firmwareapi/pycom/network/lora: ./firmwareapi/pycom/network/lora.md
chapter/firmwareapi/pycom/network/sigfox: ./firmwareapi/pycom/network/sigfox.md
chapter/firmwareapi/pycom/network/lte: ./firmwareapi/pycom/network/lte.md
chapter/firmwareapi/pycom/aes: ./firmwareapi/pycom/aes.md
chapter/firmwareapi/pycom/pycom: ./firmwareapi/pycom/pycom.md
chapter/firmwareapi/micropython: ./firmwareapi/micropython/README.md
chapter/firmwareapi/micropython/micropython: ./firmwareapi/micropython/micropython.md
chapter/firmwareapi/micropython/uctypes: ./firmwareapi/micropython/uctypes.md
chapter/firmwareapi/micropython/sys: ./firmwareapi/micropython/sys.md
chapter/firmwareapi/micropython/uos: ./firmwareapi/micropython/uos.md
chapter/firmwareapi/micropython/array: ./firmwareapi/micropython/array.md
chapter/firmwareapi/micropython/cmath: ./firmwareapi/micropython/cmath.md
chapter/firmwareapi/micropython/math: ./firmwareapi/micropython/math.md
chapter/firmwareapi/micropython/gc: ./firmwareapi/micropython/gc.md
chapter/firmwareapi/micropython/ubinascii: ./firmwareapi/micropython/ubinascii.md
chapter/firmwareapi/micropython/ujson: ./firmwareapi/micropython/ujson.md
chapter/firmwareapi/micropython/ure: ./firmwareapi/micropython/ure.md
chapter/firmwareapi/micropython/usocket: ./firmwareapi/micropython/usocket.md
chapter/firmwareapi/micropython/select: ./firmwareapi/micropython/select.md
chapter/firmwareapi/micropython/utime: ./firmwareapi/micropython/utime.md
chapter/firmwareapi/micropython/uhashlib: ./firmwareapi/micropython/uhashlib.md
chapter/firmwareapi/micropython/ussl: ./firmwareapi/micropython/ussl.md
chapter/firmwareapi/micropython/ucrypto: ./firmwareapi/micropython/ucrypto.md
chapter/firmwareapi/micropython/ustruct: ./firmwareapi/micropython/ustruct.md
chapter/firmwareapi/micropython/uzlib: ./firmwareapi/micropython/uzlib.md
chapter/firmwareapi/micropython/_thread: ./firmwareapi/micropython/_thread.md
chapter/firmwareapi/micropython/builtin: ./firmwareapi/micropython/builtin.md
chapter/firmwareapi/notes: ./firmwareapi/notes.md
product-info: ./datasheets/introduction.md
product-info/development: ./datasheets/development/README.md
product-info/development/wipy2: ./datasheets/development/wipy2.md
product-info/development/wipy3: ./datasheets/development/wipy3.md
product-info/development/lopy: ./datasheets/development/lopy.md
product-info/development/lopy4: ./datasheets/development/lopy4.md
product-info/development/sipy: ./datasheets/development/sipy.md
product-info/development/gpy: ./datasheets/development/gpy.md
product-info/development/fipy: ./datasheets/development/fipy.md
product-info/oem: ./datasheets/oem/README.md
product-info/oem/w01: ./datasheets/oem/w01.md
product-info/oem/l01: ./datasheets/oem/l01.md
product-info/oem/l04: ./datasheets/oem/l04.md
product-info/oem/g01: ./datasheets/oem/g01.md
product-info/oem/l01_reference: ./datasheets/oem/l01_reference.md
product-info/oem/universal_reference: ./datasheets/oem/universal_reference.md
product-info/boards: ./datasheets/boards/README.md
product-info/boards/expansion3: ./datasheets/boards/expansion3.md
product-info/boards/pytrack: ./datasheets/boards/pytrack.md
product-info/boards/pysense: ./datasheets/boards/pysense.md
product-info/boards/pyscan: ./datasheets/boards/pyscan.md
product-info/boards/expansion2: ./datasheets/boards/expansion2.md
product-info/boards/deepsleep: ./datasheets/boards/deepsleep/README.md
product-info/boards/deepsleep/api: ./datasheets/boards/deepsleep/api.md
product-info/notes: ./datasheets/notes.md
chapter/datasheets: ./datasheets/introduction.md
chapter/datasheets/development: ./datasheets/development/README.md
chapter/datasheets/development/wipy2: ./datasheets/development/wipy2.md
chapter/datasheets/development/wipy3: ./datasheets/development/wipy3.md
chapter/datasheets/development/lopy: ./datasheets/development/lopy.md
chapter/datasheets/development/lopy4: ./datasheets/development/lopy4.md
chapter/datasheets/development/sipy: ./datasheets/development/sipy.md
chapter/datasheets/development/gpy: ./datasheets/development/gpy.md
chapter/datasheets/development/fipy: ./datasheets/development/fipy.md
chapter/datasheets/oem: ./datasheets/oem/README.md
chapter/datasheets/oem/w01: ./datasheets/oem/w01.md
chapter/datasheets/oem/l01: ./datasheets/oem/l01.md
chapter/datasheets/oem/l04: ./datasheets/oem/l04.md
chapter/datasheets/oem/g01: ./datasheets/oem/g01.md
chapter/datasheets/oem/l01_reference: ./datasheets/oem/l01_reference.md
chapter/datasheets/oem/universal_reference: ./datasheets/oem/universal_reference.md
chapter/datasheets/boards: ./datasheets/boards/README.md
chapter/datasheets/boards/expansion3: ./datasheets/boards/expansion3.md
chapter/datasheets/boards/pytrack: ./datasheets/boards/pytrack.md
chapter/datasheets/boards/pysense: ./datasheets/boards/pysense.md
chapter/datasheets/boards/pyscan: ./datasheets/boards/pyscan.md
chapter/datasheets/boards/expansion2: ./datasheets/boards/expansion2.md
chapter/datasheets/boards/deepsleep: ./datasheets/boards/deepsleep/README.md
chapter/datasheets/boards/deepsleep/api: ./datasheets/boards/deepsleep/api.md
chapter/datasheets/notes: ./datasheets/notes.md
chapter/pybytes: ./pybytes/introduction.md
chapter/pybytes/getstarted/intro: ./pybytes/getstarted.md
chapter/pybytes/connect/intro: ./pybytes/connect/README.md
chapter/pybytes/connect/quick: ./pybytes/connect/quick.md
chapter/pybytes/connect/flash: ./pybytes/connect/flash.md
chapter/pybytes/connect/sigfox/sigfox: ./pybytes/connect/sigfox/README.md
chapter/pybytes/connect/sigfox/sigfoxDevKit: ./pybytes/connect/sigfox/devkit.md
chapter/pybytes/connect/sigfox/sigfoxCustomContract: ./pybytes/connect/sigfox/custom.md
chapter/pybytes/dashboard/intro: ./pybytes/dashboard.md
chapter/docnotes: ./docnotes/introduction.md
chapter/docnotes/syntax: ./docnotes/syntax.md
chapter/docnotes/replscript: ./docnotes/replscript.md
chapter/docnotes/mesh-networks: ./docnotes/mesh-networks.md
chapter/advance/downgrade: ./advance/downgrade.md
chapter/advance/cli: ./advance/cli.md
chapter/advance/encryption: ./advance/encryption.md

58
404.txt
View File

@@ -1,58 +0,0 @@
http://localhost:1313/pybytes/dashboard/connect/
http://localhost:1313/firmwareapi/pycom/network/lora/lora.md
http://localhost:1313/tutorials/lte/nb-iot/firmware
http://localhost:1313/pybytes/introduction/dashboard
http://localhost:1313/firmwareapi/pycom/machine/pin/pin.md
http://localhost:1313/gettingstarted/introduction/connection/
http://localhost:1313/gettingstarted/introduction/installation/
http://localhost:1313/pybytes/introduction/getstarted
http://localhost:1313/pybytes/introduction/integrations/
http://localhost:1313/products/datasheets/boards/pytrack.md
http://localhost:1313/firmwareapi/micropython/ustruct/uzlib/
http://localhost:1313/firmwareapi/pycom/network/wlan/wlan.md
http://localhost:1313/pybytes/introduction/connect/
http://localhost:1313/advance/downgrade/cli.md
http://localhost:1313/development/wipy2
http://localhost:1313/products/datasheets/development/wipy3
http://localhost:1313/getting-started/hardwaresetup/readme/wipy
http://localhost:1313/quick
http://localhost:1313/firmwareapi/notes/pycom/machine/timer.md
http://localhost:1313/products/datasheets/oem/g01
http://localhost:1313/tutorials/pytrack/pysense
http://localhost:1313/products/datasheets/development/lopy4
http://localhost:1313/firmwareapi/micropython/builtin/builtin
http://localhost:1313/advance/downgrade/cli
http://localhost:1313/gettingstarted/introduction/registration/
http://localhost:1313/gitbook/assets/lopy%20%282%29.png
http://localhost:1313/pybytes/connect/flash/quick
http://localhost:1313/products/datasheets/development/fipy
http://localhost:1313/boards/deepsleep/
http://localhost:1313/firmwareapi/notes/pycom/machine/pin
http://localhost:1313/products/datasheets/oem/w01
http://localhost:1313/datasheets/development/wipy2/wipy3
http://localhost:1313/datasheets/oem/l01_reference/universal_reference
http://localhost:1313/products/datasheets/boards/expansion3.md
http://localhost:1313/notes.md
http://localhost:1313/gettingstarted/introduction/programming/
http://localhost:1313/tutorials/lte/cat-m1/firmware
http://localhost:1313/getting-started/hardwaresetup/readme/lopy
http://localhost:1313/products/datasheets/oem/l01
http://localhost:1313/products/datasheets/oem/l04
http://localhost:1313/products/datasheets/oem/universal_reference
http://localhost:1313/pybytes/connect/quick/flash
http://localhost:1313/introduction
http://localhost:1313/products/datasheets/development/sipy
http://localhost:1313/firmwareapi/pycom/machine/sd/sd.md
http://localhost:1313/products/datasheets/boards/pysense.md
http://localhost:1313/products/datasheets/development/gpy
http://localhost:1313/getting-started/hardwaresetup/readme/lopy4
http://localhost:1313/products/datasheets/development/lopy
http://localhost:1313/firmwareapi/pycom/network/lora.md
http://localhost:1313/products/datasheets/boards/pyscan.md
http://localhost:1313/products/datasheets/oem/l01_reference
http://localhost:1313/firmwareapi/micropython/usocket/usocket.md
http://localhost:1313/pycom/aes
FINISHED --2019-06-17 14:18:41--
Total wall clock time: 2.2s
Downloaded: 250 files, 7.8M in 0.08s (96.7 MB/s)

54
README.md
View File

@@ -1,43 +1,41 @@
# local visualization
# run locally
.md files are in the content folder, the theme forlder contains the theme.
install Hugo and run it on the current directory.
```
brew install hugo
hugo serve
```
The file config.toml contains the global .toml
# Workflow
# First generation of publish branch
- Make PR using Master branch
- PR get merged on master
- Then merge publish with master
Some commands that have been used for building:
- ```
# it clone gh-pages in ./tmp/ and appy all .md files
./reclone.sh
# generate toc, title, redirects
python3 migration.py
# apply this changes to remove remaining not needed slashes protections
rpl -R '\)' ')' *
rpl -R '(' '(' *
# use carrefully but there should be not .html in content
# find "./content/" -name "*.html" -exec rm {} \;
# then finally fix link self to images
rpl -R "gitbook/assets/" "gitbook/assets/" *
rpl -R "../gitbook/assets" "/gitbook/assets" content
rpl -R "..//gitbook/assets" "/gitbook/assets" content
rpl -R "’" "'" content
rpl -R "✔" "✔" content
rpl -R "(../" "(/"
# get the images in static
cp tmp/pydocs/gitbook/assets/* static/gitbook/assets/
```
git commit -m "section: commit message"
git push origin master
git checkout publish
git merge master
git push origin publish
```
# some infos:
- assets are in ./static directory, a directory aliased at /
- css in /themes/doc-theme/static/doc-theme.css
- SUMMARY.md is in config.toml
# help
- gohugo.io
# detect broken links
```
wget -o 404.txt -r --spider http://localhost:1313
cat ~/output.txt | grep -B 7 404 | grep "\-\-20"
```
A webhook has been installed on the publish branch to:
- https://publish.d1rmdw1xyxqk1e.amplifyapp.com/

8
config.toml
View File

@@ -1,4 +1,4 @@
baseURL = "http://localhost:1313/"
baseURL = "https://development.pycom.io/"
languageCode = "en-us"
title = "documentation"
uglyurls = false
@@ -951,8 +951,8 @@ theme = "doc-theme"
[[menu.main]]
name = "uzlib"
url = "/firmwareapi/micropython/ustruct/uzlib/"
identifier = "firmwareapi@micropython@ustruct@uzlib"
url = "/firmwareapi/micropython/uzlib/"
identifier = "firmwareapi@micropython@uzlib"
parent = "firmwareapi@micropython@ustruct"
weight = 10
@@ -993,7 +993,7 @@ theme = "doc-theme"
[[menu.main]]
name = "WiPy 2.0"
url = "development/wipy2"
url = "/datasheets/development/wipy2/"
identifier = "datasheets@development@wipy2"
parent = "datasheets@development"
weight = 10

BIN
content/.DS_Store vendored
View File

Binary file not shown.

15
content/README.md
View File

@@ -1,15 +0,0 @@
---
title: "Introduction"
aliases:
---
Welcome to the Pycom documentation site. We recommend reading through all the sections to familiarise yourself with the various tools and features available to you to help you develop on your Pycom module.
To get started, read through the Getting Started guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects.
* [Products](products)
* [Getting Started](gettingstarted/introduction)
* [Tutorials](tutorials/introduction)
* [Product Info](datasheets/introduction)
* [API Documentation](firmwareapi/introduction)
* [Pybytes](pybytes/introduction)

221
content/SUMMARY.md
View File

@@ -1,221 +0,0 @@
---
title: ""
aliases:
- SUMMARY.html
- SUMMARY.md
---
* [Introduction](README)
* [Pycom Products](products)
## Getting Started
* [Introduction](gettingstarted/introduction)
* [Hardware Setup](gettingstarted/connection/README)
* [LoPy](gettingstarted/connection/lopy)
* [LoPy 4](gettingstarted/connection/lopy4)
* [SiPy](gettingstarted/connection/sipy)
* [GPy](gettingstarted/connection/gpy)
* [FiPy](gettingstarted/connection/fipy)
* [WiPy](gettingstarted/connection/wipy)
* [Software](gettingstarted/installation/README)
* [Drivers](gettingstarted/installation/drivers)
* [Updating Firmware](gettingstarted/installation/firmwaretool)
* [Pymakr](gettingstarted/installation/pymakr)
* [Programming the modules](gettingstarted/programming/README)
* [Introduction to MicroPython](gettingstarted/programming/micropython)
* [MicroPython Examples](gettingstarted/programming/examples)
* [Your first Pymakr project](gettingstarted/programming/first-project)
* [REPL](gettingstarted/programming/repl/README)
* [Serial USB (UART)](gettingstarted/programming/repl/serial)
* [Telnet REPL](gettingstarted/programming/repl/telnet)
* [FTP](gettingstarted/programming/ftp)
* [Safe boot](gettingstarted/programming/safeboot)
* [Device Registration](gettingstarted/registration/README)
* [Sigfox](gettingstarted/registration/sigfox)
* [Cellular](gettingstarted/registration/cellular)
* [LoRaWAN](gettingstarted/registration/lora/README)
* [The Things Network](gettingstarted/registration/lora/ttn)
* [Objenious](gettingstarted/registration/lora/objenious)
## Pymakr Plugin
* [Installation](pymakr/installation/README)
* [Atom](pymakr/installation/atom)
* [Visual Studio Code](pymakr/installation/vscode)
* [Tools/Features](pymakr/toolsfeatures)
* [Settings](pymakr/settings)
## Pytrack, Pysense, Pyscan
* [Introduction](pytrackpysense/introduction)
* [Installing Software](pytrackpysense/installation/README)
* [Updating Firmware](pytrackpysense/installation/firmware)
* [Installing Drivers - Windows 7](pytrackpysense/installation/drivers)
* [Installing Libraries](pytrackpysense/installation/libraries)
* [API Reference](pytrackpysense/apireference/README)
* [Pytrack](pytrackpysense/apireference/pytrack)
* [Pysense](pytrackpysense/apireference/pysense)
* [Pyscan](pytrackpysense/apireference/pyscan)
* [Sleep](pytrackpysense/apireference/sleep)
## Tutorials & Examples
* [Introduction](tutorials/introduction)
* [All Pycom Device Examples](tutorials/all/README)
* [REPL](tutorials/all/repl)
* [WLAN](tutorials/all/wlan)
* [Bluetooth](tutorials/all/ble)
* [HTTPS](tutorials/all/https)
* [MQTT](tutorials/all/mqtt)
* [AWS](tutorials/all/aws)
* [ADC](tutorials/all/adc)
* [I2C](tutorials/all/i2c)
* [Onewire Driver](tutorials/all/owd)
* [Threading](tutorials/all/threading)
* [RGB LED](tutorials/all/rgbled)
* [Timers](tutorials/all/timers)
* [PIR Sensor](tutorials/all/pir)
* [Modbus](tutorials/all/modbus)
* [OTA update](tutorials/all/ota)
* [RMT](tutorials/all/rmt)
* [Socket](tutorials/all/socket)
* [Touch](tutorials/all/touch)
* [LoRa Examples](tutorials/lora/README)
* [LoRa-MAC (Raw LoRa)](tutorials/lora/lora-mac)
* [LoRaWAN with OTAA](tutorials/lora/lorawan-otaa)
* [LoRaWAN with ABP](tutorials/lora/lorawan-abp)
* [LoRa-MAC Nano-Gateway](tutorials/lora/lora-mac-nano-gateway)
* [LoPy to LoPy](tutorials/lora/module-module)
* [LoRaWAN Nano-Gateway](tutorials/lora/lorawan-nano-gateway)
* [RN2483 to LoPy](tutorials/lora/rn2483-to-lopy)
* [LoRa Mesh](tutorials/lora/lora-mesh)
* [PyMesh Border Router](tutorials/lora/pymesh-br)
* [Sigfox Examples](tutorials/sigfox)
* [LTE Examples](tutorials/lte/README)
* [CAT-M1](tutorials/lte/cat-m1)
* [NB-IoT](tutorials/lte/nb-iot)
* [Module IMEI](tutorials/lte/imei)
* [Modem Firmware Update](tutorials/lte/firmware)
* [Pytrack Examples](tutorials/pytrack)
* [Pysense Examples](tutorials/pysense)
* [Pyscan Examples](tutorials/pyscan)
## Firmware & API Reference
* [Introduction](firmwareapi/introduction)
* [Pycom Modules](firmwareapi/pycom/README)
* [machine](firmwareapi/pycom/machine/README)
* [ADC](firmwareapi/pycom/machine/adc)
* [DAC](firmwareapi/pycom/machine/dac)
* [I2C](firmwareapi/pycom/machine/i2c)
* [Pin](firmwareapi/pycom/machine/pin)
* [PWM](firmwareapi/pycom/machine/pwm)
* [RTC](firmwareapi/pycom/machine/rtc)
* [SPI](firmwareapi/pycom/machine/spi)
* [UART](firmwareapi/pycom/machine/uart)
* [WDT](firmwareapi/pycom/machine/wdt)
* [Timer](firmwareapi/pycom/machine/timer)
* [SD](firmwareapi/pycom/machine/sd)
* [CAN](firmwareapi/pycom/machine/can)
* [RMT](firmwareapi/pycom/machine/rmt)
* [network](firmwareapi/pycom/network/README)
* [WLAN](firmwareapi/pycom/network/wlan)
* [Server](firmwareapi/pycom/network/server)
* [Bluetooth](firmwareapi/pycom/network/bluetooth/README)
* [GATT](firmwareapi/pycom/network/bluetooth/gatt)
* [GATTCConnection](firmwareapi/pycom/network/bluetooth/gattcconnection)
* [GATTCService](firmwareapi/pycom/network/bluetooth/gattccservice)
* [GATTCCharacteristic](firmwareapi/pycom/network/bluetooth/gattccharacteristic)
* [GATTSService](firmwareapi/pycom/network/bluetooth/gattsservice)
* [GATTSCharacteristic](firmwareapi/pycom/network/bluetooth/gattscharacteristic)
* [LoRa](firmwareapi/pycom/network/lora/README)
* [Pymesh](firmwareapi/pycom/network/lora/pymesh)
* [Sigfox](firmwareapi/pycom/network/sigfox)
* [LTE](firmwareapi/pycom/network/lte)
* [AES](firmwareapi/pycom/aes)
* [pycom](firmwareapi/pycom/pycom)
* [MicroPython Modules](firmwareapi/micropython/README)
* [micropython](firmwareapi/micropython/micropython)
* [uctypes](firmwareapi/micropython/uctypes)
* [sys](firmwareapi/micropython/sys)
* [uos](firmwareapi/micropython/uos)
* [array](firmwareapi/micropython/array)
* [cmath](firmwareapi/micropython/cmath)
* [math](firmwareapi/micropython/math)
* [gc](firmwareapi/micropython/gc)
* [ubinascii](firmwareapi/micropython/ubinascii)
* [ujson](firmwareapi/micropython/ujson)
* [ure](firmwareapi/micropython/ure)
* [usocket](firmwareapi/micropython/usocket)
* [select](firmwareapi/micropython/select)
* [utime](firmwareapi/micropython/utime)
* [uhashlib](firmwareapi/micropython/uhashlib)
* [ussl](firmwareapi/micropython/ussl)
* [ucrypto](firmwareapi/micropython/ucrypto)
* [ustruct](firmwareapi/micropython/ustruct/README)
* [uzlib](firmwareapi/micropython/ustruct/uzlib)
* [\_thread](firmwareapi/micropython/_thread)
* [Builtin](firmwareapi/micropython/builtin)
* [Notes](firmwareapi/notes)
## Product Info, Datasheets
* [Introduction](datasheets/introduction)
* [Development Modules](datasheets/development/README)
* [WiPy 2.0](datasheets/development/wipy2)
* [WiPy 3.0](datasheets/development/wipy3)
* [LoPy](datasheets/development/lopy)
* [LoPy 4](datasheets/development/lopy4)
* [SiPy](datasheets/development/sipy)
* [GPy](datasheets/development/gpy)
* [FiPy](datasheets/development/fipy)
* [OEM Modules](datasheets/oem/README)
* [W01](datasheets/oem/w01)
* [L01](datasheets/oem/l01)
* [L04](datasheets/oem/l04)
* [G01](datasheets/oem/g01)
* [L01 OEM Baseboard Reference](datasheets/oem/l01_reference)
* [Universal OEM Baseboard Reference](datasheets/oem/universal_reference)
* [Expansion Boards and Shields](datasheets/boards/README)
* [Expansion Board 3.0](datasheets/boards/expansion3)
* [Pytrack](datasheets/boards/pytrack)
* [Pysense](datasheets/boards/pysense)
* [Pyscan](datasheets/boards/pyscan)
* [Expansion Board 2.0](datasheets/boards/expansion2)
* [Deep Sleep Shield](datasheets/boards/deepsleep/README)
* [Deep Sleep API](datasheets/boards/deepsleep/api)
* [Notes](datasheets/notes)
## Pybytes
* [Introduction](pybytes/introduction)
* [Getting Started with Pybytes](pybytes/getstarted)
* [Add a device to Pybytes](pybytes/connect/README)
* [Connect to Pybytes: Quick Add](pybytes/connect/quick)
* [Connect to Pybytes: Flash Pybytes library manually](pybytes/connect/flash)
* [Add Sigfox device](pybytes/connect/sigfox/README)
* [DevKit contract](pybytes/connect/sigfox/devkit)
* [Custom contract](pybytes/connect/sigfox/custom)
* [Visualise data from your device](pybytes/dashboard)
* [Integrations](pybytes/integrations/README)
* [Amazon IoT](pybytes/integrations/amazon-iot)
## Documentation Notes
* [Introduction](docnotes/introduction)
* [Syntax](docnotes/syntax)
* [REPL vs Scripts](docnotes/replscript)
* [Mesh Networks](docnotes/mesh-networks)
## Advanced Topics
* [Firmware Downgrade](advance/downgrade)
* [CLI Updater](advance/cli)
* [SecureBoot and Encryption](advance/encryption)
* [License](advance/license)
## Have a question?
* [Ask on the Forum](https://forum.pycom.io)

2
content/_index.md
View File

@@ -1,6 +1,7 @@
---
title: "Introduction"
aliases:
- /introduction
---
Welcome to the Pycom documentation site. We recommend reading through all the sections to familiarise yourself with the various tools and features available to you to help you develop on your Pycom module.
@@ -12,4 +13,3 @@ To get started, read through the Getting Started guide then feel free to jump st
* [Product Info](datasheets/introduction)
* [API Documentation](firmwareapi/introduction)
* [Pybytes](pybytes/introduction)

5
content/advance/downgrade.md
View File

@@ -21,7 +21,7 @@ You can obtain previous firmware versions here:
* [LoPy4](https://software.pycom.io/downloads/LoPy4.html)
{{% 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#lpwan)).
{{< /hint >}}
## GUI
@@ -36,9 +36,8 @@ When you tick the `Flash from local file` option, an address bar will appear. Cl
## Command line
You can also use the [CLI](cli) version of the update tool to downgrade your device. Will need to get a `.tar` or `.tar.gz` archive of the firmware you wish to upload to the board. Then run the following commands:
You can also use the [CLI](../cli) version of the update tool to downgrade your device. Will need to get a `.tar` or `.tar.gz` archive of the firmware you wish to upload to the board. Then run the following commands:
```bash
$ pycom-fwtool-cli -v -p PORT flash -t /path/to/firmware/archive.tar.gz
```

25
content/datasheets/_index.md
View File

@@ -1,23 +1,30 @@
---
title: ""
title: "Introduction"
aliases:
- datasheets/introduction.html
- datasheets/introduction.md
- datasheets/introduction
- product-info
- chapter/datasheets
---
# datasheets
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
## Development Modules
{{% 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/wipy2.md" %}}
{{% 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

1
content/datasheets/boards/README.md
View File

@@ -4,6 +4,7 @@ aliases:
- product-info/boards
- chapter/datasheets/boards
---
This section contains all of the datasheets for the Pycom Expansion Boards and Shields. This includes the Expansion Board, Pytrack, Pysense and Deep Sleep Shield.
{{% refname "expansion3.md" %}}

1
content/datasheets/boards/_index.md
View File

@@ -2,6 +2,7 @@
title: "Expansion Boards and Shields"
aliases:
---
This section contains all of the datasheets for the Pycom Expansion Boards and Shields. This includes the Expansion Board, Pytrack, Pysense and Deep Sleep Shield.
{{% refname "expansion3.md" %}}

10
content/datasheets/boards/deepsleep/README.md
View File

@@ -4,21 +4,23 @@ aliases:
- product-info/boards/deepsleep
- chapter/datasheets/boards/deepsleep
---
The schematic of the Deep Sleep Shield is available as a PDF File.
{% file src="..//gitbook/assets/deepsleep-schematic.pdf" caption="Deep Sleep Schematic" %}
<a href="/gitbook/assets/deepsleep-schematic.pdf" target="_blank"> Deep Sleep Schematic </a>
## Pinout
The pinout of the Deep Sleep Shield is available as a PDF File
{% file src="..//gitbook/assets/deepsleep-pinout.pdf" caption="Deep Sleep Pinout" %}
<a href="/gitbook/assets/deepsleep-pinout.pdf" target="_blank"> Deep Sleep Pinout </a>
![](//gitbook/assets/deepsleep-pinout%20%281%29.png)
![](/gitbook/assets/deepsleep-pinout%20%281%29.png)
{{% hint style="info" %}}
To correctly connect a WiPy 2.0, LoPy or SiPy to the Deep Sleep Shield, align the white triangle on the Shield with the LED of the Pycom Device. Once the Pycom Device is seated onto the Deep Sleep Shield, this can then be connected to the Expansion Board
{{< /hint >}}
![](//gitbook/assets/deepsleep-image-1.jpg)
![](/gitbook/assets/deepsleep-image-1.jpg)

10
content/datasheets/boards/deepsleep/_index.md
View File

@@ -2,21 +2,23 @@
title: "Deep Sleep Shield"
aliases:
---
The schematic of the Deep Sleep Shield is available as a PDF File.
{% file src="..//gitbook/assets/deepsleep-schematic.pdf" caption="Deep Sleep Schematic" %}
<a href="/gitbook/assets/deepsleep-schematic.pdf" target="_blank"> Deep Sleep Schematic </a>
## Pinout
The pinout of the Deep Sleep Shield is available as a PDF File
{% file src="..//gitbook/assets/deepsleep-pinout.pdf" caption="Deep Sleep Pinout" %}
<a href="/gitbook/assets/deepsleep-pinout.pdf" target="_blank"> Deep Sleep Pinout </a>
![](//gitbook/assets/deepsleep-pinout%20%281%29.png)
![](/gitbook/assets/deepsleep-pinout%20%281%29.png)
{{% hint style="info" %}}
To correctly connect a WiPy 2.0, LoPy or SiPy to the Deep Sleep Shield, align the white triangle on the Shield with the LED of the Pycom Device. Once the Pycom Device is seated onto the Deep Sleep Shield, this can then be connected to the Expansion Board
{{< /hint >}}
![](//gitbook/assets/deepsleep-image-1.jpg)
![](/gitbook/assets/deepsleep-image-1.jpg)

5
content/datasheets/boards/deepsleep/api.md
View File

@@ -6,6 +6,7 @@ aliases:
- product-info/boards/deepsleep/api
- chapter/datasheets/boards/deepsleep/api
---
This chapter describes the library which controls the Deep Sleep Shield. This includes the controls for external interrupts and timer setup of the deep sleep functionality.
To use this library, please upload the associated [Deep Sleep Library](https://github.com/pycom/pycom-libraries/tree/master/deepsleep) to `/lib` on the target Pycom device.
@@ -13,6 +14,8 @@ To use this library, please upload the associated [Deep Sleep Library](https://g
## Quick Example
```python
from deepsleep import DeepSleep
import deepsleep
@@ -46,6 +49,7 @@ The Deep Sleep Shield allows for waking up via a user trigger and also via an ex
Creates a DeepSleep object, that will control the board's sleep features. For example;
```python
ds = DeepSleep()
```
@@ -98,4 +102,3 @@ This method resets the PIC controller and resets it to the state previous to the
{{% hint style="info" %}}
Please note that more functionality is being added weekly to these libraries. If a required feature is not available, feel free to contribute with a pull request at the [Pycom Libraries](https://github.com/pycom/pycom-libraries) GitHub repository.
{{< /hint >}}

16
content/datasheets/boards/expansion2.md
View File

@@ -6,13 +6,21 @@ aliases:
- product-info/boards/expansion2
- chapter/datasheets/boards/expansion2
---
![](/gitbook/assets/expansion2.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86jsexys_ho7ct7c-expansion2.png)
## Datasheet
The datasheet of the Expansion Board is available as a PDF File.
<a href="/gitbook/assets/expansion2-specsheet.pdf" target="_blank">Expansion Board 2 Datasheet </a>
## Pinout
The pinout of the Expansion Board is available as a PDF File
{% file src="/gitbook/assets/expansion2-pinout.pdf" caption="Expansion Board 2 Pinout" %}
<a href="/gitbook/assets/expansion2-pinout.pdf" target="_blank"> Expansion Board 2 Pinout </a>
![](/gitbook/assets/expansion2-pinout-1.png)
@@ -24,9 +32,5 @@ Be gentle when plugging/unplugging from the USB connector. Whilst the USB connec
The Expansion Board features a single cell Li-Ion/Li-Po charger. When the board is being powered via the micro USB connector, the Expansion Board will charge the battery (if connected). When the `CHG` jumper is present the battery will be charged at `450mA`. If this value is too high for your application, removing the jumper lowers the charge current to `100mA`.
## Specsheets
The specsheet of the Expansion Board is available as a PDF File.
{% file src="/gitbook/assets/expansion2-specsheet.pdf" caption="Expansion Board 2 Datasheet" %}

24
content/datasheets/boards/expansion3.md
View File

@@ -6,13 +6,20 @@ aliases:
- product-info/boards/expansion3
- chapter/datasheets/boards/expansion3
---
![](/gitbook/assets/expansion3%20%281%29.png)
## ![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82uldmpus0lnq1kx-expansion3.png)
## Datasheet
The datasheet of the Expansion Board is available as a PDF File.
<a href="/gitbook/assets/expansion3-specsheet-1.pdf" target="_blank"> Expansion Board Datasheet </a>
## Pinout
The pinout of the Expansion Board is available as a PDF File
{% file src="/gitbook/assets/expansion3-pinout.pdf" caption="Expansion Board 3 Pinout" %}
<a href="/gitbook/assets/expansion3-pinout.pdf" target="_blank"> Expansion Board 3 Pinout </a>
![](/gitbook/assets/expansion3-pinout-1.png)
@@ -24,11 +31,9 @@ Be gentle when plugging/unplugging from the USB connector. Whilst the USB connec
The Expansion Board features a single cell Li-Ion/Li-Po charger. When the board is being powered via the micro USB connector, the Expansion Board will charge the battery (if connected). When the `CHG` jumper is present the battery will be charged at `450mA`. If this value is too high for your application, removing the jumper lowers the charge current to `100mA`.
## Specsheets
The specsheet of the Expansion Board is available as a PDF File.
{% file src="/gitbook/assets/expansion3-specsheet-1.pdf" caption="Expansion Board 3 Datasheet" %}
{{% hint style="info" %}}
To use the battery, pull `P8/G15` high (connect to `3v3`). If you want to use the SD card as well, use a 10k pull-up.
{{< /hint >}}
## Differences between v2.0 and v3.0
@@ -46,5 +51,8 @@ The specsheet of the Expansion Board is available as a PDF File.
## Troubleshooting
* If PIC stays in bootloader mode, the [`dfu-util` update](/../pytrackpysense/installation/firmware) should be performed
* If PIC stays in bootloader mode, the [`dfu-util` update](/pytrackpysense/installation/firmware) should be performed
## 3D model for case design
* Please see the <a href="/gitbook/assets/Expansion_Board_3D.step" target="_blank"> 3D model </a> (step format)

22
content/datasheets/boards/pyscan.md
View File

@@ -6,7 +6,14 @@ aliases:
- product-info/boards/pyscan
- chapter/datasheets/boards/pyscan
---
![](/gitbook/assets/pyscan-new%20%281%29.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hfia61dsuyojco-pyscan-new.png)
## Datasheet
The datasheet of the Pyscan is available as a PDF File.
<a href="/gitbook/assets/pyscan-specsheet.pdf" target="_blank"> Pyscan Datasheet </a>
## Pyscan Libraries
@@ -27,7 +34,7 @@ Libraries for the rest of the components will be added soon.
## Driver
The Windows 7 driver for Pyscan is located [here](/../pytrackpysense/installation/firmware).
The Windows 7 driver for Pyscan is located [here](/pytrackpysense/installation/firmware).
For other Operating Systems there's no driver required.
@@ -35,7 +42,7 @@ For other Operating Systems there's no driver required.
The pinout of the Pyscan is available as a PDF File
{% file src="/gitbook/assets/pyscan-pinout.pdf" caption="Pyscan Pinout" %}
<a href="/gitbook/assets/pyscan-pinout.pdf" target="_blank"> Pyscan Pinout </a>
![](/gitbook/assets/pyscan-pinout-1.png)
@@ -43,9 +50,12 @@ The pinout of the Pyscan is available as a PDF File
The board features a single cell Li-Ion/Li-Po charger. When the board is being powered via the micro USB connector, it will charge the battery (if connected).
## Specsheets
The specsheet of the Pyscan is available as a PDF File.
{% file src="/gitbook/assets/pyscan-specsheet.pdf" caption="Pyscan Datasheet" %}
## Mechanical Dimensionsde
![](/gitbook/assets/pyscan_V0.7_20180416_MecahnicalDimensions.png)
## 3D model for case design
* Please see the <a href="/gitbook/assets/PyScan_v0.7.step" target="_blank"> 3D model </a> (step format)

20
content/datasheets/boards/pysense.md
View File

@@ -6,13 +6,20 @@ aliases:
- product-info/boards/pysense
- chapter/datasheets/boards/pysense
---
![](/gitbook/assets/pysense%20%281%29.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hclnq-gurt2p_m-pysense.png)
## Datasheet
The datasheet of the Pysense is available as a PDF File.
<a href="/gitbook/assets/pysense-specsheet.pdf" target="_blank"> Pysense Datasheet </a>
## Pinout
The pinout of the Pysense is available as a PDF File
{% file src="/gitbook/assets/pysense-pinout.pdf" caption="Pysense Pinout" %}
<a href="/gitbook/assets/pysense-pinout.pdf" target="_blank"> Pysense Pinout </a>
![](/gitbook/assets/pysense-pinout-1.png)
@@ -20,9 +27,12 @@ The pinout of the Pysense is available as a PDF File
The board features a single cell Li-Ion/Li-Po charger. When the board is being powered via the micro USB connector, it will charge the battery (if connected).
## Specsheets
## Mechanical Dimensions
The specsheet of the Pysense is available as a PDF File.
![](/gitbook/assets/Pysense_v1.1_MechanicalDimensions_b.png)
{% file src="/gitbook/assets/pysense-specsheet.pdf" caption="Pysense Datasheet" %}
## 3D model for case design
* Please see the <a href="/gitbook/assets/PySense_v1.1.step" target="_blank"> 3D model </a> (step format)

20
content/datasheets/boards/pytrack.md
View File

@@ -6,13 +6,20 @@ aliases:
- product-info/boards/pytrack
- chapter/datasheets/boards/pytrack
---
![](/gitbook/assets/pytrack%20%282%29.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ejihh1jeasccad-pytrack.png)
## Datasheet
The datasheet of the Pytrack is available as a PDF File.
<a href="/gitbook/assets/pytrack-specsheet-1.pdf" target="_blank"> Pytrack Datasheet </a>
## Pinout
The pinout of the Pytrack is available as a PDF File
{% file src="/gitbook/assets/pytrack-pinout.pdf" caption="Pytrack Pinout" %}
<a href="/gitbook/assets/pytrack-pinout.pdf" target="_blank"> Pytrack Pinout </a>
![](/gitbook/assets/pytrack-pinout-1.png)
@@ -20,9 +27,12 @@ The pinout of the Pytrack is available as a PDF File
The board features a single cell Li-Ion/Li-Po charger. When the board is being powered via the micro USB connector, it will charge the battery (if connected).
## Specsheets
The specsheet of the Pytrack is available as a PDF File.
{% file src="/gitbook/assets/pytrack-specsheet-1.pdf" caption="Pytrack Datasheet" %}
## Mechanical Dimensions
![](/gitbook/assets/Pysense_v1.1_MechanicalDimensions_b.png)
## 3D model for case design
* Please see the <a href="/gitbook/assets/PyTrack_v1.1.step" target="_blank"> 3D model </a> (step format)

1
content/datasheets/development/README.md
View File

@@ -4,6 +4,7 @@ aliases:
- product-info/development
- chapter/datasheets/development
---
This section contains all of the datasheets for the Pycom Development Devices. This includes the WiPy 2.0 and 3.0, LoPy, LoPy 4, SiPy, GPy, and FiPy.
{{% refname "wipy2.md" %}}

1
content/datasheets/development/_index.md
View File

@@ -2,6 +2,7 @@
title: "Development Modules"
aliases:
---
This section contains all of the datasheets for the Pycom Development Devices. This includes the WiPy 2.0 and 3.0, LoPy, LoPy 4, SiPy, GPy, and FiPy.
{{% refname "wipy2.md" %}}

54
content/datasheets/development/fipy.md
View File

@@ -6,17 +6,34 @@ aliases:
- product-info/development/fipy
- chapter/datasheets/development/fipy
---
![](/gitbook/assets/fipy-1.png)
**Store**: [Buy Here](http://www.pycom.io/fipy)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82srvkf3rhetvjpi-fipy-1.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/fipy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/fipy/)
**Getting Started:** [Click Here](/gettingstarted/connection/fipy)
## Datasheet
The datasheet of the FiPy is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_FiPy_v2.pdf" target="_blank"> FiPy Datasheet </a>
The drawing of the LTE-M antenna is available as a PDF File.
<a href="/gitbook/assets/lte-m-antenna-drawing.pdf" target="_blank"> LTE-M Antenna Drawing </a>
## Pinout
The pinout of the FiPy is available as a PDF File
{% file src="/gitbook/assets/fipy-pinout.pdf" caption="FiPy Pinout" %}
<a href="/gitbook/assets/fipy-pinout.pdf" target="_blank"> FiPy Pinout </a>
![](/gitbook/assets/fipy-pinout.png)
@@ -24,16 +41,6 @@ The pinout of the FiPy is available as a PDF File
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 >}}
## Datasheet
The datasheet of the FiPy is available as a PDF File.
{% file src="/gitbook/assets/fipy-specsheet-1.pdf" caption="FiPy Datasheet" %}
The drawing of the LTE-M antenna is available as a PDF File.
{% file src="/gitbook/assets/lte-m-antenna-drawing.pdf" caption="LTE-M Antenna Drawing" %}
## Notes
### WiFi
@@ -50,17 +57,16 @@ The `Vin` pin on the FiPy can be supplied with a voltage ranging from `3.5v` to
The AT commands for the Sequans Monarch modem on the FiPy are available in a PDF file.
{% file src="/gitbook/assets/monarch\_4g-ez\_lr5110\_atcommands\_referencemanual\_rev3\_noconfidential-2.pdf" caption="AT Commands for Sequans" %}
<a href="/gitbook/assets/Monarch-LR5110-ATCmdRefMan-rev6_noConfidential.pdf" target="_blank"> AT Commands for Sequans </a>
## Tutorials
Tutorials on how to the FiPy module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the FiPy:
* [WiFi connection](/../tutorials/all/wlan)
* [LoRaWAN node](/../tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/../tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/../tutorials/sigfox)
* [LTE CAT-M1](/../tutorials/lte/cat-m1)
* [NB-IoT](/../tutorials/lte/nb-iot)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the FiPy module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the FiPy:
* [WiFi connection](/tutorials/all/wlan)
* [LoRaWAN node](/tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/tutorials/sigfox)
* [LTE CAT-M1](/tutorials/lte/cat-m1)
* [NB-IoT](/tutorials/lte/nb-iot)
* [BLE](/tutorials/all/ble)

51
content/datasheets/development/gpy.md
View File

@@ -4,20 +4,39 @@ aliases:
- datasheets/development/gpy.html
- datasheets/development/gpy.md
- product-info/development/gpy
- datasheets/development/gpy
- chapter/datasheets/development/gpy
---
![](/gitbook/assets/gpy-1.png)
**Store**: [Buy Here](http://www.pycom.io/gpy)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn87yf-xz772800vwc-gpy-1.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/gpy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/gpy)
**Getting Started:** [Click Here](/gettingstarted/connection/gpy)
## Datasheet
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
The datasheet of the GPy is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_GPy_v2.pdf" target="_blank"> GPy Datasheet </a>
The drawing of the LTE-M antenna is available as a PDF File.
<a href="/gitbook/assets/lte-m-antenna-drawing.pdf" target="_blank"> LTE-M Antenna Drawing </a>
## Pinout
The pinout of the GPy is available as a PDF File
{% file src="/gitbook/assets/gpy-pinout.pdf" caption="GPy Pinout" %}
<a href="/gitbook/assets/gpy-pinout.pdf" target="_blank"> GPy Pinout </a>
![](/gitbook/assets/gpy-pinout.png)
@@ -25,16 +44,6 @@ The pinout of the GPy is available as a PDF File
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 >}}
## Datasheet
The datasheet of the GPy is available as a PDF File.
{% file src="/gitbook/assets/gpy-specsheet.pdf" caption="GPy Datasheet" %}
The drawing of the LTE-M antenna is available as a PDF File.
{% file src="/gitbook/assets/lte-m-antenna-drawing.pdf" caption="LTE-M Antenna Drawing" %}
## Notes
### WiFi
@@ -51,13 +60,13 @@ The `Vin` pin on the GPy can be supplied with a voltage ranging from `3.5v` to `
The AT commands for the Sequans Monarch modem on the GPy are available in a PDF file.
{% file src="/gitbook/assets/monarch\_4g-ez\_lr5110\_atcommands\_referencemanual\_rev3\_noconfidential-1.pdf" caption="AT Commands for Sequans" %}
<a href="/gitbook/assets/Monarch-LR5110-ATCmdRefMan-rev6_noConfidential.pdf" target="_blank"> AT Commands for Sequans </a>
## Tutorials
Tutorials on how to the GPy module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the GPy:
Tutorials on how to the GPy module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the GPy:
* [WiFi connection](/../tutorials/all/wlan)
* [LTE CAT-M1](/../tutorials/lte/cat-m1)
* [NB-IoT](/../tutorials/lte/nb-iot)
* [BLE](/../tutorials/all/ble)
* [WiFi connection](/tutorials/all/wlan)
* [LTE CAT-M1](/tutorials/lte/cat-m1)
* [NB-IoT](/tutorials/lte/nb-iot)
* [BLE](/tutorials/all/ble)

39
content/datasheets/development/lopy.md
View File

@@ -6,17 +6,29 @@ aliases:
- product-info/development/lopy
- chapter/datasheets/development/lopy
---
![](/gitbook/assets/lopy-1.png)
**Store**: [Buy Here](http://www.pycom.io/lopy)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn80ythqnrgah01r2m-lopy-1.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/lopy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/lopy)
**Getting Started:** [Click Here](/gettingstarted/connection/lopy)
## Datasheet
The datasheet of the LoPy is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_LoPy_v2.pdf" target="_blank"> LoPy Datasheet </a>
## Pinout
The pinout of the LoPy is available as a PDF File
{% file src="/gitbook/assets/lopy-pinout.pdf" caption="LoPy Pinout" %}
<a href="/gitbook/assets/lopy-pinout.pdf" target="_blank"> LoPy Pinout </a>
![](/gitbook/assets/lopy-pinout.png)
@@ -24,12 +36,6 @@ The pinout of the LoPy is available as a PDF File
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 >}}
## Datasheet
The datasheet of the LoPy is available as a PDF File.
{% file src="/gitbook/assets/lopy-specsheet.pdf" caption="LoPy Datasheet" %}
## Notes
### WiFi
@@ -42,14 +48,13 @@ The `Vin` pin on the LoPy can be supplied with a voltage ranging from `3.5v` to
### Deep Sleep
Due to a couple issues with the LoPy design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](/boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
Due to a couple issues with the LoPy design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](../../boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
## Tutorials
Tutorials on how to the LoPy module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the LoPy:
* [WiFi connection](/../tutorials/all/wlan)
* [LoRaWAN node](/../tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/../tutorials/lora/lorawan-nano-gateway)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the LoPy module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the LoPy:
* [WiFi connection](/tutorials/all/wlan)
* [LoRaWAN node](/tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/tutorials/lora/lorawan-nano-gateway)
* [BLE](/tutorials/all/ble)

40
content/datasheets/development/lopy4.md
View File

@@ -6,17 +6,30 @@ aliases:
- product-info/development/lopy4
- chapter/datasheets/development/lopy4
---
![](/gitbook/assets/lopy4-1.png)
**Store**: [Buy Here](http://www.pycom.io/lopy4)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85npgnazxzxyv-nu-lopy4-1.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/lopy4)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/lopy4/)
**Getting Started:** [Click Here](/gettingstarted/connection/lopy4)
## Datasheet
The datasheet of the LoPy4 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_LoPy4_v2.pdf" target="_blank"> LoPy4 Datasheet </a>
## Pinout
The pinout of the LoPy4 is available as a PDF File
{% file src="/gitbook/assets/lopy4-pinout.pdf" caption="LoPy4 Pinout" %}
<a href="/gitbook/assets/lopy4-pinout.pdf" target="_blank"> LoPy4 Pinout </a>
![](/gitbook/assets/lopy4-pinout.png)
@@ -24,12 +37,6 @@ The pinout of the LoPy4 is available as a PDF File
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 >}}
## Datasheet
The datasheet of the LoPy4 is available as a PDF File.
{% file src="/gitbook/assets/lopy4-specsheet-1.pdf" caption="LoPy4 Datasheet" %}
## Notes
### WiFi
@@ -44,11 +51,10 @@ The `Vin` pin on the LoPy4 can be supplied with a voltage ranging from `3.5v` to
## Tutorials
Tutorials on how to the LoPy4 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the LoPy4:
* [WiFi connection](/../tutorials/all/wlan)
* [LoRaWAN node](/../tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/../tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/../tutorials/sigfox)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the LoPy4 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the LoPy4:
* [WiFi connection](/tutorials/all/wlan)
* [LoRaWAN node](/tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/tutorials/sigfox)
* [BLE](/tutorials/all/ble)

40
content/datasheets/development/sipy.md
View File

@@ -6,17 +6,32 @@ aliases:
- product-info/development/sipy
- chapter/datasheets/development/sipy
---
![](/gitbook/assets/sipy-2.png)
**Store**: [Buy Here](http://www.pycom.io/sipy)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86n8h-hb1oh1idwb-sipy-2.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/sipy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/sipy)
**Getting Started:** [Click Here](/gettingstarted/connection/sipy)
## Datasheet
The datasheet of the SiPy is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_SiPy_v2.pdf" target="_blank"> SiPy Datasheet </a>
## Pinout
The pinout of the SiPy is available as a PDF File
{% file src="/gitbook/assets/sipy-pinout.pdf" caption="SiPy Pinout" %}
<a href="/gitbook/assets/sipy-pinout.pdf" target="_blank"> SiPy Pinout </a>
![](/gitbook/assets/sipy-pinout.png)
@@ -24,12 +39,6 @@ The pinout of the SiPy is available as a PDF File
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 >}}
## Datasheet
The datasheet of the SiPy is available as a PDF File.
{% file src="/gitbook/assets/sipy-specsheet.pdf" caption="SiPy Datasheet" %}
## Notes
### WiFi
@@ -42,13 +51,12 @@ The `Vin` pin on the SiPy can be supplied with a voltage ranging from `3.5v` to
### Deep Sleep
Due to a couple issues with the SiPy design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](/boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
Due to a couple issues with the SiPy design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](../../boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
## Tutorials
Tutorials on how to the SiPy module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the SiPy:
* [WiFi connection](/../tutorials/all/wlan)
* [Sigfox](/../tutorials/sigfox)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the SiPy module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the SiPy:
* [WiFi connection](/tutorials/all/wlan)
* [Sigfox](/tutorials/sigfox)
* [BLE](/tutorials/all/ble)

37
content/datasheets/development/wipy2.md
View File

@@ -6,17 +6,31 @@ aliases:
- product-info/development/wipy2
- chapter/datasheets/development/wipy2
---
![](/gitbook/assets/wipy2-1.png)
**Store**: Discontinued, See [WiPy3](wipy3)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ftusu7mke5ppmd-wipy2-1.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/wipy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: Discontinued, See [WiPy3](../wipy3)
**Getting Started:** [Click Here](/gettingstarted/connection/wipy)
## Datasheet
The datasheet of the WiPy2 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_WiPy2.0_v2.pdf" target="_blank"> WiPy 2 Datasheet </a>
## Pinout
The pinout of the WiPy2 is available as a PDF File.
{% file src="/gitbook/assets/wipy2-pinout.pdf" caption="WiPy 2 Pinout" %}
<a href="/gitbook/assets/wipy2-pinout.pdf" target="_blank"> WiPy 2 Pinout </a>
![](/gitbook/assets/wipy2-pinout.png)
@@ -24,12 +38,6 @@ The pinout of the WiPy2 is available as a PDF File.
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 >}}
## Datasheet
The datasheet of the WiPy2 is available as a PDF File.
{% file src="/gitbook/assets/wipy2-specsheet.pdf" caption="WiPy 2 Datasheet" %}
## Notes
### WiFi
@@ -42,12 +50,11 @@ The `Vin` pin on the WiPy2 can be supplied with a voltage ranging from `3.5v` to
### Deep Sleep
Due to a couple issues with the WiPy2 design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](/boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
Due to a couple issues with the WiPy2 design the module draws more current than it should while in deep sleep. The DC-DC switching regulator always stays in high performance mode which is used to provide the lowest possible output ripple when the modules is in use. In this mode, it draws a quiescent current of 10mA. When the regulator is put into ECO mode, the quiescent current goes down to 10uA. Unfortunately, the pin used to control this mode is out of the RTC domain, and therefore not usable during deep sleep. This causes the regulator to always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this the flash chip doesn't enter power down mode because the CS pin is floating during deep sleep. This causes the flash chip to consume around 2mA of current. To work around this issue a ["deep sleep shield"](../../boards/deepsleep/) is available that attaches to the module and allows power to be cut off from the device. The device can then be re-enabled either on a timer or via pin interrupt. With the deep sleep shield the current consumption during deep sleep is between 7uA and 10uA depending on the wake sources configured.
## Tutorials
Tutorials on how to the WiPy2 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the WiPy2:
* [WiFi connection](/../tutorials/all/wlan)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the WiPy2 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the WiPy2:
* [WiFi connection](/tutorials/all/wlan)
* [BLE](/tutorials/all/ble)

33
content/datasheets/development/wipy3.md
View File

@@ -6,17 +6,29 @@ aliases:
- product-info/development/wipy3
- chapter/datasheets/development/wipy3
---
![](/gitbook/assets/wipy3.png)
**Store**: [Buy Here](http://www.pycom.io/wipy-3)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86pdzbdvrponxeg6-wipy3.png)
**Getting Started:** [Click Here](/../gettingstarted/connection/wipy)
{{% hint style="info" %}}
Please Note: We have removed the labels from the pictures in the documentation due to inconsistencies with label orientation. *The LED must be aligned above the USB socket* when inserting or removing a development board from an expansion board/Pytrack/Pysense/Pyscan.
{{< /hint >}}
**Store**: [Buy Here](https://pycom.io/product/wipy-3-0/)
**Getting Started:** [Click Here](/gettingstarted/connection/wipy)
## Datasheet
The datasheet of the WiPy3 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_WiPy3.0_v2.pdf" target="_blank"> WiPy3 Datasheet </a>
## Pinout
The pinout of the WiPy3 is available as a PDF File.
{% file src="/gitbook/assets/wipy3-pinout.pdf" caption="WiPy3 Pinout" %}
<a href="/gitbook/assets/wipy3-pinout.pdf" target="_blank"> WiPy3 Pinout </a>
![](/gitbook/assets/wipy3-pinout.png)
@@ -31,12 +43,6 @@ Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO)
* Upgraded External FLASH from 4MB to 8MB
* Antenna select pin moved from GPIO16 to GPIO21 (P12)
## Datasheet
The datasheet of the WiPy3 is available as a PDF File.
{% file src="/gitbook/assets/wipy3-specsheet.pdf" caption="WiPy3 Datasheet" %}
## Notes
### WiFi
@@ -51,8 +57,7 @@ The `Vin` pin on the WiPy3 can be supplied with a voltage ranging from `3.5v` to
## Tutorials
Tutorials on how to the WiPy3 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the WiPy3:
* [WiFi connection](/../tutorials/all/wlan)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the WiPy3 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the WiPy3:
* [WiFi connection](/tutorials/all/wlan)
* [BLE](/tutorials/all/ble)

53
content/datasheets/introduction.md
View File

@@ -1,53 +0,0 @@
---
title: "Datasheets"
aliases:
- datasheets/introduction.html
- datasheets/introduction.md
- product-info
- chapter/datasheets
---
The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes.
## Development Modules
{{% refname "development/wipy2.md" %}}
{{% refname "development/wipy3.md" %}}
{{% refname "development/lopy.md" %}}
{{% refname "development/lopy4.md" %}}
{{% refname "development/sipy.md" %}}
{{% refname "development/gpy/" %}}
{{% refname "development/fipy.md" %}}
## OEM modules
{{% refname "oem/w01.md" %}}
{{% refname "oem/l01.md" %}}
{{% refname "oem/g01.md" %}}
{{% refname "oem/l01\_reference.md" %}}
{{% refname "oem/universal\_reference.md" %}}
## Expansion Boards and Shields
{{% refname "boards/expansion3.md" %}}
{{% refname "boards/pytrack.md" %}}
{{% refname "boards/pysense.md" %}}
{{% refname "boards/pyscan.md" %}}
{{% refname "boards/expansion2.md" %}}
{{% refname "boards/deepsleep/" %}}

1
content/datasheets/notes.md
View File

@@ -6,6 +6,7 @@ aliases:
- product-info/notes
- chapter/datasheets/notes
---
## Powering with an external power source
The devices can be powered by a battery or other external power source.

18
content/datasheets/oem/README.md
View File

@@ -1,18 +0,0 @@
---
title: "OEM Modules"
aliases:
- product-info/oem
- chapter/datasheets/oem
---
This section contains all of the datasheets for the Pycom OEM Devices. This includes the W01, L01, L04, and G01.
{{% refname "w01.md" %}}
{{% refname "l01.md" %}}
{{% refname "g01.md" %}}
{{% refname "l01\_reference.md" %}}
{{% refname "universal\_reference.md" %}}

4
content/datasheets/oem/_index.md
View File

@@ -1,7 +1,10 @@
---
title: "OEM Modules"
aliases:
- product-info/oem
- chapter/datasheets/oem
---
This section contains all of the datasheets for the Pycom OEM Devices. This includes the W01, L01, L04, and G01.
{{% refname "w01.md" %}}
@@ -13,4 +16,3 @@ This section contains all of the datasheets for the Pycom OEM Devices. This incl
{{% refname "l01\_reference.md" %}}
{{% refname "universal\_reference.md" %}}

31
content/datasheets/oem/g01.md
View File

@@ -6,27 +6,28 @@ aliases:
- product-info/oem/g01
- chapter/datasheets/oem/g01
---
![](/gitbook/assets/g01-1.png)
## ![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1%20%282%29.png)
## Datasheet
The datasheet of the G01 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_G01_v2.pdf" target="_blank"> G01 Datasheet </a>
## Pinout
The pinout of the G01 is available as a PDF File
{% file src="/gitbook/assets/g01-pinout.pdf" caption="G01 Pinout" %}
<a href="/gitbook/assets/g01-pinout.pdf" target="_blank"> G01 Pinout </a>
![](/gitbook/assets/g01-pinout.png)
## Specsheets
The specsheet of the G01 is available as a PDF File.
{% file src="/gitbook/assets/g01-specsheet.pdf" caption="G01 Datasheet" %}
## Drawings
The drawings for the G01 is available as a PDF File.
{% file src="/gitbook/assets/g01-drawing.pdf" caption="G01 Drawings" %}
<a href="/gitbook/assets/g01-drawing.pdf" target="_blank"> G01 Drawings </a>
{{% 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.
@@ -36,14 +37,14 @@ Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO)
The AT commands for the Sequans Monarch modem on the G01 are available in a PDF file.
{% file src="/gitbook/assets/monarch\_4g-ez\_lr5110\_atcommands\_referencemanual\_rev3\_noconfidential-3.pdf" caption="AT Commands for Sequans" %}
<a href="/gitbook/assets/Monarch-LR5110-ATCmdRefMan-rev6_noConfidential.pdf" target="_blank"> AT Commands for Sequans </a>
## Tutorials
Tutorials on how to the G01 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the G01:
Tutorials on how to the G01 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the G01:
* [WiFi connection](/../tutorials/all/wlan)
* [LTE CAT-M1](/../tutorials/lte/cat-m1)
* [NB-IoT](/../tutorials/lte/nb-iot)
* [BLE](/../tutorials/all/ble)
* [WiFi connection](/tutorials/all/wlan)
* [LTE CAT-M1](/tutorials/lte/cat-m1)
* [NB-IoT](/tutorials/lte/nb-iot)
* [BLE](/tutorials/all/ble)

29
content/datasheets/oem/l01.md
View File

@@ -6,27 +6,28 @@ aliases:
- product-info/oem/l01
- chapter/datasheets/oem/l01
---
![](/gitbook/assets/l01-1.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn7x3eyyjifoqpxmzd-l01-1.png)
## Datasheet
The datasheet of the L01 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_L01_v2.pdf" target="_blank"> L01 Datasheet </a>
## Pinout
The pinout of the L01 is available as a PDF File
{% file src="/gitbook/assets/l01-pinout.pdf" caption="L01 Pinout" %}
<a href="/gitbook/assets/l01-pinout.pdf" target="_blank"> L01 Pinout </a>
![](/gitbook/assets/l01-pinout.png)
## Specsheets
The specsheet of the L01 is available as a PDF File.
{% file src="/gitbook/assets/l01-specsheet-1.pdf" caption="L01 Datasheet" %}
## Drawings
The drawings for the L01 is available as a PDF File.
{% file src="/gitbook/assets/l01-drawing.pdf" caption="L01 Drawing" %}
<a href="/gitbook/assets/l01-drawing.pdf" target="_blank"> L01 Drawing </a>
{{% 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.
@@ -34,10 +35,10 @@ Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO)
## Tutorials
Tutorials on how to the L01 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the L01:
Tutorials on how to the L01 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the L01:
* [WiFi connection](/../tutorials/all/wlan)
* [LoRaWAN node](/../tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/../tutorials/lora/lorawan-nano-gateway)
* [BLE](/../tutorials/all/ble)
* [WiFi connection](/tutorials/all/wlan)
* [LoRaWAN node](/tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/tutorials/lora/lorawan-nano-gateway)
* [BLE](/tutorials/all/ble)

10
content/datasheets/oem/l01_reference.md
View File

@@ -6,12 +6,13 @@ aliases:
- product-info/oem/l01_reference
- chapter/datasheets/oem/l01_reference
---
![](/gitbook/assets/l01-reference%20%281%29.png)
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" %}}
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 >}}
## Features
@@ -33,7 +34,7 @@ If you require a reference board for the L04 or G01, this design is **not** suit
The layout of the L01 baseboard reference is available as a PDF File
{% file src="/gitbook/assets/l01-oem-layout.pdf" caption="L01 OEM Layout" %}
<a href="/gitbook/assets/l01-oem-layout.pdf" target="_blank"> L01 OEM Layout </a>
![](/gitbook/assets/l01-oem-layout-1.png)
@@ -41,11 +42,10 @@ The layout of the L01 baseboard reference is available as a PDF File
The schematic of the L01 baseboard reference is available as a PDF File.
{% file src="/gitbook/assets/l01-oem-schematic.pdf" caption="L01 OEM Schematic" %}
<a href="/gitbook/assets/l01-oem-schematic.pdf" target="_blank"> L01 OEM Schematic </a>
## Altium Project and Gerber Files
The Altium Project and Gerber files are also available as a ZIP File.
{% file src="/gitbook/assets/l01-oem-baseboard-ref.zip" caption="L01 OEM Altium Project and Gerber Files" %}
<a href="/gitbook/assets/l01-oem-baseboard-ref.zip" target="_blank"> L01 OEM Altium Project and Gerber Files </a>

43
content/datasheets/oem/l04.md
View File

@@ -6,39 +6,52 @@ aliases:
- product-info/oem/l04
- chapter/datasheets/oem/l04
---
![](/gitbook/assets/l04-1.png)
![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86hknsrea22r0i-s-l04-1.png)
## Datasheet
The datasheet of the L04 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_L04_v2.pdf" target="_blank"> L04 Datasheet </a>
## Pinout
The pinout of the L04 is available as a PDF File
{% file src="/gitbook/assets/l04-pinout.pdf" caption="L04 Pinout" %}
<a href="/gitbook/assets/l04-pinout.pdf" target="_blank"> L04 Pinout </a>
![](/gitbook/assets/l04-pinout.png)
## Specsheets
The specsheet of the L04 is available as a PDF File.
{% file src="/gitbook/assets/l04-specsheet.pdf" caption="L04 Datasheet" %}
## Drawings
The drawings for the L04 is available as a PDF File.
{% file src="/gitbook/assets/l04-drawing.pdf" caption="L04 Drawings" %}
<a href="/gitbook/assets/l04-drawing.pdf" target="_blank"> L04 Drawings </a>
{{% hint style="info" %}}
Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software.
{{< /hint >}}
## Power Consumption
Here are some basic power usage measurements for various scenarios.
* Idle : 36.2mA - Whilst the LO4 is idle. but awake
* Lora transmit : 141mA - Whilst the LO4 is transmitting a Lora Payload
* WiFi AP: 116mA - Whilst the LO4 is serving as a Wifi Access Point
* Wifi client : 110mA - Whilst the LO4 is serving as a Wifi Access Client
* Bluetooth : 116mA - Whilst the LO4 has bluetooth active
* DeepSleep : 5.5 uA - Whilst the LO4 is in deepsleep
## Tutorials
Tutorials on how to the L04 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the L04:
Tutorials on how to the L04 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the L04:
* [WiFi connection](/../tutorials/all/wlan)
* [LoRaWAN node](/../tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/../tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/../tutorials/sigfox)
* [BLE](/../tutorials/all/ble)
* [WiFi connection](/tutorials/all/wlan)
* [LoRaWAN node](/tutorials/lora/lorawan-abp)
* [LoRaWAN nano gateway](/tutorials/lora/lorawan-nano-gateway)
* [Sigfox](/tutorials/sigfox)
* [BLE](/tutorials/all/ble)

7
content/datasheets/oem/universal_reference.md
View File

@@ -6,6 +6,7 @@ aliases:
- product-info/oem/universal_reference
- chapter/datasheets/oem/universal_reference
---
![](/gitbook/assets/universal_reference%20%281%29.png)
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.
@@ -33,7 +34,7 @@ If you require a reference board for the G01, only this design is suitable. The
The layout of the OEM baseboard reference is available as a PDF File
{% file src="/gitbook/assets/oem-universal-layout.pdf" caption="OEM Layout" %}
<a href="/gitbook/assets/oem-universal-layout.pdf" target="_blank"> OEM Layout </a>
![](/gitbook/assets/oem-universal-layout-1.png)
@@ -41,11 +42,11 @@ The layout of the OEM baseboard reference is available as a PDF File
The schematic of the OEM baseboard reference is available as a PDF File.
{% file src="/gitbook/assets/oem-universal-schematic.pdf" caption="OEM Schematic" %}
<a href="/gitbook/assets/oem-universal-schematic.pdf" target="_blank"> OEM Schematic </a>
## Altium Project and Gerber Files
The Altium Project and Gerber files are also available as a ZIP File.
{% file src="/gitbook/assets/oem-universal-baseboard-ref.zip" caption="OEM Altium Project and Gerber Files" %}
[OEM Altium Project and Gerber Files](/gitbook/assets/oem-universal-baseboard-ref.zip)

25
content/datasheets/oem/w01.md
View File

@@ -6,27 +6,27 @@ aliases:
- product-info/oem/w01
- chapter/datasheets/oem/w01
---
![](/gitbook/assets/w01%20%281%29.png)
## ![](/gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85ios3qzh5brsxk2-w01.png)
## Datasheet
The datasheet of the W01 is available as a PDF File.
<a href="/gitbook/assets/specsheets/Pycom_002_Specsheets_W01_v2.pdf" target="_blank"> W01 Datasheet </a>
## Pinout
The pinout of the W01 is available as a PDF File
{% file src="/gitbook/assets/w01-pinout.pdf" caption="W01 Pinout" %}
<a href="/gitbook/assets/w01-pinout.pdf" target="_blank"> W01 Pinout </a>
![](/gitbook/assets/w01-pinout.png)
## Specsheets
The specsheet of the W01 is available as a PDF File.
{% file src="/gitbook/assets/w01-specsheet-1.pdf" caption="W01 Datasheet" %}
## Drawings
The drawings for the W01 is available as a PDF File.
{% file src="/gitbook/assets/w01-drawing.pdf" caption="W01 Drawings" %}
<a href="/gitbook/assets/w01-drawing.pdf" target="_blank"> W01 Drawings </a>
{{% 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.
@@ -34,8 +34,7 @@ Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO)
## Tutorials
Tutorials on how to the W01 module can be found in the [examples](/../tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the W01:
* [WiFi connection](/../tutorials/all/wlan)
* [BLE](/../tutorials/all/ble)
Tutorials on how to the W01 module can be found in the [examples](/tutorials/introduction) section of this documentation. The following tutorials might be of specific interest for the W01:
* [WiFi connection](/tutorials/all/wlan)
* [BLE](/tutorials/all/ble)

3
content/firmwareapi/micropython/builtin.md
View File

@@ -5,7 +5,7 @@ aliases:
- firmwareapi/micropython/builtin.md
- chapter/firmwareapi/micropython/builtin
---
All builtin functions are described here. They are also available via [builtins](builtin) module.
All builtin functions are described here. They are also available via [builtins](../builtin) module.
abs()
@@ -128,4 +128,3 @@ class tuple
type()
zip()

3
content/firmwareapi/micropython/ucrypto.md
View File

@@ -9,7 +9,7 @@ This module provides native support for cryptographic algorithms. It's loosely b
## Classes
* [class AES](/pycom/aes) - Advanced Encryption Standard
* [class AES](../../pycom/aes) - Advanced Encryption Standard
## **Methods**
@@ -24,4 +24,3 @@ The parameter `bits` is rounded upwards to the nearest multiple of 32 bits.
{{% hint style="danger" %}}
Cryptography is not a trivial business. Doing things the wrong way could quickly result in decreased or no security. Please document yourself in the subject if you are depending on encryption to secure important information.
{{< /hint >}}

4
content/firmwareapi/micropython/usocket.md
View File

@@ -127,7 +127,7 @@ Closing the file object returned by `makefile()` **WILL** close the original soc
#### socket.read(size)
Read up to size bytes from the socket. Return a bytes object. If `size` is not given, it behaves just like [`socket.readall()`](usocket.md#socket-readall), see below.
Read up to size bytes from the socket. Return a bytes object. If `size` is not given, it behaves just like [`socket.readall()`](../usocket#socket-readall), see below.
#### socket.readall()
@@ -157,7 +157,7 @@ Perform the SSL handshake on the previously "wrapped" socket with ssl.wrap_socke
COuld be used when the socket is non-blocking and the SSL handshake is not performed during connect().
#### socket.dnsserver(*, dnsIndex, ip_addr)
When no arguments are passed this function returns the configured DNS servers Primary (Index=0) and backup (Index = 1)
to set primary and Backup DNS servers specify the Index and Ip Address.

3
content/firmwareapi/micropython/uzlib.md
View File

@@ -1,5 +1,5 @@
---
title: ""
title: "uzlib"
aliases:
- firmwareapi/micropython/uzlib.html
- firmwareapi/micropython/uzlib.md
@@ -24,4 +24,3 @@ Create a `stream` wrapper which allows transparent decompression of compressed d
This class is MicroPython extension. It's included on provisional basis and may be changed considerably or removed in later versions.
{{< /hint >}}

3
content/firmwareapi/notes.md
View File

@@ -13,9 +13,8 @@ These limitations were raised by handling the interrupt events differently. When
The user can do whatever is required inside of the callback, such as creating new variables, or even sending network packets. Bear in mind that interrupts are processed sequentially and thus it is ideal to keep the handlers as short as possible in order to attend all of them in the minimum time.
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`](/firmwareapi/pycom/machine/timer.md#class-timer-alarm-handler-none-s-ms-us-arg-none-periodic-false) and [`Pin`](/firmwareapi/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" %}}
Currently the interrupt system can queue up to **16 interrupts**.
{{< /hint >}}

6
content/firmwareapi/pycom/machine/adc.md
View File

@@ -5,11 +5,6 @@ aliases:
- firmwareapi/pycom/machine/adc.md
- chapter/firmwareapi/pycom/machine/adc
---
keywords:
- ADC
- Analog
- ADCChannel
---
# ADC
@@ -102,4 +97,3 @@ Converts the provided value into a voltage (in millivolts) in the same way volta
{{% hint style="danger" %}}
ADC pin input range is `0-1.1V`. This maximum value can be increased up to `3.3V` using the highest attenuation of `11dB`. **Do not exceed the maximum of 3.3V**, to avoid damaging the device.
{{< /hint >}}

5
content/firmwareapi/pycom/machine/pin.md
View File

@@ -28,7 +28,7 @@ p_in() # get value, 0 or 1
#### class machine.Pin(id, ...)
Create a new Pin object associated with the string `id`. If additional arguments are given, they are used to initialise the pin. [See pin.init()](pin.md#pin-init-mode-pull-alt)
Create a new Pin object associated with the string `id`. If additional arguments are given, they are used to initialise the pin. [See pin.init()](../pin#pin-init-mode-pull-alt)
```python
from machine import Pin
@@ -124,7 +124,7 @@ p_in.callback(Pin.IRQ_FALLING | Pin.IRQ_RISING, pin_handler)
```
{{% 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 >}}
## Attributes
@@ -155,4 +155,3 @@ The following constants are used to configure the pin objects. Note that not all
* Selects the pin mode: `Pin.IN`, `Pin.OUT`, `Pin.OPEN_DRAIN`
* Enables the pull up or pull down resistor: `Pin.PULL_UP`, `Pin.PULL_DOWN`

9
content/firmwareapi/pycom/machine/rmt.md
View File

@@ -5,14 +5,6 @@ aliases:
- firmwareapi/pycom/machine/rmt.md
- chapter/firmwareapi/pycom/machine/rmt
---
keywords:
- RMT
- Remote
- Remote Controller
- Pulse
---
# RMT
The RMT (Remote Control) module is primarily designed to send and receive infrared remote control signals that use on-off-keying of a carrier frequency, but due to its design it can be used to generate various types of signals.
@@ -132,4 +124,3 @@ Generates pulses as defined by the parameters below
## Constants
* Define the level of the pulse: `RMT.LOW`, `RMT.HIGH`

3
content/firmwareapi/pycom/machine/sd.md
View File

@@ -40,7 +40,7 @@ f.close()
#### class machine.SD(id, ...)
Create a SD card object. See [`sd.init()`](sd.md#sd-init-id-0) for parameters if initialisation.
Create a SD card object. See [`sd.init()`](../sd#sd-init-id-0) for parameters if initialisation.
## Methods
@@ -55,4 +55,3 @@ Disable the SD card.
{{% hint style="info" %}}
Please note that the SD card library currently supports FAT16/32 formatted SD cards up to 32 GB. Future firmware updates will increase compatibility with additional formats and sizes.
{{< /hint >}}

3
content/firmwareapi/pycom/machine/timer.md
View File

@@ -127,6 +127,5 @@ clock = Clock()
```
{{% 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 >}}

536
content/firmwareapi/pycom/network/lora/README.md
View File

@@ -1,536 +0,0 @@
---
title: "LoRa"
aliases:
---
This class provides a LoRaWAN 1.0.2 compliant driver for the LoRa network processor in the LoPy and FiPy. Below is an example demonstrating LoRaWAN Activation by Personalisation usage:
```python
from network import LoRa
import socket
import ubinascii
import struct
# Initialise LoRa in LORAWAN mode.
# Please pick the region that matches where you are using the device:
# Asia = LoRa.AS923
# Australia = LoRa.AU915
# Europe = LoRa.EU868
# United States = LoRa.US915
lora = LoRa(mode=LoRa.LORAWAN, region=LoRa.EU868)
# create an ABP authentication params
dev_addr = struct.unpack(">l", binascii.unhexlify('00000005'))[0]
nwk_swkey = ubinascii.unhexlify('2B7E151628AED2A6ABF7158809CF4F3C')
app_swkey = ubinascii.unhexlify('2B7E151628AED2A6ABF7158809CF4F3C')
# join a network using ABP (Activation By Personalisation)
lora.join(activation=LoRa.ABP, auth=(dev_addr, nwk_swkey, app_swkey))
# create a LoRa socket
s = socket.socket(socket.AF_LORA, socket.SOCK_RAW)
# set the LoRaWAN data rate
s.setsockopt(socket.SOL_LORA, socket.SO_DR, 5)
# make the socket non-blocking
s.setblocking(False)
# send some data
s.send(bytes([0x01, 0x02, 0x03]))
# get any data received...
data = s.recv(64)
print(data)
```
{{% hint style="danger" %}}
Please ensure that there is an antenna connected to your device before sending/receiving LoRa messages as improper use (e.g. without an antenna), may damage the device.
{{< /hint >}}
## Additional Examples
For various other complete LoRa examples, check here for additional examples.
## Constructors
#### class network.LoRa(id=0, ...)
Create and configure a LoRa object. See init for params of configuration.
```python
lora = LoRa(mode=LoRa.LORAWAN, region=LoRa.EU868)
```
## Methods
#### lora.init(mode, \* ,region=LoRa.EU868, frequency=868000000, tx\_power=14, bandwidth=LoRa.BW\_125KHZ, sf=7, preamble=8, coding\_rate=LoRa.CODING\_4\_5, power\_mode=LoRa.ALWAYS\_ON, tx\_iq=False, rx\_iq=False, adr=False, public=True, tx\_retries=1, device\_class=LoRa.CLASS\_A)
This method is used to set the LoRa subsystem configuration and to specific raw LoRa or LoRaWAN.
The arguments are:
* `mode` can be either `LoRa.LORA` or `LoRa.LORAWAN`.
* `region` can take the following values: `LoRa.AS923`, `LoRa.AU915`, `LoRa.EU868` or `LoRa.US915`. If not provided this will default to `LoRaEU868`. If they are not specified, this will also set appropriate defaults for `frequency` and `tx_power`.
* `frequency` accepts values between `863000000` and `870000000` in the 868 band, or between `902000000` and `928000000` in the 915 band.
* `tx_power` is the transmit power in dBm. It accepts between 2 and 14 for the 868 band, and between 5 and 20 in the 915 band.
* `bandwidth` is the channel bandwidth in KHz. In the 868 band the accepted values are `LoRa.BW_125KHZ` and `LoRa.BW_250KHZ`. In the 915 band the accepted values are `LoRa.BW_125KHZ` and `LoRa.BW_500KHZ`.
* `sf` sets the desired spreading factor. Accepts values between 7 and 12.
* `preamble` configures the number of pre-amble symbols. The default value is 8.
* `coding_rate` can take the following values: `LoRa.CODING_4_5`, `LoRa.CODING_4_6`, `LoRa.CODING_4_7` or `LoRa.CODING_4_8`.
* `power_mode` can be either `LoRa.ALWAYS_ON`, `LoRa.TX_ONLY` or `LoRa.SLEEP`. In `ALWAYS_ON` mode, the radio is always listening for incoming - packets whenever a transmission is not taking place. In `TX_ONLY` the radio goes to sleep as soon as the transmission completes. In `SLEEP` mode the radio is sent to sleep permanently and won't accept any commands until the power mode is changed.
* `tx_iq` enables TX IQ inversion.
* `rx_iq` enables RX IQ inversion.
* `adr` enables Adaptive Data Rate.
* `public` selects between the public and private sync word.
* `tx_retries` sets the number of TX retries in `LoRa.LORAWAN` mode.
* `device_class` sets the LoRaWAN device class. Can be either `LoRa.CLASS_A` or `LoRa.CLASS_C`.
{{% hint style="info" %}}
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 >}}
For example, you can do:
```python
# initialize in raw LoRa mode
lora.init(mode=LoRa.LORA, tx_power=14, sf=12)
```
or
```python
# initialize in LoRaWAN mode
lora.init(mode=LoRa.LORAWAN)
```
#### lora.join(activation, auth, \* ,timeout=None, dr=None)
Join a LoRaWAN network. Internally the stack will automatically retry every 15 seconds until a Join Accept message is received.
The parameters are:
* `activation`: can be either `LoRa.OTAA` or `LoRa.ABP`.
* `auth`: is a tuple with the authentication data.
* `timeout`: is the maximum time in milliseconds to wait for the Join Accept message to be received. If no timeout (or zero) is given, the call returns immediately and the status of the join request can be checked with `lora.has_joined()`.
* `dr`: is an optional value to specify the initial data rate for the Join Request. Possible values are 0 to 5 for **EU868**, or 0 to 4 for **US915**.
In the case of `LoRa.OTAA` the authentication tuple is: `(dev_eui, app_eui, app_key)` where `dev_eui` is optional. If it is not provided the LoRa MAC will be used. Therefore, you can do OTAA in 2 different ways:
```python
lora.join(activation=LoRa.OTAA, auth=(app_eui, app_key), timeout=0) # the device MAC address is used as DEV_EUI
```
or
```python
lora.join(activation=LoRa.OTAA, auth=(dev_eui, app_eui, app_key), timeout=0) # a custom DEV_EUI is specified
```
Example:
```python
from network import LoRa
import socket
import time
import ubinascii
# Initialise LoRa in LORAWAN mode.
# Please pick the region that matches where you are using the device:
# Asia = LoRa.AS923
# Australia = LoRa.AU915
# Europe = LoRa.EU868
# United States = LoRa.US915
lora = LoRa(mode=LoRa.LORAWAN, region=LoRa.EU868)
# create an OTAA authentication parameters
app_eui = ubinascii.unhexlify('ADA4DAE3AC12676B')
app_key = ubinascii.unhexlify('11B0282A189B75B0B4D2D8C7FA38548B')
# join a network using OTAA (Over the Air Activation)
lora.join(activation=LoRa.OTAA, auth=(app_eui, app_key), timeout=0)
# wait until the module has joined the network
while not lora.has_joined():
time.sleep(2.5)
print('Not yet joined...')
```
In the case of `LoRa.ABP` the authentication tuple is: `(dev_addr, nwk_swkey, app_swkey)`. Example:
```python
from network import LoRa
import socket
import ubinascii
import struct
# Initialise LoRa in LORAWAN mode.
# Please pick the region that matches where you are using the device:
# Asia = LoRa.AS923
# Australia = LoRa.AU915
# Europe = LoRa.EU868
# United States = LoRa.US915
lora = LoRa(mode=LoRa.LORAWAN, region=LoRa.EU868)
# create an ABP authentication params
dev_addr = struct.unpack(">l", ubinascii.unhexlify('00000005'))[0]
nwk_swkey = ubinascii.unhexlify('2B7E151628AED2A6ABF7158809CF4F3C')
app_swkey = ubinascii.unhexlify('2B7E151628AED2A6ABF7158809CF4F3C')
# join a network using ABP (Activation By Personalisation)
lora.join(activation=LoRa.ABP, auth=(dev_addr, nwk_swkey, app_swkey))
```
#### lora.bandwidth(\[bandwidth\])
Get or set the bandwidth in raw LoRa mode (`LoRa.LORA`). Can be either `LoRa.BW_125KHZ` (0), `LoRa.BW_250KHZ` (1) or `LoRa.BW_500KHZ` (2):
```python
# get raw LoRa Bandwidth
lora.bandwidth()
# set raw LoRa Bandwidth
lora.bandwidth(LoRa.BW_125KHZ)
```
#### lora.frequency(\[frequency\])
Get or set the frequency in raw LoRa mode (`LoRa.LORA`). The allowed range is between `863000000` and `870000000` Hz for the 868 MHz band version or between `902000000` and `928000000` Hz for the 915 MHz band version.
```python
# get raw LoRa Frequency
lora.frequency()
# set raw LoRa Frequency
lora.frequency(868000000)
```
#### lora.coding\_rate(\[coding\_rate\])
Get or set the coding rate in raw LoRa mode (`LoRa.LORA`). The allowed values are: `LoRa.CODING_4_5` (1), `LoRa.CODING_4_6` (2), `LoRa.CODING_4_7` (3) and `LoRa.CODING_4_8` (4).
```python
# get raw LoRa Coding Rate
lora.coding_rate()
# set raw LoRa Coding Rate
lora.coding_rate(LoRa.CODING_4_5)
```
#### lora.preamble(\[preamble\])
Get or set the number of preamble symbols in raw LoRa mode (`LoRa.LORA`):
```python
# get raw LoRa preamble symbols
lora.preamble()
# set raw LoRa preamble symbols
lora.preamble(LoRa.CODING_4_5)
```
#### lora.sf(\[sf\])
Get or set the spreading factor value in raw LoRa mode (`LoRa.LORA`). The minimum value is 7 and the maximum is 12:
```python
# get raw LoRa spread factor value
lora.sf()
# set raw LoRa spread factor value
lora.sf(7)
```
#### lora.power\_mode(\[power\_mode\])
Get or set the power mode in raw LoRa mode (`LoRa.LORA`). The accepted values are: `LoRa.ALWAYS_ON`, `LoRa.TX_ONLY`, and `LoRa.SLEEP`:
#### lora.stats()
Return a named tuple with useful information from the last received LoRa or LoRaWAN packet. The named tuple has the following form:
`(rx_timestamp, rssi, snr, sftx, sfrx, tx_trials, tx_power, tx_time_on_air, tx_counter, tx_frequency)`
Example:
```python
lora.stats()
```
Where:
* `rx_timestamp` is an internal timestamp of the last received packet with microseconds precision.
* `rssi` holds the received signal strength in dBm.
* `snr` contains the signal to noise ratio id dB (as a single precision float).
* `sfrx` tells the data rate (in the case of LORAWAN mode) or the spreading factor (in the case of LORA mode) of the last packet received.
* `sftx` tells the data rate (in the case of LORAWAN mode) or the spreading factor (in the case of LORA mode) of the last packet transmitted.
* `tx_trials` is the number of tx attempts of the last transmitted packet (only relevant for LORAWAN confirmed packets).
* `tx_power` is the power of the last transmission (in dBm).
* `tx_time_on_air` is the time on air of the last transmitted packet (in ms).
* `tx_counter` is the number of packets transmitted.
* `tx_frequency` is the frequency used for the last transmission.
#### lora.has\_joined()
Returns `True` if a LoRaWAN network has been joined. `False` otherwise.
#### lora.add\_channel(index, \* , frequency, dr\_min, dr\_max)
Add a LoRaWAN channel on the specified `index`. If there's already a channel with that index it will be replaced with the new one.
The arguments are:
* `index`: Index of the channel to add. Accepts values between 0 and 15 for EU and between 0 and 71 for US.
* `frequency`: Centre frequency in Hz of the channel.
* `dr_min`: Minimum data rate of the channel (0-7).
* `dr_max`: Maximum data rate of the channel (0-7).
Examples:
```python
lora.add_channel(index=0, frequency=868000000, dr_min=5, dr_max=6)
```
#### lora.remove\_channel(index)
Removes the channel from the specified `index`. On the 868MHz band the channels 0 to 2 cannot be removed, they can only be replaced by other channels using the `lora.add_channel` method. A way to remove all channels except for one is to add the same channel, 3 times on indexes 0, 1 and 2. An example can be seen below:
```python
lora.remove_channel()
```
On the 915MHz band there are no restrictions around this.
#### lora.mac()
Returns a byte object with the 8-Byte MAC address of the LoRa radio.
#### lora.callback(trigger, handler=None, arg=None)
Specify a callback handler for the LoRa radio. The `trigger` types are `LoRa.RX_PACKET_EVENT`, `LoRa.TX_PACKET_EVENT`, and `LoRa.TX_FAILED_EVENT`
The `LoRa.RX_PACKET_EVENT` event is raised for every received packet. The `LoRa.TX_PACKET_EVENT` event is raised as soon as the packet transmission cycle ends, which includes the end of the receive windows (even if a downlink is received, the `LoRa.TX_PACKET_EVENT` will come last). In the case of non-confirmed transmissions, this will occur at the end of the receive windows, but, in the case of confirmed transmissions, this event will only be raised if the `ack` is received. If the `ack` is not received `LoRa.TX_FAILED_EVENT` will be raised after the number of `tx_retries` configured have been performed.
An example of how this callback functions can be seen the in method [`lora.events()`](lora.md#lora-events).
#### lora.ischannel\_free(rssi\_threshold)
This method is used to check for radio activity on the current LoRa channel, and if the `rssi` of the measured activity is lower than the `rssi_threshold` given, the return value will be `True`, otherwise `False`. Example:
```python
lora.ischannel_free(-100)
```
#### lora.set\_battery\_level(level)
Set the battery level value that will be sent when the LoRaWAN MAC command that retrieves the battery level is received. This command is sent by the network and handled automatically by the LoRaWAN stack. The values should be according to the LoRaWAN specification:
* `0` means that the end-device is connected to an external power source.
* `1..254` specifies the battery level, 1 being at minimum and 254 being at maximum.
* `255` means that the end-device was not able to measure the battery level.
```python
lora.set_battery_level(127) # 50% battery
```
#### lora.events()
This method returns a value with bits sets (if any) indicating the events that have triggered the callback. Please note that by calling this function the internal events registry is cleared automatically, therefore calling it immediately for a second time will most likely return a value of 0.
Example:
```python
def lora_cb(lora):
events = lora.events()
if events & LoRa.RX_PACKET_EVENT:
print('Lora packet received')
if events & LoRa.TX_PACKET_EVENT:
print('Lora packet sent')
lora.callback(trigger=(LoRa.RX_PACKET_EVENT | LoRa.TX_PACKET_EVENT), handler=lora_cb)
```
#### lora.nvram\_save()
Save the LoRaWAN state (joined status, network keys, packet counters, etc) in non-volatile memory in order to be able to restore the state when coming out of deepsleep or a power cycle.
```python
lora.nvram_save()
```
#### lora.nvram\_restore()
Restore the LoRaWAN state (joined status, network keys, packet counters, etc) from non-volatile memory. State must have been previously stored with a call to `nvram_save` before entering deepsleep. This is useful to be able to send a LoRaWAN message immediately after coming out of deepsleep without having to join the network again. This can only be used if the current region matches the one saved.
```python
lora.nvram_restore()
```
#### lora.nvram\_erase()
Remove the LoRaWAN state (joined status, network keys, packet counters, etc) from non-volatile memory.
```python
lora.nvram_erase()
```
#### lora.nvram\_erase()
Remove the LoRaWAN state (joined status, network keys, packet counters, etc) from non-volatile memory.
```python
lora.nvram_erase()
```
#### lora.mesh()
Enable the Mesh network. Only after Mesh enabling the `lora.cli()` and `socket` can be used.
```python
lora.mesh()
```
#### lora.cli()
Send OpenThread CLI commands, the list is [here](https://github.com/openthread/openthread/blob/master/src/cli/README). The output is multiline string, having as line-endings the `\r\n`.
```bash
>>> print(lora.cli("ipaddr"))
fdde:ad00:beef:0:0:ff:fe00:fc00
fdde:ad00:beef:0:0:ff:fe00:e800
fdde:ad00:beef:0:e1f0:783c:1e8f:c763
fe80:0:0:0:2c97:cb65:3219:c86
```
## Constants
* LoRa stack mode: `LoRa.LORA`, `LoRa.LORAWAN`
* LoRaWAN join procedure: `LoRa.OTAA`, `LoRa.ABP`
* Raw LoRa power mode: `LoRa.ALWAYS_ON`, `LoRa.TX_ONLY`, `LoRa.SLEEP`
* Raw LoRa bandwidth: `LoRa.BW_125KHZ`, `LoRa.BW_250KHZ`, `LoRa.BW_500KHZ`
* Raw LoRa coding rate: `LoRa.CODING_4_5`, `LoRa.CODING_4_6`, `LoRa.CODING_4_7`, `LoRa.CODING_4_8`
* Callback trigger types (may be ORed): `LoRa.RX_PACKET_EVENT`, `LoRa.TX_PACKET_EVENT`, `LoRa.TX_FAILED_EVENT`
* LoRaWAN device class: `LoRa.CLASS_A`, `LoRa.CLASS_C`
* LoRaWAN regions: `LoRa.AS923`, `LoRa.AU915`, `LoRa.EU868`, `LoRa.US915`
## Exceptions
* `LoRa.timeout`
## Working with LoRa and LoRaWAN Sockets
LoRa sockets are created in the following way:
```python
import socket
s = socket.socket(socket.AF_LORA, socket.SOCK_RAW)
```
And they must be created after initialising the LoRa network card.
LoRa-Mesh socket is created, if the Mesh was enabled before (`lora.mesh()` was called).
{{% hint style="info" %}}
The LoRa-Mesh socket supports only the following socket methods: `close()` , `bind()`, `sendto()`, and `recvfrom()`.
{{< /hint >}}
LoRa sockets support the following standard methods from the socket module:
#### socket.close()
Usage:
```python
s.close()
```
#### socket.bind(port\_number)
Usage:
```python
s.bind(1)
```
{{% hint style="info" %}}
The `bind()` method is only applicable when the radio is configured in `LoRa.LORAWAN` mode.
{{< /hint >}}
#### socket.send(bytes)
Usage:
```python
s.send(bytes([1, 2, 3]))
```
or
```python
s.send('Hello')
```
#### socket.sendto(bytes,(ip, port))
This is supported only by the LoRa Mesh socket.
Usage:
```python
s.sendto('Hello', ('fdde:ad00:beef:0:0:ff:fe00:e800', 1234))
```
#### socket.recv(bufsize)
Usage:
```python
s.recv(128)
```
#### socket.recvfrom(bufsize)
This method is useful to know the destination port number of the message received. Returns a tuple of the form: `(data, port)`
Usage:
```python
s.recvfrom(128)
```
#### socket.setsockopt(level, optname, value)
Set the value of the given socket option. The needed symbolic constants are defined in the socket module (`SO_*` etc.). In the case of LoRa the values are always integers. Examples:
```python
# configuring the data rate
s.setsockopt(socket.SOL_LORA, socket.SO_DR, 5)
# selecting non-confirmed type of messages
s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, False)
# selecting confirmed type of messages
s.setsockopt(socket.SOL_LORA, socket.SO_CONFIRMED, True)
```
{{% hint style="info" %}}
Socket options are only applicable when the LoRa radio is used in LoRa.LORAWAN mode. When using the radio in LoRa.LORA mode, use the class methods to change the spreading factor, bandwidth and coding rate to the desired values.
{{< /hint >}}
#### socket.settimeout(value)
Sets the socket timeout value in seconds. Accepts floating point values.
Usage:
```python
s.settimeout(5.5)
```
#### socket.setblocking(flag)
Usage:
```python
s.setblocking(True)
```

4
content/firmwareapi/pycom/network/lora/_index.md
View File

@@ -1,6 +1,7 @@
---
title: "LoRa"
aliases:
- /firmwareapi/pycom/network/lora.md
---
This class provides a LoRaWAN 1.0.2 compliant driver for the LoRa network processor in the LoPy and FiPy. Below is an example demonstrating LoRaWAN Activation by Personalisation usage:
@@ -310,7 +311,7 @@ Specify a callback handler for the LoRa radio. The `trigger` types are `LoRa.RX_
The `LoRa.RX_PACKET_EVENT` event is raised for every received packet. The `LoRa.TX_PACKET_EVENT` event is raised as soon as the packet transmission cycle ends, which includes the end of the receive windows (even if a downlink is received, the `LoRa.TX_PACKET_EVENT` will come last). In the case of non-confirmed transmissions, this will occur at the end of the receive windows, but, in the case of confirmed transmissions, this event will only be raised if the `ack` is received. If the `ack` is not received `LoRa.TX_FAILED_EVENT` will be raised after the number of `tx_retries` configured have been performed.
An example of how this callback functions can be seen the in method [`lora.events()`](lora.md#lora-events).
An example of how this callback functions can be seen the in method [`lora.events()`](../lora#lora-events).
#### lora.ischannel\_free(rssi\_threshold)
@@ -533,4 +534,3 @@ Usage:
```python
s.setblocking(True)
```

4
content/firmwareapi/pycom/network/lora/pymesh.md
View File

@@ -5,10 +5,6 @@ aliases:
- firmwareapi/pycom/network/lora/pymesh.md
---
# Pymesh - LoRa Mesh
This class provides Pymesh - LoRa Mesh protocol compliant for the LoRa network processor in the LoPy and FiPy. Below is an example demonstrating Pymesh initialisation and basic usage:
```python

3
content/firmwareapi/pycom/network/wlan.md
View File

@@ -41,7 +41,7 @@ print(wlan.ifconfig())
### class network.WLAN(id=0, ...)
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#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.
@@ -350,4 +350,3 @@ To get the current Filter mask, call the function with empty args.
`WLAN.FILTER_CTRL_PKT_CFEND`: Filter Control CFEND Packets
`WLAN.FILTER_CTRL_PKT_CFENDACK`: Filter Control CFENDACK Packets

12
content/getting-started/hardwaresetup/README.md
View File

@@ -1,12 +0,0 @@
---
title: ""
aliases:
---
This chapter of the documentation will show you how to connect you Pycom module. For each device there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter or WiFi as well as what antennas you might need to connect. Please select your module below to be taken to the appropriate guide.
[![](/gitbook/assets/wipy.png)](wipy)
[![](/gitbook/assets/lopy%20%282%29.png)](lopy)
[![](/gitbook/assets/lopy4.png)](lopy4)

118
content/getting-started/hardwaresetup/fipy.md
View File

@@ -1,118 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/fipy.html
- getting-started/hardwaresetup/fipy.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the FiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_fipy.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/pytrackpysense/installation/firmware.html).
* When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the FiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_fipy.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/pytrackpysense/installation/firmware.html).
* Look for the reset button on the FiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_fipy.png)
![](/gitbook/assets/pytrack_fipy.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your FiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the FiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_fipy.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the FiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the FiPy:
![](/gitbook/assets/bare_fipy.png)
* By default, when the FiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `fipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the FiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### Lora/Sigfox
{{% hint style="danger" %}}
If you intend on using the LoRa/Sigfox connectivity of the FiPy you **must** connect a LoRa/Sigfox antenna to your FiPy before trying to use LoRa/Sigfox otherwise you risk damaging the device.
{{< /hint >}}
{{% hint style="info" %}}
The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
{{< /hint >}}
* Firstly you will need to connect the U.FL to SMA pig tail to the FiPy using the U.FL connector on the same side of the FiPy as the LED.
![](/gitbook/assets/lora_sigfox_pigtail_fipy.png)
* If you are using a pycase, you will next need to put the SMA connector through the antenna hole, ensuring you align the flat edge correctly, and screw down the connector using the provided nut.
* Finally you will need to screw on the antenna to the SMA connector.
![](/gitbook/assets/lora_sigfox_pigtail_ant_fipy.png)
### LTE Cat-M1/NB-IoT
{{% hint style="danger" %}}
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your FiPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device.
{{< /hint >}}
* You will need to connect the antenna to the FiPy using the U.FL connector on the under side of the FiPy.
![](/gitbook/assets/lte_ant_fipy.png)
### WiFi/Bluetooth (optional)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_fipy.png)
### SIM card {#sim-card}
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you will need to insert a SIM card into your FiPy. It should be noted that the FiPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM.
![](/gitbook/assets/sim_fipy.png)

97
content/getting-started/hardwaresetup/gpy.md
View File

@@ -1,97 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/gpy.html
- getting-started/hardwaresetup/gpy.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the GPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_gpy.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the GPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_gpy.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the GPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_gpy.png)
![](/gitbook/assets/pytrack_gpy.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your GPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the GPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_gpy.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the GPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the GPy:
![](/gitbook/assets/bare_gpy.png)
* By default, when the GPy boots, it will create a WiFi access point with the following credentials:
* SSID:`gpy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the GPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### LTE Cat-M1/NB-IoT
{{% hint style="danger" %}}
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your GPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device.
{{< /hint >}}
* You will need to connect the antenna to the GPy using the U.FL connector on the same side of the GPy as the LED.
![](/gitbook/assets/lte_ant_gpy.png)
### WiFi/Bluetooth (optional)
All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/chapter/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_gpy.png)
### SIM card {#sim-card}
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you will need to insert a SIM card into your GPy. It should be noted that the GPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM.
![](/gitbook/assets/sim_gpy.png)

104
content/getting-started/hardwaresetup/lopy.md
View File

@@ -1,104 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/lopy.html
- getting-started/hardwaresetup/lopy.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_lopy.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/pytrackpysense/installation/firmware.html).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_lopy.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/pytrackpysense/installation/firmware.html).
* Look for the reset button on the LoPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_lopy.png)
![](/gitbook/assets/pytrack_lopy.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your LoPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do _not_ feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the LoPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_lopy.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the LoPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the LoPy:
![](/gitbook/assets/bare_lopy.png)
* By default, when the LoPy boots, it will create a WiFi access point with the following credentials:
* SSID: `lopy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### Lora
{{% hint style="danger" %}}
If you intend on using the LoRa connectivity of the LoPy you **must** connect a LoRa antenna to your LoPy before trying to use LoRa otherwise you risk damaging the device.
{{< /hint >}}
{{% hint style="danger" %}}
The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4.
{{< /hint >}}
* Firstly you will need to connect the U.FL to SMA pig tail to the LoPy using the U.FL connector on the same side of the LoPy as the LED.
![](/gitbook/assets/lora_pigtail_lopy.png)
* If you are using a pycase, you will next need to put the SMA connector through the antenna hole, ensuring you align the flat edge correctly, and screw down the connector using the provided nut.
* Finally you will need to screw on the antenna to the SMA connector.
![](/gitbook/assets/lora_pigtail_ant_lopy.png)
### WiFi/Bluetooth (optional)
All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/chapter/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_lopy.png)
### Deep Sleep current issue {#deep-sleep-current-issue}
The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a high current consumption in deep sleep mode. This issue has been resolved in all newer products. The cause for this issue is the DC to DC switch mode converter remains in a high performance mode even when the device is in deep sleep. The flash memory chip also does not power down. A more detailed explanation can be found [here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)

96
content/getting-started/hardwaresetup/lopy4.md
View File

@@ -1,96 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/lopy4.html
- getting-started/hardwaresetup/lopy4.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy4 module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_lopy4.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy4 module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_lopy4.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the LoPy4 module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_lopy4.png)
![](/gitbook/assets/pytrack_lopy4.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your LoPy4. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the LoPy4 into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_lopy4.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the LoPy4 via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the LoPy4:
![](/gitbook/assets/bare_lopy4.png)
* By default, when the LoPy4 boots, it will create a WiFi access point with the following credentials:
* SSID: `lopy4-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy4. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### Lora/Sigfox
{{% hint style="danger" %}}
If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** connect a LoRa/Sigfox antenna to your LoPy4 before trying to use LoRa/Sigfox otherwise you risk damaging the device.
{{< /hint >}}
* Firstly you will need to connect the U.FL to SMA pig tail to the LoPy4 using one of the two the U.FL connectors on the same side of the LoPy4 as the LED. The one on the left hand side is for 433MHz (LoRa only), the one of the right hand side is for 868MHz/915MHz (LoRa & Sigfox). **Note:** This is different from the LoPy.
![](/gitbook/assets/lora_sigfox_pigtail_lopy4.png)
* If you are using a pycase, you will next need to put the SMA connector through the antenna hole, ensuring you align the flat edge correctly, and screw down the connector using the provided nut.
* Finally you will need to screw on the antenna to the SMA connector.
![](/gitbook/assets/lora_sigfox_pigtail_ant_lopy4.png)
### WiFi/Bluetooth (optional)
All Pycom modules, including the LoPy4, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy4 in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/chapter/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_lopy4.png)

98
content/getting-started/hardwaresetup/sipy.md
View File

@@ -1,98 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/sipy.html
- getting-started/hardwaresetup/sipy.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the SiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_sipy.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the SiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_sipy.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the SiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_sipy.png)
![](/gitbook/assets/pytrack_sipy.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your SiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the SiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_sipy.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the SiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the SiPy:
![](/gitbook/assets/bare_sipy.png)
* By default, when the SiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `sipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the SiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### Sigfox
{{% hint style="danger" %}}
If you intend on using the Sigfox connectivity of the SiPy you **must** connect a Sigfox antenna to your SiPy before trying to use Sigfox otherwise you risk damaging the device.
{{< /hint >}}
* Firstly you will need to connect the U.FL to SMA pig tail to the SiPy using the U.FL connector on the same side of the SiPy as the LED.
![](/gitbook/assets/sigfox_pigtail_sipy.png)
* If you are using a pycase, you will next need to put the SMA connector through the antenna hole, ensuring you align the flat edge correctly, and screw down the connector using the provided nut.
* Finally you will need to screw on the antenna to the SMA connector.
![](/gitbook/assets/sigfox_pigtail_ant_sipy.png)
### WiFi/Bluetooth (optional)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_sipy.png)
### Deep Sleep current issue {#deep-sleep-current-issue}
The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a high current consumption in deep sleep mode. This issue has been resolved in all newer products. The cause for this issue is the DC to DC switch mode converter remains in a high performance mode even when the device is in deep sleep. The flash memory chip also does not power down. A more detailed explanation can be found [here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)

92
content/getting-started/hardwaresetup/wipy.md
View File

@@ -1,92 +0,0 @@
---
title: ""
aliases:
- getting-started/hardwaresetup/wipy.html
- getting-started/hardwaresetup/wipy.md
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the WiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_wipy.png)
{% endtab %}
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the WiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_wipy.png)
{% endtab %}
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](https://docs.pycom.io/chapter/pytrackpysense/installation/firmware.html).
* Look for the reset button on the WiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/pysense_wipy.png)
![](/gitbook/assets/pytrack_wipy.png)
{% endtab %}
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your WiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
* In order to put the WiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_wipy.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the WiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the WiPy:
![](/gitbook/assets/bare_wipy.png)
* By default, when the WiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `wipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the WiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### WiFi/Bluetooth (optional)
All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](https://docs.pycom.io/chapter/firmwareapi/pycom/network/wlan.html)
![](/gitbook/assets/wifi_pigtail_ant_wipy.png)
### Deep Sleep current issue {#deep-sleep-current-issue}
The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a high current consumption in deep sleep mode. This issue has been resolved in all newer products. The cause for this issue is the DC to DC switch mode converter remains in a high performance mode even when the device is in deep sleep. The flash memory chip also does not power down. A more detailed explanation can be found [here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)
### WiPy 2.0 vs WiPy 3.0
The WiPy 3.0 is an upgraded version of the WiPy 2.0 with the following changes:
* The FLASH has been upgraded from 4MB to 8MB.
* The RAM has been upgraded from 512KB to 4MB.
* The deepsleep current consumption issue has been fixed
* The antenna select pin has moved to GPIO21 (P12)

10
content/gettingstarted/_index.md
View File

@@ -1,6 +1,14 @@
---
title: ""
title: "Introduction"
aliases:
- gettingstarted/introduction.html
- gettingstarted/introduction.md
- gettingstarted/introduction
- chapter/gettingstarted
- getting-started
- gettingstarted
- getting-started/introduction
- chapter/gettingstarted/introduction
---
So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](/products) page before you place your order to ensure you know which accessories you might require.

3
content/gettingstarted/connection/README.md
View File

@@ -3,12 +3,11 @@ title: "Hardware Setup"
aliases:
- chapter/gettingstarted/hardwaresetup
---
This chapter of the documentation will show you how to connect you Pycom module. For each device there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter or WiFi as well as what antennas you might need to connect. Please select your module below to be taken to the appropriate guide.
{{% refname "lopy.md" %}}
{{% refname "lopy4.md" %}}
{{% refname "sipy.md" %}}
{{% refname "gpy.md" %}}

3
content/gettingstarted/connection/_index.md
View File

@@ -2,12 +2,11 @@
title: "Hardware Setup"
aliases:
---
This chapter of the documentation will show you how to connect you Pycom module. For each device there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter or WiFi as well as what antennas you might need to connect. Please select your module below to be taken to the appropriate guide.
{{% refname "lopy.md" %}}
{{% refname "lopy4.md" %}}
{{% refname "sipy.md" %}}
{{% refname "gpy.md" %}}

135
content/gettingstarted/connection/fipy.md
View File

@@ -6,68 +6,108 @@ aliases:
- chapter/gettingstarted/connection/fipy
- gettingstarted/fipy.html
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the FiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<div>
![](/gitbook/assets/expansion_board_2_fipy.png)
{% endtab %}
<v-tabs
dark
color="#1E1E3C"
slider-color="red">
<v-tab ripple key="1">Exp Board 3.0</v-tab>
<v-tab ripple key="2">Exp Board 2.0</v-tab>
<v-tab ripple key="3"> Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple key="4">USB UART Adapter</v-tab>
<v-tab ripple key="5">WiFi</v-tab>
<v-tabs-items>
<!-- Tab 1 -->
<v-tab-item key="1">
<ul>
<li>Before connecting your module to an Expansion Board 3.0, you should <a href="/pytrackpysense/installation/firmware">update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found here. </a></li>
<li>When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.</li>
<li>Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li>Locate the USB connector on the expansion board.</li>
<li>Insert the FiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/expansion_board_3_fipy.png">
</v-tab-item>
<!-- Tab 2 -->
<v-tab-item key="2">
<ul>
<li> When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.</li>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the FiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/expansion_board_2_fipy.png">
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the FiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</v-tab-item>
![](/gitbook/assets/expansion_board_3_fipy.png)
{% endtab %}
<v-tab-item key="3">
<div>
<ul>
<li> Before connecting your module to a Pysense/Pytrack/Pyscan board, you should <a href="/pytrackpysense/installation/firmware">update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found here</a>.</li>
<li> Look for the reset button on the FiPy module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the Pysense/Pytrack/Pyscan.</li>
<li> Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/pysense_fipy.png">
<img src="/gitbook/assets/pytrack_fipy.png">
</div>
</v-tab-item>
<v-tab-item key="4">
<div>
<ul>
<li>Firstly you will need to connect power to your FiPy. You will need to supply <code>3.5v</code>-<code>5.5v</code> to the <code>Vin</code> pin.
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the FiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqVauBuoNMgcByrNql%2FPysense_FiPy.png?generation=1534772069160637&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqVdDdxkK38AlRxtkc%2FPytrack_FiPy.png?generation=1534772071490748&alt=media)
{% endtab %}
Do **not** feed <code>3.3v</code> directly to the <code>3.3v</code> supply pin, this will damage the regulator.</li>
{% 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.
<li>The connect the <code>RX</code> and <code>TX</code> of your USB UART to the <code>TX</code> and <code>RX</code> of the FiPy respectively.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
Please ensure you have the signal level of the UART adapter set to <code>3.3v</code> before connecting it.</li>
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the FiPy respectively.
<li>In order to put the FiPy into bootloader mode to update the device firmware you will need to connect <code>P2</code> to <code>GND</code>. We recommend you connect a button between the two to make this simpler.</li>
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
</ul>
* In order to put the FiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
<img src="/gitbook/assets/uart_fipy.png">
</div>
</v-tab-item>
![](/gitbook/assets/uart_fipy.png)
{% endtab %}
<v-tab-item key="5">
<div>
<p>
<b>Note:</b> This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
</p>
<ul>
<li>In order to access the FiPy via WiFi you only need to provide <code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the FiPy:
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<img src="/gitbook/assets/bare_fipy.png">
* In order to access the FiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the FiPy:
</li>
![](/gitbook/assets/bare_fipy.png)
<li>By default, when the FiPy boots, it will create a WiFi access point with the following credentials:
<ul>
<li> SSID: <code>fipy-wlan</code></li>
<li> password: <code>www.pycom.io</code></li>
</ul>
</li>
<li>Once connected to this network you will be able to access the telnet and FTP servers running on the FiPy. For both of these the login details are:
<ul>
<li>username: <code>micro</code></li>
<li>password: <code>python</code></li>
</ul>
</li>
</ul>
</div>
</v-tab-item>
</v-tabs-item>
</v-tab>
</div>
* By default, when the FiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `fipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the FiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
@@ -102,7 +142,7 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **m
### WiFi/Bluetooth (optional)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_fipy.png)
@@ -111,4 +151,3 @@ All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you will need to insert a SIM card into your FiPy. It should be noted that the FiPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM.
![](/gitbook/assets/sim_fipy.png)

128
content/gettingstarted/connection/gpy.md
View File

@@ -6,66 +6,97 @@ aliases:
- chapter/gettingstarted/connection/gpy
- gettingstarted/gpy.html
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the GPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_2_gpy.png)
{% endtab %}
<div>
<v-tabs
dark
color="#1E1E3C"
slider-color="red">
<v-tab ripple key="1">Exp Board 3.0</v-tab>
<v-tab ripple key="2">Exp Board 2.0</v-tab>
<v-tab ripple key="3"> Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple key="4">USB UART Adapter</v-tab>
<v-tab ripple key="5">WiFi</v-tab>
<v-tabs-items>
<v-tab-item key="1">
<ul>
<li> Before connecting your module to an Expansion Board 3.0, you should
<a href="/pytrackpysense/installation/firmware">
update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found here</a></li>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the GPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
<img src="/gitbook/assets/expansion_board_3_gpy.png">
</ul>
</v-tab-item>
<v-tab-item key="2">
<ul>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).
<li> Locate the USB connector on the expansion board.
<li> Insert the GPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</ul>
<img src="/gitbook/assets/expansion_board_2_gpy.png">
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the GPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</v-tab-item>
![](/gitbook/assets/expansion_board_3_gpy.png)
{% endtab %}
<v-tab-item key="3">
<ul>
<li> Before connecting your module to a Pysense/Pytrack/Pyscan board, you should
<a href="/pytrackpysense/installation/firmware">
update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found here</a>
<li> Look for the reset button on the GPy module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the Pysense/Pytrack/Pyscan.</li>
<li> Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
<img src="/gitbook/assets/pysense_gpy.png">
<img src="/gitbook/assets/pytrack_gpy.png">
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the GPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqejpmTIS1tbGw0Vrl%2FPysense_GPy.png?generation=1534772072781141&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqekpWIfccll6qkt85%2FPytrack_GPy.png?generation=1534772080535030&alt=media)
{% endtab %}
</ul>
</v-tab-item>
{% 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.
<v-tab-item key="4">
<ul>
<li> Firstly you will need to connect power to your GPy. You will need to supply <code>3.5v</code>-<code>5.5v</code> to the <code>Vin</code> pin.
Do <b>not</b> feed <code>3.3v</code> directly to the <code>3.3v</code> supply pin, this will damage the regulator.</li>
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
<li> The connect the <code>RX</code> and <code>TX</code> of your USB UART to the <code>TX</code> and <code>RX</code> of the GPy respectively.
Please ensure you have the signal level of the UART adapter set to <code>3.3v</code> before connecting it.</li>
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the GPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
<li> In order to put the GPy into bootloader mode to update the device firmware you will need to connect <code>P2</code> to <code>GND</code>. We recommend you connect a button between the two to make this simpler.</li>
</ul>
* In order to put the GPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
</v-tab-item>
<v-tab-item key="5">
![](/gitbook/assets/uart_gpy.png)
{% endtab %}
<b>Note:</b> This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<ul>
<li>In order to access the GPy via WiFi you only need to provide
<code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the GPy:
<img src="/gitbook/assets/bare_gpy.png">
</li>
<li>By default, when the GPy boots, it will create a WiFi access point with the following credentials:
<ul>
<li>SSID:<code>gpy-wlan</code></li>
<li> password: <code>www.pycom.io</code></li>
</ul>
</li>
<li>Once connected to this network you will be able to access the telnet and FTP servers running on the GPy. For both of these the login details are:
<ul>
<li>username: <code>micro</code></li>
<li>password: <code>python</code></li>
</li>
</ul>
</li>
</ul>
</v-tab-item>
</v-tabs-items>
</v-tabs>
</div>
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the GPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the GPy:
![](/gitbook/assets/bare_gpy.png)
* By default, when the GPy boots, it will create a WiFi access point with the following credentials:
* SSID:`gpy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the GPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
---
## Antennas
@@ -81,7 +112,7 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **mu
### WiFi/Bluetooth (optional)
All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_gpy.png)
@@ -90,4 +121,3 @@ All Pycom modules, including the GPy, come with a on-board WiFi antenna as well
If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you will need to insert a SIM card into your GPy. It should be noted that the GPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM.
![](/gitbook/assets/sim_gpy.png)

149
content/gettingstarted/connection/lopy.md
View File

@@ -6,72 +6,114 @@ aliases:
- chapter/gettingstarted/connection/lopy
- gettingstarted/lopy.html
---
## Basic connection <a id="basic-connection"></a>
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
## Basic connection
<div>
<v-tabs
dark
color="#1E1E3C"
slider-color="#FC1247">
<v-tab ripple>Exp Board 3.0</v-tab>
<v-tab ripple>Exp Board 2.0</v-tab>
<v-tab ripple>Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple>USB UART Adapter</v-tab>
<v-tab ripple>WiFi</v-tab>
<v-tabs-items>
<!-- Tab 1 -->
<v-tab-item>
<ul>
<li> Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this
<a href="/pytrackpysense/installation/firmware">can be found here</a>
</li>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the LoPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/expansion_board_3_lopy.png">
</v-tab-item>
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIq_D1o1RiKJjzcBlfJ%2FExpansion_Board_2_LoPy.png?generation=1534772069584204&alt=media)
{% endtab %}
<!-- Tab 2 -->
<v-tab-item>
<ul>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the LoPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/expansion_board_2_lopy.png">
</v-tab-item>
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<!-- Tab 3 -->
<v-tab-item>
<ul>
<li> Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this
<a href="/pytrackpysense/installation/firmware">can be found here.</a></li>
<li> Look for the reset button on the LoPy module (located at a corner of the board, next to the LED).
</li>
<li> Locate the USB connector on the Pysense/Pytrack/Pyscan.
</li>
<li> Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<img src="/gitbook/assets/pysense_lopy.png">
<img src="/gitbook/assets/pytrack_lopy.png">
</li>
</ul>
</v-tab-item>
<!-- Tab 4 -->
<v-tab-item>
<ul>
<li> Firstly you will need to connect power to your LoPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIq_UweAMmh-NueZ_dX%2FExpansion_Board_3_LoPy.png?generation=1534772081040942&alt=media)
{% endtab %}
Do _not_ feed 3.3v directly to the 3.3v supply pin, this will damage the regulator.
</li>
<li>
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the LoPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively.
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIq_ZvQtB3k9-QzXSEi%2FPysense_LoPy.png?generation=1534772084691543&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIq_aBQabbigN5pR8W2%2FPytrack_LoPy.png?generation=1534772068406423&alt=media)
{% endtab %}
Please ensure you have the signal level of the UART adapter set to 3.3v before connecting it.
</li>
<li>
In order to put the LoPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
</li>
</ul>
<img src="/gitbook/assets/uart_lopy.png">
</v-tab-item>
<!-- Tab 5 -->
<v-tab-item>
{% 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.
<b>Note:</b> This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<ul>
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
<li>
In order to access the LoPy via WiFi you only need to provide
<code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the LoPy:
<img src="/gitbook/assets/bare_lopy.png">
</li>
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy respectively.
<li>
By default, when the LoPy boots, it will create a WiFi access point with the following credentials:
<ul>
<li> SSID: <code>lopy-wlan</code></li>
<li>password: <code>www.pycom.io</code></li>
</ul>
</li>
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
<li> Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy. For both of these the login details are:
<ul>
<li> username: <code>micro</code></li>
<li> password: <code>python</code></li>
</ul>
</li>
</ul>
</v-tab-item>
</v-tabs-items>
</v-tabs>
</div>
* In order to put the LoPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
***
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIq_kogUb61sVzFipSE%2FUART_LoPy.png?generation=1534772074950525&alt=media)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
* In order to access the LoPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the LoPy:
![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqa1aumXwEUaXR6jHk%2FBare_LoPy.png?generation=1534772083120637&alt=media)
* By default, when the LoPy boots, it will create a WiFi access point with the following credentials:
* SSID: `lopy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
## Antennas
### Lora
### Lora antenna
{{% 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.
@@ -90,13 +132,12 @@ The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4
![](/gitbook/assets/lora_pigtail_ant_lopy.png)
### WiFi/Bluetooth (optional)
### WiFi/Bluetooth antenna (optional)
All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_lopy.png)
## Deep Sleep current issue
The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a high current consumption in deep sleep mode. This issue has been resolved in all newer products. The cause for this issue is the DC to DC switch mode converter remains in a high performance mode even when the device is in deep sleep. The flash memory chip also does not power down. A more detailed explanation can be found [here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)

139
content/gettingstarted/connection/lopy4.md
View File

@@ -6,66 +6,110 @@ aliases:
- chapter/gettingstarted/connection/lopy4
- gettingstarted/lopy4.html
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy4 module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<div>
<v-tabs
dark
color="#1E1E3C"
slider-color="red">
<v-tab ripple key="1">Exp Board 3.0</v-tab>
<v-tab ripple key="2">Exp Board 2.0</v-tab>
<v-tab ripple key="3"> Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple key="4">USB UART Adapter</v-tab>
<v-tab ripple key="5">WiFi</v-tab>
<v-tabs-items>
<!-- Tab 1 -->
<v-tab-item key="1">
<ul>
<li> Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this
<a href="/pytrackpysense/installation/firmware">can be found here</a>
</li>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).
</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the LoPy4 module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</li>
</ul>
<img src="/gitbook/assets/expansion_board_3_lopy4.png">
</v-tab-item>
<!-- Tab 2 -->
<v-tab-item key="2">
<ul>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the LoPy4 module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
<img src="/gitbook/assets/expansion_board_2_lopy4.png">
</v-tab-item>
<!-- Tab 3 -->
<v-tab-item key="3">
<ul>
<li> Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this
<a href="/pytrackpysense/installation/firmware">can be found here</a>.</li>
<li> Look for the reset button on the LoPy4 module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the Pysense/Pytrack/Pyscan.</li>
<li> Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
</ul>
![](/gitbook/assets/expansion_board_2_lopy4.png)
{% endtab %}
<img src="/gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbk7blltxqntvqzh_-2fpysense_lopy4.png">
<img src="/gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbluw130dl1amaklt-2fpytrack_lopy4.png">
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the LoPy4 module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_lopy4.png)
{% endtab %}
</v-tab-item>
<!-- Tab 4 -->
<v-tab-item key="4">
<ul>
<li> Firstly you will need to connect power to your LoPy4. You will need to supply <code>3.5v</code>-<code>5.5v</code> to the <code>Vin</code> pin.
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the LoPy4 module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqbk7blltxqNtvQzH_%2FPysense_LoPy4.png?generation=1534772087747503&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqblUw130dL1aMAkLT%2FPytrack_LoPy4.png?generation=1534772079835788&alt=media)
{% endtab %}
Do **not** feed <code>3.3v</code> directly to the <code>3.3v</code>
supply pin, this will damage the regulator.</li>
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your LoPy4. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
<li> The connect the <code>RX</code> and <code>TX</code> of your USB UART to the
<code>TX</code> and <code>RX</code> of the LoPy4 respectively.
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the LoPy4 respectively.
Please ensure you have the signal level of the UART adapter set to
<code>3.3v</code> before connecting it.</li>
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
<li> In order to put the LoPy4 into bootloader mode to update the device firmware you will need to connect <code>P2</code> to <code>GND</code>. We recommend you connect a button between the two to make this simpler.
</li>
</ul>
* In order to put the LoPy4 into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
<img src="/gitbook/assets/uart_lopy4.png">
![](/gitbook/assets/uart_lopy4.png)
{% endtab %}
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
</v-tab-item>
<!-- Tab 5 -->
<v-tab-item key="5">
* In order to access the LoPy4 via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the LoPy4:
<b>Note:</b> This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<ul>
<li> In order to access the LoPy4 via WiFi you only need to provide
<code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the LoPy4:
![](/gitbook/assets/bare_lopy4.png)
<ing src="/gitbook/assets/bare_lopy4.png">
</li>
<li> By default, when the LoPy4 boots, it will create a WiFi access point with the following credentials:
<ul>
<li> SSID: <code>lopy4-wlan</code>
<li> password: <code>www.pycom.io</code>
</ul>
</li>
<li> Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy4. For both of these the login details are:
<ul>
<li> username: <code>micro</code>
<li> password: <code>python</code>
</ul>
</li>
</ul>
</v-tab-item>
</v-tabs-items>
</v-tabs>
</div>
* By default, when the LoPy4 boots, it will create a WiFi access point with the following credentials:
* SSID: `lopy4-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy4. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
---
## Antennas
@@ -84,9 +128,12 @@ If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** co
![](/gitbook/assets/lora_sigfox_pigtail_ant_lopy4.png)
{{% hint style="danger" %}}
Since the LoRa chip only runs on one frequency band at a time you only need to connect an antenna to the appropriate U.FL connecor. You should be supplied with a the antenna that suits the band you intend using.
{{< /hint >}}
### WiFi/Bluetooth (optional)
All Pycom modules, including the LoPy4, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy4 in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the LoPy4, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy4 in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_lopy4.png)

127
content/gettingstarted/connection/sipy.md
View File

@@ -6,66 +6,104 @@ aliases:
- chapter/gettingstarted/connection/sipy
- gettingstarted/sipy.html
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the SiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<div>
<v-tabs
dark
color="#1E1E3C"
slider-color="red">
<v-tab ripple key="1">Exp Board 3.0</v-tab>
<v-tab ripple key="2">Exp Board 2.0</v-tab>
<v-tab ripple key="3"> Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple key="4">USB UART Adapter</v-tab>
<v-tab ripple key="5">WiFi</v-tab>
<v-tabs-items>
<!-- Tab 1 -->
![](/gitbook/assets/expansion_board_2_sipy.png)
{% endtab %}
<!-- Tab 1 -->
<v-tab-item key="1">
<ul>
<li> Before connecting your module to an Expansion Board 3.0, you should
<a href="/pytrackpysense/installation/firmware">update the firmware on the Expansion Board 3.0. Instructions on how to do this
can be found here</a>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).
<li> Locate the USB connector on the expansion board.
<li> Insert the SiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<img src="/gitbook/assets/expansion_board_3_sipy.png">
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the SiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</ul>
</v-tab-item>
<v-tab-item key="2">
<ul>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).
<li> Locate the USB connector on the expansion board.
<li> Insert the SiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
![](/gitbook/assets/expansion_board_3_sipy.png)
{% endtab %}
<img src="/gitbook/assets/expansion_board_2_sipy.png">
</ul>
</v-tab-item>
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the SiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqd_e51Wyuw40k6yJv%2FPysense_SiPy.png?generation=1534772077104600&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqdauW7rAnQlc-AL07%2FPytrack_SiPy.png?generation=1534772072530754&alt=media)
{% endtab %}
{% 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.
</v-tab-item>
<v-tab-item key="3">
<ul>
<li> Before connecting your module to a Pysense/Pytrack/Pyscan board, you should
<a href="/pytrackpysense/installation/firmware">update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found here</a></li>
<li> Look for the reset button on the SiPy module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the Pysense/Pytrack/Pyscan.</li>
<li> Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<img src="/gitbook/assets/pysense_sipy.png">
<img src="/gitbook/assets/pytrack_sipy.png">
</li>
</ul>
</v-tab-item>
<v-tab-item key="4">
<ul>
<li> Firstly you will need to connect power to your SiPy. You will need to supply
<code>3.5v</code>-<code>5.5v</code> to the <code>Vin</code> pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
Do **not** feed <code>3.3v</code> directly to the <code>3.3v</code> supply pin, this will damage the regulator.
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the SiPy respectively.
<li> The connect the <code>RX</code> and <code>TX</code> of your USB UART to
the <code>TX</code> and <code>RX</code> of the SiPy respectively.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
Please ensure you have the signal level of the UART adapter set to
<code>3.3v</code> before connecting it.
* In order to put the SiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
![](/gitbook/assets/uart_sipy.png)
{% endtab %}
<li> In order to put the SiPy into bootloader mode to update the device firmware you will need to connect <code>P2</code> to <code>GND</code>. We recommend you connect a button between the two to make this simpler.
{% tab title="WiFi" %}
<img src="/gitbook/assets/uart_sipy.png"/>
</ul>
</v-tab-item>
<v-tab-item key="5">
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<ul>
<li> In order to access the SiPy via WiFi you only need to provide <code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the SiPy:
* In order to access the SiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the SiPy:
<img src="/gitbook/assets/bare_sipy.png">
</li>
<li> By default, when the SiPy boots, it will create a WiFi access point with the following credentials:
<ul>
<li> SSID: <code>sipy-wlan</code>
<li> password: <code>www.pycom.io</code>
</ul>
</li>
<li> Once connected to this network you will be able to access the telnet and FTP servers running on the SiPy. For both of these the login details are:
<ul>
<li> username: <code>micro</code>
<li> password: <code>python</code></li>
</ul>
</ul>
</v-tab-item>
![](/gitbook/assets/bare_sipy.png)
</v-tabs-items>
</v-tabs>
</div>
* By default, when the SiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `sipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the SiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
---
## Antennas
@@ -86,11 +124,10 @@ If you intend on using the Sigfox connectivity of the SiPy you **must** connect
### WiFi/Bluetooth (optional)
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_sipy.png)
## Deep Sleep current issue
The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a high current consumption in deep sleep mode. This issue has been resolved in all newer products. The cause for this issue is the DC to DC switch mode converter remains in a high performance mode even when the device is in deep sleep. The flash memory chip also does not power down. A more detailed explanation can be found [here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)

134
content/gettingstarted/connection/wipy.md
View File

@@ -6,72 +6,113 @@ aliases:
- chapter/gettingstarted/connection/wipy
- gettingstarted/wipy.html
---
## Basic connection
{% tabs %}
{% tab title="Exp Board 2.0" %}
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the WiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<div>
<v-tabs
dark
color="#1E1E3C"
slider-color="red">
<v-tab ripple key="1">Exp Board 3.0</v-tab>
<v-tab ripple key="2">Exp Board 2.0</v-tab>
<v-tab ripple key="3"> Pytrack/Pysense/Pyscan</v-tab>
<v-tab ripple key="4">USB UART Adapter</v-tab>
<v-tab ripple key="5">WiFi</v-tab>
<v-tabs-items>
![](/gitbook/assets/expansion_board_2_wipy.png)
{% endtab %}
<!-- Tab 1 -->
<v-tab-item key="1">
<ul>
<li>Before connecting your module to an Expansion Board 3.0, you should
<a href="/pytrackpysense/installation/firmware">
update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found here</a>.</li>
<li> Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the WiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.</li>
{% tab title="Exp Board 3.0" %}
* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the module (located at a corner of the board, next to the LED).
* Locate the USB connector on the expansion board.
* Insert the WiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<img src="">
</li>
</ul>
</v-tab-item>
![](/gitbook/assets/expansion_board_3_wipy.png)
{% endtab %}
<!-- Tab 2 -->
<v-tab-item key="2">
<ul>
<li>Look for the reset button on the module (located at a corner of the board, next to the LED).</li>
<li> Locate the USB connector on the expansion board.</li>
<li> Insert the WiPy module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
</li>
</ul>
<img src="/gitbook/assets/expansion_board_2_wipy.png">
</v-tab-item>
{% tab title="Pytrack/Pysense/Pyscan" %}
* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
* Look for the reset button on the WiPy module (located at a corner of the board, next to the LED).
* Locate the USB connector on the Pysense/Pytrack/Pyscan.
* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqfutE_BZ6gjVdmiv0%2FPysense_WiPy.png?generation=1534772071067482&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqfvoSjvxTIwgw2MSg%2FPytrack_WiPy.png?generation=1534772075484372&alt=media)
{% endtab %}
<!-- Tab 3 -->
<v-tab-item key="3">
<ul>
<li>Before connecting your module to a Pysense/Pytrack/Pyscan board, you should
<a href="/pytrackpysense/installation/firmware">
update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found here</a>.</li>
<li>Look for the reset button on the WiPy module (located at a corner of the board, next to the LED).
<li>Locate the USB connector on the Pysense/Pytrack/Pyscan.</li>
<li>Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
<img src="/gitbook/assets/pysense_wipy.png">
<img src="/gitbook/assets/pytrack_wipy.png">
</li>
</ul>
{% tab title="USB UART Adapter" %}
* Firstly you will need to connect power to your WiPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin.
{{% hint style="danger" %}}
Do **not** feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
{{< /hint >}}
</v-tab-item>
* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the WiPy respectively.
<!-- Tab 4 -->
<v-tab-item key="4">
<ul>
<li>Firstly you will need to connect power to your WiPy. You will need to supply
<code>3.5v</code>-<code>5.5v</code> to the <code>Vin</code> pin.
{{% hint style="warning" %}}
Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
{{< /hint >}}
Do **not** feed <code>3.3v</code> directly to the <code>3.3v</code> supply pin, this will damage the regulator.
</li>
* In order to put the WiPy into bootloader mode to update the device firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
<li>The connect the <code>RX</code> and <code>TX</code> of your USB UART to the <code>TX</code> and <code>RX</code> of the WiPy respectively.
![](/gitbook/assets/uart_wipy.png)
{% endtab %}
Please ensure you have the signal level of the UART adapter set to <code>3.3v</code> before connecting it.
</li>
<li>In order to put the WiPy into bootloader mode to update the device firmware you will need to connect <code>P2</code> to <code>GND</code>. We recommend you connect a button between the two to make this simpler.
</li>
</ul>
<img src="/gitbook/assets/uart_wipy.png">
</v-tab-item>
{% tab title="WiFi" %}
**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<!-- Tab 5 -->
<v-tab-item key="5">
<b>Note:</b> This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
<ul>
<li>In order to access the WiPy via WiFi you only need to provide <code>3.5v</code> - <code>5.5v</code> on the <code>Vin</code> pin of the WiPy:
<img src="/gitbook/assets/bare_wipy.png">
<li>By default, when the WiPy boots, it will create a WiFi access point with the following credentials:
<ul>
<li> SSID: <code>wipy-wlan</code></li>
<li> password: <code>www.pycom.io</code></li>
</ul>
<li>Once connected to this network you will be able to access the telnet and FTP servers running on the WiPy. For both of these the login details are:
<ul>
<li>username: <code>micro</code></li>
<li>password: <code>python</code></li>
</li>
</ul>
</v-tab-item>
* In order to access the WiPy via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the WiPy:
</v-tabs-items>
</v-tabs>
</div>
![](/gitbook/assets/bare_wipy.png)
* By default, when the WiPy boots, it will create a WiFi access point with the following credentials:
* SSID: `wipy-wlan`
* password: `www.pycom.io`
* Once connected to this network you will be able to access the telnet and FTP servers running on the WiPy. For both of these the login details are:
* username: `micro`
* password: `python`
{% endtab %}
{% endtabs %}
---
## Antennas
### WiFi/Bluetooth (optional)
All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]()
All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](/firmwareapi/pycom/network/wlan)
![](/gitbook/assets/wifi_pigtail_ant_wipy.png)
@@ -87,4 +128,3 @@ The WiPy 3.0 is an upgraded version of the WiPy 2.0 with the following changes:
* The RAM has been upgraded from 512KB to 4MB.
* The deepsleep current consumption issue has been fixed
* The antenna select pin has moved to GPIO21 (P12)

41
content/gettingstarted/installation/firmwaretool.md
View File

@@ -3,8 +3,9 @@ title: "Updating Firmware"
aliases:
- gettingstarted/installation/firmwaretool.html
- gettingstarted/installation/firmwaretool.md
- gettingstarted/installation/firmwaretool
- chapter/gettingstarted/installation/firmwaretool
---
We strongly recommend you to upgrade your firmware to the latest version as we are constantly making improvements and adding new features to the devices.
Here are the download links to the update tool. Please download the appropriate one for your OS and follow the instructions on the screen.
@@ -14,7 +15,7 @@ Here are the download links to the update tool. Please download the appropriate
* [Linux](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=unix&redirect=true) (requires `dialog` and `python-serial` package)
{{% hint style="info" %}}
Previous versions of firmware are available for download [**here**](/../advance/downgrade).
Previous versions of firmware are available for download [**here**](/advance/downgrade).
{{< /hint >}}
## Updating Device Firmware
@@ -23,8 +24,23 @@ The basic firmware upgrade procedure can be found below, please follow these ste
After you're done with upgrading, you can use the Pymakr Plugins to upload and run programs in your device.
{% tabs %}
{% tab title="Expansion Board 2.0" %}
### Expansion Board 3.0
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.
1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](/pytrackpysense/installation/firmware).
2. Disconnect your device from your computer
3. Insert module into Expansion Board
4. Reconnect the board via USB to your computer
5. Run the Firmware Upgrade tool
![](/gitbook/assets/firmware-update-2.png)
6. Disconnect the USB cable from the board and reconnect it, your device is now ready to use
### Expansion Board 2.0
1. Disconnect your device from your computer
2. Insert module into the Expansion Board
3. Connect a jumper cable or wire between `G23` and `GND`
@@ -38,23 +54,6 @@ After you're done with upgrading, you can use the Pymakr Plugins to upload and r
7. Reboot the device (button or power off then on), your device is now ready to use
If you are having any issues, make sure the **TX and RX jumpers** are present on your Expansion Board, as the jumpers sometimes come loose in the box during transport. Without these jumpers, the updater will fail.
{% endtab %}
{% tab title=" Pysense/Pytrack/Pyscan/Expansion Board 3.0" %}
{{% hint style="info" %}}
When using a Pysense/Pytrack/Pyscan/Expansion Board 3.0 to update your module you are not required to make a connection between `G23` and `GND`, the Pysense/Pytrack/Pyscan/Expansion Board 3.0 will do this automatically.
{{< /hint >}}
1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](/../pytrackpysense/installation/firmware).
2. Disconnect your device from your computer
3. Insert module into Expansion Board
4. Reconnect the board via USB to your computer
5. Run the Firmware Upgrade tool
![](/gitbook/assets/firmware-update-2.png)
6. Disconnect the USB cable from the board and reconnect it, your device is now ready to use
{% endtab %}
{% endtabs %}
After you're done with upgrading, you can use the Pymakr Plugins to upload and run programs in your device.

5
content/gettingstarted/installation/pymakr.md
View File

@@ -11,7 +11,6 @@ aliases:
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:
{{% refname "../../pymakr/installation/atom.md" %}}
{{% refname "../../pymakr/installation/vscode.md" %}}
{{% refname "/pymakr/installation/atom.md" %}}
{{% refname "/pymakr/installation/vscode.md" %}}

34
content/gettingstarted/introduction.md
View File

@@ -1,34 +0,0 @@
---
title: "Introduction"
aliases:
- gettingstarted/introduction.html
- gettingstarted/introduction.md
- chapter/gettingstarted
- getting-started
- getting-started/introduction
- chapter/gettingstarted/introduction
---
So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](/products) page before you place your order to ensure you know which accessories you might require.
![](/gitbook/assets/getting_started%20%281%29.png)
## [Step 1: Setting up the hardware](connection/)
In the first part of this getting started guide, we will take you through setting up your device. Firstly we will cover how to connect the module to your computer either via USB or WiFi. Secondly we will explain how to connect various accessories such as antennas or SIM cards to your module.
## [Step 2: Setting up your computer](installation/)
Now that your module is successfully connected, you will need to install some software on your computer to interface with it. The second part of this guide will guide you through installing drivers; performing firmware updates for your module/accessories to ensure you have the most stable and feature packed version; and how to setup the software use to program the device.
## [Step 3: Using your module](programming/)
Now that you have a connected module and all the required software installed it is time to begin programming your device. This part of the guide will get you started with a basic example and point you in the right direction for getting your device connected to your chosen network.
## [Step 4: Connecting to a network](registration/)
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" %}}
You can navigate through this guide using the arrow buttons at the bottom of the page.
{{< /hint >}}

51
content/products.md
View File

@@ -5,6 +5,7 @@ aliases:
- products.md
- chapter/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.
@@ -13,12 +14,12 @@ Below you will find tables of all Pycom products. These tables illustrate the fu
| Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1NB-IoT |
| :--- | :--- | :--- | :--- | :--- | :--- |
| [ WiPy 3.0](datasheets/development/wipy3) | &#10004; | &#10004; | | | |
| [SiPy](datasheets/development/sipy) | &#10004; | &#10004; | | &#10004; | |
| [GPy](datasheets/development/gpy) | &#10004; | &#10004; | | | &#10004; |
| [LoPy](datasheets/development/lopy) | &#10004; | &#10004; | &#10004; | | |
| [LoPy4](datasheets/development/lopy4) | &#10004; | &#10004; | &#10004; | &#10004; | |
| [FiPy](datasheets/development/fipy) | &#10004; | &#10004; | &#10004; | &#10004; | &#10004; |
| [WiPy 3.0](/datasheets/development/wipy3) | &#10004; | &#10004; | | | |
| [SiPy](/datasheets/development/sipy) | &#10004; | &#10004; | | &#10004; | |
| [GPy](/datasheets/development/gpy) | &#10004; | &#10004; | | | &#10004; |
| [LoPy](/datasheets/development/lopy) | &#10004; | &#10004; | &#10004; | | |
| [LoPy4](/datasheets/development/lopy4) | &#10004; | &#10004; | &#10004; | &#10004; | |
| [FiPy](/datasheets/development/fipy) | &#10004; | &#10004; | &#10004; | &#10004; | &#10004; |
| 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
@@ -27,13 +28,13 @@ Below you will find tables of all Pycom products. These tables illustrate the fu
<thead>
<tr>
<th style="text-align:left">Accessory</th>
<th style="text-align:left"><a href="datasheets/boards/expansion3.md">Expansion Board</a>
<th style="text-align:left"><a href="/datasheets/boards/expansion3.md">Expansion Board</a>
</th>
<th style="text-align:left"><a href="datasheets/boards/pysense.md">Pysense</a>
<th style="text-align:left"><a href="/datasheets/boards/pysense.md">Pysense</a>
</th>
<th style="text-align:left"><a href="datasheets/boards/pytrack.md">Pytrack</a>
<th style="text-align:left"><a href="/datasheets/boards/pytrack.md">Pytrack</a>
</th>
<th style="text-align:left"><a href="datasheets/boards/pyscan.md">Pyscan</a>
<th style="text-align:left"><a href="/datasheets/boards/pyscan.md">Pyscan</a>
</th>
</tr>
</thead>
@@ -84,32 +85,12 @@ Below you will find tables of all Pycom products. These tables illustrate the fu
<td style="text-align:left">&#10004;</td>
<td style="text-align:left">&#10004;</td>
</tr>
<tr>
<td style="text-align:left">
<p>Pyscan Modules</p>
<p><a href="https://pycom.io/product/oled-screen/">OLED Module</a>
</p>
<p><a href="https://pycom.io/product/2mp-camera/">2MP Camera</a>
</p>
<p><a href="https://pycom.io/product/barcode-reader">Barcode Reader</a>
</p>
<p><a href="https://pycom.io/product/fingerprint-scanner/">Fingerprint Scanner</a>
</p>
<p><a href="https://pycom.io/product/infared-image-sensor/">IR Image Sensor</a>
</p>
</td>
<td style="text-align:left"></td>
<td style="text-align:left"></td>
<td style="text-align:left"></td>
<td style="text-align:left">&#10004;</td>
</tr>
</tbody>
</table>## OEM Modules
| OEM Module | [L01/W01 Reference Board](datasheets/oem/l01_reference) | [Universal Reference Board](datasheets/oem/universal_reference) |
| OEM Module | [L01/W01 Reference Board](/datasheets/oem/l01_reference) | [Universal Reference Board](/datasheets/oem/universal_reference) |
| :--- | :--- | :--- |
| [W01](datasheets/oem/w01) | &#10004; | &#10004; |
| [L01](datasheets/oem/l01) | &#10004; | &#10004; |
| [L04](datasheets/oem/l04) | | &#10004; |
| [G01](datasheets/oem/g01) | | &#10004; |
| [W01](/datasheets/oem/w01) | &#10004; | &#10004; |
| [L01](/datasheets/oem/l01) | &#10004; | &#10004; |
| [L04](/datasheets/oem/l04) | | &#10004; |
| [G01](/datasheets/oem/g01) | | &#10004; |

17
content/pybytes/_index.md
View File

@@ -1,12 +1,14 @@
---
title: ""
aliases:
- pybytes/introduction
---
![](/gitbook/assets/pybyteslogo%20%281%29.png)
[![pybytes](/gitbook/assets/pybytes/introduction/pybytes_logo.png)](https://pybytes.pycom.io/?utm_source=docs&utm_medium=web&utm_campaign=pybytes-introduction)
## What is Pybytes?
Pybytes is an IoT Ecosystem that empowers you by granting full control of all your Pycom devices.
Pybytes is an IoT platform that empowers you by granting full control of all your Pycom devices.
With Pybytes you have control over your device's data stream and more:
@@ -20,15 +22,14 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati
## What Pybytes offers you?
* Data Visualisation: Pybytes dashboard is customisable, allowing you to freely set up key performance indicators and time series data from all your sensors.
* Intelligent notifications: Keep track of your device's status, battery level, data streaming and measurements with pre-defined alarms. Receive notifications via email or SMS.
* Intelligent notifications: Keep track of your device's status, battery level, data streaming and measurements with pre-defined alarms.
* Terminal: Execute commands to gather accurate information from your devices using Pybytes terminal shell.
* Firmware updates over the air: Upgrade or downgrade firmware versions with our exclusive firmware update.
* Track your assets position: Google Maps API empowers your view over your device's geolocation.
## Let's get started!
* [Getting started with Pybytes](getstarted)
* [Connect your Pycom module to Pybytes](connect/)
* [Visualise data from your device](dashboard)
* [Integrations with external services](integrations/)
* [Getting started with Pybytes](/pybytes/getstarted)
* [Connect your Pycom module to Pybytes](/pybytes/connect)
* [Visualise data from your device](/pybytes/dashboard)
* ​[Integrations with external services](/pybytes/integrations/index.html)​

44
content/pybytes/connect/README.md
View File

@@ -1,51 +1,35 @@
---
title: "Add a device to Pybytes"
aliases:
- chapter/pybytes/connect/intro
---
In this section, we will explain to you how to add a device to Pybytes
In this section, we will explain to you how to add a device to Pybytes.
## Step 1: Add device wizard
In Pybytes, go to `Devices` Page:
In Pybytes, go to *Devices* Page:
1. Click on `Add Device`.
1. Click on *Add Device*.
![](/gitbook/assets/1-1.jpg)
![](/gitbook/assets/pybytes/add-device/add-device-btn.png)
2. Select your device (e.g., WiPy, LoPy, SiPy, etc.);
2. Select your device (WiPy, LoPy, SiPy, etc.);
![](/gitbook/assets/2-1.jpg)
3. Select your shield (e.g., PySense, PyTrack, PyScan or other);
![](/gitbook/assets/3%20%281%29.jpg)
![](/gitbook/assets/pybytes/add-device/select-device-type.png)
4. Select your network option;
![](/gitbook/assets/4%20%281%29.jpg)
![](/gitbook/assets/pybytes/add-device/network-step.png)
5. Enter a unique name and the network credentials (SSID and password) for your device;
![](/gitbook/assets/5-1.jpg)
![](/gitbook/assets/pybytes/add-device/customize-step.png)
## Step 2: Connect your device to Pybytes
At the end of the "Add Device" wizard, Pybytes will give you two options for you to connect your device to Pybytes:
At the end of the "Add Device" wizard, Pybytes will show that your device profile was successfully created.
![](/gitbook/assets/7-1.png)
![](/gitbook/assets/pybytes/add-device/final-step.png)
Select how you would like to connect your device to Pybytes:
1. [Connect your device quickly (Recommended)](quick)
{{% refname "quick.md" %}}
2. [Connect your device by flashing Pybytes Library](flash)
{{% refname "flash.md" %}}
{{% hint style="info" %}}
From firmware 1.16.x onwards all Pycom devices come with Pybytes library built-in `/frozen` folder. That means that you can choose between adding your device quickly with the firmware updater or you can flash Pybytes library manually.
{{< /hint >}}
1. **[Connect your device quickly](../quick) (Recommended)**
2. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code).

39
content/pybytes/connect/_index.md
View File

@@ -1,50 +1,39 @@
---
title: "Add a device to Pybytes"
aliases:
- chapter/pybytes/connect/intro
---
In this section, we will explain to you how to add a device to Pybytes
In this section, we will explain to you how to add a device to Pybytes.
## Step 1: Add device wizard
In Pybytes, go to `Devices` Page:
In Pybytes, go to *Devices* Page:
1. Click on `Add Device`.
1. Click on *Add Device*.
![](/gitbook/assets/1-1.jpg)
![](/gitbook/assets/pybytes/add-device/add-device-btn.png)
2. Select your device (e.g., WiPy, LoPy, SiPy, etc.);
2. Select your device (WiPy, LoPy, SiPy, etc.);
![](/gitbook/assets/2-1.jpg)
3. Select your shield (e.g., PySense, PyTrack, PyScan or other);
![](/gitbook/assets/3%20%281%29.jpg)
![](/gitbook/assets/pybytes/add-device/select-device-type.png)
4. Select your network option;
![](/gitbook/assets/4%20%281%29.jpg)
![](/gitbook/assets/pybytes/add-device/network-step.png)
5. Enter a unique name and the network credentials (SSID and password) for your device;
![](/gitbook/assets/5-1.jpg)
![](/gitbook/assets/pybytes/add-device/customize-step.png)
## Step 2: Connect your device to Pybytes
At the end of the "Add Device" wizard, Pybytes will give you two options for you to connect your device to Pybytes:
At the end of the "Add Device" wizard, Pybytes will show that your device profile was successfully created.
![](/gitbook/assets/7-1.png)
![](/gitbook/assets/pybytes/add-device/final-step.png)
Select how you would like to connect your device to Pybytes:
1. [Connect your device quickly (Recommended)](quick)
{{% refname "quick.md" %}}
2. [Connect your device by flashing Pybytes Library](flash)
{{% refname "flash.md" %}}
{{% hint style="info" %}}
From firmware 1.16.x onwards all Pycom devices come with Pybytes library built-in `/frozen` folder. That means that you can choose between adding your device quickly with the firmware updater or you can flash Pybytes library manually.
{{< /hint >}}
1. **[Connect your device quickly](quick) (Recommended)**
2. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code).

73
content/pybytes/connect/flash.md
View File

@@ -1,74 +1,49 @@
---
title: "Connect to Pybytes: Flash Pybytes library manually"
title: "Flash Pybytes-library (advanced)"
aliases:
- pybytes/connect/flash.html
- pybytes/connect/flash.md
- chapter/pybytes/connect/flash
---
## Connecting a 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.
In this section, we will explain to you how to connect your device to Pybytes by flashing the Pybytes library.
Use this, if you want to have full control over the Pybytes library on your device.
{{% 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)
Pybytes firmware already contains [Pybytes library](https://github.com/pycom/pycom-micropython-sigfox/tree/pybytes-master/esp32/frozen/Base). That means that you can [add your device quickly](../quick) without the need of flashing Pybytes library.
{{< /hint >}}
### Step 1: Download your Pybytes Library
### Step 1: Flash stable firmware to your device with Pycom firmware updater tool
1. Open Pycom firmware updater tool
2. Select a stable firmware
3. Click on continue
At the last step of the "Add Device" process:
Here's more information about [firmware updates](/gettingstarted/installation/firmwaretool).
![](/gitbook/assets/pybyteslib-box-1.gif)
### Step 2: Download your Pybytes Library
1. Click on download "Pybytes library"
![](/gitbook/assets/pybytes-library-wizard%20%281%29.png)
You can also download _Pybytes library_ at the device's settings page:
You can download _Pybytes library_ at the device's settings page:
2. Navigate to your device in Pybytes;
3. On your device's page click on settings tab;
3. Click on the settings tab;
4. Click on the button _Download_ at Pybytes library;
4. Click on the _Download_ button at Pybytes library section;
![](/gitbook/assets/pybytes-library-download%20%281%29.gif)
![](/gitbook/assets/pybytes/flash-pybytes-library/settingsTab.png)
### Step 2. Flash your device with Pymakr
### Step 3. Flash your device with Pymakr
{{% 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).
We recommend to install Pymakr in Atom.
{{< /hint >}}
1. Connect your device to your computer with USB cable.
2. Extract download Pybytes library and open extracted folder with Atom.
3. Get your device serial port: in Pymakr plugin click on _More_ &gt; _get serial ports_
4. Paste your device's serial port to `pymakr.conf` file:
```text
{
"address": "PASTE_YOUR_SERIAL_PORT_HERE",
"username": "micro",
"password": "python",
"sync_folder": "flash"
}
```
5. Checkout your `flash/pybytes_config.json` file. It will be pre-filled with your information from Pybytes
Like deviceToken or WiFi credentials. You can change e.g. your WiFy password here.
6. Put your device in [safe boot mode](/../gettingstarted/programming/safeboot).
7. Upload code to your device by clicking on _Upload_ button in Pymakr.
After all Pybytes library files are uploaded to device, device will restart and will connect to Pybytes.
{{% hint style="info" %}}
Pybytes library is written to `/flash` folder and will take precedence over build in firmware libraries in `/frozen` folder.
{{< /hint >}}
## Next step: Set up your device's dashboard!
Now it's time to display data from your device into Pybytes dashboard.
{{% refname "../dashboard.md" %}}
1. Connect your device to the computer with a USB cable.
2. Open zip archive of Pybytes library and extract a containing folder.
3. Check your `flash/pybytes_config.json` file. It should be pre-filled with your Pybytes credentials (deviceToken, WiFi credentials, ...)
3. Open Pybytes library folder as a project folder in Atom.
4. Click on the Connect button in Pymakr. Pymakr should connect to your device.
7. Upload code to your device by clicking on the _Upload_ button in Pymakr.
After all the Pybytes library files are uploaded to your device, the device will restart and connect to Pybytes.

77
content/pybytes/connect/quick.md
View File

@@ -1,59 +1,60 @@
---
title: "Connect to Pybytes: Quick Add"
title: "Connect the device to Pybytes"
aliases:
- pybytes/connect/quick.html
- pybytes/connect/quick.md
- chapter/pybytes/connect/quick
---
## Connecting a device to Pybytes quickly by using the Firmware Updater
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 tool.
### 1. Download Pycom Firmware updater tool
![](/gitbook/assets/pybytes/add-device/final-step.png)
From the last step of the "Add Device" process. Download and install Pycom Firmware updater tool from the provided link (Firmware updater is also available on [pycom.io](https://pycom.io/downloads/)).
![](/gitbook/assets/pybytes/add-device/connect-your-device-component.png)
Copy the activation token by pressing the copy button. The activation token is valid for one hour. If your activation token is expired, you can create a new one.
### 2. Flash Pybytes firmware with Pycom Firmware updater tool
#### Before you start
* Connect your device to the computer
* If your device is already connected, make sure it is not connected to Pymakr
#### Firmware update process
Open the Pycom Firmware updater tool on your computer and click on the Continue button.
![](/gitbook/assets/pybytes/add-device/fw-updater/intro-screen.png)
Click again on the Continue button.
![](/gitbook/assets/pybytes/add-device/fw-updater/attention-screen.png)
{{% hint style="info" %}}
In case you want to extend Pybytes library you can flash Pybytes library manually. [Click here for more information.](flash)
If your device is already connected to your computer, on MacOS serial port will be automatically filled for you.
At this step, you can also click on Rescan ports button to update ports listed in the Firmware updater.
{{< /hint >}}
### Step 1: Download the firmware updater
Check the options "Erase flash file system" and "Force update Pybytes registration";
At the last step of the "Add Device" process:
![](/gitbook/assets/pybytes/add-device/fw-updater/settings-screen.png)
![](/gitbook/assets/7-1.png)
Paste your activation token from Pybytes. Firmware updater should display **Registration successful!**
1. Download the [firmware updater](https://pycom.io/downloads/) for your operating system;
![](/gitbook/assets/pybytes/add-device/fw-updater/activation-token-screen.png)
![](/gitbook/assets/8-1.png)
Then press the Continue button. Your device will be flashed with the Pybytes firmware. This should take about a minute.
2. Copy the device token.
![](/gitbook/assets/pybytes/add-device/fw-updater/update-in-progress-screen.png)
### Step 2: Firmware updater
After the updating process is done. You will be welcomed with the final screen. Click on Done to close the Firmware updater.
Install the Firmware updater on your computer.
1. Start the `Firmware updater`;
![](/gitbook/assets/1-1.png)
![](/gitbook/assets/2%20%281%29.png)
2 .Select your device serial port (Make sure your device is connected to your computer);
3. Mark the options "Erase flash file system" and "Force update Pybytes registration";
![](/gitbook/assets/3.png)
4. Paste your device token from Pybytes;
![](/gitbook/assets/5-1.gif)
5. The firmware updater will update the device's firmware.
![](/gitbook/assets/6%20%281%29.png)
![](/gitbook/assets/7%20%282%29.png)
![](/gitbook/assets/pybytes/add-device/fw-updater/success-screen.png)
## Next step: Set up your device's dashboard!
Now it's time to display data from your device into Pybytes dashboard.
{{% refname "../dashboard.md" %}}
[Now it's time to display data from your device into Pybytes dashboard](../../dashboard)

14
content/pybytes/connect/sigfox/README.md
View File

@@ -3,8 +3,9 @@ title: "Add Sigfox device"
aliases:
- chapter/pybytes/connect/sigfox/sigfox
---
{{% 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 >}}
## Create Sigfox API credentials
@@ -13,19 +14,19 @@ Once you have you account setup and are logged in Sigfox backend, you need to cr
Click on GROUP → &lt;your\_company\_name&gt; → API ACCESS → New
![](//gitbook/assets/apiaccess%20%281%29.png)
![](/gitbook/assets/apiaccess%20%281%29.png)
In the form chose arbitrary _name_, select Profiles `DEVICE MANAGER [R]` and `DEVICE MANAGER [W]`. Then click on Ok.
In the form chose arbitrary _name_, select `LIMITED_ADMIN` and Profile and click on Ok.
![](//gitbook/assets/apiaccessscope.png)
![](/gitbook/assets/apiaccessscope.png)
Copy _Login_ and _Password_ to the clipboard.
![](//gitbook/assets/apiaccesskeys.png)
![](/gitbook/assets/apiaccesskeys.png)
In Pybytes go to Settings → Sigfox API or [follow this link](https://pybytes.pycom.io/settings/sigfox-credentials) then paste in the form.
![](//gitbook/assets/pybytessigfoxcredentials.png)
![](/gitbook/assets/pybytessigfoxcredentials.png)
## Sigfox contract types
@@ -40,4 +41,3 @@ Read more how to use Sigfox with [devKit contract](devkit).
Read more how to use Sigfox with [Custom contract](devkit).
{{% refname "custom.md" %}}

14
content/pybytes/connect/sigfox/_index.md
View File

@@ -2,8 +2,9 @@
title: "Add Sigfox device"
aliases:
---
{{% 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 >}}
## Create Sigfox API credentials
@@ -12,19 +13,19 @@ Once you have you account setup and are logged in Sigfox backend, you need to cr
Click on GROUP → &lt;your\_company\_name&gt; → API ACCESS → New
![](//gitbook/assets/apiaccess%20%281%29.png)
![](/gitbook/assets/apiaccess%20%281%29.png)
In the form chose arbitrary _name_, select Profiles `DEVICE MANAGER [R]` and `DEVICE MANAGER [W]`. Then click on Ok.
In the form chose arbitrary _name_, select `LIMITED_ADMIN` and Profile and click on Ok.
![](//gitbook/assets/apiaccessscope.png)
![](/gitbook/assets/apiaccessscope.png)
Copy _Login_ and _Password_ to the clipboard.
![](//gitbook/assets/apiaccesskeys.png)
![](/gitbook/assets/apiaccesskeys.png)
In Pybytes go to Settings → Sigfox API or [follow this link](https://pybytes.pycom.io/settings/sigfox-credentials) then paste in the form.
![](//gitbook/assets/pybytessigfoxcredentials.png)
![](/gitbook/assets/pybytessigfoxcredentials.png)
## Sigfox contract types
@@ -39,4 +40,3 @@ Read more how to use Sigfox with [devKit contract](devkit).
Read more how to use Sigfox with [Custom contract](devkit).
{{% refname "custom.md" %}}

10
content/pybytes/connect/sigfox/custom.md
View File

@@ -5,6 +5,7 @@ aliases:
- pybytes/connect/sigfox/custom.md
- chapter/pybytes/connect/sigfox/sigfoxCustomContract
---
For building Sigfox application on Pybytes we recommend to [buy Sigfox contract](https://buy.sigfox.com/).
With Sigfox custom contract you can use Pybytes to register Sigfox devices on Sigfox backend automatically (Pybytes talk to Sigfox backend API to register Sigfox devices automatically).
@@ -19,7 +20,7 @@ Go to: Settings (in sidebar) → Sigfox API → Settings
and select Sigfox device type which is associated with Sigfox custom contract.
![](//gitbook/assets/selectdevicetypecustomcontract.png)
![](/gitbook/assets/selectdevicetypecustomcontract.png)
### Add your Sigfox device to Pybytes
@@ -29,14 +30,13 @@ and select Sigfox device type which is associated with Sigfox custom contract.
2. Paste your device token to firmware updater
{{% 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 >}}
After your device was flashed with Pybytes firmware in automatically start adding itself to Sigfox backend.
![](//gitbook/assets/sigfoxcustomcontractstatus%20%281%29.png)
![](/gitbook/assets/sigfoxcustomcontractstatus%20%281%29.png)
## Troubleshooting
[Disengage Sigfox sequence number](/../../tutorials/sigfox.md#disengage-sequence-number)
[Disengage Sigfox sequence number](/tutorials/sigfox#disengage-sequence-number)

12
content/pybytes/connect/sigfox/devkit.md
View File

@@ -5,13 +5,14 @@ aliases:
- pybytes/connect/sigfox/devkit.md
- chapter/pybytes/connect/sigfox/sigfoxDevKit
---
Every Sigfox Pycom device comes with free Sigfox connectivity - Sigfox DevKit contract. It provides one year of Sigfox connectivity. This is great for prototyping.
But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](/../../gettingstarted/registration/sigfox).
But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](/gettingstarted/registration/sigfox).
After you add your Sigfox credentials to Pybytes you can see DevKit contract type is selected as default (on page Settings → Sigfox API).
![](//gitbook/assets/pybytesdevkit%20%281%29.png)
![](/gitbook/assets/pybytesdevkit%20%281%29.png)
## Add your device to Pybytes
@@ -21,7 +22,7 @@ After you add your Sigfox credentials to Pybytes you can see DevKit contract typ
2. Paste your device token to firmware updater
{{% 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 >}}
## Check sigfox status
@@ -32,7 +33,7 @@ Now you should see sigfox status component.
Click on _Check Sigfox status_ button
![](//gitbook/assets/devkitcheck.png)
![](/gitbook/assets/devkitcheck.png)
You should see two green lights.
@@ -46,5 +47,4 @@ This is not an issue with Custom contract, where _device type_ on Sigfox backend
## Troubleshooting
[Disengage Sigfox sequence number](/../../tutorials/sigfox.md#disengage-sequence-number)
[Disengage Sigfox sequence number](/tutorials/sigfox#disengage-sequence-number)

137
content/pybytes/dashboard.md
View File

@@ -5,132 +5,139 @@ aliases:
- pybytes/dashboard.md
- chapter/pybytes/dashboard/intro
---
In this section, we will explain to you how to create widgets for data visualisation and set up your device's dashboard on Pybytes.
{{% hint style="info" %}}
We assume that you already have your device connected to Pybytes. In case you haven't, check how to [add your device here](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 >}}
## Step 1: Set up your application (main.py)
## Step 1: Set up your python application
The first step is to have an application running on your device. The application in this example sends data from a vector every 10 seconds to Pybytes.
The first step is to have your python application uploaded and running on your Pycom device.
1. Open the `main.py` file on Pymakr;
2. Insert the following code on your `main.py`;
1. Install the [Pymakr](https://atom.io/packages/pymakr) plugin.
(We highly recommend using Pymakr with Atom, but you can also use Pymakr with [VS Code](https://marketplace.visualstudio.com/items?itemName=pycom.Pymakr)). Learn more about Pymakr [here](/pymakr).
2. In Atom create a project folder `my-first-wipy` (any other name will work as well).
4. In your project folder create the `main.py` file
3. Copy and paste the following code into your `main.py`
{{% hint style="info" %}}
Scroll a bit down to see the picture of the project structure in Atom.
{{< /hint >}}
This python application will send data from the array every 5 seconds to Pybytes.
```python
# # Import what is necessary to create a thread
# Import what is necessary to create a thread
import _thread
from time import sleep
# # Increment index used to scan each point from vector sensors_data
# Increment index used to scan each point from vector sensors_data
def inc(index, vector):
if index < len(vector)-1:
return index+1
else:
return 0
# # Define your thread's behaviour, here it's a loop sending sensors data every 10 seconds
# Define your thread's behaviour, here it's a loop sending sensors data every 5 seconds
def send_env_data():
idx = 0
sensors_data = [0, -0.2, -0.5, -0.7, -0.8, -0.9, -0.9, -0.9, -0.8, -0.6, -0.4, -0.2, 0, 0.3, 0.5, 0.7, 0.8, 0.9, 0.9, 0.9, 0.8, 0.6, 0.4, 0.1]
while (pybytes):
pybytes.send_virtual_pin_value(False, 1, sensors_data[idx])
while True:
# send one element from array `sensors_data` as signal 1
pybytes.send_signal(1, sensors_data[idx])
idx = inc(idx, sensors_data)
sleep(10)
sleep(5)
# # Start your thread
# Start your thread
_thread.start_new_thread(send_env_data, ())
```
3. Upload the code into your device. Now your device is sending data to Pybytes.
{{% hint style="info" %}}
In this code, we're calling the function `pybytes.send_signal(signalNumber, value))` to send data to Pybytes. This function is part of the Pybytes library, and it has two arguments: `signalNumber` 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`.
* `signalNumber` represents which signal is receiving data:
* `persistent` denotes information that is infrequently accessed and not likely to be modified;
* `pin` represents which virtual pin is receiving data;
* `value` is the value being attributed to that particular pin.
**255** different values: **0 ... 254** (signalNumber 255 is reserved for the Pybytes terminal)
* `value` is the value being attributed to that particular signal number
{{< /hint >}}
Your example project in Atom (with Pymakr) should look like this.
Press *Upload* button to upload the code into your device.
![](/gitbook/assets/pybytes/dashboard/pymakr-with-example-code.png)
By default, Pymakr will upload all files like `*.py` from your project folder (`my-first-wipy` in this case).
File `main.py` will be uploaded to `/flash` folder on your device.
After the upload is done, the device will reboot and start sending data to Pybytes.
In the Pymakr terminal, you should see messages send to Pybytes.
![](/gitbook/assets/pybytes/dashboard/device-sending-messsages.png)
Every line stands for one message sent every 5 seconds. Line `1 [-0.7]` means signal `1` sent value `-0.7`.
## Step 2: Add a signal from your device
Go to Pybytes.
Go to Pybytes and on *Devices* page select your device;
1. On `Devices` page select a device;
![](/gitbook/assets/pybytes/dashboard/device-table.png)
![](/gitbook/assets/01%20%281%29.gif)
Then go to `Data` tab and click on the row in the *Undefined signals* table (recommended). Alternatively, you can click on *Define new signal* button.
{{% hint style="info" %}}
If you don't see your undefined signal in *Undefined signals* table, please reload your browser.
{{< /hint >}}
2. On your device's page click on `Data` tab.
![](/gitbook/assets/pybytes/dashboard/undefined-signals-table.png)
![](/gitbook/assets/02-1.png)
Define new signal by entering a signal name, and optionally a unit (If you clicked on "undefined signal row" your signal number `1` will be already pre-filled).
3. Click on the `Define New Signal` button.
![](/gitbook/assets/pybytes/dashboard/define-new-signal.png)
![](/gitbook/assets/03-1.png)
Your signal was defined!
4. Define the new signal by entering a number, a name, a data type and a unit. Finally, click on the button `Define`.
![](/gitbook/assets/04-1.gif)
5. Your signal was added!
![](/gitbook/assets/05%20%281%29.png)
![](/gitbook/assets/pybytes/dashboard/signal-was-added.png)
{{% hint style="info" %}}
The name and unit are labels used to identify your signal inside Pybytes (In this example we defined `Sinwave` as the name of the signal and `Rad` as the unit).
The signal number has to match the pin number that you defined on `pybytes.send_virtual_pin_value` function call, inside your `main.py` code (In this example we defined `pin = 1`);
The datatype also has to match the variable used as argument on `pybytes.send_virtual_pin_value` function call, inside your `main.py` code (In this example our variable is a floating number; therefore we defined as a `Float32`).
The signal number has to match the signal number that you defined on `pybytes.send_signal` function call, inside your `main.py` code (In this example we defined `signalNumber = 1`);
{{< /hint >}}
## Step 3: Add a widget for the signal
1. Click on the signal card.
Click on the *"signal card"*.
![](/gitbook/assets/01.png)
![](/gitbook/assets/pybytes/dashboard/signal-card.png)
2. Click on the button `Create a new display`.
Click on the *Create a new display* button.
![](/gitbook/assets/02-1%20%281%29.png)
![](/gitbook/assets/pybytes/dashboard/create-new-display.png)
3. Select the type of visualisation (e.g. Bar chart or Line chart).
Select the type of visualisation (e.g. *Bar chart* or *Line chart*). Let's select the *Line chart*.
![](/gitbook/assets/03.gif)
![](/gitbook/assets/pybytes/dashboard/line-chart.png)
4. You can adjust the parameters of your widget at `Settings`. After, click on the button `Create`.
You can adjust the parameters of your widget at `Settings`. After, click on the button `Create`.
![](/gitbook/assets/04-1.png)
![](/gitbook/assets/pybytes/dashboard/confirm-graph-creation.png)
5. Your widget was created. Now, add your widget to your device's dashboard. Click on the button `Edit` on your widget.
Your widget was created. Now, add your widget to your device's dashboard. Click on the button `Edit` on your widget.
![](/gitbook/assets/05-1.png)
![](/gitbook/assets/pybytes/dashboard/graph-settings-button.png)
6. Mark the checkbox `Display on Dashboard` at `Settings`. Finally, click on the button `Save`.
Mark the checkbox `Display on Dashboard` at `Settings`. Finally, click on the button `Save`.
![](/gitbook/assets/06.gif)
![](/gitbook/assets/pybytes/dashboard/display-on-dashboard-checkbox.png)
7. Click on the tab `Dashboard`. Your widget was successfully added there!
Click on the `Dashboard` tab. Your widget was successfully added there!
![](/gitbook/assets/07.png)
## Step 4: Organise your dashboard
1. Click on the button `Organise`. Now the dashboard's grid will enter the edit mode and allow you to resize and reposition its widgets.
![](/gitbook/assets/edit-mode%20%281%29.gif)
2. Resize a widget by clicking on the triangle icon at the bottom right corner of the widget and drag the cursor over the grid. After, click on the button `Save` to save this action.
![](/gitbook/assets/02-1.gif)
3. Change the widget's position by drag-and-dropping it over the grid. After, click on the button `Save` to save this action.
![](/gitbook/assets/03-1.gif)
![](/gitbook/assets/pybytes/dashboard/sinwave-dashboard-widget.png)
## Done!
Now you've learned how to set up your device's dashboard to display data. Also, you can add more widgets to other pins of your device.
Now you've learned how to set up your device's dashboard to display data. Also, you can add more widgets to other signals of your device.

8
content/pybytes/getstarted.md
View File

@@ -5,18 +5,16 @@ aliases:
- pybytes/getstarted.md
- chapter/pybytes/getstarted/intro
---
Follow these steps to create a Pybytes account:
## Step 1: Go to the registration page
1. Go to [this link](https://pyauth.pybytes.pycom.io/register).
1. Go to [https://pybytes.pycom.io](https://pybytes.pycom.io/?utm_source=docs&utm_medium=web&utm_campaign=pybytes-getting-started).
2. Enter your full name, email address and a password to your account.
3. Confirm the verification message sent to your email address.
4. Click on the link and complete your login.
## Go Invent!
Now it's time to explore Pybytes. You can start by connecting your Pycom board to Pybytes.
{{% refname "connect/" %}}
Now it's time to explore Pybytes. You can start by [connecting your Pycom board to Pybytes](../connect).

4
content/pybytes/integrations/README.md
View File

@@ -2,12 +2,12 @@
title: "Integrations"
aliases:
---
## Integration with external services
Pybytes offers a way to interact with external IoT platform or custom services, like the following:
* [AWS IoT](amazon-iot): a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices
* [Microsoft Azure](azure): it's a comprehensive collection of services and solutions designed to help you create end-to-end IoT applications on Azure.
* [Google Cloud IoT](google): a complete set of tools to connect, process, store, and analyze data both at the edge and in the cloud.
* [Web Hooks](webhooks): user-defined HTTP callbacks to a defined remote destination. All elements of
the requests (headers, query string parameters, etc) are customizable.
the requests (headers, query string parameters, etc) are customizable.

4
content/pybytes/integrations/_index.md
View File

@@ -2,12 +2,12 @@
title: "Integrations"
aliases:
---
## Integration with external services
Pybytes offers a way to interact with external IoT platform or custom services, like the following:
* [AWS IoT](amazon-iot): a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices
* [Microsoft Azure](azure): it's a comprehensive collection of services and solutions designed to help you create end-to-end IoT applications on Azure.
* [Google Cloud IoT](google): a complete set of tools to connect, process, store, and analyze data both at the edge and in the cloud.
* [Web Hooks](webhooks): user-defined HTTP callbacks to a defined remote destination. All elements of
the requests (headers, query string parameters, etc) are customizable.
the requests (headers, query string parameters, etc) are customizable.

26
content/pybytes/integrations/amazon-iot.md
View File

@@ -4,37 +4,39 @@ aliases:
- pybytes/integrations/amazon-iot.html
- pybytes/integrations/amazon-iot.md
---
Whenever one of your integrated devices sends a signal to our broker, we republish the binary payload to the endpoint specified for its integration.
## Integrate your devices
1. Go in the sidebar, click on _New Integration_ and then on _Amazon Web Services_
Go in the sidebar, click on _New Integration_ and then on _Amazon Web Services_
![New AWS integration](/gitbook/assets/01_aws_integration.png)
![New AWS integration](/gitbook/assets/pybytes/integrations/aws/choose-aws.png)
2. Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_
Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_
![Fill in the form with AWS keys and choosing a region](/gitbook/assets/02_aws_integration.png)
![Fill in the form with AWS keys and choosing a region](/gitbook/assets/pybytes/integrations/aws/aws-login-form.png)
3. In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name (just alphanumeric letter, dashes and underscore are allowed), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_
In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name (just alphanumeric letter, dashes and underscore are allowed), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_
![AWS group creation](/gitbook/assets/03_aws_integration.png)
![AWS group creation](/gitbook/assets/pybytes/integrations/aws/aws-group-creation.png)
4. If everything's worked as expected, you should be able to see a summary of your integration like the following:
If everything's worked as expected, you should be able to see a summary of your integration like the following:
![Creation process result](/gitbook/assets/04_aws_integration.png)
![Creation process result](/gitbook/assets/pybytes/integrations/aws/aws-integration-result.png)
5. The corresponding AWS Thing and AWS Group has been created as well, you just have to [log in to the console](https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin) and choose the same region of your devices from the topbar. You'll be able to explore groups and things' details.
The corresponding AWS Thing and AWS Group has been created as well, you just have to [log in to the console](https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin) and choose the same region on AWS. You'll be able to explore groups and things' details.
![AWS things and groups just created](/gitbook/assets/05_aws_integration.png)
6. The device's name is specified as an attribute of the thing.
The device's name is specified as an attribute of the thing.
![Device's attributes](/gitbook/assets/06_aws_integration.png)
## Final considerations
In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html). You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html). Please notice that it's not possible to download the private key from AWS once it has been generated, by the way we securely store it inside our database. We may consider to allow its download in the future, so that you could also directly send your device to AWS, by passing Pybytes.
In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html).
You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html).
Please notice that it's not possible to download the private key from AWS once it has been generated, by the way, we securely store it inside our database.
**Warning**: do not delete AWS things or groups directly from AWS user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete AWS things or groups.

39
content/pybytes/integrations/azure.md
View File

@@ -1,44 +1,51 @@
---
title: ""
title: "Azure"
aliases:
- pybytes/integrations/azure.html
- pybytes/integrations/azure.md
---
Whenever one of your integrated devices sends a signal to our broker, we republish the binary payload to the endpoint specified for its integration through [Azure IoT Hub SDK](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-sdks).
## Integrate your devices
1. The first step requires you to create an [IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/). This is an Azure service that enables you to ingest high volumes of telemetry from your IoT devices into the cloud for storage or processing. In order to do that, [follow the offical documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal). To summarize you'll need to:
The first step requires you to create an [IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/). This is an Azure service that enables you to ingest high volumes of telemetry from your IoT devices into the cloud for storage or processing. In order to do that, [follow the official documentation](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal). To summarize you'll need to:
- specify your [subscription plan](https://account.azure.com/subscriptions/)
- create or choose a [resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-portal), a container that holds resources that share the same lifecycle, permissions, and policies. This name must contains only alphanumeric characters, periods, underscores, hyphens and parenthesis and cannot end in a period.
- create or choose a [resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-portal), a container that holds resources that share the same lifecycle, permissions, and policies. This name must contain only alphanumeric characters, periods, underscores, hyphens and parenthesis and cannot end in a period.
- choose a [region](https://azure.microsoft.com/en-us/global-infrastructure/regions/)
- choose the Iot Hub name (its length must be between 3 and 50, and it must contains only alphanumeric characters and hyphens). It won't be possible to change this name later.
- choose the IoT Hub name (its length must be between 3 and 50, and it must contain only alphanumeric characters and hyphens). It won't be possible to change this name later.
- [specify tier scaling and units](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-scaling)
![IoT Hub creation](/gitbook/assets/01_azure_integration.png)
2. Now copy and paste a connection string with the privilege to write into the registry by clicking on the relative button
Now copy and paste a connection string with the privilege to write into the registry by clicking on the relative button
![Copy the connection string](/gitbook/assets/02_azure_integration.png)
Go to Pybytes and click on *Integrations* > *New Integration* and choose *Microsoft Azure*.
3. Now go into Pybytes and click on *Integrations* > *New Integration* and choose *Microsoft Azure*. Paste the IoT Hub Connection String copied from the previous step and click *Login*
![select-azure-integration](/gitbook/assets/pybytes/integrations/azure/select-azure-integration.png)
![Login](/gitbook/assets/03_azure_integration.png)
Paste the IoT Hub Connection String copied from the previous step and click on *Login* button.
4. This step requires you to create a custom MQTT topic and the devices you want to bind to this Azure IoT hub. All the messages sent by your devices, will be republished to the Azure's MQTT broker with the topic specified here.
When you're ready, click _Create_
![Copy the connection string](/gitbook/assets/pybytes/integrations/azure/azure-login-form.png)
![Specify topic and name](/gitbook/assets/04_azure_integration.png)
This step requires you to create a custom MQTT topic and the devices you want to bind to this Azure IoT hub.
All the messages sent by your devices will be republished to the Azure's MQTT broker with the topic specified here.
When you're ready, click on the _Create_ button.
5. If everything's worked as expected, you should be able to see a summary of your integration like the following:
![select-azure-integration](/gitbook/assets/pybytes/integrations/azure/azure-configuration-form.png)
![Azure integration's summary](/gitbook/assets/05_azure_integration.png)
If everything's worked as expected, you should be able to see a summary of your integration like the following:
6. The corresponding device has been created in Azure as well, you just have to [log in to the portal](https://portal.azure.com/), click on its IoT Hub and then click on the device just created. You should be able to see all the device's details, also the connection string which will be saved encrypted in our database and used to republish your data to your Azure IoT Hub.
![Azure integration's summary](/gitbook/assets/pybytes/integrations/azure/azure-integration-inspector.png)
The corresponding device has been created in Azure as well, you just have to [log in to the portal](https://portal.azure.com/), click on its IoT Hub and then click on the device just created.
You should be able to see all the device's details, also the connection string which will be saved encrypted in our database and used to republish your data to your Azure IoT Hub.
![Azure device's details](/gitbook/assets/06_azure_integration.png)
7. Try to send some signal messages with your device. You should be able to see in the dashboard that the system has received them. More information on testing device's connectivity could be found [here](https://docs.microsoft.com/en-us/azure/iot-hub/tutorial-connectivity).
Try to send some signal messages with your device.
You should be able to see in the dashboard that the system has received them.
More information on the testing device's connectivity could be found [here](https://docs.microsoft.com/en-us/azure/iot-hub/tutorial-connectivity).
![Test device connectivity](/gitbook/assets/07_azure_integration.png)
@@ -51,4 +58,4 @@ In order to see the data sent to Azure, you could do different things, depending
- [Read the telemetry from the hub with a back-end application (Node.js)](https://docs.microsoft.com/en-us/azure/iot-hub/quickstart-send-telemetry-node)
- [Configure message routing with IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/tutorial-routing)
**Warning**: do not delete Azure devices directly from Azure user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete Azure devices.
**Warning**: do not delete Azure devices directly from Azure user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete Azure devices.

51
content/pybytes/integrations/google.md
View File

@@ -1,51 +0,0 @@
---
title: ""
aliases:
- pybytes/integrations/google.html
- pybytes/integrations/google.md
---
Whenever one of your integrated devices sends a signal to our broker, we republish the binary payload to the Google endpoint specified for its integration through MQTT protocol.
## Integrate your devices
1. First of all, you have to create a Google project or select an existing one inside [Google console](https://console.cloud.google.com/cloud-resource-manager) ([read also here for further information](https://cloud.google.com/resource-manager/docs/creating-managing-projects)). Take note of the Project ID, which it will be used for integrating your devices.
2. Make sure to [enable billing](https://cloud.google.com/billing/docs/how-to/modify-project) and [the Cloud IoT Core API](https://console.cloud.google.com/flows/enableapi?apiid=cloudiot.googleapis.com&redirect=https://console.cloud.google.com&_ga=2.236270149.-51976751.1517992223) for that project.
3. At this point, you should see inside your Google IoT dashboard that your project is correctly bound to Google IoT services
![Google dashboard](/gitbook/assets/01_google_integration.png)
4. Now let's access Pybytes and click _Integrations > New integration > Google Cloud_
![Google Cloud's selection](/gitbook/assets/02_google_integration.png)
5. You'll see that Pybytes requires you to authenticate with your Google account. The account you'll be using, must have the privileges to access that project.
![Google's authentication](/gitbook/assets/03_google_integration.png)
6. Once you've logged in, the first thing to do is to specify the project's ID and the region. This is required to correctly identify a resource and list all the related [registries](https://cloud.google.com/iot/docs/concepts/devices#device_registries).
![Step 1: project ID and region](/gitbook/assets/04_google_integration.png)
7. The following step allows you to create a new registry or select an existing one. Whenever you choose a registry, the corresponding topics will be loaded in the dropdown menu below. This is required by Google, but it's different from the topics used by the integration to publish payloads to Google cloud. For further information, [please read this section](https://cloud.google.com/iot/docs/how-tos/mqtt-bridge#publishing_telemetry_events).
![Step 2: registry and topic](/gitbook/assets/05_google_integration.png)
8. The last step allows you to choose the devices you want to integrate and summarizes the identifying elements of this integration.
![Step 3: Choose devices](/gitbook/assets/06_google_integration.png)
9. Once you click _Create_, if the operation is successful, you'll be able to see the final screen which states the correct integration.
![Successfully integrated](/gitbook/assets/07_google_integration.png)
If you access the registry on Google cloud, you'll be able to see the just created device there as well.
![Google registry's devices view](/gitbook/assets/08_google_integration.png)
## Final considerations
We create an [ES256 key with a self-signed X.509 certificate](https://cloud.google.com/iot/docs/how-tos/credentials/keys#generating_an_es256_key_with_a_self-signed_x509_certificate) for every device. The private key will be used for authenticating the device with the Google's broker.
You could access the [StackDriver application](https://app.google.stackdriver.com) to see the events, according to the log level you chosed for a device. In case you haven't chosen one, it will inherit the level of the registry it belongs.
**Warning**: do not delete Google devices directly from Google cloud user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete Google devices.

28
content/pybytes/integrations/webhooks.md
View File

@@ -1,29 +1,31 @@
---
title: ""
title: "Webhooks"
aliases:
- pybytes/integrations/webhooks.html
- pybytes/integrations/webhooks.md
---
Whenever one of your integrated devices sends a signal to our broker, we perform an HTTP request defined by the user. You can use some presets (`DEVICE_TOKEN`, `USER_ID`, etc), which will act like placeholders and will be dinamically replaced at the moment of performing the request with the relative content.
Whenever one of your integrated devices sends a signal to our MQTT broker, we perform an HTTP request defined by the user.
You can use some presets (`DEVICE_TOKEN`, `USER_ID`, etc), which will act as placeholders and will be dynamically replaced at the moment of performing the request with the relative content.
## Integrate your devices
1. Go in the sidebar, click on _New Integration_ and then on _Webhook_
Go in the sidebar, click on _New Integration_ and then on _Webhook_
![New Web Hook integration](/gitbook/assets/01_webhook_integration.png)
![New WebHook integration](/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png)
2. Fill in the form specifying the following information:
1. The remote URL to which we will send the data
2. An event name
3. The HTTP method
4. The request format. Please note that we will prefill some headers whenever you change the format. The prefilled headers are not modifiable.
5. You can optionally add some more headers and query parameters. There's also an eased interface for basci HTTP auth.
Fill in the form specifying the following information:
1. The remote URL to which we will send the data
2. An event name
3. The HTTP method
4. The request format. Please note that we will prefill some headers whenever you change the format. The prefilled headers are not modifiable.
5. You can optionally add some more headers and query parameters. There's also an eased interface for basic HTTP authentication.
We will take care of formatting the body accordingly to the chosen request format. In case you've chosen _Custom Body_, you'll have to define everything by yourself and you'll also be allowed to manually insert the presets.
Once you're done, you'll see a preview of the request at the bottom of the page. Remember to choose the devices you want to bind to this service.
![Web Hook definition](/gitbook/assets/02_webhook_integration.png)
![Webhook definition](/gitbook/assets/pybytes/integrations/webhook/webhook-form.png)
1. If everything's worked as expected, you should be able to see a summary of your integration like the following:
If everything's worked as expected, you should be able to see a summary of your integration like the following:
![Creation process result](/gitbook/assets/03_webhook_integration.png)
![Creation process result](/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png)

37
content/pybytes/introduction.md
View File

@@ -1,37 +0,0 @@
---
title: "Introduction"
aliases:
- pybytes/introduction.html
- pybytes/introduction.md
- chapter/pybytes
---
![](/gitbook/assets/pybyteslogo%20%281%29.png)
## What is Pybytes?
Pybytes is an IoT Ecosystem that empowers you by granting full control of all your Pycom devices.
With Pybytes you have control over your device's data stream and more:
* Visualise sensors data according to your interests using our customisable dashboard;
* Check the status of your entire fleet;
* Keep track of your assets with our geolocation feature;
* Distribute firmware updates on a scalable approach.
In a nutshell, Pybytes is an environment designed to optimise your IoT applications using Pycom boards.
## What Pybytes offers you?
* Data Visualisation: Pybytes dashboard is customisable, allowing you to freely set up key performance indicators and time series data from all your sensors.
* Intelligent notifications: Keep track of your device's status, battery level, data streaming and measurements with pre-defined alarms. Receive notifications via email or SMS.
* Terminal: Execute commands to gather accurate information from your devices using Pybytes terminal shell.
* Firmware updates over the air: Upgrade or downgrade firmware versions with our exclusive firmware update.
* Track your assets position: Google Maps API empowers your view over your device's geolocation.
## Let's get started!
* [Getting started with Pybytes](getstarted)
* [Connect your Pycom module to Pybytes](connect/)
* [Visualise data from your device](dashboard)
* [Integrations with external services](integrations/)

15
content/pymakr/installation/README.md
View File

@@ -1,15 +0,0 @@
---
title: "Installation"
aliases:
- chapter/pymakr/installation
---
![](/gitbook/assets/pymakr-logo-1.png)
## Pymakr Plugins <a id="pymakr-plugins"></a>
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:
{{% refname "atom.md" %}}
{{% refname "vscode.md" %}}

6
content/pymakr/installation/_index.md
View File

@@ -2,13 +2,13 @@
title: "Installation"
aliases:
---
![](/gitbook/assets/pymakr-logo-1.png)
## Pymakr Plugins <a id="pymakr-plugins"></a>
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:
{{% refname "atom.md" %}}
{{% refname "vscode.md" %}}
- {{% refname "atom.md" %}}
- {{% refname "vscode.md" %}}

1
content/pymakr/installation/atom.md
View File

@@ -5,6 +5,7 @@ aliases:
- pymakr/installation/atom.md
- chapter/pymakr/installation/atom
---
For beginners, users getting started with MicroPython & Pycom as well as Atom text editor users, we recommend the **Pymakr Plugin for Atom**. This section will help you get started using the Atom Text Editor & Pymakr Plugin.
Please follow these steps to install the Pymakr Plugin:

1
content/pymakr/installation/vscode.md
View File

@@ -5,6 +5,7 @@ aliases:
- pymakr/installation/vscode.md
- chapter/pymakr/installation/vscode
---
Pycom also supports Microsoft's Visual Studio Code IDE platform with the Pymakr Plugin. To download Visual Studio Code, navigate to [VS Code](https://code.visualstudio.com/).
You will also need NodeJS installed on your PC. Please download the latest LTS version available [from the NodeJS website.](https://nodejs.org/)

1
content/pymakr/settings.md
View File

@@ -5,6 +5,7 @@ aliases:
- pymakr/settings.md
- chapter/pymakr/settings
---
Below you will find a description of the various settings available for Pymakr.
## address

3
content/pymakr/toolsfeatures.md
View File

@@ -5,11 +5,13 @@ aliases:
- pymakr/toolsfeatures.md
- chapter/pymakr/toolsfeatures
---
## Console (REPL)
MicroPython has an interactive code tool known as the REPL (Read Evaluate Print Line). The REPL allows you to run code on your device, line by line. To begin coding, go to the Pymakr Plugin Console and start typing your code. Start by making the LED change colour.
```python
import pycom # we need this module to control the LED
pycom.heartbeat(False) # disable the blue blinking
@@ -19,6 +21,7 @@ pycom.rgbled(0x00ff00) # make the LED light up green in colour
You can change the colour by adjusting the hex RGB value.
```python
pycom.rgbled(0xff0000) # now make the LED light up red in colour
```

13
content/pytrackpysense/_index.md
View File

@@ -2,6 +2,7 @@
title: ""
aliases:
---
In addition to the Expansion Board, Pycom also offers three additional sensor boards, which are ideal for quickly building a fully functioning IoT solution! Whether the application is environment sensing or asset tracking, these additional boards support a variety of sensors.
## Pytrack
@@ -22,6 +23,10 @@ The Pytrack is has a number of features including GPS, 3-Axis Accelerometer and
All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL).
You can find the datasheet and more info here:
{{% refname "../datasheets/boards/pytrack.md" %}}
## Pysense
Pysense is a sensor packed version of the Expansion Board, intended for use in environment sensing applications such as temperature, humidity monitoring, and light sensing.
@@ -42,6 +47,10 @@ The Pysense is packed with a number of sensors and hardware, see the list below
All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `GPI09` (SDA) and `GPI08` (SCL).
You can find the datasheet and more info here:
{{% refname "../datasheets/boards/pysense.md" %}}
## Pyscan
Pyscan is a RFID-NFC enabled version of the Expansion Board, intended for use in scanning applications, such as RFID/NFC readers.
@@ -62,3 +71,7 @@ The Pyscan is packed with a number of sensors and hardware, see the list below f
All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL).
You can find the datasheet and more info here:
{{% refname "../datasheets/boards/pyscan.md" %}}

1
content/pytrackpysense/apireference/README.md
View File

@@ -3,5 +3,6 @@ title: "API Reference"
aliases:
- chapter/pytrackpysense/apireference
---
To simplify usability, APIs for the libraries have been created, abstracting away the low level interactions with the sensors. The next following pages refer to the respective libraries for the Pytrack, Pysense, and Pyscan.

Some files were not shown because too many files have changed in this diff Show More