Skip to content

Commit

Permalink
Add Seeed Wio-E5 documentation (#1361)
Browse files Browse the repository at this point in the history
* doc: Initial files

* doc: Further document

* doc: Further document

* doc: Cleanup

* doc: Add fixes

* doc: Update images

* doc: Small fixes
  • Loading branch information
LDannijs authored Sep 17, 2024
1 parent 6073a51 commit 3c55877
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 0 deletions.
Binary file added doc/content/devices/models/seeed-E5/AT.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
117 changes: 117 additions & 0 deletions doc/content/devices/models/seeed-E5/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
title: "Seeed Studio Wio-E5"
description: ""
weight:
---

{{< figure src="wio-e5-mini.png" alt="Image of the Wio-E5 mini" class="float plain" width="80%">}}

The [Seeed Studio Wio-E5 module](https://www.seeedstudio.com/LoRa-LoRaWAN-Modules-c-1950.html) is embedded with the ST system-level package chip STM32WLE5JC, ARM Cortex M4 ultra-low power MCU, and long range SX126X transceiver. It supports EU868, US915 and more frequency bands. It is suitable for wireless sensor networks and other battery-powered IoT devices that require low power consumption and long transmission range.

<!--more-->

In this guide, the Wio-E5 mini board is used, but the onboarding process should be the same for other Wio-E5 boards as well.

## AT Commands

First connect the Wio-E5 mini to your computer via a Type-C cable.

Then open a serial tool (for example the [Arduino IDE's](https://www.arduino.cc/en/software) Serial Monitor), select the correct COM port and set the baud rate to `9600`.

In the serial monitor's message field, type `AT` and press enter. You should see a response back.

{{< figure src="AT.png" alt="Arduino's serial console with the AT command responding." >}}

Next step is to register the device on {{% tts %}}.

## Onboarding to {{% tts %}}

The device can be onboarded using the **Device Repository** or **manually**.

The [LoRaWAN® Device repository](https://github.com/TheThingsNetwork/lorawan-devices) comprises over 800 end-device profiles, including the Wio-E5 mini, which enables quick and easy registration with {{% tts %}}.

To onboard with the **Device Repository**, in the **End device type** section, under **Input method**, select the **Select the end device in the LoRaWAN Device Repository** option. The [Onboarding devices without QR codes]({{< ref "/devices/adding-devices/#onboarding-devices-without-qr-codes" >}}) section of the [Adding Devices]({{< ref "/devices/adding-devices/" >}}) guide explains this procedure in detail. Following details are Wio-E5 mini-specific:

- End device brand: **Seeed Technology Co., Ltd**
- Model: **Wio-E5 mini (STM32WLE5JC) Dev Board**
- Hardware Ver.: `1.0`
- Firmware Ver.: `1.0`

{{< figure src="repository-onboard.png" alt="Settings for registration through device repository" >}}

If you prefer onboarding **manually**, in the **End device type** section, under **Input Method**, select the **Enter end device specifics manually** option. The [Manually adding devices]({{< ref "/devices/adding-devices/manual/" >}}) and [Over the Air Activation (OTAA)]({{< ref "/devices/adding-devices/manual/otaa/" >}}) guides explain this procedure in detail. Following details are specific to the Wio-E5 mini:

- LoRaWAN version: **LoRaWAN Specification 1.0.3**
- Regional parameters version: **RP001 Regional Parameters 1.0.3 revision A**

{{< figure src="manual.png" width="70%" alt="Settings for manual registration" >}}

Now when you scroll down, you will see the **Provisioning Information** section where you need to enter some values; these values can be obtained from the device itself. To obtain this info from the device, go back to your serial monitor and send the following AT commands on the serial monitor:

- `AT+ID=DevEui` to get your Device EUI
- `AT+ID=AppEui` to get your App EUI

The output will be as follows:

```
Tx: AT+ID=DevEui
Rx: +ID: DevEui, 2C:F7:F1:20:24:90:03:63
Tx: AT+ID=AppEui
Rx: +ID: AppEui, 80:00:00:00:00:00:00:07
```

Now return to {{% tts %}} and enter the details for your device.

Finally, you need to set the `AppKey`. To do this, you can generate an AppKey in {{% tts %}} and program it into the device. Click **Generate** next to the **AppKey** field in {{% tts %}} and **copy** it. Then run the following AT command to program this key into the device:

- `AT+KEY=APPKEY,"generated-appkey"` to set the App Key

The output will be as follows:

```
Tx: AT+KEY=APPKEY,"2B7E151628AED2A6ABF7158809CF4F3C"
Rx: +KEY: APPKEY 2B7E151628AED2A6ABF7158809CF4F3C
```

{{< figure src="prov-info.png" alt="Provisioning Information" width="70%" >}}

After configuring your device, click the **Register end device** button.

Now the device is configured, but we still need to connect it to {{% tts %}}. To do so type the following AT commands:

```
// If you are using US915
AT+DR=US915
AT+CH=NUM,8-15
// If you are using EU868
AT+DR=EU868
AT+CH=NUM,0-2
// After running the region command
AT+MODE=LWOTAA
AT+JOIN
```

The output on serial monitor will be as follows:

```
Tx: AT+DR=EU868
Rx: +DR: EU868
Tx: AT+CH=NUM,0-2
Rx: +CH: NUM, 0-2
Tx: AT+MODE=LWOTAA
Rx: +MODE: LWOTAA
Tx: AT+JOIN
Rx: +JOIN: Start
+JOIN: NORMAL
+JOIN: Network joined
+JOIN: NetID 000013 DevAddr 26:01:5F:66
+JOIN: Done
```

If you see `+JOIN: Network joined` on your serial console, that means your device has successfully connected to {{% tts %}}!

This only explains the basics for connecting to {{% tts %}}. If you wish to know what other commands are available, check [here](https://files.seeedstudio.com/products/317990687/res/LoRa-E5%20AT%20Command%20Specification_V1.0%20.pdf), and if you wish to start developing with the Wio-E5, check the [Seeed Studio Wiki](https://wiki.seeedstudio.com/LoRa_E5_mini/#develop-with-stm32cube-mcu-package).
Binary file added doc/content/devices/models/seeed-E5/manual.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3c55877

Please sign in to comment.