Merge pull request #76 from chalmers-revere/pre-release

Pre release

ChangeLog

@@ -1,3 +1,4 @@
+0.8.1 - New recording use cases
 0.8.0 - Supporting new messages from CAN dbc file
 0.7.1 - Updates to proxy-velodyne16 to handle SPC and CPC; new release 0.7.1
 0.7.0 - Changing CompactPointCloud from half_float to uint16_t

VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

code/core/system/health/man/opendlv-core-system-health.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-system-health
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-system-health 1 "13 December 2016" "0.8.0" "opendlv-core-system-health man page"
+.TH opendlv-core-system-health 1 "20 December 2016" "0.8.1" "opendlv-core-system-health man page"
 
 .SH NAME
 opendlv-core-system-health \- This component checks the health of the runtime environment.

code/core/system/proxy-applanix/man/opendlv-core-system-proxy-applanix.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-applanix
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-applanix 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-applanix man page"
+.TH opendlv-core-proxy-applanix 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-applanix man page"
 
 .SH NAME
 opendlv-core-proxy-applanix \- This tool interfaces to GPS/IMU unit Applanix.

code/core/system/proxy-camera-axis/man/opendlv-core-system-proxy-camera-axis.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-camera-axis
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-camera-axis 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-camera-axis man page"
+.TH opendlv-core-proxy-camera-axis 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-camera-axis man page"
 
 .SH NAME
 opendlv-core-proxy-camera-axis \- This tool interfaces with Axis cameras.

code/core/system/proxy-camera/man/opendlv-core-system-proxy-camera.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-camera
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-camera 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-camera man page"
+.TH opendlv-core-proxy-camera 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-camera man page"
 
 .SH NAME
 opendlv-core-proxy-camera \- This tool interfaces with the FH16 truck.

code/core/system/proxy-fh16/man/opendlv-core-system-proxy-fh16.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-fh16truck
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-fh16truck 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-fh16truck man page"
+.TH opendlv-core-proxy-fh16truck 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-fh16truck man page"
 
 .SH NAME
 opendlv-core-proxy-fh16truck \- This tool interfaces with the FH16 truck.

code/core/system/proxy-imu/man/opendlv-core-system-proxy-imu.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-imu
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-imu 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-imu man page"
+.TH opendlv-core-proxy-imu 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-imu man page"
 
 .SH NAME
 opendlv-core-proxy-imu \- This tool interfaces with a imu.

code/core/system/proxy-ledstrip/man/opendlv-core-system-proxy-ledstrip.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-ledstrip
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-ledstrip 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-ledstrip man page"
+.TH opendlv-core-proxy-ledstrip 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-ledstrip man page"
 
 .SH NAME
 opendlv-core-proxy-ledstrip \- This tool interfaces with an LED strip.

code/core/system/proxy-sick/man/opendlv-core-system-proxy-sick.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-sick
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-sick 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-sick man page"
+.TH opendlv-core-proxy-sick 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-sick man page"
 
 .SH NAME
 opendlv-core-proxy-sick \- This tool interfaces with the Sick lidar device.

code/core/system/proxy-trimble/man/opendlv-core-system-proxy-trimble.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-trimble
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-trimble 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-trimble man page"
+.TH opendlv-core-proxy-trimble 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-trimble man page"
 
 .SH NAME
 opendlv-core-proxy-trimble \- This tool interfaces to GPS/IMU unit Trimble.

code/core/system/proxy-v2v/man/opendlv-core-system-proxy-v2v.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-v2v
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-v2v 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-v2v man page"
+.TH opendlv-core-proxy-v2v 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-v2v man page"
 
 .SH NAME
 opendlv-core-proxy-v2v \- This tool interfaces with a V2V unit.

code/core/system/proxy-velodyne16/man/opendlv-core-system-proxy-velodyne16.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-velodyne16
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-velodyne16 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-velodyne man page"
+.TH opendlv-core-proxy-velodyne16 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-velodyne man page"
 
 .SH NAME
 opendlv-core-proxy-velodyne16 \- This tool interfaces with the FH16 truck.

