Hermes SDK Documentation
HermesSDK.h
Go to the documentation of this file.
1 #pragma once
3 
5 #include "protodefinitions/Landscape.pb.h"
6 #include "protodefinitions/Devices.pb.h"
7 #include "protodefinitions/MeshConfig.pb.h"
8 #include "LeafInfo.h"
9 
10 namespace HermesSDK
11 {
19  void ConnectLocal(const std::string& _clientName,
20  const std::string& _clientInfo,
21  HermesSDK::filterSetupCallback& _onFilterSetup,
22  HermesSDK::deviceDataCallback& _onDeviceData,
23  HermesSDK::deviceLandscapeCallback& _onDeviceLandscape,
25 
32  HermesSDK::deviceDataCallback& _onDeviceData,
33  HermesSDK::deviceLandscapeCallback& _onDeviceLandscape,
35 
36 
45  void ConnectNetworkHostName(const std::string& _clientName,
46  const std::string& _clientInfo,
47  const std::string& _hostName,
48  HermesSDK::filterSetupCallback& _onFilterSetup,
49  HermesSDK::deviceDataCallback& _onDeviceData,
50  HermesSDK::deviceLandscapeCallback& _onDeviceLandscape,
52 
53 
62  void ConnectNetworkAddress(const std::string& _clientName,
63  const std::string& _clientInfo,
64  const std::string& _address,
65  HermesSDK::filterSetupCallback& _onFilterSetup,
66  HermesSDK::deviceDataCallback& _onDeviceData,
67  HermesSDK::deviceLandscapeCallback& _onDeviceLandscape,
69 
77  bool VibrateWrist(uint32_t _deviceId, float _unitStrength, uint16_t _durationInMilliseconds);
78 
85  bool VibrateFingers(uint32_t _dongleId, Hermes::Protocol::HandType _handType, const std::array<float, 5>& _powers);
86 
89  void Stop();
90 
93  bool IsRunning();
94 
101 
105 
109  bool SetPipeline(Hermes::Protocol::Pipeline* _pipeline);
110 
111 
112  std::map<std::string, std::string> GetFoundHosts();
113 
120 }
HermesSDK::filterSetupCallback
std::function< void(Hermes::Protocol::Pipeline &_pipeline)> filterSetupCallback
Typedef to support callback for filter pipeline data.
Definition: HermesCallbackTypes.hpp:61
HermesSDK::errorMessageCallback
std::function< void(const ErrorMessage &msg)> errorMessageCallback
Typedef to support callback for error messages.
Definition: HermesCallbackTypes.hpp:63
Hermes::Protocol::FilterInventory
Definition: Pipeline.proto:17
HermesSDK::Stop
void Stop()
Definition: HermesSDK.cpp:119
HermesSDK::FindNetworkHosts
void FindNetworkHosts(HermesSDK::filterSetupCallback &_onFilterSetup, HermesSDK::deviceDataCallback &_onDeviceData, HermesSDK::deviceLandscapeCallback &_onDeviceLandscape, HermesSDK::errorMessageCallback &_onError)
Definition: HermesSDK.cpp:74
Hermes::Protocol::Hardware::DeviceLeaf
Definition: Landscape.proto:19
HermesSDK::VibrateWrist
bool VibrateWrist(uint32_t _deviceId, float _unitStrength, uint16_t _durationInMilliseconds)
Definition: HermesSDK.cpp:132
HermesCallbackTypes.hpp
HermesSDK::GetFilterInventory
bool GetFilterInventory(Hermes::Protocol::FilterInventory &_inventory)
Definition: HermesSDK.cpp:147
HermesSDK::IsRunning
bool IsRunning()
Definition: HermesSDK.cpp:142
HermesSDK::VibrateFingers
bool VibrateFingers(uint32_t _dongleId, Hermes::Protocol::HandType _handType, const std::array< float, 5 > &_powers)
Definition: HermesSDK.cpp:137
HermesSDK::ConnectNetworkHostName
void ConnectNetworkHostName(const std::string &_clientName, const std::string &_clientInfo, const std::string &_hostName, HermesSDK::filterSetupCallback &_onFilterSetup, HermesSDK::deviceDataCallback &_onDeviceData, HermesSDK::deviceLandscapeCallback &_onDeviceLandscape, HermesSDK::errorMessageCallback &_onError)
Definition: HermesSDK.cpp:86
HermesSDK::ConnectLocal
void ConnectLocal(const std::string &_clientName, const std::string &_clientInfo, HermesSDK::filterSetupCallback &_onFilterSetup, HermesSDK::deviceDataCallback &_onDeviceData, HermesSDK::deviceLandscapeCallback &_onDeviceLandscape, HermesSDK::errorMessageCallback &_onError)
Definition: HermesSDK.cpp:61
HermesSDK::SetPipeline
bool SetPipeline(Hermes::Protocol::Pipeline *_pipeline)
Definition: HermesSDK.cpp:157
HermesSDK::ConnectNetworkAddress
void ConnectNetworkAddress(const std::string &_clientName, const std::string &_clientInfo, const std::string &_address, HermesSDK::filterSetupCallback &_onFilterSetup, HermesSDK::deviceDataCallback &_onDeviceData, HermesSDK::deviceLandscapeCallback &_onDeviceLandscape, HermesSDK::errorMessageCallback &_onError)
Definition: HermesSDK.cpp:102
HermesSDK::GetLeafInfo
LeafInfo GetLeafInfo(Hermes::Protocol::Hardware::DeviceLeaf &leaf)
Definition: HermesSDK.cpp:162
HermesSDK::GetActivePipeline
Hermes::Protocol::Pipeline * GetActivePipeline()
Definition: HermesSDK.cpp:152
HermesSDK::deviceDataCallback
std::function< void(const Hermes::Protocol::Devices &_devices)> deviceDataCallback
Typedef to support callback for device data
Definition: HermesCallbackTypes.hpp:57
Hermes::Protocol::Pipeline
Definition: Pipeline.proto:23
LeafInfo
Definition: LeafInfo.h:12
HermesSDK::deviceLandscapeCallback
std::function< void(const Hermes::Protocol::Hardware::DeviceLandscape &_landscape)> deviceLandscapeCallback
Typedef to support callback for landscape (connected devices) data.
Definition: HermesCallbackTypes.hpp:59