Skip to content

Commit

Permalink
Update documentation to reflect recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
bcharrow committed Apr 3, 2014
1 parent c634d18 commit b6cc87e
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 32 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Changelog for package matlab_rosbag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0.4.0 (2014-03-31)
------------------
* Add ability to 1) filter messages by time and 2) access bag start/stop time.
* New class, ros.TFTree, for working with stored TF messages
* Autocomplete paths to bags using ros.Bag.load()
* Update build to use Hydro

0.3.0 (2013-06-09)
------------------
* Add equivalents of 'rosbag info', 'rosmsg show', and 'rosmsg show --raw' to ros.Bag
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2013, Benjamin Charrow
Copyright (C) 2013-2014 Benjamin Charrow

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

matlab_rosbag is a library for reading ROS bags in Matlab. It uses the C++ ROS API and returns messages as structs. It also lets get meta-data about the bag (i.e., topic info and message definitions similar to <tt>rosmsg show</tt> and <tt>rosbag info</tt>). Because all of the work is done inside of a statically linked mex function, ROS does not need to be installed on a machine to use this library.
matlab_rosbag is a library for reading ROS bags in Matlab. It uses the C++ ROS API to read stored messages and lets get meta-data about the bag (e.g., topic info and message definitions similar to <tt>rosmsg show</tt> and <tt>rosbag info</tt>). The library also contains methods for working with TF messages. ROS does <emph>not</emp> not need to be installed on a machine to use this library.

You can download the compiled code for Mac and Linux from sourceforge:

Expand All @@ -10,7 +10,7 @@ If you want to compile things yourself see [COMPILING.md](COMPILING.md). WARNIN

# Usage

Download the library and add the base directory to your Matlab path (i.e., add the directory that contains <tt>+ros</tt> and <tt>rosbag_wrapper</tt>). You should now be able to access <tt>ros.Bag</tt>, a Matlab class which can read ROS messages on topics from a bag and return them as structs. Multiple messages are returned as cell arrays. It's also possible to access some meta-data (e.g., topic, msg type). To get an idea of how the code works go to the <tt>example</tt> directory and look at <tt>example.m</tt> and <tt>example.bag</tt>.
Download the library and add the base directory to your Matlab path (i.e., add the directory that contains <tt>+ros</tt> and <tt>rosbag_wrapper</tt>). You should now be able to access <tt>ros.Bag</tt>, a Matlab class which can read ROS messages on topics from a bag and return them as structs. Multiple messages are returned as cell arrays. To get an idea of how the code works go to the <tt>example</tt> directory and look at <tt>bag_example.m</tt> and <tt>tf_example.m</tt>

The fields in the structs are guaranteed to be in the same order as they are in the message definition. There are also some utilities for converting messages from structs to matrices.

Expand Down
2 changes: 1 addition & 1 deletion release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ rm -fr $DEST && mkdir -p $DEST
cp src/rosbag_wrapper.mex* $DEST/
cp -r src/example $DEST/
cp -r src/+ros $DEST/
cp src/README $DEST/
cp README.md $DEST/README
cp LICENSE.txt $DEST/
cp LICENSE-Willow.txt $DEST/
cd build/ && rm -f $NAME.zip && zip -r $NAME.zip $NAME
Expand Down
28 changes: 0 additions & 28 deletions src/README

This file was deleted.

0 comments on commit b6cc87e

Please sign in to comment.