Skip to content

Commit 5cc029f

Browse files
Update README.md (#39)
* Update README.md * Add link to FreeRTOS qualification program * Add text for set up tests * Add subsections in Getting Started * Change prerequisites as subsection of GSG
1 parent 8ef281e commit 5cc029f

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ as part of the [AWS Device Qualification for FreeRTOS](https://docs.aws.amazon.c
1111
### Tests
1212

1313
The following test groups are included in this repository:
14-
1. Transport Interface Test validates the implementation of transport interface. The implementation can be plain text or TLS. See [transport interface tests](/src/transport_interface) for details.
15-
2. PKCS11 Test validates the implementation of PKCS11 interface required by [corePKCS11](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-pkcs.html).
16-
3. OTA Test validates the implementation of Physical Abstract Layer for [Over-the-Air Updates](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-ota.html).
14+
1. Transport Interface Test validates the implementation of transport interface required by [coreMQTT](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-mqtt.html) and [coreHTTP](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-corehttp.html). The implementation can be plain text or TLS. See [Transport Interface Test](/src/transport_interface) for details.
15+
2. PKCS11 Test validates the implementation of PKCS11 interface required by [corePKCS11](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-pkcs.html).See [PKCS11 Test](/src/pkcs11) for details.
16+
3. OTA Test validates the implementation of Physical Abstract Layer for [Over-the-Air Updates](https://docs.aws.amazon.com/freertos/latest/portingguide/afr-porting-ota.html). See [OTA Test](/src/ota) for details.
1717
4. MQTT Test validates the integration with coreMQTT library.
1818

1919

@@ -38,19 +38,28 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and
3838
3. `tools` contains utility tools for the tests, such as echo server for Transport Interface Test.
3939

4040
### Getting Started
41-
As a starting point, you should have a working FreeRTOS project and [Unity](https://github.com/ThrowTheSwitch/Unity) ported.
41+
#### Prerequisites
42+
1. The tests are ran as an individual test task. You should have a working FreeRTOS project to add test task on.
43+
2. Unity Test Framework is used to run the tests. See [Unity](https://github.com/ThrowTheSwitch/Unity) for integration guide.
44+
45+
#### Follow these steps to set up the tests
4246
1. Take FreeRTOS-Libraries-Integration-Tests as a submodule in your project.
4347
2. Copy config_template/test_execution_config_template.h and config_template/test_param_config_template.h to a project location in the build path, and rename them to test_execution_config.h and test_param_config.h.
4448
3. Include relevant files into the build system. If using CMake, qualification_test.cmake and corresponding test cmake files in `src/` can be used to include relevant files.
4549
4. Implement platform functions in [src/common/platform_function.h](https://github.com/FreeRTOS/FreeRTOS-Libraries-Integration-Tests/blob/main/src/common/platform_function.h).
4650
5. Implement test specific configurations. This is usually in the form of implementing a parameter setup function, which should fill out the struct of parameters passed into the function. Please refer to the documentation of specific tests.
4751
6. In your application, call `RunQualificationTest()` function to start qualification tests.
4852

49-
For running the tests on your own:
53+
#### For running the tests locally using your IDE
5054
1. In test_param_config.h, fill out the parameters required by the test.
5155
2. In test_execution_config.h, set `<TEST_NAME>_TEST_ENABLED` to 1.
56+
3. Compile and run the test application in your development environment.
5257

58+
#### For running the tests using AWS IoT Device Tester for Device Qualification
59+
See [AWS Qualification Program for FreeRTOS](https://docs.aws.amazon.com/freertos/latest/qualificationguide/afr-qualification.html) for details.
5360

61+
### Contribution
62+
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
5463

5564
### License
5665
This library is distributed under the [MIT Open Source License](LICENSE).

0 commit comments

Comments
 (0)