VMX-pi C++ HAL Library for Raspberry Pi
VMX-pi Robotics Controller & Vision/Motion Processor
VMXVersion.h
1 /* ============================================
2 VMX-pi HAL source code is placed under the MIT license
3 Copyright (c) 2017 Kauai Labs
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 The above copyright notice and this permission notice shall be included in
11 all copies or substantial portions of the Software.
12 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
17 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
18 THE SOFTWARE.
19 ===============================================
20 */
21 
22 #ifndef VMXVERSION_H_
23 #define VMXVERSION_H_
24 
25 #include <string>
26 #include "AHRS.h"
27 
29 class VMXVersion {
30 
31  friend class VMXPi;
32  friend class VMXZero;
33 
34  vmx::AHRS& ahrs;
35 
36  VMXVersion(vmx::AHRS& ahrs_ref);
37  void ReleaseResources();
38  virtual ~VMXVersion();
39 
40 public:
41  std::string GetFirmwareVersion();
42  std::string GetHALVersion();
43 };
44 
45 #endif /* VMXVERSION_H_ */
Top-level Library Class providing access to all VMX-pi functionality.
Definition: VMXPi.h:40
std::string GetHALVersion()
Returns the current VMX HAL Library Version.
Definition: VMXVersion.cpp:47
vmx::AHRS ahrs
The AHRS object providing access to VMXzero IMU functionality.
Definition: VMXZero.h:56
The VMXVersion class provides library version management functions.
Definition: VMXVersion.h:29
The AHRS class provides accesst to the VMX-pi IMU and Attitude/Heading Reference System functionality...
Definition: AHRS.h:59
std::string GetFirmwareVersion()
Returns the current VMX Firmware Version.
Definition: VMXVersion.cpp:34
Top-level Library Class providing access to all VMXzero functionality.
Definition: VMXZero.h:40