Skip to content

Commit

Permalink
Update for release 1.6.4. See release notese for details.
Browse files Browse the repository at this point in the history
  • Loading branch information
waltjohnson committed Aug 25, 2018
1 parent c02331f commit fe4c2d9
Show file tree
Hide file tree
Showing 788 changed files with 9,713 additions and 35,139 deletions.
39 changes: 26 additions & 13 deletions CLTool/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# C++ API - Inertial Sense Class and Cltool Example Project
# C++ API - Inertial Sense Class and CLTool Example Project

The <span style="color:blue">InertialSense C++ class</span>, defined in InertialSense.h/.cpp, provides all SDK capabilities including serial communications, data logging to file, and embedded firmware update for <a href="https://inertialsense.com">InertialSense</a> products.
The <a href="https://github.com/inertialsense/InertialSenseSDK/blob/master/src/InertialSense.cpp">InertialSense C++ class</a>, defined in InertialSense.h/.cpp, provides all SDK capabilities including serial communications, data logging to file, and embedded firmware update for <a href="https://inertialsense.com">InertialSense</a> products.

## Cltool Example
## CLTool Example

The <span style="color:blue">Command Line Tool (cltool)</span> is a light weight open source project designed to illustrate InertialSense class implementation. The cltool project can be compiled on most operating systems using cmake and gcc. A Visual Studio project for Windows is also included. See [Using CLTool](../App_Usage/cltool.md) section for details on compiling and runing the cltool.
The <a href="https://github.com/inertialsense/InertialSenseSDK/tree/master/CLTool">Command Line Tool (CLTool)</a> is an open source project designed to illustrate InertialSense C++ class implementation. The CLTool project can be compiled on most operating systems using cmake and gcc and can be used to communicate, log data, and update firmware for Inertial Sense products. A Visual Studio project for Windows is also included. See [Using CLTool](../App_Usage/cltool.md) for details on compiling and running the CLTool.

### Implementation Keywords
The following keywords are found in the cltool soure code identify the steps for InertialSense class implementation.
The following keywords are found in the CLTool soure code identify the steps for InertialSense class implementation.

```C++
/* SDK Implementation Keywords:
Expand All @@ -31,9 +31,9 @@ Include the InertialSense header file. Create InertialSense object.
InertialSense inertialSenseInterface(cltool_dataCallback);
```
### Step 2: Open serial port
### Step 2: Open serial port
Open the serial by specifying the com port number, buadrate, and and The serial port used for communications
Open the serial by specifying the com port number, buadrate, and and The serial port used for communications
```C++
if (!inertialSenseInterface.Open(g_commandLineOptions.comPort.c_str(),
Expand Down Expand Up @@ -130,10 +130,22 @@ if (!cltool_setupLogger(inertialSenseInterface))
}
```

### Run ()

```c
// [LOGGER INSTRUCTION] Setup and start data logger
if (!cltool_setupLogger(inertialSenseInterface))
{
cout << "Failed to setup logger!" << endl;
return -1;
}
```

## Compile & Run (Linux/Mac)

