![]() |
OpenZWave Library
1.4.164
|
Base class for all Z-Wave command classes. More...
#include <CommandClass.h>
Classes | |
struct | RefreshValue |
Public Types | |
enum | { RequestFlag_Static = 0x00000001, RequestFlag_Session = 0x00000002, RequestFlag_Dynamic = 0x00000004, RequestFlag_AfterMark = 0x00000008 } |
enum | StaticRequest { StaticRequest_Instances = 0x01, StaticRequest_Values = 0x02, StaticRequest_Version = 0x04 } |
typedef struct OpenZWave::CommandClass::RefreshValue | RefreshValue |
Public Member Functions | |
CommandClass (uint32 const _homeId, uint8 const _nodeId) | |
virtual | ~CommandClass () |
virtual void | ReadXML (TiXmlElement const *_ccElement) |
virtual void | WriteXML (TiXmlElement *_ccElement) |
virtual bool | RequestState (uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) |
virtual bool | RequestValue (uint32 const _requestFlags, uint8 const _index, uint8 const _instance, Driver::MsgQueue const _queue) |
virtual uint8 const | GetCommandClassId () const =0 |
virtual string const | GetCommandClassName () const =0 |
virtual bool | HandleMsg (uint8 const *_data, uint32 const _length, uint32 const _instance=1)=0 |
virtual bool | SetValue (Value const &_value) |
virtual void | SetValueBasic (uint8 const _instance, uint8 const _level) |
virtual void | SetVersion (uint8 const _version) |
bool | RequestStateForAllInstances (uint32 const _requestFlags, Driver::MsgQueue const _queue) |
bool | CheckForRefreshValues (Value const *_value) |
virtual uint8 | GetMaxVersion () |
uint8 | GetVersion () const |
Bitfield const * | GetInstances () const |
uint32 | GetHomeId () const |
uint8 | GetNodeId () const |
Driver * | GetDriver () const |
Node * | GetNodeUnsafe () const |
Value * | GetValue (uint8 const _instance, uint8 const _index) |
bool | RemoveValue (uint8 const _instance, uint8 const _index) |
uint8 | GetEndPoint (uint8 const _instance) |
uint8 | GetInstance (uint8 const _endPoint) |
void | SetInstances (uint8 const _instances) |
void | SetInstance (uint8 const _endPoint) |
void | SetAfterMark () |
void | SetEndPoint (uint8 const _instance, uint8 const _endpoint) |
bool | IsAfterMark () const |
bool | IsCreateVars () const |
bool | IsGetSupported () const |
bool | IsSecured () const |
void | SetSecured () |
bool | IsSecureSupported () const |
void | ClearSecureSupport () |
void | SetSecureSupport () |
void | SetInNIF () |
bool | IsInNIF () |
string | ExtractValue (uint8 const *_data, uint8 *_scale, uint8 *_precision, uint8 _valueOffset=1) const |
void | AppendValue (Msg *_msg, string const &_value, uint8 const _scale) const |
uint8 const | GetAppendValueSize (string const &_value) const |
int32 | ValueToInteger (string const &_value, uint8 *o_precision, uint8 *o_size) const |
void | UpdateMappedClass (uint8 const _instance, uint8 const _classId, uint8 const _value) |
virtual void | CreateVars (uint8 const _instance, uint8 const _index) |
bool | HasStaticRequest (uint8 _request) const |
void | SetStaticRequest (uint8 _request) |
void | ClearStaticRequest (uint8 _request) |
uint32 | GetSentCnt () const |
uint32 | GetReceivedCnt () const |
void | SentCntIncr () |
void | ReceivedCntIncr () |
Protected Member Functions | |
virtual void | CreateVars (uint8 const _instance) |
void | ReadValueRefreshXML (TiXmlElement const *_ccElement) |
Base class for all Z-Wave command classes.
anonymous enum |
|
virtual |
Append a floating-point value to a message.
_msg | The message to which the value should be appended. |
_value | A string containing a decimal number to be appended. |
_scale | A byte indicating the scale corresponding to this value (e.g., 1=F and 0=C for temperatures). |
bool CommandClass::CheckForRefreshValues | ( | Value const * | _value | ) |
|
inline |
void CommandClass::ClearStaticRequest | ( | uint8 | _request | ) |
|
inlineprotectedvirtual |
Reimplemented in OpenZWave::Security, OpenZWave::Powerlevel, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Basic, OpenZWave::Protection, OpenZWave::Alarm, OpenZWave::SwitchMultilevel, OpenZWave::AssociationCommandConfiguration, OpenZWave::Color, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::DoorLock, OpenZWave::SwitchAll, OpenZWave::Version, OpenZWave::SensorBinary, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::CentralScene, OpenZWave::Clock, OpenZWave::DoorLockLogging, OpenZWave::Meter, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::TimeParameters, OpenZWave::Indicator, OpenZWave::Lock, OpenZWave::SwitchToggleBinary, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Language, OpenZWave::MeterPulse, OpenZWave::BasicWindowCovering, OpenZWave::ControllerReplication, and OpenZWave::ZWavePlusInfo.
|
inlinevirtual |
Reimplemented in OpenZWave::ThermostatSetpoint.
string CommandClass::ExtractValue | ( | uint8 const * | _data, |
uint8 * | _scale, | ||
uint8 * | _precision, | ||
uint8 | _valueOffset = 1 |
||
) | const |
uint8 const CommandClass::GetAppendValueSize | ( | string const & | _value | ) | const |
|
pure virtual |
Implemented in OpenZWave::MultiInstance, OpenZWave::Security, OpenZWave::Powerlevel, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::AssociationCommandConfiguration, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::Configuration, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Alarm, OpenZWave::Association, OpenZWave::Color, OpenZWave::SwitchAll, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SwitchMultilevel, OpenZWave::CentralScene, OpenZWave::Clock, OpenZWave::MultiCmd, OpenZWave::SceneActivation, OpenZWave::TimeParameters, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::ManufacturerSpecific, OpenZWave::BasicWindowCovering, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::ZWavePlusInfo, OpenZWave::ApplicationStatus, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::Hail, and OpenZWave::Proprietary.
|
pure virtual |
Implemented in OpenZWave::MultiInstance, OpenZWave::Security, OpenZWave::Powerlevel, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::AssociationCommandConfiguration, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::Alarm, OpenZWave::ClimateControlSchedule, OpenZWave::Configuration, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::Color, OpenZWave::SwitchAll, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::CentralScene, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SceneActivation, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SwitchMultilevel, OpenZWave::Clock, OpenZWave::MultiCmd, OpenZWave::TimeParameters, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::ManufacturerSpecific, OpenZWave::BasicWindowCovering, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::ZWavePlusInfo, OpenZWave::ApplicationStatus, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::Hail, and OpenZWave::Proprietary.
Driver * CommandClass::GetDriver | ( | ) | const |
|
inline |
|
inline |
|
inlinevirtual |
|
inline |
Node * CommandClass::GetNodeUnsafe | ( | ) | const |
|
inline |
|
inline |
|
inline |
|
pure virtual |
Implemented in OpenZWave::MultiInstance, OpenZWave::Security, OpenZWave::Powerlevel, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::AssociationCommandConfiguration, OpenZWave::Alarm, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::Configuration, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::CentralScene, OpenZWave::Color, OpenZWave::SceneActivation, OpenZWave::SwitchAll, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SwitchMultilevel, OpenZWave::Clock, OpenZWave::MultiCmd, OpenZWave::TimeParameters, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::ManufacturerSpecific, OpenZWave::BasicWindowCovering, OpenZWave::NodeNaming, OpenZWave::NoOperation, OpenZWave::ZWavePlusInfo, OpenZWave::ApplicationStatus, OpenZWave::ControllerReplication, OpenZWave::CRC16Encap, OpenZWave::DeviceResetLocally, OpenZWave::Hail, and OpenZWave::Proprietary.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
protected |
|
virtual |
Reimplemented in OpenZWave::Security, OpenZWave::MultiInstance, OpenZWave::CentralScene, OpenZWave::UserCode, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, and OpenZWave::SensorBinary.
|
inline |
|
inlinevirtual |
Reimplemented in OpenZWave::Powerlevel, OpenZWave::CentralScene, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::AssociationCommandConfiguration, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::SwitchAll, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::Alarm, OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SwitchMultilevel, OpenZWave::Clock, OpenZWave::TimeParameters, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::ManufacturerSpecific, OpenZWave::NodeNaming, and OpenZWave::ZWavePlusInfo.
bool CommandClass::RequestStateForAllInstances | ( | uint32 const | _requestFlags, |
Driver::MsgQueue const | _queue | ||
) |
|
inlinevirtual |
Reimplemented in OpenZWave::Powerlevel, OpenZWave::CentralScene, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::AssociationCommandConfiguration, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::SwitchAll, OpenZWave::ThermostatFanState, OpenZWave::ThermostatOperatingState, OpenZWave::Alarm, OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SensorAlarm, OpenZWave::SensorBinary, OpenZWave::SwitchMultilevel, OpenZWave::Clock, OpenZWave::Configuration, OpenZWave::TimeParameters, OpenZWave::Battery, OpenZWave::EnergyProduction, OpenZWave::Indicator, OpenZWave::Language, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::MeterPulse, OpenZWave::SensorMultilevel, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::ManufacturerSpecific, OpenZWave::NodeNaming, and OpenZWave::ZWavePlusInfo.
|
inline |
|
inline |
|
inline |
void CommandClass::SetInstance | ( | uint8 const | _endPoint | ) |
void CommandClass::SetInstances | ( | uint8 const | _instances | ) |
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Reimplemented in OpenZWave::Powerlevel, OpenZWave::WakeUp, OpenZWave::SwitchToggleMultilevel, OpenZWave::UserCode, OpenZWave::Protection, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::Configuration, OpenZWave::ThermostatSetpoint, OpenZWave::Color, OpenZWave::SwitchAll, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, OpenZWave::SwitchMultilevel, OpenZWave::Clock, OpenZWave::TimeParameters, OpenZWave::Indicator, OpenZWave::Lock, OpenZWave::Meter, OpenZWave::SwitchBinary, OpenZWave::SwitchToggleBinary, OpenZWave::BasicWindowCovering, and OpenZWave::ControllerReplication.
|
inlinevirtual |
Reimplemented in OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::SwitchMultilevel, OpenZWave::SensorBinary, and OpenZWave::SwitchBinary.
|
inlinevirtual |
Reimplemented in OpenZWave::WakeUp, and OpenZWave::SwitchMultilevel.
void CommandClass::UpdateMappedClass | ( | uint8 const | _instance, |
uint8 const | _classId, | ||
uint8 const | _value | ||
) |
int32 CommandClass::ValueToInteger | ( | string const & | _value, |
uint8 * | o_precision, | ||
uint8 * | o_size | ||
) | const |
|
virtual |
Reimplemented in OpenZWave::Security, OpenZWave::MultiInstance, OpenZWave::CentralScene, OpenZWave::UserCode, OpenZWave::Basic, OpenZWave::ThermostatFanMode, OpenZWave::ThermostatMode, OpenZWave::ClimateControlSchedule, OpenZWave::MultiInstanceAssociation, OpenZWave::ThermostatSetpoint, OpenZWave::Version, OpenZWave::Association, OpenZWave::Color, OpenZWave::DoorLock, OpenZWave::DoorLockLogging, and OpenZWave::SensorBinary.