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
Copy file name to clipboardExpand all lines: docs/pelion_ready/device-management-test.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
<h2id="device-management-test">Validation and testing</h2>
2
2
3
-
Mbed Device Management provides built-in tests to help you when define your device management configuration. Before running these tests, we recommend you refer to the [testing setup](#testing-setup) section below.
3
+
Device Management provides built-in tests to help you define your device management configuration. Before running these tests, we recommend you refer to the [testing setup](#testing-setup) section below.
4
4
5
5
### Test suites
6
6
@@ -19,13 +19,13 @@ Mbed Device Management provides built-in tests to help you when define your devi
19
19
|`Connect to <Network type>`| Tests the connection to the network through the network interface. |
20
20
|`Initialize <Blockdevice>+<Filesystem>`| Initializes the block device driver and file system on top. Usually, the test will be stuck at this point if there's a problem with the storage device. |
21
21
|`Format <Filesystem>`| Tests that you can successfully format the block device for the file system type. |
22
-
| `Initialize Simple PDMC ` | Verifies you can initialize Pelion Device Management with the given network, storage and file system configuration. This is where the FCU and KCM configuration is written to storage and the Root of Trust is written to SOTP.
23
-
|`Pelion DM Bootstrap & Register`| Bootstraps the device and registers it for first time with Pelion Device Management. |
24
-
|`Pelion DM Directory`| Verifies that a registered device appears in the Device Directory in Pelion Device Management. |
25
-
|`Pelion DM Re-register`| Resets the device and reregisters with Pelion Device Management with previously bootstrapped credentials. |
22
+
| `Initialize Simple PDMC ` | Verifies you can initialize Device Management with the given network, storage and file system configuration. This is where the FCU and KCM configuration is written to storage and the Root of Trust is written to SOTP.
23
+
|`Pelion DM Bootstrap & Register`| Bootstraps the device and registers it for first time with Device Management. |
24
+
|`Pelion DM Directory`| Verifies that a registered device appears in the Device Directory in Device Management. |
25
+
|`Pelion DM Re-register`| Resets the device and reregisters with Device Management with previously bootstrapped credentials. |
26
26
|`Post-reset Identity`| Verifies that the device identity is preserved over device reset, confirming that Root of Trust is stored in SOTP correctly. |
27
27
|`ResourceLwM2M GET`| Verifies that the device can perform a GET request on an LwM2M resource. |
28
-
|`ResourceLwM2M SET Test`| Sets or changes value from the device and verifies the Pelion Device Management API client can observe the value changing. |
28
+
|`ResourceLwM2M SET Test`| Sets or changes value from the device and verifies the Device Management API client can observe the value changing. |
29
29
|`ResourceLwM2M PUT Test`| Verifies the device can perform a PUT request on an LwM2M resource by setting a new value. |
30
30
|`Resource LwM2M POST Test`| Verifies the device can execute a POST on an LwM2M resource and the callback function on the device is called. |
31
31
@@ -36,18 +36,18 @@ Mbed Device Management provides built-in tests to help you when define your devi
36
36
|`Connect to <Network type>`| Tests the connection to the network using the network interface. |
37
37
|`Initialize <Blockdevice>+<Filesystem>`| Initializes block device driver and file system on top. Usually the test will be stuck at this point if there's problem with the storage device. |
38
38
|`Format <Filesystem>`| Tests that you can successfully format the block device for the file system type. |
39
-
| `Initialize Simple PDMC ` | Verifies you can initialize Pelion Device Management with the given network, storage and file system configuration. This is where the FCU and KCM configuration is written to storage and the Root of Trust is written to SOTP.
40
-
|`Pelion DM Bootstrap & Register`| Bootstraps the device and registers it for first time with Pelion Device Management. |
41
-
|`Pelion DM Directory`| Verifies a registered device appears in the Device Directory in Pelion Device Management. |
42
-
|`Firmware Prepare`| Prepares the firmware on the host side and calls `mbed dm` to initiate the Pelion Device Management update campaign. |
39
+
| `Initialize Simple PDMC ` | Verifies you can initialize Device Management with the given network, storage and file system configuration. This is where the FCU and KCM configuration is written to storage and the Root of Trust is written to SOTP.
40
+
|`Pelion DM Bootstrap & Register`| Bootstraps the device and registers it for first time with Device Management. |
41
+
|`Pelion DM Directory`| Verifies a registered device appears in the Device Directory in Device Management. |
42
+
|`Firmware Prepare`| Prepares the firmware on the host side and calls `mbed dm` to initiate the Device Management update campaign. |
43
43
|`Firmware Download`| Downloads the firmware onto the device. |
44
44
|`Firmware Update`| Resets the device, verifies that the firmware has correct checksum, applies it and reverifies the applied firmware checksum. |
45
-
|`Pelion DM Re-register`| Reregisters the device with Pelion Device Management using the new firmware and previously bootstrapped credentials. |
45
+
|`Pelion DM Re-register`| Reregisters the device with Device Management using the new firmware and previously bootstrapped credentials. |
46
46
|`Post-update Identity`| Verifies that the device identity is preserved over firmware update and device reset, confirming that Root of Trust is stored in SOTP correctly. |
47
47
48
48
### Requirements
49
49
50
-
Mbed Device Management tests rely on the Python SDK to test the end-to-end solution. To install the Python SDK:
50
+
Device Management tests rely on the Python SDK to test the end-to-end solution. To install the Python SDK:
51
51
52
52
```
53
53
$ pip install mbed-cloud-sdk
@@ -57,30 +57,30 @@ Mbed Device Management tests rely on the Python SDK to test the end-to-end solut
57
57
58
58
### Testing setup
59
59
60
-
1. Import an example application for Pelion Device Management that contains the corresponding configuration for your target.
60
+
1. Import an example application for Device Management that contains the corresponding configuration for your target.
61
61
62
-
Please refer to the following [application example](https://github.com/ARMmbed/pelion-ready-example). It demonstrates how to connect to the Pelion IoT Platform service, register resources and get ready to receive a firmware update.
62
+
Please refer to the following [application example](https://github.com/ARMmbed/pelion-ready-example). It demonstrates how to connect to the Device Management service, register resources and get ready to receive a firmware update.
63
63
64
-
Also, there are board-specific applications that focus on providing more elaborate hardware features with Mbed OS and the Pelion IoT Platform. These are available in the Pelion [quick start](https://cloud.mbed.com/quick-start).
64
+
Also, there are board-specific applications that focus on providing more elaborate hardware features with Mbed OS and Device Management. These are available in the Pelion [quick start](https://cloud.mbed.com/quick-start).
65
65
66
66
1. Set a global `mbed config` variable `CLOUD_SDK_API_KEY` on the host machine valid for the account your device will connect to. For example:
67
67
68
68
```
69
69
$ mbed config -G CLOUD_SDK_API_KEY <API_KEY>
70
70
```
71
71
72
-
For instructions on how to generate an API key, please [see the documentation](https://cloud.mbed.com/docs/latest/integrate-web-app/api-keys.html#generating-an-api-key).
72
+
For instructions on how to generate an API key, please [see the documentation](https://cloud.mbed.com/docs/current/integrate-web-app/api-keys.html#generating-an-api-key).
73
73
74
-
1. Initialize your Pelion DM credentials (once per project):
74
+
1. Initialize your Device Management credentials (once per project):
75
75
76
76
```
77
77
$ mbed dm init -d "<your company name.com>" --model-name "<product model identifier>"
78
78
```
79
79
80
-
This creates your private and public key pair and also initializes various `.c` files with these credentials, so you can use Connect and (firmware) Update device management features.
80
+
This creates your private and public key pair and also initializes various `.c` files with these credentials, so you can use Device Management Connect and (firmware) Update.
81
81
82
82
1. Remove the `main.cpp` application from the project, or ensure the content of the file is wrapped with `#ifndef MBED_TEST_MODE`.
83
-
83
+
84
84
1. Compile the tests with the `MBED_TEST_MODE` compilation flag.
85
85
86
86
```
@@ -107,7 +107,7 @@ Occasionally, if the test failed during a previous attempt, the SMCC Greentea te
107
107
108
108
#### Device identity is inconsistent
109
109
110
-
If your device ID in Pelion Device Management is inconsistent over a device reset, it could be because it is failing to open the credentials on the storage held in the Enhanced Secure File System. Typically, this is because the device cannot access the Root of Trust stored in SOTP.
110
+
If your device ID in Device Management is inconsistent when your device resets, it could be because it is failing to open the credentials on the storage held in the Enhanced Secure File System. Typically, this is because the device cannot access the Root of Trust stored in SOTP.
111
111
112
112
One way to verify this is to see if the storage is reformatted after a device reset when `format-storage-layer-on-error` is set to `1` in `mbed_app.json`. It would appear on the serial terminal output from the device as:
113
113
@@ -139,7 +139,7 @@ If you receive a stack overflow error, increase the Mbed OS main stack size to a
139
139
140
140
#### Device failed to register
141
141
142
-
Check the device allocation on your Pelion account to see if you are allowed additional devices to connect. You can delete development devices. After being deleted, they will not count toward your allocation.
142
+
Check the device allocation on your Device Management account to see if you are allowed additional devices to connect. You can delete development devices. After being deleted, they will not count toward your allocation.
0 commit comments