OpenZWave Library 1.6.0
Battery.h
Go to the documentation of this file.
1//-----------------------------------------------------------------------------
2//
3// Battery.h
4//
5// Implementation of the Z-Wave COMMAND_CLASS_BATTERY
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 _Battery_H
29#define _Battery_H
30
32
33namespace OpenZWave
34{
35 class ValueByte;
36
40 class Battery: public CommandClass
41 {
42 public:
43 static CommandClass* Create( uint32 const _homeId, uint8 const _nodeId ){ return new Battery( _homeId, _nodeId ); }
44 virtual ~Battery(){}
45
46 static uint8 const StaticGetCommandClassId(){ return 0x80; }
47 static string const StaticGetCommandClassName(){ return "COMMAND_CLASS_BATTERY"; }
48
49 // From CommandClass
50 virtual bool RequestState( uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue );
51 virtual bool RequestValue( uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue );
52 virtual uint8 const GetCommandClassId()const{ return StaticGetCommandClassId(); }
53 virtual string const GetCommandClassName()const{ return StaticGetCommandClassName(); }
54 virtual bool HandleMsg( uint8 const* _data, uint32 const _length, uint32 const _instance = 1 );
55
56 protected:
57 virtual void CreateVars( uint8 const _instance );
58
59 private:
60 Battery( uint32 const _homeId, uint8 const _nodeId ): CommandClass( _homeId, _nodeId ){}
61 };
62
63} // namespace OpenZWave
64
65#endif
66
unsigned short uint16
Definition: Defs.h:92
unsigned int uint32
Definition: Defs.h:95
unsigned char uint8
Definition: Defs.h:89
Implements COMMAND_CLASS_BATTERY (0x80), a Z-Wave device command class.
Definition: Battery.h:41
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Battery.cpp:51
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Battery.h:43
static uint8 const StaticGetCommandClassId()
Definition: Battery.h:46
virtual uint8 const GetCommandClassId() const
Definition: Battery.h:52
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue)
Definition: Battery.cpp:70
virtual ~Battery()
Definition: Battery.h:44
virtual void CreateVars(uint8 const _instance)
Definition: Battery.cpp:136
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1)
Definition: Battery.cpp:103
virtual string const GetCommandClassName() const
Definition: Battery.h:53
static string const StaticGetCommandClassName()
Definition: Battery.h:47
Base class for all Z-Wave command classes.
Definition: CommandClass.h:56
MsgQueue
Definition: Driver.h:592
Definition: Bitfield.h:35