Skip to content

Commit

Permalink
Update user guide (#251)
Browse files Browse the repository at this point in the history
  • Loading branch information
hiltonlima authored Apr 19, 2024
1 parent a43efcf commit 372d882
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/Matter_TH_User_Guide/Matter_TH_User_Guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ endif::[]
| 23 | 26-Fev-2024 | [Apple]Carolina Lopes | * Added volume mapping for data model XML files on docker run commands for SDK containter.
| 24 | 27-Fev-2024 | [Apple]Carolina Lopes | * Updated mapping in docker run command for SDK container.
| 25 | 17-Apr-2024 | [Apple]Hilton Lima | * Updated Test Harness links related to final release of Spring 2024.
| 26 | 18-Apr-2024 | [Apple]Hilton Lima | * Update section TH installation without a Raspberry Pi.
|===
<<<
Expand Down Expand Up @@ -172,7 +173,7 @@ Refer to <<bringing-up-of-matter-node-dut-for-certification-testing, Section 5,
For hobby developers who want to get acquainted with certification tools/process/TC’s, can spin DUT’s using the example apps provided in the SDK. Refer to the instructions to set up one https://groups.csa-iot.org/wg/matter-csg/document/folder/2756[here].
TH runs on Ubuntu 22.04 Server LTS. The official installation method uses a Raspberry Pi (<<fresh_install>>), but there's an alternative method used in the tool's development that uses a virtual machine instead (<<th-installation-without-a-raspberry-pi>>). Keep in mind that thread networking is not officially supported in VM installations at the moment.
TH runs on Ubuntu Server 22.04 LTS (64-bit). The official installation method uses a Raspberry Pi (<<fresh_install>>), but there's an alternative method used in the tool's development that uses a virtual machine instead (<<th-installation-without-a-raspberry-pi>>). Keep in mind that thread networking is not officially supported in VM installations at the moment.
[#fresh_install]
=== TH Installation on Raspberry Pi
Expand Down Expand Up @@ -300,19 +301,28 @@ The above command might take a while to get executed, wait for 5-10 minutes and
The official installation method uses a Raspberry Pi (<<th-image-installation-on-raspberry-pi>>). **This alternative installation method is targeted for development purpose and it only supports onnetwork pairing mode.**
To install TH without using a Raspberry Pi you'll need a machine with Ubuntu 22.04 Server LTS. You can <<create-an-ubuntu-virtual-machine, create a virtual machine>> for this purpose, but be aware that if the host's architecture is not arm64 you'll need to <<substitute-the-sdks-docker-image-and-update-sample-apps, substitute the SDK's docker image>> in order for it to work properly.
|===
|To install TH without using a Raspberry Pi you'll need a machine with Ubuntu Server 22.04 LTS (64-bit). You can <<create-an-ubuntu-virtual-machine, create a virtual machine>> for this purpose, but *be aware that if the host's architecture is not arm64* you'll need to substitute `backend`, `frontend` and <<substitute-the-sdks-docker-image-and-update-sample-apps, the SDK's docker image>> in order for it to work properly.
|===
|===
|Images for linux/amd64 will not always be available in the github registry. So, if necessary, the images needed to be built locally.
|===
==== Create an Ubuntu virtual machine
Here's an example of how to create a virtual machine for TH using multipass (https://multipass.run/).
|===
|Please make sure the docker images are compatible with the host architecture.
|===
* Install multipass
|===
|`brew install multipass`
|===
* Create new VM with Ubuntu 22.04 (2 cpu cores, 8G mem and a 50G disk)
* Create new VM with Ubuntu Server 22.04 LTS (64-bit) (2 cpu cores, 8G mem and a 50G disk)
|===
|`multipass launch 22.04 -n matter-vm -c 2 -m 8G -d 50G`
Expand Down
Binary file modified docs/Matter_TH_User_Guide/Matter_TH_User_Guide.pdf
Binary file not shown.

0 comments on commit 372d882

Please sign in to comment.