Skip to content

Commit 895d795

Browse files
gijsiogijsio
authored
Changing shield examples (#396)
* changed shield examples * changed shield links * added example text * added getting-started * added getting started * upate shield getting started * add new examples * add sleep and scan examples * update links * changed links to release
1 parent 4de8b43 commit 895d795

File tree

14 files changed

+466
-51
lines changed

14 files changed

+466
-51
lines changed

‎config.toml‎

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -427,46 +427,34 @@ theme = "doc-theme"
427427
parent = "tutorials"
428428
weight = 50
429429
[[menu.main]]
430-
name = "Pygate"
431-
url = "/tutorials/expansionboards/pygate/"
432-
identifier = "tutorials@expansionboards@pygate"
430+
name = "Tracking"
431+
url = "/tutorials/expansionboards/tracking/"
432+
identifier = "tutorials@expansionboards@tracking"
433433
parent = "tutorials@expansionboards"
434434
weight = 10
435435
[[menu.main]]
436-
name = "pysense"
437-
url = "/tutorials/expansionboards/pysense/"
438-
identifier = "tutorials@expansionboards@pysense"
436+
name = "Sensing"
437+
url = "/tutorials/expansionboards/sensing/"
438+
identifier = "tutorials@expansionboards@sensing"
439439
parent = "tutorials@expansionboards"
440440
weight = 20
441441
[[menu.main]]
442-
name = "pysense 2.0 X"
443-
url = "/tutorials/expansionboards/pysense2/"
444-
identifier = "tutorials@expansionboards@pysense2"
442+
name = "Scanning"
443+
url = "/tutorials/expansionboards/scanning/"
444+
identifier = "tutorials@expansionboards@scanning"
445445
parent = "tutorials@expansionboards"
446446
weight = 30
447447
[[menu.main]]
448-
name = "pytrack"
449-
url = "/tutorials/expansionboards/pytrack/"
450-
identifier = "tutorials@expansionboards@pytrack"
448+
name = "Pysleep"
449+
url = "/tutorials/expansionboards/sleep/"
450+
identifier = "tutorials@expansionboards@sleep"
451451
parent = "tutorials@expansionboards"
452452
weight = 40
453-
[[menu.main]]
454-
name = "pytrack 2.0 X"
455-
url = "/tutorials/expansionboards/pytrack2/"
456-
identifier = "tutorials@expansionboards@pytrack2"
457-
parent = "tutorials@expansionboards"
458-
weight = 50
459-
[[menu.main]]
460-
name = "pyscan"
461-
url = "/tutorials/expansionboards/pyscan/"
462-
identifier = "tutorials@expansionboards@pyscan"
463-
parent = "tutorials@expansionboards"
464-
weight = 60
465453
[[menu.main]]
466454
name = "Sleep"
467455
url = "/tutorials/expansionboards/sleep/"
468456
identifier = "tutorials@expansionboards@sleep"
469-
parent = "tutorials@basic"
457+
parent = "tutorials@expansionboards"
470458
weight = 20
471459
[[menu.main]]
472460
name = "Advanced"
@@ -1068,7 +1056,7 @@ theme = "doc-theme"
10681056
weight = 60
10691057

10701058
[[menu.main]]
1071-
name = "Expansion Boards and Shields"
1059+
name = "Shields"
10721060
url = "/datasheets/expansionboards/"
10731061
identifier = "datasheets@boards"
10741062
parent = "datasheets"

‎content/datasheets/expansionboards/pygate.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@ aliases:
88
---
99
**Store**: [Buy Here](https://pycom.io/product/pygate/)
1010

11-
## ![](/gitbook/assets/pygate.png)
11+
The Pygate is an 8-channel LoRa Gateway
12+
13+
## Getting started
14+
1. Upload the latest stable `pygate` firmware release using the [firmware updater](/updatefirmware/device/).
15+
1. Follow the [tutorial](/tutorials/expansionboards/pygate/) to get your Pygate up and connected to The Things Network.
16+
17+
## Features
18+
19+
![](/gitbook/assets/pygate.png)
1220

1321
## Datasheet
1422

‎content/datasheets/expansionboards/pyscan.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,21 @@ aliases:
88
---
99
**Store**: [Buy Here](https://pycom.io/product/pyscan/)
1010

11-
![](/gitbook/assets/pyscan-new.png)
11+
The Pyscan shield allows you to scan RFID and NFC tags and includes an accelerometer and light sensor.
1212

13+
## Getting started
14+
1. Find the libraries for the Pyscan in the [Pycom libraries](https://github.com/pycom/pycom-libraries/releases/) repository on Github.
15+
1. Download the files and extract them into the project folder in Pymakr
16+
1. Click the `upload project to device` button. This will store all necessary files on the device and allow you to import them in the example `main.py`.
17+
1. Check the REPL. If you have Pybytes activated, the example will send the sensor data to Pybytes automatically. Note that the Pyscan will return command to the REPL while it scans for NFC cards in the background. Note that the example also allows the decoding of cards by changing the variable `DECODE_CARD = True`
18+
19+
### Examples
20+
The Pyscan has several examples:
21+
* [Scanning](/tutorials/expansionboards/scanning/)
22+
23+
## Features
24+
25+
![](/gitbook/assets/pyscan-pinout-1.png)
1326
## Datasheet & Pinout
1427

1528
The pinout and datasheet of the Pyscan is available as a [PDF File](/gitbook/assets/pyscan-pinout.pdf)
@@ -18,7 +31,7 @@ The pinout and datasheet of the Pyscan is available as a [PDF File](/gitbook/ass
1831
The Pyscan is certified for:
1932
* [ROHS certification](/gitbook/assets/RoHs_declarations/RoHS-for-Pyscan(8286-00031P)-20190523.pdf)
2033

21-
![](/gitbook/assets/pyscan-pinout-1.png)
34+
2235

2336
## Pyscan Libraries
2437

@@ -50,4 +63,4 @@ The board features a single cell Li-Ion/Li-Po charger with a JST PHR‑2 connect
5063

5164
## 3D model for case design
5265

53-
* Please see the [3D model] (/gitbook/assets/PyScan_v0.7.step) (step format)
66+
* Please see the [3D model](/gitbook/assets/PyScan_v0.7.step) (step format)

‎content/datasheets/expansionboards/pysense.md‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,26 @@ aliases:
88
---
99
**Store**: [Buy Here](https://pycom.io/product/pysense/)
1010

11+
The Pysense shield allows you to sense the environment using 5 different sensors:
12+
* Accelerometer (LIS2HH12)
13+
* Light Sensor (LTR329ALS01)
14+
* Pressure Sensor (MPL3115A2)
15+
* Temperature / Humidity Sensor (SI7006A20)
1116

12-
![](/gitbook/assets/pysense.png)
17+
## Getting started
18+
1. Find the libraries for the Pysense in the [Pycom libraries](https://github.com/pycom/pycom-libraries/releases/) repository on Github.
19+
1. Download the files and extract them into the project folder in Pymakr
20+
1. Click the `upload project to device` button. This will store all necessary files on the device and allow you to import them in the example `main.py`.
21+
1. Check the REPL. If you have Pybytes activated, the example will send the sensor data to Pybytes automatically.
22+
23+
24+
### Examples
25+
The Pysense has several examples:
26+
* [Sensing](/tutorials/expansionboards/sensing/)
27+
28+
## Features
29+
30+
![](/gitbook/assets/pysense-pinout-1.png)
1331

1432
## Datasheet
1533

@@ -24,7 +42,7 @@ The Pysense is certified for:
2442
The pinout of the Pysense is available as a [PDF File](/gitbook/assets/pysense-pinout.pdf)
2543
* The user button is connected to `P14`. This button can also be used to put the Pysense board in `dfu-bootloader` mode to update the firmware.
2644

27-
![](/gitbook/assets/pysense-pinout-1.png)
45+
2846

2947
## Notes
3048
### Battery Charger

‎content/datasheets/expansionboards/pysense2.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,25 @@ aliases:
77
- chapter/datasheets/boards/pysense2
88
---
99

10+
The Pysense 2.0 X shield allows you to sense the environment using 5 different sensors:
11+
* Accelerometer (LIS2HH12)
12+
* Light Sensor (LTR329ALS01)
13+
* Pressure Sensor (MPL3115A2)
14+
* Temperature / Humidity Sensor (SI7006A20)
15+
16+
## Getting started
17+
1. Find the libraries for the Pysense 2.0 X in the [Pycom libraries](https://github.com/pycom/pycom-libraries/releases/) repository on Github.
18+
1. Download the files and extract them into the project folder in Pymakr
19+
1. Click the `upload project to device` button. This will store all necessary files on the device and allow you to import them in the example `main.py`.
20+
1. Check the REPL. If you have Pybytes activated, the example will send the sensor data to Pybytes automatically.
21+
22+
23+
### Examples
24+
The Pysense has several examples:
25+
* [Sensing](/tutorials/expansionboards/sensing/)
26+
27+
## Features
28+
1029
![](/gitbook/assets/pysense2_desc.png)
1130

1231
## Datasheet

‎content/datasheets/expansionboards/pytrack.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ aliases:
88
---
99
**Store**: [Buy Here](https://pycom.io/product/pytrack/)
1010

11+
The Pytrack shield allows you track your location using the onboard GPS and accelerometer.
12+
13+
## Getting started
14+
1. Find the libraries for the Pytrack in the [Pycom libraries](https://github.com/pycom/pycom-libraries/releases/) repository on Github.
15+
1. Download the files and extract them into the project folder in Pymakr
16+
1. Click the `upload project to device` button. This will store all necessary files on the device and allow you to import them in the example `main.py`.
17+
1. Check the REPL. If you have Pybytes activated, the example will send the location data to Pybytes automatically.
18+
19+
20+
### Examples
21+
The Pytrack has several examples:
22+
* [Tracking](/tutorials/expansionboards/tracking/)
23+
24+
## Features
25+
1126
![](/gitbook/assets/pytrack.png)
1227

1328

‎content/datasheets/expansionboards/pytrack2.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,21 @@ aliases:
77
- chapter/datasheets/boards/pytrack2
88
---
99

10+
The Pytrack 2.0 X shield allows you track your location using the onboard GPS and accelerometer.
11+
12+
## Getting started
13+
1. Find the libraries for the Pytrack 2.0 X in the [Pycom libraries](https://github.com/pycom/pycom-libraries/releases/) repository on Github.
14+
1. Download the files and extract them into the project folder in Pymakr
15+
1. Click the `upload project to device` button. This will store all necessary files on the device and allow you to import them in the example `main.py`.
16+
1. Check the REPL. If you have Pybytes activated, the example will send the location data to Pybytes automatically.
17+
18+
19+
### Examples
20+
The Pytrack has several examples:
21+
* [Tracking](/tutorials/expansionboards/tracking/)
22+
23+
## Features
24+
1025
![](/gitbook/assets/pytrack2_decs.png)
1126

1227
## Datasheet

‎content/firmwareapi/pycom/expansionboards/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Note that this functionality is not built into the firmware, and you will need t
1414
The API pages are separated per sensor:
1515
* [Accelerometer](lis2hh12/) (LIS2HH12)
1616
* [Light Sensor](ltr329als01/) (LTR329ALS01)
17-
* [Temperature Sensor](si7006a20/) (SI7006A20)
17+
* [Temperature / Humidity Sensor](si7006a20/) (SI7006A20)
1818
* [Pressure Sensor](mpl3115a2/) (MPL3115A2)
1919
* [RFID / NFC](mfrc630/) (MFRC630)
2020
* [GPS](l76gnss/) (L76GNSS)

‎content/gettingstarted/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,9 @@ In the previous section we got code running on on your Pycom module using the `r
124124
From here on, you can continue to use the additional features of your expansionboard:
125125
>Note The Expansionboard requires no additional libraries and all functions work out of the box!
126126
127-
|[ Pygate](/tutorials/expansionboards/pygate/)| [Pysense](/tutorials/expansionboards/pysense/) | [Pysense 2.0 X](/tutorials/expansionboards/pysense2/)| [Pytrack](/tutorials/expansionboards/pytrack/)| [Pytrack 2.0 X](/tutorials/expansionboards/pytrack2/)| [PyScan ](/tutorials/expansionboards/pyscan/)|
127+
|[ Pygate](/datasheets/expansionboards/pygate/)| [Pysense](/datasheets/expansionboards/pysense/) | [Pysense 2.0 X](/datasheets/expansionboards/pysense2/)| [Pytrack](/datasheets/expansionboards/pytrack/)| [Pytrack 2.0 X](/datasheets/expansionboards/pytrack2/)| [PyScan ](/datasheets/expansionboards/pyscan/)|
128128
|:----|:-----|:-----|:-----|:-----|:----|
129-
| [![](/gitbook/assets/expansionboards/pygate.png)](/tutorials/expansionboards/pygate/)|[![](/gitbook/assets/expansionboards/pysense1.png)](/tutorials/expansionboards/pysense/) | [![](/gitbook/assets/expansionboards/pysense2.png)](/tutorials/expansionboards/pysense2/)| [![](/gitbook/assets/expansionboards/pytrack1.png)](/tutorials/expansionboards/pytrack/)| [![](/gitbook/assets/expansionboards/pytrack2.png)](/tutorials/expansionboards/pytrack2/)| [![](/gitbook/assets/expansionboards/pyscan.png)](/tutorials/expansionboards/pyscan/) |
129+
| [![](/gitbook/assets/expansionboards/pygate.png)](/datasheets/expansionboards/pygate/)|[![](/gitbook/assets/expansionboards/pysense1.png)](/datasheets/expansionboards/pysense/) | [![](/gitbook/assets/expansionboards/pysense2.png)](/datasheets/expansionboards/pysense2/)| [![](/gitbook/assets/expansionboards/pytrack1.png)](/datasheets/expansionboards/pytrack/)| [![](/gitbook/assets/expansionboards/pytrack2.png)](/datasheets/expansionboards/pytrack2/)| [![](/gitbook/assets/expansionboards/pyscan.png)](/datasheets/expansionboards/pyscan/) |
130130

131131
## Step 5: Connecting to a network
132132

‎content/tutorials/expansionboards/_index.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ disable_breadcrumbs: true
99

1010
>Note: Before using the Pysense, Pytrack and Pyscan boards, check the [GitHub](https://github.com/pycom/pycom-libraries) for the latest version of the libraries.
1111
12-
To use the Pysense, Pytrack or Pyscan, make a folder inside your project folder and call it `lib`. Then, copy the appropiate sensor libraries from the github repository to the folder. Always copy the `pysense.py` or `pytrack.py` and `pycoproc.py` files if you want to use the boards' functions. The `pycoproc.py` library also allows for a special sleep mode. An example for this is provided [here](../expansionboards/sleep/)
12+
To use the Pysense, Pytrack or Pyscan, make a folder inside your project folder and call it `lib`. Then, copy the appropiate sensor libraries from the github repository to the folder. Always copy the `pysense.py` or `pytrack.py` and `pycoproc.py` files if you want to use the boards' functions. The `pycoproc.py` library also allows for a special sleep mode. An example for this is provided [here](sleep/)
13+
14+
* [Asset tracking](tracking/)
15+
* [Environment sensing](sensing/)
16+
* [Scanning RFID / NFC Tags](scanning/)
17+
* [Pysleep](sleep/)
18+
* [Movement detection](/accelerometer/)
1319

1420

15-
* [Pygate](../expansionboards/pygate/)
16-
* [Pysense](../expansionboards/pysense/)
17-
* [Pysense 2.0 X](../expansionboards/pysense2/)
18-
* [Pytrack](../expansionboards/pytrack/)
19-
* [Pytrack 2.0 X](../expansionboards/pytrack2/)
20-
* [Pyscan](../expansionboards/pyscan/)
2121

2222

2323
>Note: Make sure to click `upload to device` to be able to `import` the appropriate libraries in your code!

0 commit comments

Comments
 (0)