Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ Follow these steps to install Testrun:

Testrun installs under the `/usr/local/testrun` directory. Testing data is available in the `local/devices/{device}/reports` folders.

Note: Local CA certificates should be uploaded within Testrun to run TLS server testing.

![Terminal during install](/docs/setup/install.gif)

# Testing
Expand All @@ -67,10 +65,10 @@ Follow these steps to start Testrun:
- Connect one USB Ethernet adapter to the internet source (e.g., router or switch) using an Ethernet cable.
- Connect the other USB Ethernet adapter directly to the IoT device you want to test using an Ethernet cable.

Notes:

- Disable both adapters in the host system (IPv4, IPv6, and general) by opening **Settings**, then **Network**.
- Keep the DUT powered off until prompted.
Notes:
- Disable both adapters in the host system (IPv4, IPv6, and general) by opening **Settings**, then **Network**.
- Keep the DUT powered off until prompted.

1. Start Testrun with the command `sudo testrun`
- To run Testrun in network-only mode (without running any tests), use the `--net-only` option.
Expand All @@ -84,20 +82,20 @@ 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 **device repository** icon on the left panel to add a new device for testing.
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)

4. Select the **Add Device** button.
5. Enter the MAC address, manufacturer name, and model number.
6. Select the test modules you want to enable for this device.
6. Select the **Add Device** button.
7. Enter the MAC address, manufacturer name, and model number.
8. Select the test modules you want to enable for this device.
Note: For qualification purposes, you must select all.
7. Select **Save**.
8. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted--w09wecsry3.png)
9. Select **Save**.
10. Select the Testrun progress icon, then select the **Testing** button.![Testing button](/docs/ui/getstarted--w09wecsry3.png)

9. Select the device you want to test.
10. Enter the version number of the firmware running on the device.
11. Select **Start Testrun**.
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)
Expand Down Expand Up @@ -183,4 +181,4 @@ Once you complete a test attempt, you can review the test report provided by Tes

# Uninstall

To uninstall Testrun correctly, use the built-in dpkg uninstall command: `sudo apt-get remove testrun`
To uninstall Testrun correctly, use the built-in dpkg uninstall command: `sudo apt-get remove testrun`
Binary file added docs/ui/getstarted--j21skepmx1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading