OpenZWave Library  1.6.962
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);
369  list<Driver*> m_pendingDrivers;
370  map<uint32, Driver*> m_readyDrivers;
372  //-----------------------------------------------------------------------------
373  // Polling Z-Wave devices
374  //-----------------------------------------------------------------------------
381  public:
385  int32 GetPollInterval();
386 
398  void SetPollInterval(int32 _milliseconds, bool _bIntervalBetweenPolls);
399 
406  bool EnablePoll(ValueID const &_valueId, uint8 const _intensity = 1);
407 
413  bool DisablePoll(ValueID const &_valueId);
414 
420  bool isPolled(ValueID const &_valueId);
421 
426  void SetPollIntensity(ValueID const &_valueId, uint8 const _intensity);
427 
435  uint8 GetPollIntensity(ValueID const &_valueId);
436 
439  //-----------------------------------------------------------------------------
440  // Node information
441  //-----------------------------------------------------------------------------
446  public:
457  bool RefreshNodeInfo(uint32 const _homeId, uint8 const _nodeId);
458 
467  bool RequestNodeState(uint32 const _homeId, uint8 const _nodeId);
468 
477  bool RequestNodeDynamic(uint32 const _homeId, uint8 const _nodeId);
478 
485  bool IsNodeListeningDevice(uint32 const _homeId, uint8 const _nodeId);
486 
494  bool IsNodeFrequentListeningDevice(uint32 const _homeId, uint8 const _nodeId);
495 
502  bool IsNodeBeamingDevice(uint32 const _homeId, uint8 const _nodeId);
503 
510  bool IsNodeRoutingDevice(uint32 const _homeId, uint8 const _nodeId);
511 
518  bool IsNodeSecurityDevice(uint32 const _homeId, uint8 const _nodeId);
519 
526  uint32 GetNodeMaxBaudRate(uint32 const _homeId, uint8 const _nodeId);
527 
534  uint8 GetNodeVersion(uint32 const _homeId, uint8 const _nodeId);
535 
542  uint8 GetNodeSecurity(uint32 const _homeId, uint8 const _nodeId);
543 
551  bool IsNodeZWavePlus(uint32 const _homeId, uint8 const _nodeId);
552 
559  uint8 GetNodeBasic(uint32 const _homeId, uint8 const _nodeId);
560 
567  uint8 GetNodeGeneric(uint32 const _homeId, uint8 const _nodeId);
568 
575  uint8 GetNodeSpecific(uint32 const _homeId, uint8 const _nodeId);
576 
584  string GetNodeType(uint32 const _homeId, uint8 const _nodeId);
585 
594  uint32 GetNodeNeighbors(uint32 const _homeId, uint8 const _nodeId, uint8** _nodeNeighbors);
595 
607  void SyncronizeNodeNeighbors(uint32 const _homeId, uint8 const _nodeId);
608 
622  string GetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId);
623 
637  string GetNodeProductName(uint32 const _homeId, uint8 const _nodeId);
638 
651  string GetNodeName(uint32 const _homeId, uint8 const _nodeId);
652 
664  string GetNodeLocation(uint32 const _homeId, uint8 const _nodeId);
665 
680  string GetNodeManufacturerId(uint32 const _homeId, uint8 const _nodeId);
681 
696  string GetNodeProductType(uint32 const _homeId, uint8 const _nodeId);
697 
712  string GetNodeProductId(uint32 const _homeId, uint8 const _nodeId);
713 
727  void SetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId, string const& _manufacturerName);
728 
742  void SetNodeProductName(uint32 const _homeId, uint8 const _nodeId, string const& _productName);
743 
757  void SetNodeName(uint32 const _homeId, uint8 const _nodeId, string const& _nodeName);
758 
771  void SetNodeLocation(uint32 const _homeId, uint8 const _nodeId, string const& _location);
772 
785  DEPRECATED void SetNodeOn(uint32 const _homeId, uint8 const _nodeId);
786 
797  DEPRECATED void SetNodeOff(uint32 const _homeId, uint8 const _nodeId);
798 
811  DEPRECATED void SetNodeLevel(uint32 const _homeId, uint8 const _nodeId, uint8 const _level);
812 
819  bool IsNodeInfoReceived(uint32 const _homeId, uint8 const _nodeId);
820 
828  bool GetNodeClassInformation(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, string *_className = NULL, uint8 *_classVersion = NULL);
835  bool IsNodeAwake(uint32 const _homeId, uint8 const _nodeId);
836 
843  bool IsNodeFailed(uint32 const _homeId, uint8 const _nodeId);
844 
851  string GetNodeQueryStage(uint32 const _homeId, uint8 const _nodeId);
852 
859  uint16 GetNodeDeviceType(uint32 const _homeId, uint8 const _nodeId);
860 
867  string GetNodeDeviceTypeString(uint32 const _homeId, uint8 const _nodeId);
868 
875  uint8 GetNodeRole(uint32 const _homeId, uint8 const _nodeId);
876 
883  string GetNodeRoleString(uint32 const _homeId, uint8 const _nodeId);
884 
891  uint8 GetNodePlusType(uint32 const _homeId, uint8 const _nodeId);
898  string GetNodePlusTypeString(uint32 const _homeId, uint8 const _nodeId);
899 
902  //-----------------------------------------------------------------------------
903  // Instances
904  //-----------------------------------------------------------------------------
909  public:
919  string GetInstanceLabel(ValueID const &_id);
920 
933  string GetInstanceLabel(uint32 const _homeId, uint8 const _node, uint8 const _cc, uint8 const _instance);
934 
936  //-----------------------------------------------------------------------------
937  // Values
938  //-----------------------------------------------------------------------------
944  public:
954  string GetValueLabel(ValueID const& _id, int32 _pos = -1);
955 
965  void SetValueLabel(ValueID const& _id, string const& _value, int32 _pos = -1);
966 
975  string GetValueUnits(ValueID const& _id);
976 
985  void SetValueUnits(ValueID const& _id, string const& _value);
986 
996  string GetValueHelp(ValueID const& _id, int32 _pos = -1);
997 
1007  void SetValueHelp(ValueID const& _id, string const& _value, int32 _pos = -1);
1008 
1017  int32 GetValueMin(ValueID const& _id);
1018 
1027  int32 GetValueMax(ValueID const& _id);
1028 
1037  bool IsValueReadOnly(ValueID const& _id);
1038 
1047  bool IsValueWriteOnly(ValueID const& _id);
1048 
1057  bool IsValueSet(ValueID const& _id);
1058 
1067  bool IsValuePolled(ValueID const& _id);
1068 
1075  bool IsValueValid(ValueID const& _id);
1076 
1077 
1089  bool GetValueAsBitSet(ValueID const& _id, uint8 _pos, bool* o_value);
1090 
1101  bool GetValueAsBool(ValueID const& _id, bool* o_value);
1102 
1113  bool GetValueAsByte(ValueID const& _id, uint8* o_value);
1114 
1125  bool GetValueAsFloat(ValueID const& _id, float* o_value);
1126 
1137  bool GetValueAsInt(ValueID const& _id, int32* o_value);
1138 
1149  bool GetValueAsShort(ValueID const& _id, int16* o_value);
1150 
1162  bool GetValueAsString(ValueID const& _id, string* o_value);
1163 
1175  bool GetValueAsRaw(ValueID const& _id, uint8** o_value, uint8* o_length);
1176 
1187  bool GetValueListSelection(ValueID const& _id, string* o_value);
1188 
1199  bool GetValueListSelection(ValueID const& _id, int32* o_value);
1200 
1211  bool GetValueListItems(ValueID const& _id, vector<string>* o_value);
1212 
1223  bool GetValueListValues(ValueID const& _id, vector<int32>* o_value);
1224 
1235  bool GetValueFloatPrecision(ValueID const& _id, uint8* o_value);
1236 
1251  bool SetValue(ValueID const& _id, uint8 _pos, bool const _value);
1252 
1266  bool SetValue(ValueID const& _id, bool const _value);
1267 
1280  bool SetValue(ValueID const& _id, uint8 const _value);
1281 
1295  bool SetValue(ValueID const& _id, float const _value);
1296 
1309  bool SetValue(ValueID const& _id, int32 const _value);
1310 
1323  bool SetValue(ValueID const& _id, int16 const _value);
1324 
1337  bool SetValue(ValueID const& _id, uint8 const* _value, uint8 const _length);
1338 
1351  bool SetValue(ValueID const& _id, string const& _value);
1352 
1366  bool SetValueListSelection(ValueID const& _id, string const& _selectedItem);
1367 
1377  bool RefreshValue(ValueID const& _id);
1378 
1389  void SetChangeVerified(ValueID const& _id, bool _verify);
1390 
1400  bool GetChangeVerified(ValueID const& _id);
1401 
1411  bool PressButton(ValueID const& _id);
1412 
1422  bool ReleaseButton(ValueID const& _id);
1423 
1434  bool SetBitMask(ValueID const& _id, uint32 _mask);
1435 
1446  bool GetBitMask(ValueID const& _id, int32* o_mask);
1447 
1458  bool GetBitSetSize(ValueID const& _id, uint8* o_size);
1459 
1462  //-----------------------------------------------------------------------------
1463  // Climate Control Schedules
1464  //-----------------------------------------------------------------------------
1478 
1487  uint8 GetNumSwitchPoints(ValueID const& _id);
1488 
1508  bool SetSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes, int8 const _setback);
1509 
1525  bool RemoveSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes);
1526 
1535  void ClearSwitchPoints(ValueID const& _id);
1536 
1554  bool GetSwitchPoint(ValueID const& _id, uint8 const _idx, uint8* o_hours, uint8* o_minutes, int8* o_setback);
1555 
1558  //-----------------------------------------------------------------------------
1559  // SwitchAll
1560  //-----------------------------------------------------------------------------
1568 
1574  DEPRECATED void SwitchAllOn(uint32 const _homeId);
1575 
1581  DEPRECATED void SwitchAllOff(uint32 const _homeId);
1582 
1585  //-----------------------------------------------------------------------------
1586  // Configuration Parameters
1587  //-----------------------------------------------------------------------------
1597  public:
1613  bool SetConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param, int32 _value, uint8 const _size = 2);
1614 
1630  void RequestConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param);
1631 
1638  void RequestAllConfigParams(uint32 const _homeId, uint8 const _nodeId);
1641  //-----------------------------------------------------------------------------
1642  // Groups (wrappers for the Node methods)
1643  //-----------------------------------------------------------------------------
1648  public:
1658  uint8 GetNumGroups(uint32 const _homeId, uint8 const _nodeId);
1659 
1671  uint32 GetAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8** o_associations);
1672 
1687  uint32 GetAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, InstanceAssociation** o_associations);
1688 
1697  uint8 GetMaxAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1698 
1707  bool IsMultiInstance(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1708 
1717  string GetGroupLabel(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx);
1718 
1731  void AddAssociation(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
1732 
1745  void RemoveAssociation(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8 const _targetNodeId, uint8 const _instance = 0x00);
1746 
1749  //-----------------------------------------------------------------------------
1750  // Notifications
1751  //-----------------------------------------------------------------------------
1756  public:
1767  bool AddWatcher(pfnOnNotification_t _watcher, void* _context);
1768 
1776  bool RemoveWatcher(pfnOnNotification_t _watcher, void* _context);
1779  private:
1780  void NotifyWatchers(Notification* _notification); // Passes the notifications to all the registered watcher callbacks in turn.
1781 
1782  struct Watcher
1783  {
1784  pfnOnNotification_t m_callback;
1785  void* m_context;
1786 
1787  Watcher(pfnOnNotification_t _callback, void* _context) :
1788  m_callback(_callback), m_context(_context)
1789  {
1790  }
1791  };
1792 
1793  list<Watcher*> m_watchers; // List of all the registered watchers.
1794  list<list<Watcher*>::iterator*> m_watcherIterators; // Iterators currently operating on the list of watchers
1795  Internal::Platform::Mutex* m_notificationMutex;
1796 
1797  //-----------------------------------------------------------------------------
1798  // Controller commands
1799  //-----------------------------------------------------------------------------
1804  public:
1811  void ResetController(uint32 const _homeId);
1812 
1819  void SoftReset(uint32 const _homeId);
1820 
1877  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);
1878 
1885  bool CancelControllerCommand(uint32 const _homeId);
1888  //-----------------------------------------------------------------------------
1889  // Network commands
1890  //-----------------------------------------------------------------------------
1896  public:
1904  void TestNetworkNode(uint32 const _homeId, uint8 const _nodeId, uint32 const _count);
1905 
1913  void TestNetwork(uint32 const _homeId, uint32 const _count);
1914 
1922  void HealNetworkNode(uint32 const _homeId, uint8 const _nodeId, bool _doRR);
1923 
1931  void HealNetwork(uint32 const _homeId, bool _doRR);
1932 
1946  bool AddNode(uint32 const _homeId, bool _doSecurity = true);
1947 
1960  bool RemoveNode(uint32 const _homeId);
1961 
1978  bool RemoveFailedNode(uint32 const _homeId, uint8 const _nodeId);
1979 
1994  bool HasNodeFailed(uint32 const _homeId, uint8 const _nodeId);
1995 
2008  bool RequestNodeNeighborUpdate(uint32 const _homeId, uint8 const _nodeId);
2009 
2022  bool AssignReturnRoute(uint32 const _homeId, uint8 const _nodeId);
2023 
2036  bool DeleteAllReturnRoutes(uint32 const _homeId, uint8 const _nodeId);
2037 
2047  bool SendNodeInformation(uint32 const _homeId, uint8 const _nodeId);
2048 
2060  bool CreateNewPrimary(uint32 const _homeId);
2061 
2073  bool ReceiveConfiguration(uint32 const _homeId);
2074 
2089  bool ReplaceFailedNode(uint32 const _homeId, uint8 const _nodeId);
2090 
2102  bool TransferPrimaryRole(uint32 const _homeId);
2103 
2115  bool RequestNetworkUpdate(uint32 const _homeId, uint8 const _nodeId);
2116 
2128  bool ReplicationSend(uint32 const _homeId, uint8 const _nodeId);
2129 
2144  bool CreateButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2145 
2160  bool DeleteButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2161 
2176  void SendRawData(uint32 const _homeId, uint8 const _nodeId, string const& _logText, uint8 const _msgType, const bool _sendSecure, uint8 const* _content, uint8 const _length);
2177 
2180  //-----------------------------------------------------------------------------
2181  // Scene commands
2182  //-----------------------------------------------------------------------------
2189  public:
2196  DEPRECATED uint8 GetNumScenes();
2197 
2205  DEPRECATED uint8 GetAllScenes(uint8** _sceneIds);
2206 
2213  DEPRECATED void RemoveAllScenes(uint32 const _homeId);
2214 
2222  DEPRECATED uint8 CreateScene();
2223 
2231  DEPRECATED bool RemoveScene(uint8 const _sceneId);
2232 
2242  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2243 
2253  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2254 
2264  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2265 
2275  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2276 
2286  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2287 
2297  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2298 
2308  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2309 
2319  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2320 
2329  DEPRECATED bool RemoveSceneValue(uint8 const _sceneId, ValueID const& _valueId);
2330 
2339  DEPRECATED int SceneGetValues(uint8 const _sceneId, vector<ValueID>* o_value);
2340 
2350  DEPRECATED bool SceneGetValueAsBool(uint8 const _sceneId, ValueID const& _valueId, bool* o_value);
2351 
2361  DEPRECATED bool SceneGetValueAsByte(uint8 const _sceneId, ValueID const& _valueId, uint8* o_value);
2362 
2372  DEPRECATED bool SceneGetValueAsFloat(uint8 const _sceneId, ValueID const& _valueId, float* o_value);
2373 
2383  DEPRECATED bool SceneGetValueAsInt(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2384 
2394  DEPRECATED bool SceneGetValueAsShort(uint8 const _sceneId, ValueID const& _valueId, int16* o_value);
2395 
2405  DEPRECATED bool SceneGetValueAsString(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2406 
2416  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2417 
2427  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2428 
2438  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2439 
2449  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2450 
2460  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2461 
2471  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2472 
2482  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2483 
2493  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2494 
2504  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2505 
2515  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2516 
2524  DEPRECATED string GetSceneLabel(uint8 const _sceneId);
2525 
2533  DEPRECATED void SetSceneLabel(uint8 const _sceneId, string const& _value);
2534 
2542  DEPRECATED bool SceneExists(uint8 const _sceneId);
2543 
2551  DEPRECATED bool ActivateScene(uint8 const _sceneId);
2552 
2555  //-----------------------------------------------------------------------------
2556  // Statistics interface
2557  //-----------------------------------------------------------------------------
2562  public:
2568  void GetDriverStatistics(uint32 const _homeId, Driver::DriverData* _data);
2569 
2576  void GetNodeStatistics(uint32 const _homeId, uint8 const _nodeId, Node::NodeData* _data);
2577 
2583  static string GetNodeRouteScheme(Node::NodeData *_data);
2584 
2590  static string GetNodeRouteSpeed(Node::NodeData *_data);
2591 
2594  //-----------------------------------------------------------------------------
2595  // MetaData interface
2596  //-----------------------------------------------------------------------------
2601  public:
2609  string const GetMetaData(uint32 const _homeId, uint8 const _nodeId, Node::MetaDataFields _metadata);
2617  Node::ChangeLogEntry const GetChangeLog(uint32 const _homeId, uint8 const _nodeId, uint32_t revision);
2618 
2620  //-----------------------------------------------------------------------------
2621  // Config File Revision interface
2622  //-----------------------------------------------------------------------------
2627  public:
2640  bool checkLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2641 
2652  bool checkLatestMFSRevision(uint32 const _homeId);
2653 
2670  bool downloadLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2671 
2683  bool downloadLatestMFSRevision(uint32 const _homeId);
2684 
2687  };
2689 } // namespace OpenZWave
2690 
2691 #endif // _Manager_H
OpenZWave
Definition: Bitfield.cpp:30
OPENZWAVE_EXPORT
#define OPENZWAVE_EXPORT
Definition: Defs.h:52
uint16
unsigned short uint16
Definition: Defs.h:88
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:61
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:63
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:81
OpenZWave::Internal::CC::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
OpenZWave::Driver::ControllerCommand
ControllerCommand
Definition: Driver.h:550
int16
signed short int16
Definition: Defs.h:87
OpenZWave::Driver::ControllerInterface
ControllerInterface
Definition: Driver.h:111
int8
signed char int8
Definition: Defs.h:84
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:90
uint32
unsigned int uint32
Definition: Defs.h:91
OpenZWave::Group
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:71
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:612
ozwversion
Definition: Defs.h:106
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:53
uint8
unsigned char uint8
Definition: Defs.h:85
Generated on Sun Nov 17 2019 23:49:53 for OpenZWave Library by   doxygen 1.8.15