From 14404f045fcc0b7fcae4c96448d80696ce905825 Mon Sep 17 00:00:00 2001 From: aiab Date: Wed, 15 Aug 2018 15:21:38 +0200 Subject: [PATCH 1/4] update readme with new download information and vs2015 support --- README | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README b/README index a97990b..300c859 100644 --- a/README +++ b/README @@ -14,18 +14,20 @@ The tools required to fully build libfreespace are: Ubuntu: sudo apt-get install git 2) Python v2.7 - Windows: http://www.python.org/download/releases/2.7.5/ + Windows: http://www.python.org/download/releases/2.7.5/#download Update the environment variable PATH to include the folder that contain python.exe. Ubuntu: sudo apt-get install python 3) Doxygen v1.8.0 (older versions will have formatting problems) - Windows: http://www.stack.nl/~dimitri/doxygen/download.html + Windows: http://www.stack.nl/~dimitri/doxygen/download.html#srcbin Ubuntu: You cannot use apt-get for doxygen because the version is too old. Instead, get it from the Doxygen download page. 4) Graphviz v2.30.1 - Windows: http://www.graphviz.org/Download_windows.php + Windows: https://graphviz.gitlab.io/_pages/Download/Download_windows.html + Update the environment variable PATH to include the folder that + contain dot.exe. Ubuntu: sudo apt-get install graphviz 5) CMake v2.8 http://www.cmake.org/ @@ -93,7 +95,8 @@ Windows: Visual Studio 10 (2010) Visual Studio 11 (2012) Visual Studio 12 (2013) - + Visual Studio 14 (2015) + Linux: Unix Makefiles From ff80530b36b311c440e58b1f1d61430e63e09ad7 Mon Sep 17 00:00:00 2001 From: aiab Date: Wed, 15 Aug 2018 16:04:25 +0200 Subject: [PATCH 2/4] fix indentation in README and add build to gitignore. --- .gitignore | 1 + README | 38 +++++++++++++++++++------------------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index dc52d9b..7a064e9 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,4 @@ install_manifest.txt *.lai *.la *.a +/build diff --git a/README b/README index 300c859..19dd09e 100644 --- a/README +++ b/README @@ -10,35 +10,35 @@ Required Tools The tools required to fully build libfreespace are: 1) git - Use a stable release. - Windows: https://git-scm.com/download/win - Ubuntu: sudo apt-get install git + Windows: https://git-scm.com/download/win + Ubuntu: sudo apt-get install git 2) Python v2.7 - Windows: http://www.python.org/download/releases/2.7.5/#download + Windows: http://www.python.org/download/releases/2.7.5/#download Update the environment variable PATH to include the folder that contain python.exe. - Ubuntu: sudo apt-get install python + Ubuntu: sudo apt-get install python 3) Doxygen v1.8.0 (older versions will have formatting problems) - Windows: http://www.stack.nl/~dimitri/doxygen/download.html#srcbin + Windows: http://www.stack.nl/~dimitri/doxygen/download.html#srcbin Ubuntu: You cannot use apt-get for doxygen because the version is too old. Instead, get it from the Doxygen download page. 4) Graphviz v2.30.1 - Windows: https://graphviz.gitlab.io/_pages/Download/Download_windows.html + Windows: https://graphviz.gitlab.io/_pages/Download/Download_windows.html Update the environment variable PATH to include the folder that contain dot.exe. - Ubuntu: sudo apt-get install graphviz + Ubuntu: sudo apt-get install graphviz -5) CMake v2.8 http://www.cmake.org/ - Windows: http://www.cmake.org/cmake/resources/software.html - Ubuntu: sudo apt-get install cmake - sudo apt-get install cmake-gui +5) CMake v2.8 http://www.cmake.org/ + Windows: http://www.cmake.org/cmake/resources/software.html + Ubuntu: sudo apt-get install cmake + sudo apt-get install cmake-gui If using Microsoft Windows: 6) MS Visual Studio 10 (2010) or above - The "Express" versions work just fine, although they lack 64-bit compilers. + The "Express" versions work just fine, although they lack 64-bit compilers. Only the Visual C/C++ parts are necessary. 7) Windows Driver Development Kit (WinDDK) 7.1.0 @@ -57,10 +57,10 @@ If using Linux: 6) GNU Make and GNU G++ The best way to get these is to get the build-essential package. This should be available for most Linux distros. - Ubuntu: sudo apt-get install build-essential + Ubuntu: sudo apt-get install build-essential -7) libusb http://www.libusb.org/ - Ubuntu: sudo apt-get install libusb-1.0-0-dev +7) libusb http://www.libusb.org/ + Ubuntu: sudo apt-get install libusb-1.0-0-dev Getting the files @@ -99,7 +99,7 @@ Windows: Linux: - Unix Makefiles + Unix Makefiles At this point, all the configuration settings will be red. This is the time to make any changes to the settings that are displayed. Not all settings are @@ -121,9 +121,9 @@ them at your libusb installation. There are other configuration settings available: CMAKE_INSTALL_PREFIX : - The installation directory where the CMake install project will install to. - This is initiated by building the "INSTALL" project in the VS solution. - Default is typically "C:\Program Files (x86)\libfreespace" + The installation directory where the CMake install project will install to. + This is initiated by building the "INSTALL" project in the VS solution. + Default is typically "C:\Program Files (x86)\libfreespace" LIBFREESPACE_BACKEND : Specify an alternate backend on some paltforms. On Linux, valid values are 'hidraw' and 'libusb' From 81c82c36931671769cd16e67b47f04e47b98c680 Mon Sep 17 00:00:00 2001 From: aiab Date: Thu, 16 Aug 2018 10:39:06 +0200 Subject: [PATCH 3/4] update readme with vs2017 support --- README | 1 + 1 file changed, 1 insertion(+) diff --git a/README b/README index 19dd09e..099677b 100644 --- a/README +++ b/README @@ -96,6 +96,7 @@ Windows: Visual Studio 11 (2012) Visual Studio 12 (2013) Visual Studio 14 (2015) + Visual Studio 15 (2017) Linux: From 93ca745d98bb859d43543eb7206e59f61af0dffb Mon Sep 17 00:00:00 2001 From: aiab Date: Thu, 16 Aug 2018 21:36:12 +0200 Subject: [PATCH 4/4] fix table formatting in documentation (otherwise doxygen generates a incorrect number of columns) --- doc/mainpage.h.in | 50 +++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/mainpage.h.in b/doc/mainpage.h.in index 0d838f9..90ba8ce 100644 --- a/doc/mainpage.h.in +++ b/doc/mainpage.h.in @@ -15,32 +15,32 @@ */ /*! - \ingroup messages - \anchor meoutformatinfo - \page meoutformat MotionEngine Output Format + \ingroup messages + \anchor meoutformatinfo + \page meoutformat MotionEngine Output Format - When the user requests motion from a Freespace device using a - Data Mode Control V2 Request, the user must provide a Format by setting the - formatSelect field and then request data fields by setting the appropriate Format - Flags. The Format determines the different data fields that can be - transmitted, and the Format Flags determine which fields are actually - transmitted in the MotionEngine Output Packet. The MotionEngine Output Packets - that are transmitted in response to a Data Mode Control V2 Request will have - the same formatSelect and Format Flag values as the Request, plus the appropriate - real-time data. Below is a table which outlines the available data fields by - Format and Format Flag: + When the user requests motion from a Freespace device using a + Data Mode Control V2 Request, the user must provide a Format by setting the + formatSelect field and then request data fields by setting the appropriate Format + Flags. The Format determines the different data fields that can be + transmitted, and the Format Flags determine which fields are actually + transmitted in the MotionEngine Output Packet. The MotionEngine Output Packets + that are transmitted in response to a Data Mode Control V2 Request will have + the same formatSelect and Format Flag values as the Request, plus the appropriate + real-time data. Below is a table which outlines the available data fields by + Format and Format Flag: - Format Flag | formatSelect = 0 | formatSelect = 1 | formatSelect = 2 | formatSelect = 3 - ----------------|-----------------------|-----------------------|-----------------------|------------------- - FF0 | Pointer | Acceleration | Reserved | Pointer - FF1 | Linear Acceleration | Linear Acceleration, No Gravity | Reserved | Linear Acceleration - FF2 | Linear Acceleration, No Gravity | Angular Velocity | Reserved | Linear Acceleration, No Gravity - FF3 | Angular Velocity | Magnetometer | Reserved | Angular Velocity - FF4 | Magnetometer | Inclination | Reserved | Magnetometer - FF5 | Temperature | Compass Heading | Reserved | Temperature - FF6 | Angular Position (WXYZ) | Angular Position (XYZW) | Reserved | Angular Position (WXYZ) - FF7 | Reserved | Activity Classification/Power Management Flags | Reserved | Reserved + | Format Flag | formatSelect = 0 | formatSelect = 1 | formatSelect = 2 | formatSelect = 3 | + | ----------- | ------------------------------- | ---------------------------------------------- | ---------------- | ------------------------------- | + | FF0 | Pointer | Acceleration | Reserved | Pointer | + | FF1 | Linear Acceleration | Linear Acceleration, No Gravity | Reserved | Linear Acceleration | + | FF2 | Linear Acceleration, No Gravity | Angular Velocity | Reserved | Linear Acceleration, No Gravity | + | FF3 | Angular Velocity | Magnetometer | Reserved | Angular Velocity | + | FF4 | Magnetometer | Inclination | Reserved | Magnetometer | + | FF5 | Temperature | Compass Heading | Reserved | Temperature | + | FF6 | Angular Position (WXYZ) | Angular Position (XYZW) | Reserved | Angular Position (WXYZ) | + | FF7 | Reserved | Activity Classification/Power Management Flags | Reserved | Reserved | - For more information about using the Data Mode Control V2 Request and MotionEngine Output Packet, or for detailed - information about the meaning, units, and orientation of these data fields, please refer to the 1000-2984 HCOMM Reference Manual. + For more information about using the Data Mode Control V2 Request and MotionEngine Output Packet, or for detailed + information about the meaning, units, and orientation of these data fields, please refer to the 1000-2984 HCOMM Reference Manual. */ \ No newline at end of file