Skip to content

Commit

Permalink
v1.5.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
alke-q committed Sep 7, 2023
0 parents commit c48de71
Show file tree
Hide file tree
Showing 400 changed files with 106,795 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
*.a
*.bak
*.db
*.flash
*.gcda
*.gcno
*.log
*.o
*.lo
*.la
*.ninja*
*.opendb
*.orig
*.pcap
*.pyc
*.suo
*.swn
*.swo
*.swp
*.trs
*.user
*.bak
*~
.deps
.dirstamp
.DS_Store
.local-version
.libs
.vagrant
.hg
.hgignore

# CMake
Software/OpenThread/build/
CMakeCache.txt
CMakeFiles
cmake_install.cmake

# IDE / editor files
.idea/**
.vscode/**
cmake-build-*/**
/tags
.project
.pydevproject

# Python bytecodes
__pycache__

# Images
*.hex
*.zip

7 changes: 7 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[submodule "third_party/openthread"]
branch = main
path = ThirdParty/openthread
url = https://github.com/openthread/openthread.git
[submodule "ThirdParty/tool_rpi"]
path = ThirdParty/tool_rpi
url = https://github.com/raspberrypi/tools.git
80 changes: 80 additions & 0 deletions Certification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
## Certified components

### Bluetooth Low Energy

**Certification overview:**

