Update readme
[oweals/nmrpflash.git] / README.md
1 nmrp-flash - Netgear Unbrick Utility
2 ====================================
3
4 This program uses Netgear's [NMRP protocol]
5 (http://www.chubb.wattle.id.au/PeterChubb/nmrp.html)
6 to flash a new firmware image to a compatible device. This utility has been
7 tested with a Netgear EX2700, but is likely to work on many others as well.
8
9 ### Using nmrp-flash
10
11 Connect your Netgear router to your computer using a network cable.
12 Assign a static IP address to your computer (more specifically, to 
13 the network card that's plugged into the Netgear router).
14
15
16 For this example, we'll assume that your network interface is `eth0`.
17 First, we have to assign a static IP address to our network interface.
18 In this example, we'll use `192.168.1.2`. All available network interfaces 
19 can be listed using
20
21 ````
22 $ nmrp-flash -L
23 eth0      192.168.1.2  f2:11:a1:02:03:b1
24 ````
25
26 Now we can start `nmrp-flash`. The argument for the `-a` option needs
27 to be a *free* IP address from the same subnet as the one used by your
28 network interface. We'll use `192.168.1.254`. The firmware image file
29 can usually be downloaded directly from Netgear's FTP servers.
30
31 ````
32 $ nmrp-flash -i eth0 -a 192.168.1.254 -f EX2700-V1.0.1.8.img
33 Advertising NMRP server on eth0 ... /
34 Received configuration request from a4:2b:8c:00:00:01.
35 Sending configuration: ip 192.168.1.254, mask 255.255.255.0.
36 Uploading EX2700-V1.0.1.8.img ... OK
37 Waiting for remote to respond.
38 Remote finished. Closing connection.
39 ````
40
41 ### Building and installing
42
43 ````
44 $ make && sudo make install
45 ````