Skip to content

Commit dfedcdd

Browse files
Added readme info
1 parent 499f5f2 commit dfedcdd

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,44 @@
11
# actiontec-cli
22
A command line interface for Actiontec MoCA devices
3+
4+
**Requirements**
5+
+ Java 8 or later
6+
+ A route in the routing table that directs traffic to `192.168.144.30` out the port the MoCA adapter is connected too.
7+
8+
**Running the Jar**
9+
10+
To use run the jar open Terminal/Command Prompt/Power Shell and enter
11+
12+
``java -jar atcli.jar``
13+
14+
If you have a non-default IP address (``192.168.144.30``) assigned to the MoCA adapter, the jar has an optional argument
15+
to allow it to be used instead.
16+
17+
``java -jar atcli.jar <ip address>``
18+
19+
**Adding a Route**
20+
21+
The easiest way to add a route is to assign an IP address to an interface in the same subnet. For example,
22+
on windows this can be done running this command:
23+
24+
``netsh interface ip set address "Ethernet" static 192.168.144.2 255.255.255.0``
25+
26+
You will now see a route ``192.168.144.0/24`` going out the Ethernet interface.
27+
28+
NOTE: "Ethernet" must be the name of the interface that is connected to the MoCA adapter. You can find this
29+
by typing name ``ipconfig /all`` into Command Prompt or Power Shell.
30+
31+
**Help Text**
32+
33+
Dumps of important commands help text can be viewed in the ``/help-doc`` directory on this github.
34+
35+
**Basic Internal Commands**
36+
37+
Internal commands are abbreviated with ``:`` and will not send anything to the MoCA device.
38+
39+
``:dump <file> <get | set | do>`` Dumps the help text for a mocap subcommand for every subcommand provided in the
40+
``file`` (separated by newline). ``get``, ``set``, and ``do`` are the shell commands to be appended.
41+
42+
``:test`` Tests the connectivity to the MoCA adapter.
43+
44+
``:exit`` or ``exit`` Exists the process.

0 commit comments

Comments
 (0)