diff --git a/docs/get_started.md b/docs/get_started.md index b69d716c2..41a1d13f8 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -74,7 +74,7 @@ Follow these steps to start Testrun: Notes: - Disable both adapters in the host system (IPv4, IPv6, and general) by opening **Settings**, then **Network**. - - Keep the DUT powered off until prompted. + - Keep the DUT powered off until prompted. Otherwise, Testrun will not be able to fully capture the device behavior during startup - resulting in inaccurate test results. 1. Start Testrun with the command `sudo testrun` - To run Testrun in network-only mode (without running any tests), use the `--net-only` option. @@ -87,25 +87,42 @@ Follow these steps to start Testrun: Follow these steps to test your IoT device: 1. Open Testrun by navigating to [http://localhost:8080](http://localhost:8080/) in your browser. -2. Select the **Settings** menu in the top-right corner, then select your network interfaces. You can change the settings at any time. - ![Settings menu button](/docs/ui/getstarted--7cfvdpdnc5o.png) -3. Select the **Certificates** menu in the top-right corner, then upload your local CA certificates for TLS server testing. - ![Certificates menu button](/docs/ui/getstarted--j21skepmx1.png) -5. Select the **Device Repository** icon on the left panel to add a new device for testing. - ![Device repository button](/docs/ui/getstarted--q5uw26tfod.png) -6. Select the **Add Device** button. -7. Enter the MAC address, manufacturer name, and model number. +2. Select the **Settings** menu in the top-right corner. It will open the **General** tab by default. Then select your network interfaces. You can change the settings at any time. + ![Settings menu button](/docs/ui/getstarted-settings-menu.png) +3. Select the **Certificates** tab (Settings menu), then upload your local CA certificates for TLS server testing. + ![Certificates menu button](/docs/ui/getstarted-certificates-menu.png) +4. Select the **Device Repository** icon on the left panel to add a new device for testing. + ![Device repository button](/docs/ui/getstarted-device-repository.png) + + Or + + Click the **Actions** button to add a new device for testing. + ![Actions button](/docs/ui/getstarted-actions-device.png) +5. Select the **Add Device** button on the Device repository. + ![Add device](/docs/ui/getstarted-add-device.png) +6. Enter the MAC address, manufacturer name, and model number. +7. Select Qualification or Pilot program. 8. Select the test modules you want to enable for this device. Note: For qualification purposes, you must select all. -9. Select **Save**. -10. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted--w09wecsry3.png) - -11. Select the device you want to test. -12. Enter the version number of the firmware running on the device. -13. Select **Start Testrun**. -- If you need to stop Testrun during testing, select **Stop** next to the test name. -12. Once the Waiting for Device notification appears, power on the device under test. A report appears under the Reports icon once the test sequence is complete. - ![Reports button](/docs/ui/getstarted--m4si1otdu5d.png) +9. Answer a few questions about your device. +10. Select **Save**. +11. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted-testing.png) + + Or + + Click the **Actions** button, then select the **Start Testing** button. + ![Actions button](/docs/ui/getstarted-actions-testing.png) + +12. Select the device you want to test. +13. Enter the version number of the firmware running on the device. +14. Select **Start Testrun**. + - If you need to stop Testrun during testing, select **Stop** next to the test name. +15. Once the Waiting for Device notification appears, power on the device under test. + ![Waiting for device](/docs/ui/getstarted-waiting-for-device.png) +16. While testing is in progress, you could complete a Risk Assessment. To do so, go to the **Risk assessment** tab. + ![Risk assessment](/docs/ui/getstarted-risk-assessment.png) +17. A report appears under the Reports icon once the test sequence is complete. + ![Reports button](/docs/ui/getstarted-reports.png) # Troubleshooting diff --git a/docs/roadmap.pdf b/docs/roadmap.pdf new file mode 100644 index 000000000..7c377f590 Binary files /dev/null and b/docs/roadmap.pdf differ diff --git a/docs/rooadmap.pdf b/docs/rooadmap.pdf deleted file mode 100644 index 6107370e6..000000000 Binary files a/docs/rooadmap.pdf and /dev/null differ diff --git a/docs/ui/getstarted--7cfvdpdnc5o.png b/docs/ui/getstarted--7cfvdpdnc5o.png deleted file mode 100644 index 288e5f876..000000000 Binary files a/docs/ui/getstarted--7cfvdpdnc5o.png and /dev/null differ diff --git a/docs/ui/getstarted--j21skepmx1.png b/docs/ui/getstarted--j21skepmx1.png deleted file mode 100644 index 7a4de661a..000000000 Binary files a/docs/ui/getstarted--j21skepmx1.png and /dev/null differ diff --git a/docs/ui/getstarted--m4si1otdu5d.png b/docs/ui/getstarted--m4si1otdu5d.png deleted file mode 100644 index f6b7eddc9..000000000 Binary files a/docs/ui/getstarted--m4si1otdu5d.png and /dev/null differ diff --git a/docs/ui/getstarted--q5uw26tfod.png b/docs/ui/getstarted--q5uw26tfod.png deleted file mode 100644 index 4b8b2e847..000000000 Binary files a/docs/ui/getstarted--q5uw26tfod.png and /dev/null differ diff --git a/docs/ui/getstarted--w09wecsry3.png b/docs/ui/getstarted--w09wecsry3.png deleted file mode 100644 index e379040b5..000000000 Binary files a/docs/ui/getstarted--w09wecsry3.png and /dev/null differ diff --git a/docs/ui/getstarted-actions-device.png b/docs/ui/getstarted-actions-device.png new file mode 100644 index 000000000..4363a194f Binary files /dev/null and b/docs/ui/getstarted-actions-device.png differ diff --git a/docs/ui/getstarted-actions-testing.png b/docs/ui/getstarted-actions-testing.png new file mode 100644 index 000000000..dbffebb14 Binary files /dev/null and b/docs/ui/getstarted-actions-testing.png differ diff --git a/docs/ui/getstarted-add-device.png b/docs/ui/getstarted-add-device.png new file mode 100644 index 000000000..5b93b46b4 Binary files /dev/null and b/docs/ui/getstarted-add-device.png differ diff --git a/docs/ui/getstarted-certificates-menu.png b/docs/ui/getstarted-certificates-menu.png new file mode 100644 index 000000000..60eceae7a Binary files /dev/null and b/docs/ui/getstarted-certificates-menu.png differ diff --git a/docs/ui/getstarted-device-repository.png b/docs/ui/getstarted-device-repository.png new file mode 100644 index 000000000..236842ce4 Binary files /dev/null and b/docs/ui/getstarted-device-repository.png differ diff --git a/docs/ui/getstarted-reports.png b/docs/ui/getstarted-reports.png new file mode 100644 index 000000000..17577b735 Binary files /dev/null and b/docs/ui/getstarted-reports.png differ diff --git a/docs/ui/getstarted-risk-assessment.png b/docs/ui/getstarted-risk-assessment.png new file mode 100644 index 000000000..a14b7da10 Binary files /dev/null and b/docs/ui/getstarted-risk-assessment.png differ diff --git a/docs/ui/getstarted-settings-menu.png b/docs/ui/getstarted-settings-menu.png new file mode 100644 index 000000000..6c53ed4ec Binary files /dev/null and b/docs/ui/getstarted-settings-menu.png differ diff --git a/docs/ui/getstarted-testing.png b/docs/ui/getstarted-testing.png new file mode 100644 index 000000000..634269e5c Binary files /dev/null and b/docs/ui/getstarted-testing.png differ diff --git a/docs/ui/getstarted-waiting-for-device.png b/docs/ui/getstarted-waiting-for-device.png new file mode 100644 index 000000000..36a307316 Binary files /dev/null and b/docs/ui/getstarted-waiting-for-device.png differ