Skip to content

Commit 2800a66

Browse files
committed
Update README with info about mbed-os-tools
1 parent 0e4f8a7 commit 2800a66

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

legacy/mbed-ls/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
[![Build status](https://circleci.com/gh/ARMmbed/mbed-ls/tree/master.svg?style=svg)](https://circleci.com/gh/ARMmbed/mbed-ls/tree/master)
2-
[![Coverage Status](https://coveralls.io/repos/github/ARMmbed/mbed-ls/badge.svg?branch=master)](https://coveralls.io/github/ARMmbed/mbed-ls?branch=master)
1+
# Development moved
2+
3+
The development of Mbed LS has been moved into the [mbed-os-tools](../../mbed_os_tools) package. You can continue to use this module for legacy reasons, however all further development should be continued in the new package.
4+
5+
-------------
6+
37
[![PyPI version](https://badge.fury.io/py/mbed-ls.svg)](https://badge.fury.io/py/mbed-ls)
48

59
# Mbed LS
@@ -31,8 +35,8 @@ $ pip install mbed-ls --upgrade
3135
Install Mbed LS from sources with the following commands:
3236

3337
```bash
34-
$ git clone https://github.com/ARMmbed/mbed-ls.git
35-
$ cd mbed-ls
38+
$ git clone https://github.com/ARMmbed/mbed-os-tools.git
39+
$ cd mbed-os-tools/legacy/mbed-ls
3640
$ python setup.py install
3741
```
3842

@@ -400,7 +404,7 @@ Mbed LS currently supports the following types of debuggers:
400404

401405
### Adding support for DAPLink-compatible platforms (DAPLink, ST-LINK, and CMSIS-DAP)
402406

403-
Add an entry to the `daplink` section of the [`DEFAULT_PLATFORM_DB`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py#L45).
407+
Add an entry to the `daplink` section of the [`DEFAULT_PLATFORM_DB`](../../mbed_os_tools/detect/platform_database.py).
404408

405409
If your platform's name is `NEW_PLATFORM` and it has platform ID of `9999`, the new entry should be:
406410

@@ -418,7 +422,7 @@ Please order the entries by the platform ID when adding new platforms.
418422

419423
### Adding support for J-Link platforms
420424

421-
J-Link detection works differently due to the information present on the platform's filesystem. All new entries should be added to the `jlink` section of the [`DEFAULT_PLATFORM_DB`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py#L45).
425+
J-Link detection works differently due to the information present on the platform's filesystem. All new entries should be added to the `jlink` section of the [`DEFAULT_PLATFORM_DB`](../../mbed_os_tools/detect/platform_database.py).
422426

423427
The following is an example `jlink` platform entry:
424428

@@ -447,4 +451,4 @@ If your J-Link platform does not follow this convention, please raise an issue w
447451

448452
The type of debugger present on the platform affects how it is detected. The USB Vendor ID is used to detect which type of debugger is present on the platform.
449453

450-
If a new type of debugger is being introduced to Mbed LS with the platform, you will need to add the Vendor ID to the [identification map](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/lstools_base.py#L72-L76). You will also need to assign the correct "update from the filesystem" logic [here](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/lstools_base.py#L226-L230). If the debugger is compatible with the files presented by DAPLink, you may reuse that implementation when updating the device information from the filesystem. If it is not, you may need to write your own update logic. If you need guidance on this, please ask for it when you submit an issue or a pull request.
454+
If a new type of debugger is being introduced to Mbed LS with the platform, you will need to add the Vendor ID to the [identification map](../../mbed_os_tools/detect/lstools_base.py). You will also need to assign the correct "update from the filesystem" logic [here](../../mbed_os_tools/detect/lstools_base.py). If the debugger is compatible with the files presented by DAPLink, you may reuse that implementation when updating the device information from the filesystem. If it is not, you may need to write your own update logic. If you need guidance on this, please ask for it when you submit an issue or a pull request.

0 commit comments

Comments
 (0)