Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bsb808 authored Dec 19, 2016
1 parent 24f304e commit 52d2753
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# microstrain_3dm_gx5_45



## Description

Interface software, including ROS node, for Microstrain 3DM-GX5-45.

The interface makes use of the MIP SDK Version 1.1 from Microstrain to communicate with the device. Includes the following applications:

* GX4-45_Test : A port of the executable that comes with the SDK including minimial changes in the way the serial port is specified. Running {rosrun microstrain_3dm_gx5_45 GX4-45_Test /dev/ttyACM0 115200} should run the tests on a unit as a first step.
* microstrain_3dm_gx5_45 : ROS node

## Dependencies

* serial: https://github.com/wjwwood/serial - for now we build this from source in our catkin_ws
Expand All @@ -16,7 +27,7 @@ Here are the steps I took to build the code...
* cd catkin_sw
* catkin_make

## Dev Notes
## Dev Notes

The mip_sdk_user_functions are C functions that need to be called by various parts of the SDK. The main purpose of these functions is to implement the platform-specific serial (RS232) port elements. The prototype serial port open function takes the COM number as an integer input - which is clunky for Linux serial ports. Changed this to take a string defining the port (e.g., /dev/ttyS0), but this necessitated also modifying the mip_sdk_interface.[ch] files, since this is what is called by the application - changed the mip_interface_init function to accept a string argument for specifying the port.

0 comments on commit 52d2753

Please sign in to comment.