| | QDID | Declaration ID | Specification | Link |
| --- | --- | --- | --- | --- |
| BLE Controller QPG7015M | 163591 | D056523 | 5.2 | [https://launchstudio.bluetooth.com/ListingDetails/123871](https://launchstudio.bluetooth.com/ListingDetails/123871) |
| BLE Host Stack | 146344 | D049426 | 5.2 | [https://launchstudio.bluetooth.com/ListingDetails/103670](https://launchstudio.bluetooth.com/ListingDetails/103670) |
| BLE profiles subsystem | N/A | N/A | N/A | Not certified but verified with the TCRL.2018-2 compliance tester using Bluetooth Profile Tuning Suites 7.3.0. **Please include testing for the BLE profiles included in your end-product listing.** |

**End-product certification instructions**

SDK users can reference Qorvo QDIDs (see above) in their End Product Listing (EPL)
- 1 BLE controller subsystem: Supplied by Qorvo SDK
- 1 BLE host subsystem: Supplied by Qorvo SDK
- \[optional\] Profile subsystem: **No certified subsystem in this SDK**
- When modifying the profiles from the SDK or when the subsystem was not certified, one should selectively test the modified/non-certified profiles using the [profile-tuning-suite](https://www.bluetooth.com/develop-with-bluetooth/qualification-listing/qualification-test-tools/profile-tuning-suite/). Results of the Profile Tuning Suite tests should be verified by a [Bluetooth Qualification Test Facility (BQTF)](https://www.bluetooth.com/develop-with-bluetooth/qualification-listing/qualification-test-facilities).
### Thread

**Certification overview:**

| | Certification ID | Test Harness | Specification | Link |
| --- | --- | --- | --- | --- |
| QPG7015M Thread Component | 13A072.1 | v58.0 | 1.3 |[https://www.threadgroup.org](https://www.threadgroup.org/What-is-Thread/Developers#dnn_ctr1464_Thread_CompDataDefault_rptrProductData_tdcn_50)|


**Thread Device Roles**

| | |
|--- |---|
|Border Router |X|
|FTD-REED |X|
|FTD-FED ||
|MED ||
|SED ||
|SSED ||
|On-Mesh Commissioner|X|
|Thread Joiner |X|

**Optional Features**

| | |
|--- |---|
|DUA Management (BR) |X|
|DUA Registration (MTD) |X|
|Link Metrics Initiator (FTD) |X|
|DHCPv6 Agent ||
|DHCPv6 Client |X|
|Joiner Provisioning (Joiner) ||

**End-product certification instructions**

Qorvo provides a PR SDK that has been certified as "Thread Component" (tested by a [Authorized-Test-Lab](https://www.threadgroup.org/Authorized-Test-Lab) and certification requested at the ThreadGroup). The seleced *device roles* and *optional features* are tailored for generic Thread usage, but can be reduced for e.g. Matter-only devices (no need for Thread Joiner role)

Qorvo provides maintenance SDKs that have been verified by running the certification tests in-house using a Thread Test Harness. This offers confidence for customers to use this SDK, but does not allow for inheritance.

Qorvo does not provide "end product" certified modules or white-label products. A customer is expected to apply for "end product" certification which may require different tests methods than "Thread Component" certification.

**Certification by similarity (inheritance)**

The SDK offers the Thread stack in 2 ways:
- \[No inheritance possible\] Source code to run natively on your platform agter cross-compilation and porting
- \[Inheritance possible\] OpenThread Border Router docker image

### Zigbee

**Certification overview:**

| | Certification ID | Specification | Link |
| --- | --- | --- | --- |
| QPG7015M Zigbee Compliant Platform reference | ZIG22013ZCP27336-24 | R22 |[https://csa-iot.org/csa_product/qpg6105/](https://csa-iot.org/csa_product/qpg6105/)|

Note: Qorvo certified QPG6105 as parent of our Zigbee Pro R22 compliant platform family. We reference this when certifying derivitive compliant platforms by similarity.

**End-product certification instructions**

Qorvo's SDKs for their Zigbee compliant platforms can be used to apply for end-product certification.
The SDKs come with test applications and instructions that enable an [Authorized-Test-Lab](https://www.threadgroup.org/Authorized-Test-Lab) to run end-product certification testing on a Zigbee Unified Test Harness (ZUTH)
97 changes: 97 additions & 0 deletions Documents/Guides/setup_ot_borderrouter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Setup OpenThread Border Router on Qorvo's QPG7015M Gateway development kit

In this guide, step by step instructions are given to setup an OpenThread Border Router, using Qorvo's QPG7015M Gateway Development Kit.
This enables the user to set up a Matter network and control Matter devices over Wi-Fi/ethernet with the QPG7015M operating as an OpenThread Border Router, using the [Android chip-tool](https://github.com/Qorvo/QMatter/blob/v0.7.1.0/Documents/Guides/commissioning_android_chiptool.md), or the [POSIX CLI chip-tool](https://github.com/Qorvo/QMatter/blob/v0.7.1.0/Documents/Guides/commissioning_posix_cli_chiptool.md).

Required Hardware:
- Access point/Router to connect your QPG7015M Gateway development kit to a local area network (LAN).
- Qorvo's QPG7015M Gateway development kit:

<div align="center">
<img src="../Images/qpg7015m_dk_casing.png" alt="QPG7015M Gateway Development Kit">
</div>

## Index

1. [Step 1: Establish access to the QPG7015M Gateway Development Kit](#step-1-establish-access-to-the-qpg7015m-gateway-development-kit)
2. [Step 2: Configure the QPG7015M Gateway Development Kit for OpenThread Border Router](#step-2-configure-the-qpg7015m-gateway-development-kit-for-openthread-border-router)
3. [Step 3: Start the OpenThread Border Router](#step-3-start-the-openthread-border-router)
4. [Step 4: Stop the OpenThread Border Router](#step-4-stop-the-openthread-border-router)
5. [Step 5: Factory reset the OpenThread Border Router](#step-5-factory-reset-the-openthread-border-router)


## Step 1: Establish access to the QPG7015M Gateway Development Kit

Described in the section "[Accessing the QPG7015M Gateway Development Kit's terminal](./setup_qpg7015m_dk.md#accessing-the-qpg7015m-gateway-development-kits-terminal)" of the QPG7015M Gateway DK Setup guide.

## Step 2: Configure the QPG7015M Gateway Development Kit for OpenThread Border Router

How to edit the configuration file is described in the section "[Configure the QPG7015M Gateway Development Kit](./setup_qpg7015m_dk.md#configure-the-qpg7015m-gateway-development-kit)" of the QPG7015M Gateway DK Setup guide.
In [Stack configuration](./setup_qpg7015m_dk.md#stack-configuration) disable the unwanted stacks and enable following parameters:

```shell
QORVO_OT_BR=1
QORVO_OT_BRBB_INTERFACE=wlan0
```

## Step 3: Start the OpenThread Border Router

Now the QPG7015M Gateway Development Kit, must be started to run with the configuration set in [Step 2](#step-2-configure-the-qpg7015m-gateway-development-kit-for-openthread-border-router).
This is described in the section "[Start the QPG7015M Gateway Development Kit](./setup_qpg7015m_dk.md#start-the-qpg7015m-gateway-development-kit)" of the QPG7015M Gateway DK Setup guide.
Make sure you see following logging:

```shell

Loading ot-br docker image from file!
3a7cc06ad581: Loading layer [==================================================>] 48.07MB/48.07MB
57fa7918522d: Loading layer [==================================================>] 81.91MB/81.91MB
d626ab464e19: Loading layer [==================================================>] 197.7MB/197.7MB
Loaded image: connectedhomeip/otbr:te7
55dbfafd48f5297dbceb19d76e407d873e6657bf47de246908a705515164f9ba
Gateway does not start automatically at boot

-------

Docker container otbr_docker_0 is running and Up 6 seconds.

You can now start ot-ctl command-line utility, and get logs by entering the following commands:

docker exec -it otbr_docker_0 ot-ctl
docker logs otbr_docker_0

-------
GATEWAY STARTED AND READY TO USE!

```

The OpenThread Border Router launches a Wi-Fi Access Point `BorderRouter-AP` with password `Qorvo_QPG7015M`. The user is now able to access the OpenThread Border Router via its IP address or hostname on a device that's connected to that Wi-Fi Access point. Matter devices can be joined to the network using the [Android chip-tool](https://github.com/Qorvo/QMatter/blob/v0.7.1.0/Documents/Guides/commissioning_android_chiptool.md) or the [POSIX CLI chip-tool](https://github.com/Qorvo/QMatter/blob/v0.7.1.0/Documents/Guides/commissioning_posix_cli_chiptool.md).

## Step 4: Stop the OpenThread Border Router

This is described in the section "[Stop the QPG7015M Gateway Development Kit](./setup_qpg7015m_dk.md#stop-the-qpg7015m-gateway-development-kit)" of the QPG7015M Gateway DK Setup guide.
Stopping the DK will **NOT** delete the info of the joined devices.

## Step 5: Factory reset the OpenThread Border Router

This is described in the section "[Factory reset the QPG7015M Gateway Development Kit](./setup_qpg7015m_dk.md#factory-reset-the-qpg7015m-gateway-development-kit)" of the QPG7015M Gateway DK Setup guide.
This action **WILL** delete the info of all joined devices.
Pay attention to following logging:

```shell
pi@[hostname]:~ $ ./factory_reset_gateway.sh
FACTORY RESETTING GATEWAY...
STOPPING GATEWAY...

...

Total reclaimed space: 0B
Deleted Images:
untagged: connectedhomeip/otbr:te7
deleted: sha256:ba054de35dcad1ffaf528a028f2310411f24715880cef036f8351cfbebeb5bfd
deleted: sha256:b033431b9748e9f80ee127caf8596b3a5746cc44d7165ed94f98cef8a9eb8797
deleted: sha256:f8263691911c51510a7fe67946455f6a068093a0249acbfba1f6365e9eeea937
deleted: sha256:3a7cc06ad5817e6e36c96383ae1de75e1c9fc86fcb1fa65892fb30c7194a096e

Total reclaimed space: 318.1MB
GATEWAY IS FACTORY RESET!
```
Loading

0 comments on commit c48de71

Please sign in to comment.