VMX-pi C++ HAL Library for Raspberry Pi
VMX-pi Robotics Controller & Vision/Motion Processor
VMXPi.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 VMXPI_H_
23 #define VMXPI_H_
24 
25 #include <stdint.h>
26 #include "AHRS.h"
27 #include "VMXCAN.h"
28 #include "VMXIO.h"
29 #include "VMXPower.h"
30 #include "VMXTime.h"
31 #include "VMXVersion.h"
32 #include "VMXThread.h"
33 
34 class VMXPiImpl;
35 
37 class VMXPi {
38 
39  VMXPiImpl* p_impl;
40 
41 public:
42 
57 
58  VMXPi(bool realtime, uint8_t ahrs_update_rate_hz);
59  virtual ~VMXPi();
60 
61  bool IsOpen();
62 };
63 
64 #endif /* VMXPI_H_ */
VMXCAN can
The VMXCAN object providing access to VMX-pi CAN functionality.
Definition: VMXPi.h:50
Top-level Library Class providing access to all VMX-pi functionality.
Definition: VMXPi.h:37
VMXVersion version
The VMXVersion object providing access to VMX-pi Version functionality.
Definition: VMXPi.h:54
The VMXPower class provides access to VMX power management functions.
Definition: VMXPower.h:30
The VMXThread class provides thread management functions.
Definition: VMXThread.h:32
bool IsOpen()
Returns true if the communication with the VMX-pi firmware has been established.
Definition: VMXPi.cpp:53
The AHRS class provides accesst to the VMX-pi IMU and Attitude/Heading Reference System functionality...
Definition: AHRS.h:38
The VMXVersion class provides library version management functions.
Definition: VMXVersion.h:28
VMXPower power
The VMXPower object providing access to VMX-pi Power functionality.
Definition: VMXPi.h:52
VMXPi(bool realtime, uint8_t ahrs_update_rate_hz)
Constructs the VMXPi object using the specified parameters.
Definition: VMXPi.cpp:26
VMXTime time
The VMXTime object providing access to VMX-pi Time functionality.
Definition: VMXPi.h:46
The VMXTime class provides time management functions, including system timestamps, VMX Real-time Clock access, timer notifications and current thread time-delay.
Definition: VMXTime.h:38
The VMXIO class provides access to VMX Analog/Digital IO functions, including VMX Channel and VMX Res...
Definition: VMXIO.h:41
AHRS ahrs
The AHRS object providing access to VMX-pi IMU functionality.
Definition: VMXPi.h:44
The VMXCAN class provides a hardware-abstraction of the VMX-pi CAN functionality. ...
Definition: VMXCAN.h:98
VMXIO io
The VMXIO object providing access to VMX-pi IO functionality.
Definition: VMXPi.h:48
VMXThread thread
The VMXThread object providing access to VMX-pi Threading functionality.
Definition: VMXPi.h:56