Easyuino  1.2.0
RelayNamed.h
1 /*
2 MIT License
3 
4 Copyright (c) 2017 André Pires
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 /*
25 RelayNamed.h
26 */
27 #ifndef _EASYUINO_RELAY_NAMED_h
28 #define _EASYUINO_RELAY_NAMED_h
29 
30 #include "Utilities.h"
31 #include "Device.h"
32 #include "Printable.h"
33 #include "Relay.h"
34 
36 #define MAX_NAME_SIZE 15
37 
38 #define RELAY_ON_STRING "On"
39 #define RELAY_OFF_STRING "Off"
40 
41 namespace Easyuino {
42 
47  class RelayNamed : public Relay, public Printable {
48 
49  private:
51  char _name[MAX_NAME_SIZE + 1];
52 
53  public:
58  RelayNamed(IN uint8_t arduinoPin, IN const char* deviceName);
59 
60  ~RelayNamed();
61 
62  char* toString() const;
63 
64  };
65 
66 };
67 
68 #endif
RelayNamed offers the same API of the Relay plus the possibility to associate a string label to the A...
Definition: RelayNamed.h:47
char * toString() const
Used to return a string representation of the object state.
RelayNamed(IN uint8_t arduinoPin, IN const char *deviceName)
Constructor.
Definition: Button.h:38
Relay offers a simple API to interact with relay devices.
Definition: Relay.h:39
Provides an interface interface to write objects to a Stream.
Definition: Printable.h:42