OpenZWave Library: Basic.h Source File

| OpenZWave Library 1.6.0

Basic.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Basic.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_BASIC
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 _Basic_H
29#define _Basic_H
30
31#include "command_classes/CommandClass.h"
32
33namespace OpenZWave
34{
35 class ValueByte;
36
40 class Basic: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Basic( _homeId, _nodeId ); }
44 virtual ~Basic(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x20; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_BASIC"; }
48
49 bool SetMapping( uint8 const _commandClassId, bool const _doLog = true ); // Map COMMAND_CLASS_BASIC messages to another command class
50 uint8_t GetMapping() { return m_com.GetFlagByte(COMPAT_FLAG_BASIC_MAPPING); };
51 // From CommandClass
52 virtual void ReadXML( TiXmlElement const* _ccElement );
53 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
54 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
55 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
56 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
57 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
58 virtual bool SetValue( Value const& _value );
59
60 void Set( uint8 const _level );
61
62 protected:
63 virtual void CreateVars( uint8 const _instance );
64
65 private:
66 Basic( uint32 const _homeId, uint8 const _nodeId );
67
68 std::vector<int> m_instances;
69 };
70
71} // namespace OpenZWave
72
73#endif
74
CommandClass.h
uint16
unsigned short uint16
Definition: Defs.h:92
uint32
unsigned int uint32
Definition: Defs.h:95
uint8
unsigned char uint8
Definition: Defs.h:89
OpenZWave::Basic
Implements COMMAND_CLASS_BASIC (0x20), a Z-Wave device command class.
Definition: Basic.h:41
OpenZWave::Basic::SetValue
virtual bool SetValue(Value const &_value)
Definition: Basic.cpp:200
OpenZWave::Basic::StaticGetCommandClassId
static uint8 const StaticGetCommandClassId()
Definition: Basic.h:46
OpenZWave::Basic::GetCommandClassId
virtual uint8 const GetCommandClassId() const
Definition: Basic.h:55
OpenZWave::Basic::RequestValue
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Basic.cpp:111
OpenZWave::Basic::GetMapping
uint8_t GetMapping()
Definition: Basic.h:50
OpenZWave::Basic::StaticGetCommandClassName
static string const StaticGetCommandClassName()
Definition: Basic.h:47
OpenZWave::Basic::GetCommandClassName
virtual string const GetCommandClassName() const
Definition: Basic.h:56
OpenZWave::Basic::SetMapping
bool SetMapping(uint8 const _commandClassId, bool const _doLog=true)
Definition: Basic.cpp:259
OpenZWave::Basic::~Basic
virtual ~Basic()
Definition: Basic.h:44
OpenZWave::Basic::Create
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Basic.h:43
OpenZWave::Basic::ReadXML
virtual void ReadXML(TiXmlElement const *_ccElement)
Definition: Basic.cpp:73
OpenZWave::Basic::Set
void Set(uint8 const _level)
Definition: Basic.cpp:241
OpenZWave::Basic::RequestState
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Basic.cpp:87
OpenZWave::Basic::CreateVars
virtual void CreateVars(uint8 const _instance)
Definition: Basic.cpp:229
OpenZWave::Basic::HandleMsg
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Basic.cpp:140
OpenZWave::CommandClass
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
OpenZWave::CommandClass::m_com
CompatOptionManager m_com
Definition: CommandClass.h:163
OpenZWave::CompatOptionManager::GetFlagByte
uint8_t GetFlagByte(CompatOptionFlags flag) const
Definition: CompatOptionManager.cpp:284
OpenZWave::Driver::MsgQueue
MsgQueue
Definition: Driver.h:592
OpenZWave::Value
Base class for values associated with a node.
Definition: Value.h:49
OpenZWave
Definition: Bitfield.h:35
OpenZWave::COMPAT_FLAG_BASIC_MAPPING
@ COMPAT_FLAG_BASIC_MAPPING
Definition: CompatOptionManager.h:47