-
Notifications
You must be signed in to change notification settings - Fork 0
/
MeShutter.h
191 lines (182 loc) · 4.3 KB
/
MeShutter.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/**
* \par Copyright (C), 2012-2016, MakeBlock
* \class MeShutter
* \brief Driver for Me Shutter device.
* @file MeShutter.h
* @author MakeBlock
* @version V1.0.1
* @date 2016/05/24
* @brief Header for MeShutter.cpp module
*
* \par Copyright
* This software is Copyright (C), 2012-2016, MakeBlock. Use is subject to license \n
* conditions. The main licensing options available are GPL V2 or Commercial: \n
*
* \par Open Source Licensing GPL V2
* This is the appropriate option if you want to share the source code of your \n
* application with everyone you distribute it to, and you also want to give them \n
* the right to share who uses it. If you wish to use this software under Open \n
* Source Licensing, you must contribute all your source code to the open source \n
* community in accordance with the GPL Version 2 when your application is \n
* distributed. See http://www.gnu.org/copyleft/gpl.html
*
* \par Description
* This file is a drive for Me Shutter device, It supports Me Shutter device
* V1.0 provided by the MakeBlock.
*
* \par Method List:
*
* 1. void MeShutter::setpin(uint8_t ShotPin, uint8_t FocusPin)
* 2. uint8_t MeShutter::shotOn()
* 3. uint8_t MeShutter::shotOff()
* 4. uint8_t MeShutter::focusOn()
* 5. uint8_t MeShutter::focusOff()
* 6. void MeShutter::setState(uint8_t state)
*
* \par History:
* <pre>
* `<Author>` `<Time>` `<Version>` `<Descr>`
* Mark Yan 2015/09/04 1.0.0 Rebuild the old lib.
* Mark Yan 2016/05/24 1.0.1 Add function setState for mblock.
* </pre>
*
*/
#ifndef MeShutter_H
#define MeShutter_H
#include <stdint.h>
#include <stdbool.h>
#include <Arduino.h>
#include "MeConfig.h"
#ifdef ME_PORT_DEFINED
#include "MePort.h"
#endif /* ME_PORT_DEFINED */
/**
* Class: MeShutter
* \par Description
* Declaration of Class MeShutter.
*/
#ifndef ME_PORT_DEFINED
class MeShutter
#else // !ME_PORT_DEFINED
class MeShutter : public MePort
#endif // !ME_PORT_DEFINED
{
public:
#ifdef ME_PORT_DEFINED
/**
* Alternate Constructor which can call your own function to map the MeShutter to arduino port,
* no pins are used or initialized here.
* \param[in]
* None
*/
MeShutter(void);
/**
* Alternate Constructor which can call your own function to map the MeShutter to arduino port,
* and the shot and focus PIN will be set LOW
* \param[in]
* port - RJ25 port from PORT_1 to M2
*/
MeShutter(uint8_t port);
#else // ME_PORT_DEFINED
/**
* Alternate Constructor which can call your own function to map the MeShutter to arduino port,
* it will assigned the shot PIN and focus pin.
* \param[in]
* ShotPin - arduino port for shot PIN(should digital pin)
* \param[in]
* FocusPin - arduino port for focus PIN(should digital pin)
*/
MeShutter(uint8_t ShotPin, uint8_t FocusPin);
#endif // ME_PORT_DEFINED
/**
* \par Function
* setpin
* \par Description
* Reset the shutter available PIN by its arduino port.
* \param[in]
* ShotPin - arduino port for shot PIN(should digital pin)
* \param[in]
* FocusPin - arduino port for focus PIN(should digital pin)
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void setpin(uint8_t ShotPin, uint8_t FocusPin);
/**
* \par Function
* shotOn
* \par Description
* Set the shot PIN on
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void shotOn(void);
/**
* \par Function
* shotOff
* \par Description
* Set the shot PIN off
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void shotOff(void);
/**
* \par Function
* focusOn
* \par Description
* Set the focus PIN on
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void focusOn(void);
/**
* \par Function
* focusOff
* \par Description
* Set the focus PIN off
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void focusOff(void);
/**
* \par Function
* focusOff
* \par Description
* Set shutter device's work state.
* \param[in]
* state - 0:shotOff\n
* 1:shotOn\n
* 2:focusOff\n
* 3:focusOn\n
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void setState(uint8_t state);
private:
volatile uint8_t _ShotPin;
volatile uint8_t _FocusPin;
};
#endif