122 typedef void (*pfnOnNotification_t)(
Notification const* _pNotification,
void* _context );
157 static void Destroy();
163 static std::string getVersionAsString();
169 static std::string getVersionLongAsString();
204 void WriteConfig(
uint32 const _homeId );
249 bool RemoveDriver(
string const& _controllerPath );
279 bool IsPrimaryController(
uint32 const _homeId );
288 bool IsStaticUpdateController(
uint32 const _homeId );
297 bool IsBridgeController(
uint32 const _homeId );
304 string GetLibraryVersion(
uint32 const _homeId );
325 string GetLibraryTypeName(
uint32 const _homeId );
338 void LogDriverStatistics(
uint32 const _homeId );
350 string GetControllerPath(
uint32 const _homeId );
355 void SetDriverReady(
Driver* _driver,
bool success );
358 list<Driver*> m_pendingDrivers;
359 map<uint32,Driver*> m_readyDrivers;
375 int32 GetPollInterval();
388 void SetPollInterval(
int32 _milliseconds,
bool _bIntervalBetweenPolls );
396 bool EnablePoll(
ValueID const &_valueId,
uint8 const _intensity = 1 );
403 bool DisablePoll(
ValueID const &_valueId );
410 bool isPolled(
ValueID const &_valueId );
416 void SetPollIntensity(
ValueID const &_valueId,
uint8 const _intensity );
447 bool RefreshNodeInfo(
uint32 const _homeId,
uint8 const _nodeId );
458 bool RequestNodeState(
uint32 const _homeId,
uint8 const _nodeId );
468 bool RequestNodeDynamic(
uint32 const _homeId,
uint8 const _nodeId );
476 bool IsNodeListeningDevice(
uint32 const _homeId,
uint8 const _nodeId );
485 bool IsNodeFrequentListeningDevice(
uint32 const _homeId,
uint8 const _nodeId );
493 bool IsNodeBeamingDevice(
uint32 const _homeId,
uint8 const _nodeId );
501 bool IsNodeRoutingDevice(
uint32 const _homeId,
uint8 const _nodeId );
509 bool IsNodeSecurityDevice(
uint32 const _homeId,
uint8 const _nodeId );
542 bool IsNodeZWavePlus(
uint32 const _homeId,
uint8 const _nodeId );
575 string GetNodeType(
uint32 const _homeId,
uint8 const _nodeId );
599 string GetNodeManufacturerName(
uint32 const _homeId,
uint8 const _nodeId );
614 string GetNodeProductName(
uint32 const _homeId,
uint8 const _nodeId );
628 string GetNodeName(
uint32 const _homeId,
uint8 const _nodeId );
641 string GetNodeLocation(
uint32 const _homeId,
uint8 const _nodeId );
657 string GetNodeManufacturerId(
uint32 const _homeId,
uint8 const _nodeId );
673 string GetNodeProductType(
uint32 const _homeId,
uint8 const _nodeId );
689 string GetNodeProductId(
uint32 const _homeId,
uint8 const _nodeId );
704 void SetNodeManufacturerName(
uint32 const _homeId,
uint8 const _nodeId,
string const& _manufacturerName );
719 void SetNodeProductName(
uint32 const _homeId,
uint8 const _nodeId,
string const& _productName );
734 void SetNodeName(
uint32 const _homeId,
uint8 const _nodeId,
string const& _nodeName );
748 void SetNodeLocation(
uint32 const _homeId,
uint8 const _nodeId,
string const& _location );
796 bool IsNodeInfoReceived(
uint32 const _homeId,
uint8 const _nodeId );
805 bool GetNodeClassInformation(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _commandClassId,
813 bool IsNodeAwake(
uint32 const _homeId,
uint8 const _nodeId );
821 bool IsNodeFailed(
uint32 const _homeId,
uint8 const _nodeId );
829 string GetNodeQueryStage(
uint32 const _homeId,
uint8 const _nodeId );
846 string GetNodeDeviceTypeString(
uint32 const _homeId,
uint8 const _nodeId );
862 string GetNodeRoleString(
uint32 const _homeId,
uint8 const _nodeId );
877 string GetNodePlusTypeString (
uint32 const _homeId,
uint8 const _nodeId );
901 string GetValueLabel(
ValueID const& _id,
int32 _pos = -1 );
912 void SetValueLabel(
ValueID const& _id,
string const& _value,
int32 _pos = -1 );
922 string GetValueUnits(
ValueID const& _id );
932 void SetValueUnits(
ValueID const& _id,
string const& _value );
943 string GetValueHelp(
ValueID const& _id,
int32 _pos = -1 );
954 void SetValueHelp(
ValueID const& _id,
string const& _value,
int32 _pos = -1 );
984 bool IsValueReadOnly(
ValueID const& _id );
994 bool IsValueWriteOnly(
ValueID const& _id );
1004 bool IsValueSet(
ValueID const& _id );
1014 bool IsValuePolled(
ValueID const& _id );
1027 bool GetValueAsBitSet(
ValueID const& _id,
uint8 _pos,
bool* o_value );
1039 bool GetValueAsBool(
ValueID const& _id,
bool* o_value );
1051 bool GetValueAsByte(
ValueID const& _id,
uint8* o_value );
1063 bool GetValueAsFloat(
ValueID const& _id,
float* o_value );
1075 bool GetValueAsInt(
ValueID const& _id,
int32* o_value );
1087 bool GetValueAsShort(
ValueID const& _id,
int16* o_value );
1100 bool GetValueAsString(
ValueID const& _id,
string* o_value );
1125 bool GetValueListSelection(
ValueID const& _id,
string* o_value );
1137 bool GetValueListSelection(
ValueID const& _id,
int32* o_value );
1149 bool GetValueListItems(
ValueID const& _id, vector<string>* o_value );
1161 bool GetValueListValues(
ValueID const& _id, vector<int32>* o_value );
1173 bool GetValueFloatPrecision(
ValueID const& _id,
uint8* o_value );
1189 bool SetValue(
ValueID const& _id,
uint8 _pos,
bool const _value );
1204 bool SetValue(
ValueID const& _id,
bool const _value );
1218 bool SetValue(
ValueID const& _id,
uint8 const _value );
1233 bool SetValue(
ValueID const& _id,
float const _value );
1247 bool SetValue(
ValueID const& _id,
int32 const _value );
1261 bool SetValue(
ValueID const& _id,
int16 const _value );
1289 bool SetValue(
ValueID const& _id,
string const& _value );
1304 bool SetValueListSelection(
ValueID const& _id,
string const& _selectedItem );
1315 bool RefreshValue(
ValueID const& _id);
1327 void SetChangeVerified(
ValueID const& _id,
bool _verify );
1338 bool GetChangeVerified(
ValueID const& _id );
1349 bool PressButton(
ValueID const& _id );
1360 bool ReleaseButton(
ValueID const& _id );
1396 bool GetBitSetSize(
ValueID const& _id,
uint8* o_size );
1448 bool SetSwitchPoint(
ValueID const& _id,
uint8 const _hours,
uint8 const _minutes,
int8 const _setback );
1465 bool RemoveSwitchPoint(
ValueID const& _id,
uint8 const _hours,
uint8 const _minutes );
1475 void ClearSwitchPoints(
ValueID const& _id );
1570 void RequestConfigParam(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _param );
1578 void RequestAllConfigParams(
uint32 const _homeId,
uint8 const _nodeId );
1644 string GetGroupLabel(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _groupIdx );
1658 void AddAssociation(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _groupIdx,
uint8 const _targetNodeId,
uint8 const _instance = 0x00 );
1672 void RemoveAssociation(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _groupIdx,
uint8 const _targetNodeId,
uint8 const _instance = 0x00 );
1694 bool AddWatcher( pfnOnNotification_t _watcher,
void* _context );
1703 bool RemoveWatcher( pfnOnNotification_t _watcher,
void* _context );
1711 pfnOnNotification_t m_callback;
1716 pfnOnNotification_t _callback,
1719 m_callback( _callback ),
1720 m_context( _context )
1726 list<Watcher*> m_watchers;
1728 Mutex* m_notificationMutex;
1744 void ResetController(
uint32 const _homeId );
1752 void SoftReset(
uint32 const _homeId );
1818 bool CancelControllerCommand(
uint32 const _homeId );
1837 void TestNetworkNode(
uint32 const _homeId,
uint8 const _nodeId,
uint32 const _count );
1846 void TestNetwork(
uint32 const _homeId,
uint32 const _count );
1855 void HealNetworkNode(
uint32 const _homeId,
uint8 const _nodeId,
bool _doRR );
1864 void HealNetwork(
uint32 const _homeId,
bool _doRR );
1879 bool AddNode(
uint32 const _homeId,
bool _doSecurity =
true );
1893 bool RemoveNode(
uint32 const _homeId);
1911 bool RemoveFailedNode(
uint32 const _homeId,
uint8 const _nodeId);
1927 bool HasNodeFailed(
uint32 const _homeId,
uint8 const _nodeId);
1941 bool RequestNodeNeighborUpdate(
uint32 const _homeId,
uint8 const _nodeId);
1955 bool AssignReturnRoute(
uint32 const _homeId,
uint8 const _nodeId);
1969 bool DeleteAllReturnRoutes(
uint32 const _homeId,
uint8 const _nodeId);
1980 bool SendNodeInformation(
uint32 const _homeId,
uint8 const _nodeId);
1993 bool CreateNewPrimary(
uint32 const _homeId);
2006 bool ReceiveConfiguration (
uint32 const _homeId);
2022 bool ReplaceFailedNode(
uint32 const _homeId,
uint8 const _nodeId);
2035 bool TransferPrimaryRole(
uint32 const _homeId);
2048 bool RequestNetworkUpdate(
uint32 const _homeId,
uint8 const _nodeId);
2061 bool ReplicationSend(
uint32 const _homeId,
uint8 const _nodeId);
2077 bool CreateButton(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _buttonid);
2093 bool DeleteButton(
uint32 const _homeId,
uint8 const _nodeId,
uint8 const _buttonid);
2159 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
bool const _value );
2170 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
uint8 const _value );
2181 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
float const _value );
2192 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
int32 const _value );
2203 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
int16 const _value );
2214 DEPRECATED bool AddSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
string const& _value );
2225 DEPRECATED bool AddSceneValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
string const& _value );
2236 DEPRECATED bool AddSceneValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
int32 const _value );
2246 DEPRECATED bool RemoveSceneValue(
uint8 const _sceneId, ValueID
const& _valueId );
2256 DEPRECATED int SceneGetValues(
uint8 const _sceneId, vector<ValueID>* o_value );
2267 DEPRECATED bool SceneGetValueAsBool(
uint8 const _sceneId, ValueID
const& _valueId,
bool* o_value );
2278 DEPRECATED bool SceneGetValueAsByte(
uint8 const _sceneId, ValueID
const& _valueId,
uint8* o_value );
2289 DEPRECATED bool SceneGetValueAsFloat(
uint8 const _sceneId, ValueID
const& _valueId,
float* o_value );
2300 DEPRECATED bool SceneGetValueAsInt(
uint8 const _sceneId, ValueID
const& _valueId,
int32* o_value );
2311 DEPRECATED bool SceneGetValueAsShort(
uint8 const _sceneId, ValueID
const& _valueId,
int16* o_value );
2322 DEPRECATED bool SceneGetValueAsString(
uint8 const _sceneId, ValueID
const& _valueId,
string* o_value );
2333 DEPRECATED bool SceneGetValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
string* o_value );
2344 DEPRECATED bool SceneGetValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
int32* o_value );
2355 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
bool const _value );
2366 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
uint8 const _value );
2377 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
float const _value );
2388 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
int32 const _value );
2399 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
int16 const _value );
2410 DEPRECATED bool SetSceneValue(
uint8 const _sceneId, ValueID
const& _valueId,
string const& _value );
2421 DEPRECATED bool SetSceneValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
string const& _value );
2432 DEPRECATED bool SetSceneValueListSelection(
uint8 const _sceneId, ValueID
const& _valueId,
int32 const _value );
2450 DEPRECATED void SetSceneLabel(
uint8 const _sceneId,
string const& _value );
2485 void GetDriverStatistics(
uint32 const _homeId, Driver::DriverData* _data );
2493 void GetNodeStatistics(
uint32 const _homeId,
uint8 const _nodeId, Node::NodeData* _data );
2535 bool checkLatestConfigFileRevision(
uint32 const _homeId,
uint8 const _nodeId);
2547 bool checkLatestMFSRevision(
uint32 const _homeId);
2565 bool downloadLatestConfigFileRevision(
uint32 const _homeId,
uint8 const _nodeId);
2578 bool downloadLatestMFSRevision(
uint32 const _homeId);
2589 #endif // _Manager_H Message object to be passed to and from devices on the Z-Wave network.
Definition: Msg.h:44
Definition: Bitfield.h:34
Container that holds all of the values associated with a given node.
Definition: ValueStore.h:44
#define OPENZWAVE_EXPORT
Definition: Defs.h:52
unsigned short uint16
Definition: Defs.h:93
#define OPENZWAVE_EXPORT_WARNINGS_ON
Definition: Defs.h:54
The main public interface to OpenZWave.
Definition: Manager.h:110
MetaDataFields
Definition: Node.h:697
#define DEPRECATED
Definition: Defs.h:63
#define OPENZWAVE_EXPORT_WARNINGS_OFF
Definition: Defs.h:53
The Node class describes a Z-Wave node object...typically a device on the Z-Wave network.
Definition: Node.h:65
#define NULL
Definition: Defs.h:86
ControllerCommand
Definition: Driver.h:469
Base class for all Z-Wave command classes.
Definition: CommandClass.h:54
signed short int16
Definition: Defs.h:92
ControllerInterface
Definition: Driver.h:91
signed char int8
Definition: Defs.h:89
The Driver class handles communication between OpenZWave and a device attached via a serial port (typ...
Definition: Driver.h:63
Manages library options read from XML files or the command line.
Definition: Options.h:66
signed int int32
Definition: Defs.h:95
unsigned int uint32
Definition: Defs.h:96
Manages a group of devices (various nodes associated with each other).
Definition: Group.h:49
Provides a container for data sent via the notification callback handler installed by a call to Manag...
Definition: Notification.h:44
Provides a unique ID for a value reported by a Z-Wave device.The ValueID is used to uniquely identify...
Definition: ValueID.h:62
Options * GetOptions() const
Gets a pointer to the locked Options object.
Definition: Manager.h:211
static Manager * Get()
Gets a pointer to the Manager object.
Definition: Manager.h:151
Base class for values associated with a node.
Definition: Value.h:48
void(* pfnControllerCallback_t)(ControllerState _state, ControllerError _err, void *_context)
Definition: Driver.h:531
unsigned char uint8
Definition: Defs.h:90