Skip to content

Commit 3ae3193

Browse files
committed
v0.1.16 documentation update
1 parent 035a43b commit 3ae3193

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ $ python
7070
Python 2.7.8 (default, Jun 30 2014, 16:03:49) [MSC v.1500 32 bit (Intel)] on win32
7171
Type "help", "copyright", "credits" or "license" for more information.
7272
```
73-
```
73+
74+
Generic mbedls API example:
75+
```python
7476
>>> import mbed_lstools
7577
>>> mbeds = mbed_lstools.create()
7678
>>> mbeds
@@ -80,6 +82,17 @@ Type "help", "copyright", "credits" or "license" for more information.
8082
>>> print mbeds
8183
```
8284

85+
Extended mbedls API example:
86+
```python
87+
>>> import mbed_lstools
88+
>>> m = mbed_lstools.create()
89+
>>> dir(m)
90+
['DEBUG_FLAG', 'ERRORLEVEL_FLAG', '__doc__', '__init__', '__module__', '__str__', 'debug', 'discover_connected_mbeds', 'err', 'get_connected_mbeds', 'get_dos_devices', 'get_json_data_from_file', 'get_mbed_com_port', 'get_mbed_devices', 'get_mbed_htm_target_id', 'get_mbeds', 'get_mounted_devices', 'get_string', 'iter_keys', 'iter_keys_as_str', 'iter_vals', 'list_mbeds', 'list_mbeds_by_targetid', 'list_mbeds_ext', 'list_platforms', 'list_platforms_ext', 'load_mbed_description', 'manufacture_ids', 'os_supported', 'regbin2str', 'scan_html_line_for_target_id', 'usb_vendor_list', 'winreg'] >>> m.list_platforms()
91+
['LPC1768', 'K64F']
92+
>>> m.list_platforms_ext()
93+
{'K64F': 1, 'LPC1768': 2}
94+
```
95+
8396
## Installation from PyPI (Python Package Index)
8497

8598
In the near future the mbed-ls module will be redistributed via PyPI. We recommend you use the [```pip``` application](here: https://pip.pypa.io/en/latest/installing.html#install-pip).

0 commit comments

Comments
 (0)