OpenZWave Library  1.6.784
Manager.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Manager.h
4 //
5 // The main public interface to OpenZWave.
6 //
7 // Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
8 //
9 // SOFTWARE NOTICE AND LICENSE
10 //
11 // This file is part of OpenZWave.
12 //
13 // OpenZWave is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU Lesser General Public License as published
15 // by the Free Software Foundation, either version 3 of the License,
16 // or (at your option) any later version.
17 //
18 // OpenZWave is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU Lesser General Public License for more details.
22 //
23 // You should have received a copy of the GNU Lesser General Public License
24 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
25 //
26 //-----------------------------------------------------------------------------
27 
28 #ifndef _Manager_H
29 #define _Manager_H
30 
31 #include <string>
32 #include <cstring>
33 #include <vector>
34 #include <map>
35 #include <list>
36 #include <deque>
37 
38 #include "Defs.h"
39 #include "Driver.h"
40 #include "Group.h"
41 #include "value_classes/ValueID.h"
42 
43 namespace OpenZWave
44 {
45  namespace Internal
46  {
47  namespace CC
48  {
49  class CommandClass;
50  }
51  namespace VC
52  {
53  class Value;
54  class ValueStore;
55  }
56  class Msg;
57  }
58  class Options;
59  class Node;
60  class Notification;
61 
108  class OPENZWAVE_EXPORT Manager
109  {
110  friend class Driver;
111  friend class Internal::CC::CommandClass;
112  friend class Group;
113  friend class Node;
114  friend class Internal::VC::Value;
115  friend class Internal::VC::ValueStore;
116  friend class Internal::Msg;
117 
118  public:
119  typedef void (*pfnOnNotification_t)(Notification const* _pNotification, void* _context);
120 
121  //-----------------------------------------------------------------------------
122  // Construction
123  //-----------------------------------------------------------------------------
128  public:
141  static Manager* Create();
142 
148  static Manager* Get()
149  {
150  return s_instance;
151  }
152 
157  static void Destroy();
158 
163  static std::string getVersionAsString();
164 
169  static std::string getVersionLongAsString();
170 
175  static ozwversion getVersion();
178  private:
179  Manager(); // Constructor, to be called only via the static Create method.
180  virtual ~Manager(); // Destructor, to be called only via the static Destroy method.
181 
182  bool m_exit; // Flag indicating that program exit is in progress.
183  static Manager* s_instance; // Pointer to the instance of the Manager singleton.
184 
185  //-----------------------------------------------------------------------------
186  // Configuration
187  //-----------------------------------------------------------------------------
193  public:
205  DEPRECATED void WriteConfig(uint32 const _homeId);
206 
212  Options* GetOptions() const
213  {
214  return m_options;
215  }
218  private:
219  Options* m_options; // Pointer to the locked Options object that was passed in during creation.
220 
221  //-----------------------------------------------------------------------------
222  // Drivers
223  //-----------------------------------------------------------------------------
228  public:
241  bool AddDriver(string const& _controllerPath, Driver::ControllerInterface const& _interface = Driver::ControllerInterface_Serial);
242 
253  bool RemoveDriver(string const& _controllerPath);
254 
260  uint8 GetControllerNodeId(uint32 const _homeId);
261 
267  uint8 GetSUCNodeId(uint32 const _homeId);
268 
283  bool IsPrimaryController(uint32 const _homeId);
284 
292  bool IsStaticUpdateController(uint32 const _homeId);
293 
301  bool IsBridgeController(uint32 const _homeId);
302 
310  bool HasExtendedTxStatus(uint32 const _homeId);
311 
317  string GetLibraryVersion(uint32 const _homeId);
318 
338  string GetLibraryTypeName(uint32 const _homeId);
339 
345  int32 GetSendQueueCount(uint32 const _homeId);
346 
351  void LogDriverStatistics(uint32 const _homeId);
352 
357  Driver::ControllerInterface GetControllerInterfaceType(uint32 const _homeId);
358 
363  string GetControllerPath(uint32 const _homeId);
366  private:
367  Driver* GetDriver(uint32 const _homeId);
368  void SetDriverReady(Driver* _driver, bool success);
370  OPENZWAVE_EXPORT_WARNINGS_OFF
371  list<Driver*> m_pendingDrivers;
372  map<uint32, Driver*> m_readyDrivers;
373  OPENZWAVE_EXPORT_WARNINGS_ON
374 
375  //-----------------------------------------------------------------------------
376  // Polling Z-Wave devices
377  //-----------------------------------------------------------------------------
384  public:
388  int32 GetPollInterval();
389 
401  void SetPollInterval(int32 _milliseconds, bool _bIntervalBetweenPolls);
402 
409  bool EnablePoll(ValueID const &_valueId, uint8 const _intensity = 1);
410 
416  bool DisablePoll(ValueID const &_valueId);
417 
423  bool isPolled(ValueID const &_valueId);
424 
429  void SetPollIntensity(ValueID const &_valueId, uint8 const _intensity);
430 
438  uint8 GetPollIntensity(ValueID const &_valueId);
439 
442  //-----------------------------------------------------------------------------
443  // Node information
444  //-----------------------------------------------------------------------------
449  public:
460  bool RefreshNodeInfo(uint32 const _homeId, uint8 const _nodeId);
461 
470  bool RequestNodeState(uint32 const _homeId, uint8 const _nodeId);
471 
480  bool RequestNodeDynamic(uint32 const _homeId, uint8 const _nodeId);
481 
488  bool IsNodeListeningDevice(uint32 const _homeId, uint8 const _nodeId);
489 
497  bool IsNodeFrequentListeningDevice(uint32 const _homeId, uint8 const _nodeId);
498 
505  bool IsNodeBeamingDevice(uint32 const _homeId, uint8 const _nodeId);
506 
513  bool IsNodeRoutingDevice(uint32 const _homeId, uint8 const _nodeId);
514 
521  bool IsNodeSecurityDevice(uint32 const _homeId, uint8 const _nodeId);
522 
529  uint32 GetNodeMaxBaudRate(uint32 const _homeId, uint8 const _nodeId);
530 
537  uint8 GetNodeVersion(uint32 const _homeId, uint8 const _nodeId);
538 
545  uint8 GetNodeSecurity(uint32 const _homeId, uint8 const _nodeId);
546 
554  bool IsNodeZWavePlus(uint32 const _homeId, uint8 const _nodeId);
555 
562  uint8 GetNodeBasic(uint32 const _homeId, uint8 const _nodeId);
563 
570  uint8 GetNodeGeneric(uint32 const _homeId, uint8 const _nodeId);
571 
578  uint8 GetNodeSpecific(uint32 const _homeId, uint8 const _nodeId);
579 
587  string GetNodeType(uint32 const _homeId, uint8 const _nodeId);
588 
596  uint32 GetNodeNeighbors(uint32 const _homeId, uint8 const _nodeId, uint8** _nodeNeighbors);
597 
611  string GetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId);
612 
626  string GetNodeProductName(uint32 const _homeId, uint8 const _nodeId);
627 
640  string GetNodeName(uint32 const _homeId, uint8 const _nodeId);
641 
653  string GetNodeLocation(uint32 const _homeId, uint8 const _nodeId);
654 
669  string GetNodeManufacturerId(uint32 const _homeId, uint8 const _nodeId);
670 
685  string GetNodeProductType(uint32 const _homeId, uint8 const _nodeId);
686 
701  string GetNodeProductId(uint32 const _homeId, uint8 const _nodeId);
702 
716  void SetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId, string const& _manufacturerName);
717 
731  void SetNodeProductName(uint32 const _homeId, uint8 const _nodeId, string const& _productName);
732 
746  void SetNodeName(uint32 const _homeId, uint8 const _nodeId, string const& _nodeName);
747 
760  void SetNodeLocation(uint32 const _homeId, uint8 const _nodeId, string const& _location);
761 
774  DEPRECATED void SetNodeOn(uint32 const _homeId, uint8 const _nodeId);
775 
786  DEPRECATED void SetNodeOff(uint32 const _homeId, uint8 const _nodeId);
787 
800  DEPRECATED void SetNodeLevel(uint32 const _homeId, uint8 const _nodeId, uint8 const _level);
801 
808  bool IsNodeInfoReceived(uint32 const _homeId, uint8 const _nodeId);
809 
817  bool GetNodeClassInformation(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, string *_className = NULL, uint8 *_classVersion = NULL);
824  bool IsNodeAwake(uint32 const _homeId, uint8 const _nodeId);
825 
832  bool IsNodeFailed(uint32 const _homeId, uint8 const _nodeId);
833 
840  string GetNodeQueryStage(uint32 const _homeId, uint8 const _nodeId);
841 
848  uint16 GetNodeDeviceType(uint32 const _homeId, uint8 const _nodeId);
849 
856  string GetNodeDeviceTypeString(uint32 const _homeId, uint8 const _nodeId);
857 
864  uint8 GetNodeRole(uint32 const _homeId, uint8 const _nodeId);
865 
872  string GetNodeRoleString(uint32 const _homeId, uint8 const _nodeId);
873 
880  uint8 GetNodePlusType(uint32 const _homeId, uint8 const _nodeId);
887  string GetNodePlusTypeString(uint32 const _homeId, uint8 const _nodeId);
888 
891  //-----------------------------------------------------------------------------
892  // Instances
893  //-----------------------------------------------------------------------------
898  public:
908  string GetInstanceLabel(ValueID const &_id);
909 
922  string GetInstanceLabel(uint32 const _homeId, uint8 const _node, uint8 const _cc, uint8 const _instance);
923 
925  //-----------------------------------------------------------------------------
926  // Values
927  //-----------------------------------------------------------------------------
933  public:
943  string GetValueLabel(ValueID const& _id, int32 _pos = -1);
944 
954  void SetValueLabel(ValueID const& _id, string const& _value, int32 _pos = -1);
955 
964  string GetValueUnits(ValueID const& _id);
965 
974  void SetValueUnits(ValueID const& _id, string const& _value);
975 
985  string GetValueHelp(ValueID const& _id, int32 _pos = -1);
986 
996  void SetValueHelp(ValueID const& _id, string const& _value, int32 _pos = -1);
997 
1006  int32 GetValueMin(ValueID const& _id);
1007 
1016  int32 GetValueMax(ValueID const& _id);
1017 
1026  bool IsValueReadOnly(ValueID const& _id);
1027 
1036  bool IsValueWriteOnly(ValueID const& _id);
1037 
1046  bool IsValueSet(ValueID const& _id);
1047 
1056  bool IsValuePolled(ValueID const& _id);
1057 
1069  bool GetValueAsBitSet(ValueID const& _id, uint8 _pos, bool* o_value);
1070 
1081  bool GetValueAsBool(ValueID const& _id, bool* o_value);
1082 
1093  bool GetValueAsByte(ValueID const& _id, uint8* o_value);
1094 
1105  bool GetValueAsFloat(ValueID const& _id, float* o_value);
1106 
1117  bool GetValueAsInt(ValueID const& _id, int32* o_value);
1118 
1129  bool GetValueAsShort(ValueID const& _id, int16* o_value);
1130 
1142  bool GetValueAsString(ValueID const& _id, string* o_value);
1143 
1155  bool GetValueAsRaw(ValueID const& _id, uint8** o_value, uint8* o_length);
1156 
1167  bool GetValueListSelection(ValueID const& _id, string* o_value);
1168 
1179  bool GetValueListSelection(ValueID const& _id, int32* o_value);
1180 
1191  bool GetValueListItems(ValueID const& _id, vector<string>* o_value);
1192 
1203  bool GetValueListValues(ValueID const& _id, vector<int32>* o_value);
1204 
1215  bool GetValueFloatPrecision(ValueID const& _id, uint8* o_value);
1216 
1231  bool SetValue(ValueID const& _id, uint8 _pos, bool const _value);
1232 
1246  bool SetValue(ValueID const& _id, bool const _value);
1247 
1260  bool SetValue(ValueID const& _id, uint8 const _value);
1261 
1275  bool SetValue(ValueID const& _id, float const _value);
1276 
1289  bool SetValue(ValueID const& _id, int32 const _value);
1290 
1303  bool SetValue(ValueID const& _id, int16 const _value);
1304 
1317  bool SetValue(ValueID const& _id, uint8 const* _value, uint8 const _length);
1318 
1331  bool SetValue(ValueID const& _id, string const& _value);
1332 
1346  bool SetValueListSelection(ValueID const& _id, string const& _selectedItem);
1347 
1357  bool RefreshValue(ValueID const& _id);
1358 
1369  void SetChangeVerified(ValueID const& _id, bool _verify);
1370 
1380  bool GetChangeVerified(ValueID const& _id);
1381 
1391  bool PressButton(ValueID const& _id);
1392 
1402  bool ReleaseButton(ValueID const& _id);
1403 
1414  bool SetBitMask(ValueID const& _id, uint32 _mask);
1415 
1426  bool GetBitMask(ValueID const& _id, int32* o_mask);
1427 
1438  bool GetBitSetSize(ValueID const& _id, uint8* o_size);
1439 
1442  //-----------------------------------------------------------------------------
1443  // Climate Control Schedules
1444  //-----------------------------------------------------------------------------
1458 
1467  uint8 GetNumSwitchPoints(ValueID const& _id);
1468 
1488  bool SetSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes, int8 const _setback);
1489 
1505  bool RemoveSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes);
1506 
1515  void ClearSwitchPoints(ValueID const& _id);
1516 
1534  bool GetSwitchPoint(ValueID const& _id, uint8 const _idx, uint8* o_hours, uint8* o_minutes, int8* o_setback);
1535 
1538  //-----------------------------------------------------------------------------
1539  // SwitchAll
1540  //-----------------------------------------------------------------------------
1548 
1554  DEPRECATED void SwitchAllOn(uint32 const _homeId);
1555 
1561  DEPRECATED void SwitchAllOff(uint32 const _homeId);
1562 
1565  //-----------------------------------------------------------------------------
1566  // Configuration Parameters
1567  //-----------------------------------------------------------------------------
1577  public:
1593  bool SetConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param, int32 _value, uint8 const _size = 2);
1594 
1610  void RequestConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param);
1611 
1618  void RequestAllConfigParams(uint32 const _homeId, uint8 const _nodeId);
1621  //-----------------------------------------------------------------------------
1622  // Groups (wrappers for the Node methods)
1623  //-----------------------------------------------------------------------------
1628  public:
1638  uint8 GetNumGroups(uint32 const _homeId, uint8 const _nodeId);
1639 
1651  uint32 GetAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8** o_associations);
1652 
1664  uint32 GetAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, InstanceAssociation** o_associations);
1665 
1674  uint8 GetMaxAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1675 
1684  bool IsMultiInstance(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1685 
1694  string GetGroupLabel(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1695 
1708  void AddAssociation(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
1709 
1722  void RemoveAssociation(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
1723 
1726  //-----------------------------------------------------------------------------
1727  // Notifications
1728  //-----------------------------------------------------------------------------
1733  public:
1744  bool AddWatcher(pfnOnNotification_t _watcher, void* _context);
1745 
1753  bool RemoveWatcher(pfnOnNotification_t _watcher, void* _context);
1756  private:
1757  void NotifyWatchers(Notification* _notification); // Passes the notifications to all the registered watcher callbacks in turn.
1758 
1759  struct Watcher
1760  {
1761  pfnOnNotification_t m_callback;
1762  void* m_context;
1763 
1764  Watcher(pfnOnNotification_t _callback, void* _context) :
1765  m_callback(_callback), m_context(_context)
1766  {
1767  }
1768  };
1769 
1770  OPENZWAVE_EXPORT_WARNINGS_OFF
1771  list<Watcher*> m_watchers; // List of all the registered watchers.
1772  list<list<Watcher*>::iterator*> m_watcherIterators; // Iterators currently operating on the list of watchers
1773  OPENZWAVE_EXPORT_WARNINGS_ON
1774  Internal::Platform::Mutex* m_notificationMutex;
1775 
1776  //-----------------------------------------------------------------------------
1777  // Controller commands
1778  //-----------------------------------------------------------------------------
1783  public:
1790  void ResetController(uint32 const _homeId);
1791 
1798  void SoftReset(uint32 const _homeId);
1799 
1856  DEPRECATED bool BeginControllerCommand(uint32 const _homeId, Driver::ControllerCommand _command, Driver::pfnControllerCallback_t _callback = NULL, void* _context = NULL, bool _highPower = false, uint8 _nodeId = 0xff, uint8 _arg = 0);
1857 
1864  bool CancelControllerCommand(uint32 const _homeId);
1867  //-----------------------------------------------------------------------------
1868  // Network commands
1869  //-----------------------------------------------------------------------------
1875  public:
1883  void TestNetworkNode(uint32 const _homeId, uint8 const _nodeId, uint32 const _count);
1884 
1892  void TestNetwork(uint32 const _homeId, uint32 const _count);
1893 
1901  void HealNetworkNode(uint32 const _homeId, uint8 const _nodeId, bool _doRR);
1902 
1910  void HealNetwork(uint32 const _homeId, bool _doRR);
1911 
1925  bool AddNode(uint32 const _homeId, bool _doSecurity = true);
1926 
1939  bool RemoveNode(uint32 const _homeId);
1940 
1957  bool RemoveFailedNode(uint32 const _homeId, uint8 const _nodeId);
1958 
1973  bool HasNodeFailed(uint32 const _homeId, uint8 const _nodeId);
1974 
1987  bool RequestNodeNeighborUpdate(uint32 const _homeId, uint8 const _nodeId);
1988 
2001  bool AssignReturnRoute(uint32 const _homeId, uint8 const _nodeId);
2002 
2015  bool DeleteAllReturnRoutes(uint32 const _homeId, uint8 const _nodeId);
2016 
2026  bool SendNodeInformation(uint32 const _homeId, uint8 const _nodeId);
2027 
2039  bool CreateNewPrimary(uint32 const _homeId);
2040 
2052  bool ReceiveConfiguration(uint32 const _homeId);
2053 
2068  bool ReplaceFailedNode(uint32 const _homeId, uint8 const _nodeId);
2069 
2081  bool TransferPrimaryRole(uint32 const _homeId);
2082 
2094  bool RequestNetworkUpdate(uint32 const _homeId, uint8 const _nodeId);
2095 
2107  bool ReplicationSend(uint32 const _homeId, uint8 const _nodeId);
2108 
2123  bool CreateButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2124 
2139  bool DeleteButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2140 
2155  void SendRawData(uint32 const _homeId, uint8 const _nodeId, string const& _logText, uint8 const _msgType, const bool _sendSecure, uint8 const* _content, uint8 const _length);
2156 
2159  //-----------------------------------------------------------------------------
2160  // Scene commands
2161  //-----------------------------------------------------------------------------
2168  public:
2175  DEPRECATED uint8 GetNumScenes();
2176 
2184  DEPRECATED uint8 GetAllScenes(uint8** _sceneIds);
2185 
2192  DEPRECATED void RemoveAllScenes(uint32 const _homeId);
2193 
2201  DEPRECATED uint8 CreateScene();
2202 
2210  DEPRECATED bool RemoveScene(uint8 const _sceneId);
2211 
2221  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2222 
2232  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2233 
2243  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2244 
2254  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2255 
2265  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2266 
2276  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2277 
2287  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2288 
2298  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2299 
2308  DEPRECATED bool RemoveSceneValue(uint8 const _sceneId, ValueID const& _valueId);
2309 
2318  DEPRECATED int SceneGetValues(uint8 const _sceneId, vector<ValueID>* o_value);
2319 
2329  DEPRECATED bool SceneGetValueAsBool(uint8 const _sceneId, ValueID const& _valueId, bool* o_value);
2330 
2340  DEPRECATED bool SceneGetValueAsByte(uint8 const _sceneId, ValueID const& _valueId, uint8* o_value);
2341 
2351  DEPRECATED bool SceneGetValueAsFloat(uint8 const _sceneId, ValueID const& _valueId, float* o_value);
2352 
2362  DEPRECATED bool SceneGetValueAsInt(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2363 
2373  DEPRECATED bool SceneGetValueAsShort(uint8 const _sceneId, ValueID const& _valueId, int16* o_value);
2374 
2384  DEPRECATED bool SceneGetValueAsString(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2385 
2395  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2396 
2406  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2407 
2417  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2418 
2428  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2429 
2439  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2440 
2450  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2451 
2461  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2462 
2472  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2473 
2483  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2484 
2494  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2495 
2503  DEPRECATED string GetSceneLabel(uint8 const _sceneId);
2504 
2512  DEPRECATED void SetSceneLabel(uint8 const _sceneId, string const& _value);
2513 
2521  DEPRECATED bool SceneExists(uint8 const _sceneId);
2522 
2530  DEPRECATED bool ActivateScene(uint8 const _sceneId);
2531 
2534  //-----------------------------------------------------------------------------
2535  // Statistics interface
2536  //-----------------------------------------------------------------------------
2541  public:
2547  void GetDriverStatistics(uint32 const _homeId, Driver::DriverData* _data);
2548 
2555  void GetNodeStatistics(uint32 const _homeId, uint8 const _nodeId, Node::NodeData* _data);
2556 
2562  static string GetNodeRouteScheme(Node::NodeData *_data);
2563 
2569  static string GetNodeRouteSpeed(Node::NodeData *_data);
2570 
2573  //-----------------------------------------------------------------------------
2574  // MetaData interface
2575  //-----------------------------------------------------------------------------
2580  public:
2588  string const GetMetaData(uint32 const _homeId, uint8 const _nodeId, Node::MetaDataFields _metadata);
2596  Node::ChangeLogEntry const GetChangeLog(uint32 const _homeId, uint8 const _nodeId, uint32_t revision);
2597 
2599  //-----------------------------------------------------------------------------
2600  // Config File Revision interface
2601  //-----------------------------------------------------------------------------
2606  public:
2619  bool checkLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2620 
2631  bool checkLatestMFSRevision(uint32 const _homeId);
2632 
2649  bool downloadLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2650 
2662  bool downloadLatestMFSRevision(uint32 const _homeId);
2663 
2666  };
2668 } // namespace OpenZWave
2669 
2670 #endif // _Manager_H
OpenZWave
Definition: Bitfield.cpp:30
OPENZWAVE_EXPORT
#define OPENZWAVE_EXPORT
Definition: Defs.h:51
uint16
unsigned short uint16
Definition: Defs.h:89
OPENZWAVE_EXPORT_WARNINGS_ON
#define OPENZWAVE_EXPORT_WARNINGS_ON
Definition: Defs.h:53
OpenZWave::Manager
The main public interface to OpenZWave.
Definition: Manager.h:108
OpenZWave::Node::MetaDataFields
MetaDataFields
Definition: Node.h:879
DEPRECATED
#define DEPRECATED
Definition: Defs.h:62
OPENZWAVE_EXPORT_WARNINGS_OFF
#define OPENZWAVE_EXPORT_WARNINGS_OFF
Definition: Defs.h:52
OpenZWave::Internal::VC::ValueStore
Container that holds all of the values associated with a given node.
Definition: ValueStore.h:49
OpenZWave::InstanceAssociation
Definition: Group.h:51
OpenZWave::Node
The Node class describes a Z-Wave node object...typically a device on the Z-Wave network.
Definition: Node.h:81
NULL
#define NULL
Definition: Defs.h:82
OpenZWave::Internal::CC::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
OpenZWave::Driver::ControllerCommand
ControllerCommand
Definition: Driver.h:552
int16
signed short int16
Definition: Defs.h:88
OpenZWave::Driver::ControllerInterface
ControllerInterface
Definition: Driver.h:111
int8
signed char int8
Definition: Defs.h:85
OpenZWave::Driver
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:84
OpenZWave::Options
Manages library options read from XML files or the command line.
Definition: Options.h:66
int32
signed int int32
Definition: Defs.h:91
uint32
unsigned int uint32
Definition: Defs.h:92
OpenZWave::Group
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:59
OpenZWave::Notification
Provides a container for data sent via the notification callback handler installed by a call to Manag...
Definition: Notification.h:62
OpenZWave::ValueID
Provides a unique ID for a value reported by a Z-Wave device.The ValueID is used to uniquely identify...
Definition: ValueID.h:76
OpenZWave::Manager::GetOptions
Options * GetOptions() const
Gets a pointer to the locked Options object.
Definition: Manager.h:212
OpenZWave::Manager::Get
static Manager * Get()
Gets a pointer to the Manager object.
Definition: Manager.h:148
OpenZWave::Driver::pfnControllerCallback_t
void(* pfnControllerCallback_t)(ControllerState _state, ControllerError _err, void *_context)
Definition: Driver.h:614
ozwversion
Definition: Defs.h:107
OpenZWave::Internal::Msg
Message object to be passed to and from devices on the Z-Wave network.
Definition: Msg.h:50
OpenZWave::Internal::VC::Value
Base class for values associated with a node.
Definition: Value.h:54
uint8
unsigned char uint8
Definition: Defs.h:86
Generated on Tue Jun 25 2019 17:52:33 for OpenZWave Library by   doxygen 1.8.14