OpenZWave Library  1.6.897
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 
597  uint32 GetNodeNeighbors(uint32 const _homeId, uint8 const _nodeId, uint8** _nodeNeighbors);
598 
610  void SyncronizeNodeNeighbors(uint32 const _homeId, uint8 const _nodeId);
611 
625  string GetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId);
626 
640  string GetNodeProductName(uint32 const _homeId, uint8 const _nodeId);
641 
654  string GetNodeName(uint32 const _homeId, uint8 const _nodeId);
655 
667  string GetNodeLocation(uint32 const _homeId, uint8 const _nodeId);
668 
683  string GetNodeManufacturerId(uint32 const _homeId, uint8 const _nodeId);
684 
699  string GetNodeProductType(uint32 const _homeId, uint8 const _nodeId);
700 
715  string GetNodeProductId(uint32 const _homeId, uint8 const _nodeId);
716 
730  void SetNodeManufacturerName(uint32 const _homeId, uint8 const _nodeId, string const& _manufacturerName);
731 
745  void SetNodeProductName(uint32 const _homeId, uint8 const _nodeId, string const& _productName);
746 
760  void SetNodeName(uint32 const _homeId, uint8 const _nodeId, string const& _nodeName);
761 
774  void SetNodeLocation(uint32 const _homeId, uint8 const _nodeId, string const& _location);
775 
788  DEPRECATED void SetNodeOn(uint32 const _homeId, uint8 const _nodeId);
789 
800  DEPRECATED void SetNodeOff(uint32 const _homeId, uint8 const _nodeId);
801 
814  DEPRECATED void SetNodeLevel(uint32 const _homeId, uint8 const _nodeId, uint8 const _level);
815 
822  bool IsNodeInfoReceived(uint32 const _homeId, uint8 const _nodeId);
823 
831  bool GetNodeClassInformation(uint32 const _homeId, uint8 const _nodeId, uint8 const _commandClassId, string *_className = NULL, uint8 *_classVersion = NULL);
838  bool IsNodeAwake(uint32 const _homeId, uint8 const _nodeId);
839 
846  bool IsNodeFailed(uint32 const _homeId, uint8 const _nodeId);
847 
854  string GetNodeQueryStage(uint32 const _homeId, uint8 const _nodeId);
855 
862  uint16 GetNodeDeviceType(uint32 const _homeId, uint8 const _nodeId);
863 
870  string GetNodeDeviceTypeString(uint32 const _homeId, uint8 const _nodeId);
871 
878  uint8 GetNodeRole(uint32 const _homeId, uint8 const _nodeId);
879 
886  string GetNodeRoleString(uint32 const _homeId, uint8 const _nodeId);
887 
894  uint8 GetNodePlusType(uint32 const _homeId, uint8 const _nodeId);
901  string GetNodePlusTypeString(uint32 const _homeId, uint8 const _nodeId);
902 
905  //-----------------------------------------------------------------------------
906  // Instances
907  //-----------------------------------------------------------------------------
912  public:
922  string GetInstanceLabel(ValueID const &_id);
923 
936  string GetInstanceLabel(uint32 const _homeId, uint8 const _node, uint8 const _cc, uint8 const _instance);
937 
939  //-----------------------------------------------------------------------------
940  // Values
941  //-----------------------------------------------------------------------------
947  public:
957  string GetValueLabel(ValueID const& _id, int32 _pos = -1);
958 
968  void SetValueLabel(ValueID const& _id, string const& _value, int32 _pos = -1);
969 
978  string GetValueUnits(ValueID const& _id);
979 
988  void SetValueUnits(ValueID const& _id, string const& _value);
989 
999  string GetValueHelp(ValueID const& _id, int32 _pos = -1);
1000 
1010  void SetValueHelp(ValueID const& _id, string const& _value, int32 _pos = -1);
1011 
1020  int32 GetValueMin(ValueID const& _id);
1021 
1030  int32 GetValueMax(ValueID const& _id);
1031 
1040  bool IsValueReadOnly(ValueID const& _id);
1041 
1050  bool IsValueWriteOnly(ValueID const& _id);
1051 
1060  bool IsValueSet(ValueID const& _id);
1061 
1070  bool IsValuePolled(ValueID const& _id);
1071 
1078  bool IsValueValid(ValueID const& _id);
1079 
1080 
1092  bool GetValueAsBitSet(ValueID const& _id, uint8 _pos, bool* o_value);
1093 
1104  bool GetValueAsBool(ValueID const& _id, bool* o_value);
1105 
1116  bool GetValueAsByte(ValueID const& _id, uint8* o_value);
1117 
1128  bool GetValueAsFloat(ValueID const& _id, float* o_value);
1129 
1140  bool GetValueAsInt(ValueID const& _id, int32* o_value);
1141 
1152  bool GetValueAsShort(ValueID const& _id, int16* o_value);
1153 
1165  bool GetValueAsString(ValueID const& _id, string* o_value);
1166 
1178  bool GetValueAsRaw(ValueID const& _id, uint8** o_value, uint8* o_length);
1179 
1190  bool GetValueListSelection(ValueID const& _id, string* o_value);
1191 
1202  bool GetValueListSelection(ValueID const& _id, int32* o_value);
1203 
1214  bool GetValueListItems(ValueID const& _id, vector<string>* o_value);
1215 
1226  bool GetValueListValues(ValueID const& _id, vector<int32>* o_value);
1227 
1238  bool GetValueFloatPrecision(ValueID const& _id, uint8* o_value);
1239 
1254  bool SetValue(ValueID const& _id, uint8 _pos, bool const _value);
1255 
1269  bool SetValue(ValueID const& _id, bool const _value);
1270 
1283  bool SetValue(ValueID const& _id, uint8 const _value);
1284 
1298  bool SetValue(ValueID const& _id, float const _value);
1299 
1312  bool SetValue(ValueID const& _id, int32 const _value);
1313 
1326  bool SetValue(ValueID const& _id, int16 const _value);
1327 
1340  bool SetValue(ValueID const& _id, uint8 const* _value, uint8 const _length);
1341 
1354  bool SetValue(ValueID const& _id, string const& _value);
1355 
1369  bool SetValueListSelection(ValueID const& _id, string const& _selectedItem);
1370 
1380  bool RefreshValue(ValueID const& _id);
1381 
1392  void SetChangeVerified(ValueID const& _id, bool _verify);
1393 
1403  bool GetChangeVerified(ValueID const& _id);
1404 
1414  bool PressButton(ValueID const& _id);
1415 
1425  bool ReleaseButton(ValueID const& _id);
1426 
1437  bool SetBitMask(ValueID const& _id, uint32 _mask);
1438 
1449  bool GetBitMask(ValueID const& _id, int32* o_mask);
1450 
1461  bool GetBitSetSize(ValueID const& _id, uint8* o_size);
1462 
1465  //-----------------------------------------------------------------------------
1466  // Climate Control Schedules
1467  //-----------------------------------------------------------------------------
1481 
1490  uint8 GetNumSwitchPoints(ValueID const& _id);
1491 
1511  bool SetSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes, int8 const _setback);
1512 
1528  bool RemoveSwitchPoint(ValueID const& _id, uint8 const _hours, uint8 const _minutes);
1529 
1538  void ClearSwitchPoints(ValueID const& _id);
1539 
1557  bool GetSwitchPoint(ValueID const& _id, uint8 const _idx, uint8* o_hours, uint8* o_minutes, int8* o_setback);
1558 
1561  //-----------------------------------------------------------------------------
1562  // SwitchAll
1563  //-----------------------------------------------------------------------------
1571 
1577  DEPRECATED void SwitchAllOn(uint32 const _homeId);
1578 
1584  DEPRECATED void SwitchAllOff(uint32 const _homeId);
1585 
1588  //-----------------------------------------------------------------------------
1589  // Configuration Parameters
1590  //-----------------------------------------------------------------------------
1600  public:
1616  bool SetConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param, int32 _value, uint8 const _size = 2);
1617 
1633  void RequestConfigParam(uint32 const _homeId, uint8 const _nodeId, uint8 const _param);
1634 
1641  void RequestAllConfigParams(uint32 const _homeId, uint8 const _nodeId);
1644  //-----------------------------------------------------------------------------
1645  // Groups (wrappers for the Node methods)
1646  //-----------------------------------------------------------------------------
1651  public:
1661  uint8 GetNumGroups(uint32 const _homeId, uint8 const _nodeId);
1662 
1674  uint32 GetAssociations(uint32 const _homeId, uint8 const _nodeId, uint8 const _groupIdx, uint8** o_associations);
1675 
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  OPENZWAVE_EXPORT_WARNINGS_OFF
1794  list<Watcher*> m_watchers; // List of all the registered watchers.
1795  list<list<Watcher*>::iterator*> m_watcherIterators; // Iterators currently operating on the list of watchers
1796  OPENZWAVE_EXPORT_WARNINGS_ON
1797  Internal::Platform::Mutex* m_notificationMutex;
1798 
1799  //-----------------------------------------------------------------------------
1800  // Controller commands
1801  //-----------------------------------------------------------------------------
1806  public:
1813  void ResetController(uint32 const _homeId);
1814 
1821  void SoftReset(uint32 const _homeId);
1822 
1879  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);
1880 
1887  bool CancelControllerCommand(uint32 const _homeId);
1890  //-----------------------------------------------------------------------------
1891  // Network commands
1892  //-----------------------------------------------------------------------------
1898  public:
1906  void TestNetworkNode(uint32 const _homeId, uint8 const _nodeId, uint32 const _count);
1907 
1915  void TestNetwork(uint32 const _homeId, uint32 const _count);
1916 
1924  void HealNetworkNode(uint32 const _homeId, uint8 const _nodeId, bool _doRR);
1925 
1933  void HealNetwork(uint32 const _homeId, bool _doRR);
1934 
1948  bool AddNode(uint32 const _homeId, bool _doSecurity = true);
1949 
1962  bool RemoveNode(uint32 const _homeId);
1963 
1980  bool RemoveFailedNode(uint32 const _homeId, uint8 const _nodeId);
1981 
1996  bool HasNodeFailed(uint32 const _homeId, uint8 const _nodeId);
1997 
2010  bool RequestNodeNeighborUpdate(uint32 const _homeId, uint8 const _nodeId);
2011 
2024  bool AssignReturnRoute(uint32 const _homeId, uint8 const _nodeId);
2025 
2038  bool DeleteAllReturnRoutes(uint32 const _homeId, uint8 const _nodeId);
2039 
2049  bool SendNodeInformation(uint32 const _homeId, uint8 const _nodeId);
2050 
2062  bool CreateNewPrimary(uint32 const _homeId);
2063 
2075  bool ReceiveConfiguration(uint32 const _homeId);
2076 
2091  bool ReplaceFailedNode(uint32 const _homeId, uint8 const _nodeId);
2092 
2104  bool TransferPrimaryRole(uint32 const _homeId);
2105 
2117  bool RequestNetworkUpdate(uint32 const _homeId, uint8 const _nodeId);
2118 
2130  bool ReplicationSend(uint32 const _homeId, uint8 const _nodeId);
2131 
2146  bool CreateButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2147 
2162  bool DeleteButton(uint32 const _homeId, uint8 const _nodeId, uint8 const _buttonid);
2163 
2178  void SendRawData(uint32 const _homeId, uint8 const _nodeId, string const& _logText, uint8 const _msgType, const bool _sendSecure, uint8 const* _content, uint8 const _length);
2179 
2182  //-----------------------------------------------------------------------------
2183  // Scene commands
2184  //-----------------------------------------------------------------------------
2191  public:
2198  DEPRECATED uint8 GetNumScenes();
2199 
2207  DEPRECATED uint8 GetAllScenes(uint8** _sceneIds);
2208 
2215  DEPRECATED void RemoveAllScenes(uint32 const _homeId);
2216 
2224  DEPRECATED uint8 CreateScene();
2225 
2233  DEPRECATED bool RemoveScene(uint8 const _sceneId);
2234 
2244  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2245 
2255  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2256 
2266  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2267 
2277  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2278 
2288  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2289 
2299  DEPRECATED bool AddSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2300 
2310  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2311 
2321  DEPRECATED bool AddSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2322 
2331  DEPRECATED bool RemoveSceneValue(uint8 const _sceneId, ValueID const& _valueId);
2332 
2341  DEPRECATED int SceneGetValues(uint8 const _sceneId, vector<ValueID>* o_value);
2342 
2352  DEPRECATED bool SceneGetValueAsBool(uint8 const _sceneId, ValueID const& _valueId, bool* o_value);
2353 
2363  DEPRECATED bool SceneGetValueAsByte(uint8 const _sceneId, ValueID const& _valueId, uint8* o_value);
2364 
2374  DEPRECATED bool SceneGetValueAsFloat(uint8 const _sceneId, ValueID const& _valueId, float* o_value);
2375 
2385  DEPRECATED bool SceneGetValueAsInt(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2386 
2396  DEPRECATED bool SceneGetValueAsShort(uint8 const _sceneId, ValueID const& _valueId, int16* o_value);
2397 
2407  DEPRECATED bool SceneGetValueAsString(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2408 
2418  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string* o_value);
2419 
2429  DEPRECATED bool SceneGetValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32* o_value);
2430 
2440  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, bool const _value);
2441 
2451  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, uint8 const _value);
2452 
2462  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, float const _value);
2463 
2473  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2474 
2484  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, int16 const _value);
2485 
2495  DEPRECATED bool SetSceneValue(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2496 
2506  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, string const& _value);
2507 
2517  DEPRECATED bool SetSceneValueListSelection(uint8 const _sceneId, ValueID const& _valueId, int32 const _value);
2518 
2526  DEPRECATED string GetSceneLabel(uint8 const _sceneId);
2527 
2535  DEPRECATED void SetSceneLabel(uint8 const _sceneId, string const& _value);
2536 
2544  DEPRECATED bool SceneExists(uint8 const _sceneId);
2545 
2553  DEPRECATED bool ActivateScene(uint8 const _sceneId);
2554 
2557  //-----------------------------------------------------------------------------
2558  // Statistics interface
2559  //-----------------------------------------------------------------------------
2564  public:
2570  void GetDriverStatistics(uint32 const _homeId, Driver::DriverData* _data);
2571 
2578  void GetNodeStatistics(uint32 const _homeId, uint8 const _nodeId, Node::NodeData* _data);
2579 
2585  static string GetNodeRouteScheme(Node::NodeData *_data);
2586 
2592  static string GetNodeRouteSpeed(Node::NodeData *_data);
2593 
2596  //-----------------------------------------------------------------------------
2597  // MetaData interface
2598  //-----------------------------------------------------------------------------
2603  public:
2611  string const GetMetaData(uint32 const _homeId, uint8 const _nodeId, Node::MetaDataFields _metadata);
2619  Node::ChangeLogEntry const GetChangeLog(uint32 const _homeId, uint8 const _nodeId, uint32_t revision);
2620 
2622  //-----------------------------------------------------------------------------
2623  // Config File Revision interface
2624  //-----------------------------------------------------------------------------
2629  public:
2642  bool checkLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2643 
2654  bool checkLatestMFSRevision(uint32 const _homeId);
2655 
2672  bool downloadLatestConfigFileRevision(uint32 const _homeId, uint8 const _nodeId);
2673 
2685  bool downloadLatestMFSRevision(uint32 const _homeId);
2686 
2689  };
2691 } // namespace OpenZWave
2692 
2693 #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:53
uint8
unsigned char uint8
Definition: Defs.h:86
Generated on Mon Aug 26 2019 11:34:52 for OpenZWave Library by   doxygen 1.8.14