Skip to content

Commit 22a869c

Browse files
committed
update readme
1 parent 41ff2f4 commit 22a869c

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,46 @@ keep the device in ISP mode instead of just being bricked.
1313

1414

1515
## Chip Families Supported:
16-
LPC84x
17-
LPC82x
18-
LPC80x
16+
+ LPC84x
17+
+ LPC82x
18+
+ LPC80x
1919

20-
UU encoded families not supported (LPC1700 family and similar)
21-
22-
NXP chips with 1kB sector sizes should work by adding their information to the
23-
lpctools_parts.def configuration file.
24-
25-
The configuration file is identical to that used by the lpctools project
26-
<http://git.techno-innov.fr/?p=lpctools>
20+
Chips using UU-encoded protocols (e.g., LPC1700 family) are not supported.
21+
Other NXP devices with 1 kB sector sizes may work by adding their configuration to the lpctools_parts.def file.
22+
The configuration file is identical to that used by the [lpctools project](http://git.techno-innov.fr/?p=lpctools).
2723

2824
## Usage
25+
### Erase Entire Flash
26+
```bash
27+
isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 masserase
28+
```
2929

30-
Erase Entire Flash: isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 masserase
31-
Program Flash: isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 writeimage --imagein blinky804.hex
32-
Read Chip Info: isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 querychip
30+
### Program Flash
31+
```bash
32+
isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 writeimage --imagein blinky804.hex
33+
```
34+
35+
### Read Chip Info
36+
```bash
37+
isp_programmer --device /dev/ttyUSB0 -b 9600 -crystal_frequency 12000 querychip
38+
```
3339

3440
## Installation
3541
### pypi
36-
pip install ISPProgrammer
42+
```bash
43+
pip install isp_programmer
44+
```
45+
3746
### From Source
38-
isp-programmer is a python3 package and can be installed using pip.
39-
Clone the repository, enter the directory with setup.py in it and run
47+
```bash
48+
git clone https://github.com/snhobbs/isp-programmer.git
49+
cd isp-programmer
4050
pip install .
51+
```
52+
4153
The default location for the configuration file is at /etc/lpctools_parts.def.
4254
The file can either be copied there or the path passed in when calling the tool
43-
with the --config_file/-f flag.
44-
45-
1. cd isp-programmer
46-
2. pip install .
47-
3. cp lpctools_parts.def /etc
48-
55+
with the --config_file/-f flag. If none is given or found then the default parts are still available.
4956

5057
## Similar Projects
5158
+ https://github.com/JitterCompany/mxli

0 commit comments

Comments
 (0)