Skip to content

Commit 901173d

Browse files
authored
Merge pull request #915 from bridadan/update_mbed_os_tools_links
Update tools docs to point to mbed-os-tools.
2 parents 598dbdd + 2fafe9e commit 901173d

File tree

6 files changed

+14
-15
lines changed

6 files changed

+14
-15
lines changed

docs/porting/porting_full_process/built_in_tests.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ The platform under test needs to be supported in mbedls for automated tests to w
2929

3030
If an updated mbedls pip package including support for your platform hasn't been released yet, you need to direct pip to use your local directory (which includes the code changes to support the new platform):
3131

32-
1. Clone [https://github.com/ARMmbed/mbed-ls](https://github.com/ARMmbed/mbed-ls).
33-
1. [Add your target to the platform database](https://github.com/ARMmbed/mbed-ls#adding-platform-support)
34-
1. Run `pip install --editable <your_local_root_to_mbed-ls>`.
32+
1. Clone [https://github.com/ARMmbed/mbed-os-tools](https://github.com/ARMmbed/mbed-os-tools).
33+
1. [Add your target to the platform database](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls#adding-platform-support)
34+
1. Run `pip install --editable <your_local_root_to_mbed-os-tools>`.
35+
1. Run `pip install --editable <your_local_root_to_mbed-os-tools>/packages/mbed-ls`.
3536
1. If you're using an external serial probe (like an FTDI USB cable), create an `mbedls.json` file and specify the serial port.
3637

3738
The serial port path varies in different operation systems. On **Windows**, you can find it through Device Manager; it will usually be something like `COM#`. On **Mac OS** you can use `ls /dev/tty.usb*`. On Linux you can use `ls /dev/ttyACM*`. The format of `mbedls.json` is as follows:
@@ -210,4 +211,4 @@ To build and run the Mbed OS tests:
210211
211212
1. Before you begin the test run, please make sure the serial port is not already opened by programs like Screen or Teraterm (close them if they're open). In addition, verify `mbedls` lists the new target device.
212213
213-
If your test run doesn't start, please read about [troubleshooting Greentea](https://github.com/armmbed/greentea#common-issues).
214+
If your test run doesn't start, please read about [troubleshooting Greentea](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#common-issues).

docs/porting/tools/mbedls.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,4 @@ Further, Mbed-ls only detects devices that meet the following criteria:
1616

1717
### Implementation
1818

19-
When adding a board to Mbed-ls, you typically need to add a new definition to the platform database. Before you add your board to the Mbed-ls platform database, you need the Unique product code, a four-digit hexadecimal identifier, you obtained through the mbed enabled program. You can add a new board to the platform database by adding an entry mapping from your board's unique product code to the name of the board into the `DEFAULT_PLATFORM_DB` dictionary in [`mbed_lstools/platform_database.py`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py).
20-
21-
If your board uses an interface firmware other than J-Link, STLink, DAPLink or OpenSDA, you need to add a new vendor string for detection on windows. If you need to add a new vendor string, add it to the `usb_vendor_list` member of the `MbedLsToolsBase` class in [`mbed_lstools/lstools_base.py`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/lstools_base.py).
19+
Please see the [implementation guide](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls#adding-platform-support) in Mbed LS for more details.

docs/reference/configuration/mbed_targets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ The `device_name` key in `targets.json` is `MK20DX256xxx7` for any target that u
259259

260260
#### `detect_code`
261261

262-
The `detect_code` contains four ASCII characters containing only hexadecimal values (A-F and 0-9). This code is the same for all platforms of the same type. `Mbed LS` no longer uses this field to identify the platform. Instead, `Mbed LS` has its [own database](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py#L45) of detect codes.
262+
The `detect_code` contains four ASCII characters containing only hexadecimal values (A-F and 0-9). This code is the same for all platforms of the same type. `Mbed LS` no longer uses this field to identify the platform. Instead, `Mbed LS` has its [own database](https://github.com/ARMmbed/mbed-os-tools/blob/master/src/mbed_os_tools/detect/platform_database.py) of detect codes.
263263

264264
#### `OUTPUT_EXT`
265265

docs/tools/testing/greentea.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ _**G**eneric **re**gression **en**vironment for **te**st **a**utomation_
66

77
Greentea is the automated testing tool for Arm Mbed OS development. It automates the process of flashing Mbed boards, driving the test and accumulating test results into test reports. Developers use it for local development as well as for automation in a Continuous Integration environment.
88

9-
This document should help you start using Greentea. Please see the [`htrun` documentation](https://github.com/ARMmbed/htrun), the tool Greentea uses to drive tests, for the technical details of the interactions between the platform and the host machine.
9+
This document should help you start using Greentea. Please see the [`htrun` documentation](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-host-tests), the tool Greentea uses to drive tests, for the technical details of the interactions between the platform and the host machine.
1010

1111
### Prerequisites
1212

@@ -159,7 +159,7 @@ $ mbedgt --use-tids 02400203C3423E603EBEC3D8,024002031E031E6AE3FFE3D2
159159

160160
Where `02400203C3423E603EBEC3D8` and `024002031E031E6AE3FFE3D` are the target IDs of platforms attached to your system.
161161

162-
You can view target IDs using the [`mbed-ls`](https://github.com/ARMmbed/mbed-ls) tool (installed with Greentea).
162+
You can view target IDs using the [`mbed-ls`](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls) tool (installed with Greentea).
163163

164164
```
165165
$ mbedls

docs/tools/testing/testing_greentea.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A test case is named by its position in your project's file structure. For insta
4646

4747
You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the [CLI documentation](../tools/developing-mbed-cli.html).
4848

49-
When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a **test specification** file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the [Greentea documentation](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).
49+
When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a **test specification** file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the [Greentea documentation](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-formatted-input).
5050

5151
##### Building process
5252

@@ -71,9 +71,9 @@ If you need to test with multiple configurations, then you can use the `--app-co
7171

7272
You can run automated tests through Mbed CLI.
7373

74-
The testing process requires that tests be built and that a test specification JSON file that describes these available tests exists. See the [test specification format](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).
74+
The testing process requires that tests be built and that a test specification JSON file that describes these available tests exists. See the [test specification format](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-formatted-input).
7575

76-
The Greentea tool handles the actual testing process. To read more about this tool, please visit its [GitHub repository](https://github.com/ARMmbed/greentea).
76+
The Greentea tool handles the actual testing process. To read more about this tool, please visit its [GitHub repository](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea).
7777

7878
#### Writing tests
7979

@@ -148,7 +148,7 @@ Assuming your test was exported correctly to your IDE, build the project and loa
148148
149149
Bring the target out of reset and run the program. Your target waits for the test tools to send a synchronizing character string over the serial port. Do not run the `mbed test` commands because that will attempt to flash the device, which you've already done with your IDE.
150150
151-
Instead, you can use the underlying test tools to drive the test. [`htrun`](https://github.com/ARMmbed/htrun) is the tool you need to use in this scenario. Installing the requirements for Mbed OS also installs `htrun`. You can also install `htrun` by running `pip install mbed-host-tests`.
151+
Instead, you can use the underlying test tools to drive the test. [`htrun`](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-host-tests) is the tool you need to use in this scenario. Installing the requirements for Mbed OS also installs `htrun`. You can also install `htrun` by running `pip install mbed-host-tests`.
152152
153153
First, find your target's serial port by running the following command:
154154

docs/tools/testing/testing_icetea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The full build process is:
3838

3939
You can run automated tests through Mbed CLI with the `--icetea` option. You can find more information about this in the [Mbed CLI test documentation](test-and-debug.html).
4040

41-
The testing process requires that tests be built and that a test specification JSON file that describes these available tests exists. See the [test specification format](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).
41+
The testing process requires that tests be built and that a test specification JSON file that describes these available tests exists. See the [test specification format](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-format).
4242

4343
The test specification JSON is similar for the Greentea and Icetea tests.
4444

0 commit comments

Comments
 (0)