1. Create build directory
``` bash
$ cd InertialSenseCLTool
$ cd CLTool
$ mkdir build
```
2. Run cmake from within build directory
Expand All @@ -157,14 +169,15 @@ $ ./bin/cltool
```

## Compile & Run (Windows MS Visual Studio)
1. Open Visual Studio solution file (InertialSenseSDK/InertialSenseCLTool/VS_project/InertialSenseCLTool.sln)
2. Build (F7)
3. Run executable
1. [Install and Configure Visual Studio](../getting-started/#installing-and-configuring-visual-studio)
2. Open Visual Studio solution file (InertialSenseSDK/CLTool/VS_project/CLTool.sln)
3. Build (F7)
4. Run executable
``` bash
C:\InertialSenseSDK\InertialSenseCLTool\VS_project\Release\cltool.exe
C:\InertialSenseSDK\CLTool\VS_project\Release\cltool.exe
```


## Summary

That covers all the basic functionality you need to set up and talk to <a href="https://inertialsense.com">InertialSense</a> products. If this doesn't cover everything you need, feel free to reach out to us on the <a href="https://github.com/inertialsense/InertialSenseSDK">InertialSenseSDK</a> github repository, and we will be happy to help.
This section has covered the basic functionality you need to set up and communicate with <a href="https://inertialsense.com">Inertial Sense</a> products. If this doesn't cover everything you need, feel free to reach out to us on the <a href="https://github.com/inertialsense/InertialSenseSDK">Inertial Sense SDK</a> GitHub repository, and we will be happy to help.
Binary file not shown.
19 changes: 19 additions & 0 deletions CLTool/VS_project/IS_logs/20180801_225711/diagnostic_30235.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
RTK: 2018-08-02T04:57:30.20Z age of differential error (age=7516.7)
RTK: 2018-08-02T04:57:30.60Z age of differential error (age=7517.1)
RTK: 2018-08-02T04:57:31.80Z age of differential error (age=7518.3)
RTK: 2018-08-02T04:57:35.20Z age of differential error (age=7521.7)
RTK: 2018-08-02T04:57:38.00Z age of differential error (age=7524.5)
RTK: 2018-08-02T04:57:43.60Z age of differential error (age=7530.1)
RTK: 2018-08-02T04:57:46.20Z age of differential error (age=7532.7)
RTK: 2018-08-02T04:57:47.60Z age of differential error (age=7534.1)
RTK: 2018-08-02T04:57:50.80Z age of differential error (age=7537.3)
RTK: 2018-08-02T04:57:53.40Z age of differential error (age=7539.9)
RTK: 2018-08-02T04:57:56.00Z age of differential error (age=7542.5)
RTK: 2018-08-02T04:58:06.60Z age of differential error (age=7553.1)
RTK: 2018-08-02T04:58:18.00Z age of differential error (age=7564.5)
RTK: 2018-08-02T04:58:29.60Z age of differential error (age=7576.1)
RTK: 2018-08-02T04:58:37.20Z age of differential error (age=7583.7)
RTK: 2018-08-02T04:58:41.20Z age of differential error (age=7587.7)
RTK: 2018-08-02T04:58:48.60Z age of differential error (age=7595.1)
RTK: 2018-08-02T04:59:08.40Z age of differential error (age=7614.9)
RTK: 2018-08-02T04:59:10.80Z age of differential error (age=7617.3)
Empty file.
122 changes: 122 additions & 0 deletions CLTool/VS_project/IS_logs/20180801_225711/stats.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
Count: 2101
Errors: 0

Data Id: 1 - devInfo
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 3 - preintegratedImu
Count: 907
Errors: 0
Average Timestamp Delta: 0.121797
Max Timestamp Delta: 5.447597
Timestamp Drops: 66

Data Id: 5 - ins2
Count: 33
Errors: 0
Average Timestamp Delta: 3.287739
Max Timestamp Delta: 5.499878
Timestamp Drops: 6

Data Id: 6 - gpsPos
Count: 19
Errors: 0
Average Timestamp Delta: 5.844444
Max Timestamp Delta: 12.200000
Timestamp Drops: 8

Data Id: 7 - config
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 10 - sysParams
Count: 1
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 12 - flashCfg
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 21 - gpsRtkRel
Count: 18
Errors: 0
Average Timestamp Delta: 5.917647
Max Timestamp Delta: 19.800000
Timestamp Drops: 9

Data Id: 30 - DID_GPS1_VEL
Count: 20
Errors: 0
Average Timestamp Delta: 5.536842
Max Timestamp Delta: 12.200000
Timestamp Drops: 8

Data Id: 35 - userpage0
Count: 1
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 48 - inl2States
Count: 16
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 52 - magnetometer1
Count: 322
Errors: 0
Average Timestamp Delta: 0.343777
Max Timestamp Delta: 5.459597
Timestamp Drops: 94

Data Id: 53 - barometer
Count: 363
Errors: 0
Average Timestamp Delta: 0.304818
Max Timestamp Delta: 5.463577
Timestamp Drops: 102

Data Id: 55 - magnetometer2
Count: 325
Errors: 0
Average Timestamp Delta: 0.340593
Max Timestamp Delta: 5.459597
Timestamp Drops: 92

Data Id: 59 - inl2MagObs
Count: 15
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 67 - inl2Variance
Count: 33
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 72 - diagnosticMsg
Count: 19
Errors: 0
Average Timestamp Delta: 5.588778
Max Timestamp Delta: 19.804000
Timestamp Drops: 9

122 changes: 122 additions & 0 deletions CLTool/VS_project/IS_logs/20180801_225711/stats_SN30235.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
Count: 2101
Errors: 0

Data Id: 1 - devInfo
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 3 - preintegratedImu
Count: 907
Errors: 0
Average Timestamp Delta: 0.121797
Max Timestamp Delta: 5.447597
Timestamp Drops: 66

Data Id: 5 - ins2
Count: 33
Errors: 0
Average Timestamp Delta: 3.287739
Max Timestamp Delta: 5.499878
Timestamp Drops: 6

Data Id: 6 - gpsPos
Count: 19
Errors: 0
Average Timestamp Delta: 5.844444
Max Timestamp Delta: 12.200000
Timestamp Drops: 8

Data Id: 7 - config
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 10 - sysParams
Count: 1
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 12 - flashCfg
Count: 3
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 21 - gpsRtkRel
Count: 18
Errors: 0
Average Timestamp Delta: 5.917647
Max Timestamp Delta: 19.800000
Timestamp Drops: 9

Data Id: 30 - DID_GPS1_VEL
Count: 20
Errors: 0
Average Timestamp Delta: 5.536842
Max Timestamp Delta: 12.200000
Timestamp Drops: 8

Data Id: 35 - userpage0
Count: 1
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 48 - inl2States
Count: 16
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 52 - magnetometer1
Count: 322
Errors: 0
Average Timestamp Delta: 0.343777
Max Timestamp Delta: 5.459597
Timestamp Drops: 94

Data Id: 53 - barometer
Count: 363
Errors: 0
Average Timestamp Delta: 0.304818
Max Timestamp Delta: 5.463577
Timestamp Drops: 102

Data Id: 55 - magnetometer2
Count: 325
Errors: 0
Average Timestamp Delta: 0.340593
Max Timestamp Delta: 5.459597
Timestamp Drops: 92

Data Id: 59 - inl2MagObs
Count: 15
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 67 - inl2Variance
Count: 33
Errors: 0
Average Timestamp Delta: 0.000000
Max Timestamp Delta: 0.000000
Timestamp Drops: 0

Data Id: 72 - diagnosticMsg
Count: 19
Errors: 0
Average Timestamp Delta: 5.588778
Max Timestamp Delta: 19.804000
Timestamp Drops: 9

Binary file not shown.
42 changes: 42 additions & 0 deletions CLTool/VS_project/IS_logs/20180801_225926/diagnostic_30235.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
RTK: 2018-08-02T04:59:47.00Z age of differential error (age=7653.5)
RTK: 2018-08-02T04:59:50.80Z age of differential error (age=7657.3)
RTK: 2018-08-02T04:59:58.40Z age of differential error (age=7664.9)
RTK: 2018-08-02T05:00:09.60Z age of differential error (age=7676.1)
RTK: 2018-08-02T05:00:12.40Z age of differential error (age=7678.9)
RTK: 2018-08-02T05:00:28.20Z age of differential error (age=7694.7)
RTK: 2018-08-02T05:00:31.00Z age of differential error (age=7697.5)
RTK: 2018-08-02T05:00:34.60Z age of differential error (age=7701.1)
RTK: 2018-08-02T05:00:47.80Z age of differential error (age=7714.3)
RTK: 2018-08-02T05:00:57.60Z age of differential error (age=7724.1)
RTK: 2018-08-02T05:01:01.20Z age of differential error (age=7727.7)
RTK: 2018-08-02T05:01:03.20Z age of differential error (age=7729.7)
RTK: 2018-08-02T05:01:07.00Z age of differential error (age=7733.5)
RTK: 2018-08-02T05:01:13.60Z age of differential error (age=7740.1)
RTK: 2018-08-02T05:01:18.60Z age of differential error (age=7745.1)
RTK: 2018-08-02T05:01:24.40Z age of differential error (age=7750.9)
RTK: 2018-08-02T05:01:33.40Z age of differential error (age=7759.9)
RTK: 2018-08-02T05:01:38.60Z age of differential error (age=7765.1)
RTK: 2018-08-02T05:01:46.60Z age of differential error (age=7773.1)
RTK: 2018-08-02T05:01:48.40Z age of differential error (age=7774.9)
RTK: 2018-08-02T05:01:50.00Z age of differential error (age=7776.5)
RTK: 2018-08-02T05:01:55.80Z age of differential error (age=7782.3)
RTK: 2018-08-02T05:01:59.60Z age of differential error (age=7786.1)
RTK: 2018-08-02T05:02:00.60Z age of differential error (age=7787.1)
RTK: 2018-08-02T05:02:12.00Z age of differential error (age=7798.5)
RTK: 2018-08-02T05:02:19.00Z age of differential error (age=7805.5)
RTK: 2018-08-02T05:02:29.20Z age of differential error (age=7815.7)
RTK: 2018-08-02T05:02:36.00Z age of differential error (age=7822.5)
RTK: 2018-08-02T05:02:38.20Z age of differential error (age=7824.7)
RTK: 2018-08-02T05:02:38.40Z age of differential error (age=7824.9)
RTK: 2018-08-02T05:02:47.60Z age of differential error (age=7834.1)
RTK: 2018-08-02T05:02:54.80Z age of differential error (age=7841.3)
RTK: 2018-08-02T05:02:55.40Z age of differential error (age=7841.9)
RTK: 2018-08-02T05:03:02.00Z age of differential error (age=7848.5)
RTK: 2018-08-02T05:03:07.00Z age of differential error (age=7853.5)
RTK: 2018-08-02T05:03:12.20Z age of differential error (age=7858.7)
RTK: 2018-08-02T05:03:17.80Z age of differential error (age=7864.3)
RTK: 2018-08-02T05:03:23.20Z age of differential error (age=7869.7)
RTK: 2018-08-02T05:03:34.00Z age of differential error (age=7880.5)
RTK: 2018-08-02T05:03:52.40Z age of differential error (age=7898.9)
RTK: 2018-08-02T05:03:56.60Z age of differential error (age=7903.1)
RTK: 2018-08-02T05:04:01.00Z age of differential error (age=7907.5)
Empty file.
Loading

0 comments on commit fe4c2d9

Please sign in to comment.