OpenZWave Library  1.6.913
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 
33 namespace OpenZWave
34 {
35  namespace Internal
36  {
37  namespace CC
38  {
42  class Battery: public CommandClass
43  {
44  public:
45  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
46  {
47  return new Battery(_homeId, _nodeId);
48  }
49  virtual ~Battery()
50  {
51  }
52 
54  {
55  return 0x80;
56  }
57  static string const StaticGetCommandClassName()
58  {
59  return "COMMAND_CLASS_BATTERY";
60  }
61 
62  // From CommandClass
63  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
64  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
65  virtual uint8 const GetCommandClassId() const override
66  {
67  return StaticGetCommandClassId();
68  }
69  virtual string const GetCommandClassName() const override
70  {
72  }
73  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
74 
75  protected:
76  virtual void CreateVars(uint8 const _instance) override;
77 
78  private:
79  Battery(uint32 const _homeId, uint8 const _nodeId) :
80  CommandClass(_homeId, _nodeId)
81  {
82  }
83  };
84  } // namespace CC
85  } // namespace Internal
86 } // namespace OpenZWave
87 
88 #endif
89 
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Battery.cpp:69
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:658
unsigned short uint16
Definition: Defs.h:89
virtual uint8 const GetCommandClassId() const override
Definition: Battery.h:65
static string const StaticGetCommandClassName()
Definition: Battery.h:57
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: Battery.cpp:99
virtual ~Battery()
Definition: Battery.h:49
virtual void CreateVars(uint8 const _instance) override
Definition: Battery.cpp:128
static uint8 const StaticGetCommandClassId()
Definition: Battery.h:53
Implements COMMAND_CLASS_BATTERY (0x80), a Z-Wave device command class.
Definition: Battery.h:42
virtual string const GetCommandClassName() const override
Definition: Battery.h:69
unsigned int uint32
Definition: Defs.h:92
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: Battery.h:45
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: Battery.cpp:55
unsigned char uint8
Definition: Defs.h:86