Skip to content

Commit 316f6e2

Browse files
committed
periodic update 10/02/2020 13:15 PDT
1 parent 33c370c commit 316f6e2

File tree

62 files changed

+936
-801
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+936
-801
lines changed

doc_source/portingguide/afr-echo-server.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,32 @@ To run the TLS echo server, you must install the following:
1313
After you finish the prerequisites, you must enter the following commands to create your credentials\.
1414

1515
**Server**
16-
The following `openssl` command generates a self\-signed server certificate\.
16+
The following `openssl` command generates a self\-signed server certificate\.
17+
**RSA**
1718

1819
```
1920
openssl req -newkey rsa:2048 -nodes -x509 -sha256 -out certs/server.pem -keyout certs/server.key -days 365 -subj "/C=US/ST=WA/L=Place/O=YourCompany/OU=IT/CN=www.your-company-website.com/emailAddress=yourEmail@your-company-website.com"
21+
```
22+
**EC**
23+
24+
```
25+
openssl req -new -x509 -nodes -newkey ec:<(openssl ecparam -name prime256v1) -keyout certs/server.key -out certs/server.pem -days 365 -subj "/C=US/ST=WA/L=Place/O=YourCompany/OU=IT/CN=www.your-company-website.com/emailAddress=yourEmail@your-company-website.com"
2026
```
2127

2228
**Client**
23-
The following `openssl` commands generate a client certificate\.
29+
The following `openssl` commands generate a client certificate\.
30+
**RSA**
2431

2532
```
2633
openssl genrsa -out certs/client.key 2048
27-
```
28-
29-
```
3034
openssl req -new -key certs/client.key -out certs/client.csr -subj "/C=US/ST=WA/L=Place/O=YourCompany/OU=IT/CN=www.your-company-website.com/emailAddress=yourEmail@your-company-website.com"
31-
```
35+
openssl x509 -req -in certs/client.csr -CA certs/server.pem -CAkey certs/server.key -CAcreateserial -out certs/client.pem -days 365 -sha256
36+
```
37+
**EC**
3238

3339
```
40+
ecparam -genkey -name prime256v1 -out certs/client.key
41+
openssl req -new -key certs/client.key -out certs/client.csr -subj "/C=US/ST=WA/L=Place/O=YourCompany/OU=IT/CN=www.your-company-website.com/emailAddress=yourEmail@your-company-website.com"
3442
openssl x509 -req -in certs/client.csr -CA certs/server.pem -CAkey certs/server.key -CAcreateserial -out certs/client.pem -days 365 -sha256
3543
```
3644

@@ -100,10 +108,10 @@ Before you run the TCP tests on your device, we recommend that you read [Getting
100108
After you complete the steps in [Create credentials](#afr-echo-server-credentials), you should have the following files:
101109
+ `certs/server.pem`
102110
+ `certs/server.key`
111+
+ `certs/server.srl`
103112
+ `certs/client.pem`
104113
+ `certs/client.key`
105114
+ `certs/client.csr`
106-
+ `certs/server.srl`
107115

108116
Make the following changes to these files:
109117

@@ -116,7 +124,7 @@ Make the following changes to these files:
116124
+ Set `keyCLIENT_CERTIFICATE_PEM` to the contents of `certs/client.pem`\.
117125
+ Leave `keyJITR_DEVICE_CERTIFICATE_AUTHORITY_PEM` as `NULL`\.
118126
+ Set `keyCLIENT_PRIVATE_KEY_PEM` to the contents of `certs/client.key`\.
119-
+ For more information, see [ Configuring the FreeRTOS demos](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-configure.html)\.
127+
+ For more information, see [ Configuring the FreeRTOS demos](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-prereqs.html#freertos-configure)\.
120128

121129
`freertos/tests/include/aws_test_tcp.h`
122130
+ Set `tcptestECHO_HOST_ROOT_CA` to the contents of `certs/server.pem`\.

doc_source/portingguide/afr-porting-ble.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ The `CMakeLists.txt` template list file under `freertos/vendors/vendor/boards/bo
161161

162162
1. Execute the `runPI.sh` script\.
163163

164+
1. Clear any existing BLE bonds stored in the device\.
165+
164166
1. Build the test project, and then flash it to your device for execution\.
165167

166168
1. Check the test results in the UART console\.

doc_source/portingguide/afr-porting-mqtt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Devices on the edge can use the MQTT protocol to communicate with the AWS Cloud\. AWS IoT hosts an MQTT broker that sends and receives messages to and from connected devices at the edge\.
44

5-
The MQTT library implements the MQTT protocol for devices running FreeRTOS\. The MQTT library does not need to be ported, but your device's test project must pass all MQTT tests for qualification\. For more information, see [FreeRTOS MQTT Library](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-lib-cloud-mqtt.html.html) in the FreeRTOS User Guide\.
5+
The MQTT library implements the MQTT protocol for devices running FreeRTOS\. The MQTT library does not need to be ported, but your device's test project must pass all MQTT tests for qualification\. For more information, see [FreeRTOS MQTT Library](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-lib-cloud-mqtt.html) in the FreeRTOS User Guide\.
66

77
## Prerequisites<a name="testing-prereqs-mqtt"></a>
88

