Skip to content

Commit 92904c9

Browse files
committed
Fix Tera Term link, remove IDT section
The previous link was broken causing the link verifier to fail. The IDT section does not apply on the SESIP branch
1 parent 213cfce commit 92904c9

File tree

1 file changed

+2
-106
lines changed

1 file changed

+2
-106
lines changed

GSG.md

Lines changed: 2 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Many of these steps are automated in production environments.
8888
[Configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html)
8989
to configure the basic settings (security credentials, the default AWS output format and the default AWS Region)
9090
that AWS CLI uses to interact with AWS.
91-
* A serial terminal application, such as [Tera Term](https://ttssh2.osdn.jp/index.html.en).
91+
* A serial terminal application, such as [Tera Term](https://teratermproject.github.io/index-en.html).
9292

9393

9494
## 2 Hardware and Software Setup
@@ -761,108 +761,4 @@ Besides the Defender metrics graph on the console, you can also use the MQTT Cli
761761
> * The version of the new image is not higher than the current one. Recreate the signed binary with a higher version.
762762
> * The image is not signed with a valid signature. Recreate the signed binary with a correct signature.
763763
> * The device encounters a niche error condition, such as receiving duplicate blocks, or the OTA buffer is
764-
not available to handle these error conditions. In these instances, you can retry OTA job from the console.
765-
766-
## 10 Run AWS IoT Device Tester
767-
768-
The reference integration can be tested using [AWS IoT Device Tester for FreeRTOS (IDT)](https://aws.amazon.com/freertos/device-tester/). IDT is a downloadable tool that can be used to exercise a device integration with FreeRTOS to validate functionality and compatibility with Amazon IoT cloud. Passing the test suite provided by IDT is also required to qualify a device for the [Amazon Partner Device Catalogue](https://devices.amazonaws.com/).
769-
770-
IDT runs a suite of tests that include testing the device's transport interface layer implementation, PKCS11 functionality, and OTA capabilities. In IDT test cases, the IDT binary will make a copy of the source code, update the header files in the `examples/evkbmimxrt1060/test` project, then compile the project and flash the resulting image to your board. Finally, IDT will read serial output from the board and communicate with the AWS IoT cloud to ensure that test cases are passing.
771-
772-
### 10.1 Download AWS IoT Device Tester
773-
774-
The latest version of IDT can be downloaded from the [public documentation page](https://docs.aws.amazon.com/freertos/latest/userguide/dev-test-versions-afr.html). This reference implementation only supports test suites of version 2.0 or later.
775-
776-
### 10.2 Configure AWS IoT Device Tester
777-
778-
After downloading and unzipping IDT onto your file system, you should extract a file structure that includes the following directories:
779-
780-
* The `bin` directory holds the devicetester binary, which is the entry point used to run IDT
781-
* The `results` directory holds logs that are generated every time you run IDT.
782-
* The `configs` directory holds configuration values that are needed to set up IDT
783-
784-
Before we can run IDT, we have to update the files in `configs`. In this reference implementation, we have pre-defined configs available in the `idt_configs` directory. Copy these templates over into IDT, and the rest of this section will walk through the remaining values that need to be filled in.
785-
786-
First, copy one of each file from `idt_configs` (based on host OS) in this reference repository to the `configs` directory inside the newly downloaded IDT project. This should provide you with the following files in `device_tester/configs` directory:
787-
788-
```
789-
configs/flash.bat or flash.sh
790-
configs/config.json
791-
configs/userdata.json
792-
configs/device.json
793-
configs/build.bat or build.sh
794-
```
795-
796-
Next, we need to update some configuration values in these files.
797-
798-
* In `build.bat` / `build.sh`, update IDE_PATH
799-
* In `flash.bat` / `flash.sh`, update IDE_PATH, MCUX_FLASH_DIR0, and MCUX_IDE_BIN
800-
801-
A few notes on the provided build and flash scripts: First, if you run into issues with the provided scripts, you can copy commands provided by the MCUXpresso IDE during a GUI build and flash to create your own build and flash scripts. Second, these scripts only work if your `test` and `bootloader` project have been built once using the MCUXpresso GUI (this creates a required files `MIMXRT1062xxxxA.xml` and `MIMXRT1062xxxxA_part.xml` at `iot-reference-nxp-rt1060/projects/evkmimxrt1060/$PROJECT/Debug`)
802-
803-
* In `config.json`, update the `profile` and `awsRegion` fields
804-
* In `device.json`, update `serialPort` to the serial port of your board as from [section 2.1](https://github.com/FreeRTOS/iot-reference-nxp-rt1060/blob/main/GSG.md#21-setting-up-device). Update `publicDeviceCertificateArn` to the ARN of the certificate uploaded when [provisioning the device](https://github.com/FreeRTOS/iot-reference-nxp-rt1060/blob/main/GSG.md#41-provisioning-the-device).
805-
* In `userdata.json`, update `sourcePath` to the absolute path to the root of this reference implementation repository.
806-
* In `userdata.json`, update `signerCertificate` with the ARN of the [application code signing certificate you created.](https://github.com/FreeRTOS/iot-reference-nxp-rt1060/blob/main/GSG.md#62-creating-an-application-code-signing-certificate)
807-
* Run all the steps to create a [second code signing certificate](https://github.com/FreeRTOS/iot-reference-nxp-rt1060/blob/main/GSG.md#62-creating-an-application-code-signing-certificate) but do NOT provision the key onto your board. Copy the ARN for this certificate in `userdata.json` for the field `untrustedSignerCertificate`.
808-
809-
### 10.3 Configure Device
810-
811-
To run test cases "OTADataplaneMQTT" / OTACore / FullPKCS11_PreProvisioned_ECC successfully, we need to set our public keys manually once.
812-
813-
- OTADataplaneMQTT
814-
- Follow [6.2 Creating an Application Code Signing Certificate](#62-creating-an-application-code-signing-certificate) to set code signing certificate.
815-
- OTACore
816-
- Set appmainPROVISIONING_MODE to 1 and appmainRUN_QUALIFICATIOn_TEST_SUITE to 0 in app_main.c
817-
- Build and flash
818-
- In TeraTerm or putty, `pki set pub_key sss:00223346`
819-
- Copy and paste below content to the serial port
820-
```
821-
-----BEGIN PUBLIC KEY-----
822-
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEyza/tGLVbVxhL41iYtC8D6tGEvAH
823-
u498gNtqDtPsKaoR3t5xQx+6zdWiCi32fgFT2vkeVAmX3pf/Gl8nIP48Zg==
824-
-----END PUBLIC KEY-----
825-
```
826-
- Should print “OK”
827-
- FullPKCS11_PreProvisioned_ECC
828-
- Set appmainPROVISIONING_MODE to 1 and appmainRUN_QUALIFICATION_TEST_SUITE to 0 in app_main.c
829-
- Build and flash
830-
- Get the cert at the label in Teraterm
831-
```
832-
pki get cert sss:F0000001
833-
```
834-
- Paste that cert into a file cert.pem
835-
- Run command `openssl x509 -pubkey -noout -in cert.pem > pubkey.pem`
836-
- In TeraTerm or putty, `pki set pub_key sss:00223345`
837-
- Paste the content of pubkey.pem to TeraTerm or putty
838-
- Should print “OK”
839-
840-
*Note: If you fail at setting public key, try sss:00223343 and remember to change the config.*
841-
842-
### 10.4 Running AWS IoT Device Tester
843-
844-
With configuration complete, IDT can be run for an individual test group, a test case, or the entire qualification suite.
845-
846-
To list the available test groups, run:
847-
848-
```
849-
.\devicetester_win_x86-64.exe list-groups
850-
```
851-
852-
To run any one test group, run e.g.:
853-
854-
```
855-
.\devicetester_win_x86-64.exe run-suite -g FullCloudIoT
856-
```
857-
858-
To run the entire qualification suite, run:
859-
860-
```
861-
.\devicetester_win_x86-64.exe run-suite
862-
```
863-
864-
For more information, `.\devicetester_win_x86-64.exe help` will show all available commands.
865-
866-
When you run IDT, a `results/uuid` directory is generated that will contain all the logs and other information associated with your test run. This allows you to debug any failures.
867-
868-
*Note: Please run qualification test without provision mode (set appmainPROVISIONING_MODE to 0 in [app_main.c](./examples/evkbmimxrt1060/test/app_main.c)).*
764+
not available to handle these error conditions. In these instances, you can retry OTA job from the console.

0 commit comments

Comments
 (0)