Difference between revisions of "Installation"

From BITPlan can4eve Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
These are the installation instructions as of 2017-06 for the alpha state of the project
 
These are the installation instructions as of 2017-06 for the alpha state of the project
  
 +
= downloading and compiling =
 
<source lang='bash'>
 
<source lang='bash'>
 
git clone https://github.com/BITPlan/can4eve
 
git clone https://github.com/BITPlan/can4eve
Line 9: Line 10:
 
[INFO] ------------------------------------------------------------------------
 
[INFO] ------------------------------------------------------------------------
 
[INFO] BUILD SUCCESS
 
[INFO] BUILD SUCCESS
 +
</source>
 +
= command line interface =
 +
<source lang='bash'>
 +
java -jar target/com.bitplan.obdii-0.0.1-jar-with-dependencies.jar -h
 +
Help
 +
CANTriplet: 0.0.1
 +
 +
  usage: java CANTriplet
 +
--display [None | Console | Swing] : display
 +
                                      the display to use one of:
 +
                                      None,Console,Swing
 +
--host (--hostname) WERT          : host
 +
                                      the host to connect to
 +
--limit (--framelimit) N          : limit
 +
                                      the maximum number of frames to read
 +
--port (--portnumber) N            : port
 +
                                      the port to connect to
 +
--vg (--vehicle-group) WERT        : vehicleGroup
 +
                                      the vehicleGroup to connect to
 +
-c (--conn) WERT                  : connection device
 +
                                      the connection to use
 +
-d (--debug)                      : debug
 +
                                      create additional debug output if this
 +
                                      switch is used
 +
-h (--help)                        : help
 +
                                      show this usage
 +
-l (--log) WERT                    : log
 +
                                      the logfile to write
 +
-p (--pid) WERT                    : pid to monitor
 +
                                      the pid to monitor
 +
-t (--timeout) N                  : timeout in msecs
 +
                                      the timeout for elm327 communication
 +
-v (--version)                    : showVersion
 +
                                      show current version if this switch is
 +
                                      used
 
</source>
 
</source>

Revision as of 14:27, 10 June 2017

These are the installation instructions as of 2017-06 for the alpha state of the project

downloading and compiling

git clone https://github.com/BITPlan/can4eve
cd can4eve/obdii/
./rebuild
...
[INFO] Building jar: ... /can4eve/obdii/target/com.bitplan.obdii-0.0.1-jar-with-dependencies.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

command line interface

java -jar target/com.bitplan.obdii-0.0.1-jar-with-dependencies.jar -h
Help
CANTriplet: 0.0.1

  usage: java CANTriplet
 --display [None | Console | Swing] : display
                                      the display to use one of:
                                       None,Console,Swing
 --host (--hostname) WERT           : host
                                      the host to connect to
 --limit (--framelimit) N           : limit
                                      the maximum number of frames to read
 --port (--portnumber) N            : port
                                      the port to connect to
 --vg (--vehicle-group) WERT        : vehicleGroup
                                      the vehicleGroup to connect to
 -c (--conn) WERT                   : connection device
                                      the connection to use
 -d (--debug)                       : debug
                                      create additional debug output if this
                                      switch is used
 -h (--help)                        : help
                                      show this usage
 -l (--log) WERT                    : log
                                      the logfile to write
 -p (--pid) WERT                    : pid to monitor
                                      the pid to monitor
 -t (--timeout) N                   : timeout in msecs
                                      the timeout for elm327 communication
 -v (--version)                     : showVersion
                                      show current version if this switch is
                                      used