iXblue parsing library for protocol iXblue stdbin

iXblue is a global leader in the design and manufacturing of innovative solutions devoted to navigation, positioning and underwater imaging, shipbuilding, as well as photonics. Using its unique in-house technology, the company offers turnkey solutions to its Civil and Defense customers to carry out their sea, land and space operations with optimum efficiency and reliability. Employing a workforce of 600 people worldwide, iXblue conducts its business with over 60 countries.

The aim of this library is to parse the iXblue standard binary protocol which is the most generic input/output protocol for iXblue inertial system. In this library the protocol is only parsed as output protocol.

Please note that a ROS driver allows to format the protocol data into ROS messages thanks to the parsing library.

Table of Contents

1. Protocol
2. Installation
3. Implementation
4. License

Protocol

The protocol iXblue stdbin allows obtaining as much information as possible from inertial system data thanks to its modularity. Here is a non-exhaustive list of data that are proposed in the protocol:

• Attitude
• Positions
• Status
• Accelerations
• ...

This information can be given in vessel or geographic frame, compensated or not from gravity and earth rotation. You can find the details of this protocol in the interface library document of your product user manual.

Back to top

Installation

Dependencies

• Boost - Useful C++ library
• Gtest - Used to create the unit tests

This librairy is used in our ROS driver that you can find here on Github.

Build the library

If you have not already done so, you can first download the source code in the dedicated library folder:

git clone https://github.com/ixblue/ixblue_stdbin_decoder

Then you can build the code in a build directory from the library folder:

cd ixblue_stdbin_decoder
mkdir build
cd build/
cmake ..
make
sudo make install

Run Unit Tests

If you need to run unit tests, you can do it in your build directory by first enabling the tests:

To run all tests :

cmake -DBUILD_TESTING ..
make test

To run only one test :

./bin/name_of_the_test

Back to top

Usage

This library doesn't manage the communication with the IMU, only the reconstruction and parsing of the stdbin data.

Simple UDP, TCP and serial port usage examples using Boost asio are available in the examples directory.

A more complete usage example can be found in our ROS driver that implements an UDP Client based on Boost asio to receive data from the IMU and publish them as ROS topic.

The entry point of this library is the class StdBinDecoder .

Here is a minimal usage example:

StdBinDecoder decoder;

std::vector<uint8_t> binaryDatas;
// Fill binary data with data received from IMU
size_t bytesRead = mySocket.read(binaryDatas);
try {
  decoder.addNewData(binaryDatas.data(), bytesRead);
  while(decoder.parseNextFrame()) {
    auto navDatas = decoder.getLastNavData();
    // Do something with the nav data
  }
} catch(std::runtime_error& e) {
   // Parsing error are reported by throwing std::runtime_exception.
}

The StdBinDecoder::addNewData adds the newly arrived bytes to the parsed internal buffer. The parser manages the reconstruction of the frames. It can then be used on serial port, TCP and UDP. The method StdBinDecoder::parseNextFrame returns true if a valid frame has been parsed from the internal buffer. The frame content can then be retrieved with the method StdBinDecoder::getLastNavData.

Parsing errors are reported by throwing std::runtime_execpetion.

Back to top

Bug reports:

Feel free to open a Github issue if you encounter any problem with this parser, we will process it as soon as possible.

License

This project is licensed under the MIT License

(The MIT License)

Copyright (c) 2019 iXblue SAS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back to top

Changelog for package ixblue_stdbin_decoder

0.2.1 (2022-04-4)

• Fix example in readme use wrong function.
• Bump package.xml version to 0.2.1
• Fix bad protocol exception looping error with cleaning buffer with only one byte
• Fix checksum exception looping error with cleaning buffer with telegram size

- Add feature test class to merge each error recovery testing code

Add test case to validate recovery :

:   -   bad checksum recovery
    -   bad navigation protocol recovery
    -   bad answer protocol recovery

• Add in dataset erroneous frames :

  : - Nav frame with bad checksum - Nav frame with bad protocol version - Answer frame with bad protocol version

• Add classe used to test error recovery

• Add in git ignore clion generated files

• Add CMake option description for BUILD_TESTING variable

• Fix CMake error used old branch master to fixed tagged commit to release-1.11.0

• Contributors: Foissac Nicola

0.2.0 (2020-11-13)

• Fix strict aliasing warning by using memcpy
• Fix the protocol version test condition
• Do not force SHARED library to use static lib on Windows
• Add checksum checking on frame reception Allow to use on unreliable communication like serial ports
• Breaking change: Allow the decoder to parse partial frames by reconstructing the frames internally using a circular buffer This allows to work properly on TCP and moreover, serial ports. This change changes the API as reflected in README minimal example.
• Add usage examples
• Add bits enums for INSAlgorithmStatus and INSSystemStatus
• Contributors: BARRAL Adrien, Romain Reignier

0.1.3 (2020-09-21)

• Add ins algorithm status and ins system status bits description in emums
• Add clang format file
• Set CMake project version from package.xml
• Contributors: Romain Reignier

0.1.2 (2020-08-31)

• Fix CMake config file for older CMake In order to do a Kinetic release.
• Contributors: Romain Reignier

0.1.1 (2020-08-27)

• Reduce minimum required CMake version to allow build on Debian Stretch for ROS Melodic
• Contributors: Romain Reignier

0.1.0 (2020-08-26)

• Add package.xml to build with catkin
• Rework cmake installation
• Rename to ixblue_stdbin_decoder in lower case to stay consistent
• Allow the parser to read other header types (Answer and command)
• Use boost::asio::const_buffer instead of boost::asio::mutable_buffer Frame data is not modified while parsed.
• Change namespace to ixblue_stdbin_decoder to avoid naming conflict with StdBinDecoder class Causes issues in IDEs and adds confusion
• Contributors: Adrien BARRAL, Romain Reignier