Easyuino  1.2.0
Device.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 Device.h
26 */
27 
28 #ifndef _EASYUINO_DEVICE_h
29 #define _EASYUINO_DEVICE_h
30 
31 #if defined(ARDUINO) && ARDUINO >= 100
32 #include <Arduino.h>
33 #else
34 #include "WProgram.h"
35 #endif
36 
37 #include "Utilities.h"
38 
39 namespace Easyuino {
40 
42  class Device {
43 
44  protected:
47 
48  public:
50  Device();
51 
53  ~Device();
54 
55  #pragma region Public Virtual Common API Methods
56 
61  virtual bool begin() = 0;
62 
64  virtual void end() = 0;
65 
66  #pragma endregion
67 
68 
69  #pragma region Public Common API Methods
70 
74  bool isInitialized() const;
75 
76  #pragma endregion
77 
78  };
79 
80 };
81 
82 #endif
bool _isInitialized
Used to know if the device API is initialized and ready to receive requests.
Definition: Device.h:46
Device()
Constructor called by every sub-classes.
virtual bool begin()=0
Used to put the device ready to receive requests.
~Device()
Destroy all the resources associated with the device.
Definition: Button.h:38
virtual void end()=0
Used to stop the device API.
General class that provides the common API behaviour for all the devices/sensors. ...
Definition: Device.h:42
bool isInitialized() const
Verify is the device is initialized and ready to use.