OpenZWave Library  1.6.770
NodeNaming.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // NodeNaming.h
4 //
5 // Implementation of the Z-Wave COMMAND_CLASS_NODE_NAMING
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 _NodeNaming_H
29 #define _NodeNaming_H
30 
32 
33 namespace OpenZWave
34 {
35  namespace Internal
36  {
37  namespace CC
38  {
44  string ExtractString(uint8 const* _data, uint32 const _length);
45 
51  uint32 ConvertUFT16ToUTF8(uint16 _utf16, char* _buffer, uint32 pos);
52 
56  class NodeNaming: public CommandClass
57  {
58  public:
59  static CommandClass* Create(uint32 const _homeId, uint8 const _nodeId)
60  {
61  return new NodeNaming(_homeId, _nodeId);
62  }
63  virtual ~NodeNaming()
64  {
65  }
66 
68  {
69  return 0x77;
70  }
71  static string const StaticGetCommandClassName()
72  {
73  return "COMMAND_CLASS_NODE_NAMING";
74  }
75 
76  // From CommandClass
77  virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override;
78  virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override;
79  virtual uint8 const GetCommandClassId() const override
80  {
81  return StaticGetCommandClassId();
82  }
83  virtual string const GetCommandClassName() const override
84  {
86  }
87  virtual bool HandleMsg(uint8 const* _data, uint32 const _length, uint32 const _instance = 1) override;
88 
89  void SetName(string const& _name);
90  void SetLocation(string const& _location);
91 
92  private:
93  NodeNaming(uint32 const _homeId, uint8 const _nodeId) :
94  CommandClass(_homeId, _nodeId)
95  {
96  }
97  };
98  } // namespace CC
99  } // namespace Internal
100 } // namespace OpenZWave
101 
102 #endif
103 
Definition: Bitfield.cpp:30
MsgQueue
Definition: Driver.h:658
unsigned short uint16
Definition: Defs.h:88
uint32 ConvertUFT16ToUTF8(uint16 _utf16, char *_buffer, uint32 pos)
Convert from UTF16 to UTF8this function is used by the NodeNaming CC as well as the Alarm CC...
Definition: NodeNaming.cpp:455
virtual uint8 const GetCommandClassId() const override
Definition: NodeNaming.h:79
static string const StaticGetCommandClassName()
Definition: NodeNaming.h:71
Implements COMMAND_CLASS_NODE_NAMING (0x77), a Z-Wave device command class.
Definition: NodeNaming.h:56
Base class for all Z-Wave command classes.
Definition: CommandClass.h:60
virtual string const GetCommandClassName() const override
Definition: NodeNaming.h:83
static CommandClass * Create(uint32 const _homeId, uint8 const _nodeId)
Definition: NodeNaming.h:59
void SetLocation(string const &_location)
Definition: NodeNaming.cpp:354
static uint8 const StaticGetCommandClassId()
Definition: NodeNaming.h:67
unsigned int uint32
Definition: Defs.h:91
void SetName(string const &_name)
Definition: NodeNaming.cpp:325
virtual bool HandleMsg(uint8 const *_data, uint32 const _length, uint32 const _instance=1) override
Definition: NodeNaming.cpp:281
virtual bool RequestState(uint32 const _requestFlags, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: NodeNaming.cpp:205
virtual bool RequestValue(uint32 const _requestFlags, uint16 const _index, uint8 const _instance, Driver::MsgQueue const _queue) override
Definition: NodeNaming.cpp:233
virtual ~NodeNaming()
Definition: NodeNaming.h:63
std::string ExtractString(uint8 const *_data, uint32 const _length)
Extract a String from a Z-Wave Encoded Packetthis function is used by the NodeNaming CC as well as th...
Definition: NodeNaming.cpp:383
unsigned char uint8
Definition: Defs.h:85