release v0.3.0

CHANGELOG.md

@@ -1,14 +1,24 @@
-Version 0.2.1 (2017-08-31)
---------------------------
+[0.3.0] - 2017-09-06
+--------------------
+
+- start/stop rc_dynamics node instead of rc_stereo_ins
+- don't start/stop rc_dynamics for imu stream
+
+[0.2.1] - 2017-08-31
+--------------------
 
 - bug fix: header not installed 
 
-Version 0.2.0 (2017-08-30)
---------------------------
+[0.2.0] - 2017-08-30
+--------------------
 
 - bug fix: wrong name of tool: vins_stream -> rcdynamics_stream
 
-Version 0.1.0 (2017-08-29)
---------------------------
+0.1.0 - 2017-08-29
+------------------
+
+- Initial release
 
-- Initial release
+[0.3.0]: https://github.com/roboception/rc_dynamics_api/compare/v0.2.1...v0.3.0
+[0.2.1]: https://github.com/roboception/rc_dynamics_api/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/roboception/rc_dynamics_api/compare/v0.1.0...v0.2.0

README.md

@@ -1,68 +1,74 @@
-# Roboception Dynamics API
+Roboception Dynamics API
+========================
 
-The rc_dynamics_api provides an API for easy handling of the dynamic-state data 
-streams provided by Roboception's [rc_visard](http://roboception.com/en/rc_visard-en/) 
+The rc_dynamics_api provides an API for easy handling of the dynamic-state data
+streams provided by Roboception's [rc_visard](http://roboception.com/en/rc_visard-en/)
 stereo camera with self-localization.
 
-Dynamic-state estimates of the rc_visard relate to its self-localization and 
-ego-motion estimation. These states refer to rc_visard's current pose, velocity, 
-or acceleration and are published on demand via several data streams. For a 
+Dynamic-state estimates of the rc_visard relate to its self-localization and ego-motion estimation.
+These states refer to rc_visard's current pose, velocity,
+or acceleration and are published on demand via several data streams. For a
 complete list and descriptions of these dynamics states and the respective data
 streams please refer to rc_visard's user manual.
 
 
-## Dependencies
+Dependencies
+------------
 
-- **[C++ Requests](https://github.com/whoshuu/cpr) (version 1.3.0):** 
-Requesting and deleting data streams is done via rc_visard's REST-API. This 
-library provides an easy-to-use interface for doing REST-API calls. 
+- **[C++ Requests](https://github.com/whoshuu/cpr) (version 1.3.0):**
+Requesting and deleting data streams is done via rc_visard's REST-API. This
+library provides an easy-to-use interface for doing REST-API calls.
 - **[JSON for Modern C++](https://github.com/nlohmann/json) (version v2.0.0):**
-A simple and modern C++ JSON parsing library.   
+A simple and modern C++ JSON parsing library.
 - **[Google Protocol Buffers:](https://developers.google.com/protocol-buffers/)**
-The data sent via rc_visard's data streams is serialized via Google protocol 
-message definitions (/roboception/msgs). After receiving the data, the 
-rc_dynamics_api needs these definitions in order to de-serialized it. This 
-project requires both the `protobuf-compiler` for compiling the protocol buffer 
+The data sent via rc_visard's data streams is serialized via Google protocol
+message definitions (/roboception/msgs). After receiving the data, the
+rc_dynamics_api needs these definitions in order to de-serialized it. This
+project requires both the `protobuf-compiler` for compiling the protocol buffer
 definition files and the `libprotobuf` C++ library.
 
-## Build/Installation
+Build/Installation
+------------------
 
-Some libraries listed above are included as git submodules in this repository 
-(and themselves include other libs as git submodules). 
+Some libraries listed above are included as git submodules in this repository
+(and themselves include other libs as git submodules).
 Hence, before building this lib you need to
-    
+
     git submodule update --init --recursive
-    
+
 Then building follows the typical cmake buid-flow
 
     mkdir build && cd build
     cmake ..
     make
-
-## Tool
 
-Currently, the rc_dynamics_api comes with the following tools:
+Tools
+-----
+
+Currently, the rc_dynamics_api comes with the following tool which is also meant as an example on how to use this API:
 
 - **rcdynamics_stream**
+
     Connect with an rc_visard device and request a specific data stream. The received
     data messages containing aspects of rc_visard's dynamic state can be simply printed
-    to std::out or saved as .csv-file. 
-    
+    to std::out or saved as .csv-file.
+
     Simplest example:
-    
-        # Connect to rc_visard with specified IP address and request the 
-        # 'imu' stream. A certain amount of messages are received and simply 
-        # print to std::out
-        ./tools/vins_stream -v 10.0.2.99 -s imu
-        
+
+    Connect to rc_visard with specified IP address and request the 'imu' stream.
+    A certain amount of messages are received and simply print to std::out
+
+      ./tools/rcdynamics_stream -v 10.0.2.99 -s imu
+
     Different use case with more command line parameters:
-
-        # Connect to rc_visard with specified IP address and request the 
-        # 'pose_rt' stream for 10 seconds. The client host's network interface
-        # to be used to receive the data is specified as 'eth0'. Messages are
-        # stored in the specified file as .csv-lines.
-        ./tools/vins_stream -v 10.0.2.99 -s pose_rt -i eth0 -t10 -o poses.csv
-
-## Links
+
+    Connect to rc_visard with specified IP address and request the 'pose_rt' stream for 10 seconds.
+    The client host's network interface to be used to receive the data is specified as 'eth0'.
+    Messages are stored in the specified file as .csv-lines.
+
+      ./tools/rcdynamics_stream -v 10.0.2.99 -s pose_rt -i eth0 -t10 -o poses.csv
+
+Links
+-----
 
 - http://www.roboception.com