summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarco Residori <MarcoResidori@users.noreply.github.com>2016-04-25 12:26:42 +0200
committerMarco Residori <MarcoResidori@users.noreply.github.com>2016-04-25 12:26:42 +0200
commit9e9b1b927940281c59b0c4b402ef8fcb58e005ab (patch)
tree7e10f1db01f320c965a8ea314963bcd9863a4dc0
parent0c7f42cd4d289d1c07d63cb6cecff550e868842f (diff)
downloadpositioning-9e9b1b927940281c59b0c4b402ef8fcb58e005ab.tar.gz
Update README.md
-rw-r--r--README.md67
1 files changed, 35 insertions, 32 deletions
diff --git a/README.md b/README.md
index 341856b..4749f63 100644
--- a/README.md
+++ b/README.md
@@ -81,12 +81,7 @@ cmake -DWITH_NMEA=ON -DWITH_TESTS=ON -DWITH_DEBUG=ON -DGNSS_DEVICE=\"/dev/ttyACM
make
```
-To build:
-* with tests
-* with the logger
-* without the EnhancedPositionService:
-* using as GNSS source a GPS receiver with a u-blox chipset and 50ms transmission delay providing NMEA data to /dev/ttyACM0 at 38400 baud
-* using as source for gyro and accelerometer data a LSM9DS1 sensor attached via I2C (e.g. from a Sense Hat module)
+To build with tests, with the logger, without the EnhancedPositionService, using as GNSS source a GPS receiver with a u-blox chipset and 50ms transmission delay providing NMEA data to /dev/ttyACM0 at 38400 baud, using as source for gyro and accelerometer data a LSM9DS1 sensor attached via I2C (e.g. from a Sense Hat module)
```
cmake -DWITH_ENHANCED_POSITION_SERVICE=OFF -DWITH_NMEA=ON -DWITH_SENSORS=ON -DIMU_TYPE=LSM9DS1 -DWITH_LOGGER=ON -DWITH_TESTS=ON -DWITH_DEBUG=ON -DGNSS_DEVICE=\"/dev/ttyACM0\" -DGNSS_BAUDRATE=B38400 -DGNSS_CHIPSET=UBLOX -DGNSS_DELAY=50 ../
@@ -94,8 +89,7 @@ make
```
===============================
-Compiler Options and default setting
-(see dependencies below)
+Compiler options and default setting
===============================
* option(WITH_ENHANCED_POSITION_SERVICE
@@ -110,25 +104,25 @@ Compiler Options and default setting
"Build the Sensors Service" ON)
* option(WITH_FRANCA_DBUS_INTERFACE
"Build using the Franca DBus interfaces" OFF)
-option(WITH_FRANCA_SOMEIP_INTERFACE
+* option(WITH_FRANCA_SOMEIP_INTERFACE
"Build using the Franca SomeIP interfaces" OFF)
-option(WITH_DBUS_INTERFACE
+* option(WITH_DBUS_INTERFACE
"Build using the D-Bus interfaces" ON)
-option(WITH_DEBUG
+* option(WITH_DEBUG
"Enable the debug messages" OFF)
-option(WITH_DLT
+* option(WITH_DLT
"Enable DLT logging" OFF)
-option(WITH_GPSD
+* option(WITH_GPSD
"Use GPSD as source of GPS data" OFF)
-option(WITH_NMEA
+* option(WITH_NMEA
"Use NMEA as source of GPS data" OFF)
-option(WITH_REPLAYER
+* option(WITH_REPLAYER
"Use REPLAYER as source of GPS data" ON)
-option(WITH_TESTS
+* option(WITH_TESTS
"Compile test applications" OFF)
-option(WITH_IPHONE
+* option(WITH_IPHONE
"Use IPHONE as source of sensors data" OFF)
-option(WITH_SENSORS
+* option(WITH_SENSORS
"Use real sensors connected to the target device" OFF)
Just set the option to ON or OFF on the command line.
@@ -140,19 +134,22 @@ How To Test
To test the positioning proofs of concept please use the following test application (under top folder):
(please note that you need to build with -DWITH_TESTS=ON and -DWITH_DEBUG=ON to see something displayed)
+```
./run-test.sh [command]
+```
service:
- gnss Test GNSSService
- sns Test SensorsService
- enhpos Test EnhancedPositionService
- repl Test Replayer
- kill Kill all test applications
- help Print Help
+* gnss Test GNSSService
+* sns Test SensorsService
+* enhpos Test EnhancedPositionService
+* repl Test Replayer
+* kill Kill all test applications
+* help Print Help
===============================
Dependencies
===============================
+
You might have to install additional packages to Compile and run the
Positioning PoC.
This section tries to summarize those dependencies.
@@ -175,13 +172,13 @@ sudo ldconfig
To test the enhanced-position-service (commonapi-service) the package CommonAPI and CommonAPI code generators must be installed.
Please see:
-http://git.projects.genivi.org/?p=ipc/common-api-runtime.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=ipc/common-api-tools.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=ipc/common-api-dbus-runtime.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=ipc/common-api-dbus-tools.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=common-api/cpp-someip-runtime.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=common-api/cpp-someip-tools.git;a=blob;f=INSTALL
-http://git.projects.genivi.org/?p=vSomeIP.git;a=blob;f=README
+* http://git.projects.genivi.org/?p=ipc/common-api-runtime.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=ipc/common-api-tools.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=ipc/common-api-dbus-runtime.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=ipc/common-api-dbus-tools.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=common-api/cpp-someip-runtime.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=common-api/cpp-someip-tools.git;a=blob;f=INSTALL
+* http://git.projects.genivi.org/?p=vSomeIP.git;a=blob;f=README
DWITH_TESTS=ON enables the compilation of the test application(s).
@@ -191,9 +188,15 @@ git clone git://git.projects.genivi.org/dlt-daemon.git
To install the DLT-daemon, etxract the tarball and follow the
instructions in the file install.txt.
Note: You may have to call
+
+ ```
export PKG_CONFIG_PATH=/usr/lib/pkgconfig
-before
+ ```
+before
+
+ ```
sudo ldconfig
+ ```
to add DLT to the pkgconfig search path before calling cmake
DWITH_IPHONE=ON requires that the iPhone app 'SensorLogger' is