You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ as part of the [AWS Device Qualification for FreeRTOS](https://docs.aws.amazon.c
11
11
### Tests
12
12
13
13
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.
17
17
4. MQTT Test validates the integration with coreMQTT library.
18
18
19
19
@@ -38,19 +38,28 @@ Refer to ReadMe in each subfolder for details of the test group, test cases and
38
38
3.`tools` contains utility tools for the tests, such as echo server for Transport Interface Test.
39
39
40
40
### 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
42
46
1. Take FreeRTOS-Libraries-Integration-Tests as a submodule in your project.
43
47
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.
44
48
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.
45
49
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).
46
50
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.
47
51
6. In your application, call `RunQualificationTest()` function to start qualification tests.
48
52
49
-
For running the tests on your own:
53
+
#### For running the tests locally using your IDE
50
54
1. In test_param_config.h, fill out the parameters required by the test.
51
55
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.
52
57
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.
53
60
61
+
### Contribution
62
+
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
54
63
55
64
### License
56
65
This library is distributed under the [MIT Open Source License](LICENSE).
0 commit comments