doc_source/portingguide/cmake-template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The first section of the template file defines the metadata that is used to disp
3636
| SUPPORTED\_IDE | A semicolon\-delimited list of IDs for the IDEs that the board supports\. |
3737
| IDE\_ID\_NAME | The name of the supported IDE\. Replace ID with the ID listed for the IDE in the SUPPORTED\_IDE field\. |
3838
| IDE\_ID\_COMPILER | A semicolon\-delimited list of names of supported compilers for the supported IDE\. Replace ID with the ID listed for the IDE in the SUPPORTED\_IDE field\. |
39+
| KEY\_IMPORT\_PROVISIONING | Set to TRUE if the board demo project imports the credentials from the pre\-provisioned `aws_clientcredential_keys.h` header file; in this case, **Quick Connect** will be enabled in the FreeRTOS console\. Set to FALSE if the intended board provisioning mechanism is JITR/JITP or multi\-account registration; in this case, **Quick Connect** will be disabled in the FreeRTOS console\. |
3940

4041
## Compiler settings<a name="cmake-compiler"></a>
4142

doc_source/qualificationguide/cmake-template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The first section of the template file defines the metadata that is used to disp
3636
| SUPPORTED\_IDE | A semicolon\-delimited list of IDs for the IDEs that the board supports\. |
3737
| IDE\_ID\_NAME | The name of the supported IDE\. Replace ID with the ID listed for the IDE in the SUPPORTED\_IDE field\. |
3838
| IDE\_ID\_COMPILER | A semicolon\-delimited list of names of supported compilers for the supported IDE\. Replace ID with the ID listed for the IDE in the SUPPORTED\_IDE field\. |
39+
| KEY\_IMPORT\_PROVISIONING | Set to TRUE if the board demo project imports the credentials from the pre\-provisioned `aws_clientcredential_keys.h` header file; in this case, **Quick Connect** will be enabled in the FreeRTOS console\. Set to FALSE if the intended board provisioning mechanism is JITR/JITP or multi\-account registration; in this case, **Quick Connect** will be disabled in the FreeRTOS console\. |
3940

4041
## Compiler settings<a name="cmake-compiler"></a>
4142

doc_source/userguide/afr-bridgekeeper-dt-bt.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,36 @@ The `ssh-copy-id` command assumes the public key is named `id_rsa.pub`\. On macO
9999
"id": "ble-test-raspberry-pi-1",
100100
"connectivity": {
101101
"protocol": "ssh",
102-
"ip": "rasp-pi-id-address"
102+
"ip": "rasp-pi-ip-address"
103103
}
104104
}
105105
]
106106
}
107107
]
108108
```
109109
110+
1. If you didn't choose to use public key authentication for SSH, add the following to the `connectivity` section of the `resource.json` file\.
111+
112+
```
113+
"connectivity": {
114+
"protocol": "ssh",
115+
"ip": "rasp-pi-ip-address",
116+
"auth": {
117+
"method": "password",
118+
"credentials": {
119+
"user": "root",
120+
"password": "idtafr"
121+
}
122+
}
123+
}
124+
```
125+
110126
1. \(Optional\) If you chose to use public key authentication for SSH, add the following to the `connectivity` section of the `resource.json` file\.
111127
112128
```
113129
"connectivity": {
114130
"protocol": "ssh",
115-
"ip": "rasp-pi-id-address",
131+
"ip": "rasp-pi-ip-address",
116132
"auth": {
117133
"method": "pki",
118134
"credentials": {

doc_source/userguide/ble-demo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
FreeRTOS Bluetooth Low Energy includes three demo applications:
66

7-
### [MQTT over Bluetooth Low Energy](#ble-demo-mqtt) demo<a name="w14aac11c11b3b5"></a>
7+
### [MQTT over Bluetooth Low Energy](#ble-demo-mqtt) demo<a name="w15aac19c11b3b5"></a>
88

99
This application demonstrates how to use the MQTT over Bluetooth Low Energy service\.
1010

11-
### [Wi\-Fi provisioning](#ble-demo-wifi) demo<a name="w14aac11c11b3b7"></a>
11+
### [Wi\-Fi provisioning](#ble-demo-wifi) demo<a name="w15aac19c11b3b7"></a>
1212

1313
This application demonstrates how to use the Bluetooth Low Energy Wi\-Fi Provisioning service\.
1414

15-
### [Generic Attributes Server](#ble-demo-server) demo<a name="w14aac11c11b3b9"></a>
15+
### [Generic Attributes Server](#ble-demo-server) demo<a name="w15aac19c11b3b9"></a>
1616

1717
This application demonstrates how to use the FreeRTOS Bluetooth Low Energy middleware APIs to create a simple GATT server\.
1818

@@ -287,7 +287,7 @@ This policy is different from the IAM policy created for the cognito authenticat
287287
288288
**To discover and establish secure connections with your microcontroller over Bluetooth Low Energy**
289289
290-
1. In order to pair your microcontroller and mobile device securely \(step 6\), you need a serial terminal emulator with both input and output capabilities \(such as TeraTerm\)\. Configure the terminal to connect to your board by a serial connection as instructed in [Installing a terminal emulator](uart-term.md)\.
290+
1. In order to pair your microcontroller and mobile device securely \(step 6\), you need a serial terminal emulator with both input and output capabilities \(such as TeraTerm\)\. Configure the terminal to connect to your board by a serial connection as instructed in [Installing a terminal emulator](gsg-troubleshooting.md#uart-term)\.
291291
292292
1. Run the Bluetooth Low Energy demo project on your microcontroller\.
293293

doc_source/userguide/building-cmake-prereqs.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

doc_source/userguide/building-cmake.md

Lines changed: 0 additions & 157 deletions
This file was deleted.

0 commit comments

Comments
 (0)