diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 29ca5c9..a470476 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,26 +1,33 @@ -================================== -Change Log for ursa_driver package -================================== +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Changelog for package ursa_driver +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -`0.1.0`_ (2015-09-10) ---------------------- -* Initial public release -* Finished Documentation for ursa::Interface class +0.1.1 (2017-03-26) +------------------ +* `0.1.1`_ Diff +* Changelog fixes. +* Added frame to publisher +* Added Travis CI and roslaunch check. +* Fixed changelog for github +* fixed README.md +* Contributors: Mike Hosmar, Tony Baltovski, mikehosmar -`0.0.1`_ (2015-08-14) ---------------------- +0.1.0 (2015-09-10) +------------------ +* `0.1.0`_ Diff +* Initial public release +* Finished Documentation for ursa::Interface class +* Contributors: mikehosmar +0.0.1 (2015-08-17) +------------------ +* `0.0.1`_ Diff * Initial working ROS node * Driver commands tested +* Contributors: mikehosmar -`0.0.0`_ (2015-06-24) ---------------------- - -* Initial Commit - - -.. _`0.0.0`: https://github.com/mars-uoit/URSAII-Driver/commit/e1c2bf2 .. _`0.0.1`: https://github.com/mars-uoit/URSAII-Driver/compare/e1c2bf2...0.0.1 .. _`0.1.0`: https://github.com/mars-uoit/URSAII-Driver/compare/0.0.1...0.1.0 +.. _`0.1.1`: https://github.com/mars-uoit/URSAII-Driver/compare/0.1.0...0.1.1 \ No newline at end of file diff --git a/Doxyfile b/Doxyfile index 2595118..7b4c147 100644 --- a/Doxyfile +++ b/Doxyfile @@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = URSAII Driver +PROJECT_NAME = ursa_driver # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.1.0 +PROJECT_NUMBER = 0.1.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/README.md b/README.md index a38e223..a3debaf 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ URSAII Driver [![Build Status](https://travis-ci.org/mars-uoit/URSAII-Driver.svg)](https://travis-ci.org/mars-uoit/URSAII-Driver) ============= -Version 0.1.0 +Version 0.1.1 This is a ROS Node and C++ driver for the URSAII multi-channel analyser (MCA). The ROS node implements all the necessary commands to start taking readings from a radiation detector and publish them over ROS. While the library implements all the available commands. ## What is this repository for? ## -###ROS Node### +### ROS Node### This software will allow you to get radiation measurements in either gross counts (in MCS Mode) or using the URSA's 12 bit ADC to capture spectra. This data then can be transported via custom messages to other ROS Nodes. -###C++ Library### +### C++ Library ### I tried to make the driver portion of the repo as stand-alone as possible. I exposes functions to execute any of the commands that URSA will respond to. Keep in mind though that some commands are meant to only be executed by factory personnel and setting parameters in a incorrect manner could damage the URSA or the detector head. Check out the doxygen documentation for the ursa::Interface class. -####Note#### +#### Note #### If you are familiar with the standard software provided to operate the URSA there is a major difference between that software and this; This software will only provide you with the raw readings from URSA, if energy calibration or any other conditioning must be done you must implement it in your project. @@ -21,5 +21,5 @@ If you are familiar with the standard software provided to operate the URSA ther The ROS node can be compiled in a catkin workspace and its dependencies can be installed with rosdep. The Library depends on several boost libraries and William Woodall's serial library. The Library can be compiled and installed using the Makefile (TODO). -###Contact### +### Contact ### Repo Owner: Michael Hosmar mikehosmar@gmail.com diff --git a/package.xml b/package.xml index 8943328..66bf728 100644 --- a/package.xml +++ b/package.xml @@ -1,7 +1,7 @@ ursa_driver - 0.1.0 + 0.1.1 ros package and c++ library to interface with the URSAII MCA Mike Hosmar