code/core/system/proxy-velodyne64/man/opendlv-core-system-proxy-velodyne64.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-proxy-velodyne
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-proxy-velodyne 1 "13 December 2016" "0.8.0" "opendlv-core-proxy-velodyne man page"
+.TH opendlv-core-proxy-velodyne 1 "20 December 2016" "0.8.1" "opendlv-core-proxy-velodyne man page"
 
 .SH NAME
 opendlv-core-proxy-velodyne \- This tool interfaces with the FH16 truck.

code/core/system/ps3controller/man/opendlv-core-system-ps3controller.1

@@ -1,7 +1,7 @@
 .\" Manpage for opendlv-core-ps3controller
 .\" Author: Christian Berger <[email protected]>.
 
-.TH opendlv-core-ps3controller 1 "13 December 2016" "0.8.0" "opendlv-core-ps3controller man page"
+.TH opendlv-core-ps3controller 1 "20 December 2016" "0.8.1" "opendlv-core-ps3controller man page"
 
 .SH NAME
 opendlv-core-ps3controller \- This tool interfaces with the FH16 truck.

usecases/latest/recordings.doccameraRT+velodyne+applanix/.env

@@ -0,0 +1 @@
+CID=251

usecases/latest/recordings.doccameraRT+velodyne+applanix/Dockerfile

@@ -0,0 +1,20 @@
+# Dockerfile - Dockerfile to run OpenDLV software.
+# Copyright (C) 2016 Christian Berger
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+# Date: 2016-11-02
+
+FROM seresearch/opendlv-core-on-opendavinci-ubuntu-16.04-complete:latest

usecases/latest/recordings.doccameraRT+velodyne+applanix/README.md

@@ -0,0 +1,40 @@
+This folder provides the instructions for video recording with a single OpenCV camera. A docker-compose file is provided to start all micro-services to record video streams from the OpenCV camera with lossless H264 compression. It includes three services: odsupercomponent, opendlv-core-system-proxy-camera (or proxy-camera for short), and odrecorderh264. odsupercomponent is used for software component lifecycle management in OpenDaVINCI. proxy-camera activates the camera and odrecorderh264 records the video. The recording is performed in headless mode, i.e., without display during the recording. Please follow the instructions in the header of the docker-compose file to support non-headless mode. It is assumed that git, Docker, and Docker Compose are installed and the camera is properly connected. To install Docker, follow the tutorial: https://docs.docker.com/engine/installation/linux/ubuntulinux/.
+
+### Prepare proxy-camera
+
+proxy-camera is included in the opendlv.core repository (https://github.com/chalmers-revere/opendlv.core). Clone the opendlv.core source:
+
+    $ git clone https://github.com/chalmers-revere/opendlv.core
+
+    $ git pull
+
+Go to opendlv.core/docker, build and create the Docker image seresearch/opendlv-core-on-opendavinci-ubuntu-16.04-complete:latest:
+
+    $ make buildComplete
+
+    $ make createDockerImage
+
+### Use proxy-camera with Docker Compose
+
+Go to the folder usecases/recording.1opencvcamera.scott2. This folder contains a configuration file, a docker-compose file docker-compose.yml, and an environment file .env. The environment file .env defines an environment variable CID which is referred to by the docker-compose file. CID is a user-defined environment variable that specifies the cid of the UDP session established by odsupercomponent. In .env CID has the value 251, thus in docker-compose.yml "${CID}" resolves to 251.  Run Docker Compose:
+
+    $ docker-compose up --build
+
+Then proxy-camera will start the recording with the camera. To stop the recording, run
+
+    $ docker-compose stop
+
+Then remove all stopped containers:
+
+    $ docker-compose rm
+
+After the recording, the recording files are stored at ~/recordings, including a .h264 file as the actual recording with lossless H264 compression. The recording file format is CID-xxx-odrecorderh264_yyy, where xxx is the cid number and yyy is the timestamp.
+
+Note that the value of CID defined in .env can be manually overwritten by preceding the docker-compose command with CID=xxx, where xxx is the cid number. For instance, the following command makes odsupercomponent, proxy-camera, and odrecorderh264 run with cid 123 instead of 251:
+
+    $ CID=123 docker-compose up
+
+Then CID=123 should also be used for docker-compose stop and docker-compose rm accordingly.
+
+Finally, note that this use case assumes that the camera is mounted upside down. Hence video images are flipped for that reason. The configuration file in this folder includes a parameter proxy-camera.camera.flipped which is set to 1. In order to disable flipped images, change its value to 0.
+