-
Notifications
You must be signed in to change notification settings - Fork 0
/
MePort.h
459 lines (422 loc) · 9.35 KB
/
MePort.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/**
* \par Copyright (C), 2012-2016, MakeBlock
* \class MePort
* \brief Port Mapping for RJ25
* @file MePort.h
* @author MakeBlock
* @version V1.0.3
* @date 2016/09/20
* @brief Header for MePort.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 MakeBlock rj25 port.
*
* \par Method List:
*
* 1. uint8_t MePort::getSlot()
* 2. uint8_t MePort::getSlot()
* 3. bool MePort::dRead1(uint8_t mode)
* 4. bool MePort::dRead2(uint8_t mode)
* 5. bool MePort::dpRead1(void)
* 6. bool MePort::dpRead1(void)
* 7. void MePort::dWrite1(bool value)
* 8. void MePort::dWrite2(bool value)
* 9. int16_t MePort::aRead1()
* 10. int16_t MePort::aRead2()
* 11. void MePort::aWrite1(int16_t value)
* 12. void MePort::aWrite2(int16_t value)
* 13. void MePort::reset(uint8_t port)
* 14. void MePort::reset(uint8_t port, uint8_t slot)
* 15. uint8_t MePort::pin1()
* 16. uint8_t MePort::pin2()
* 17. uint8_t MePort::pin()
* 18. uint8_t MePort::pin(uint8_t port, uint8_t slot)
*
* \par History:
* <pre>
* `<Author>` `<Time>` `<Version>` `<Descr>`
* Mark Yan 2015/09/01 1.0.0 Rebuild the old lib.
* Lawrence 2015/09/09 1.0.1 Add a input parameter of function dRead1 and dRead2.
* Scott wang 2016/09/18 1.0.2 Add the PORT[15].
* Scott 2016/09/20 1.0.3 Add the PORT[16].
* </pre>
*/
#ifndef MEPORT_H_
#define MEPORT_H_
#include <Arduino.h>
#include <avr/interrupt.h>
#include <avr/io.h>
#include <util/delay.h>
#include <stdint.h>
#include <stdlib.h>
#include "MeConfig.h"
/**
* A structure to represent MePort Signal.
*/
typedef struct
{
uint8_t s1;
uint8_t s2;
} MePort_Sig;
extern MePort_Sig mePort[17]; // mePort[0] is nonsense
#define NC (0) //use UART RX for NULL port
#define PORT_1 (0x01)
#define PORT_2 (0x02)
#define PORT_3 (0x03)
#define PORT_4 (0x04)
#define PORT_5 (0x05)
#define PORT_6 (0x06)
#define PORT_7 (0x07)
#define PORT_8 (0x08)
#define PORT_9 (0x09)
#define PORT_10 (0x0a)
#define M1 (0x09)
#define M2 (0x0a)
#define PORT_11 (0x0b)
#define PORT_12 (0x0c)
#define PORT_13 (0x0d)
#define PORT_14 (0x0e)
#define PORT_15 (0x0f)
#define PORT_16 (0x10)
#ifdef MeMbot_H
#define PORT_RGB (0x05)
#define PORT_LightSensor (0x06)
#endif
#define SLOT1 (1)
#define SLOT2 (2)
#define SLOT3 (3)
#define SLOT4 (4)
#define SLOT_1 SLOT1
#define SLOT_2 SLOT2
#define SLOT_3 SLOT3
#define SLOT_4 SLOT4
#ifndef FALSE
#define FALSE (0)
#endif
#ifndef TRUE
#define TRUE (1)
#endif
/**
* Class: MePort
*
* \par Description
* Declaration of Class MePort
*/
class MePort
{
public:
/**
* Alternate Constructor which can call your own function to map the MePort to arduino port,
* no pins are used or initialized here
*/
MePort(void);
/**
* Alternate Constructor which can call your own function to map the MePort to arduino port,
* no pins are used or initialized here, but PWM frequency set to 976 Hz
* \param[in]
* port - RJ25 port from PORT_1 to M2
*/
MePort(uint8_t port);
/**
* Alternate Constructor which can call your own function to map the MePort to arduino port,
* no pins are used or initialized here, but PWM frequency set to 976 Hz
* \param[in]
* port - RJ25 port from PORT_1 to M2
* \param[in]
* slot - SLOT1 or SLOT2
*/
MePort(uint8_t port, uint8_t slot);
/**
* \par Function
* getPort
* \par Description
* Get current valid port of current RJ25 object
* \par Output
* None
* \return
* Port bumber from PORT_1 to M2
* \par Others
* None
*/
uint8_t getPort(void);
/**
* \par Function
* getSlot
* \par Description
* Get current valid slot of current RJ25 object's port
* \par Output
* None
* \return
* Slot bumber SLOT1 or SLOT2
* \par Others
* None
*/
uint8_t getSlot(void);
/**
* \par Function
* dRead1
* \par Description
* Read the digital input value on slot1 of current RJ25 object's port
* \param[in]
* mode - digital input mode INPUT or INPUT_PULLUP
* \par Output
* None
* \return
* Digital input value
* \par Others
* None
*/
bool dRead1(uint8_t mode = INPUT);
/**
* \par Function
* dRead2
* \par Description
* Read the digital input value on slot2 of current RJ25 object's port
* \param[in]
* mode - digital input mode INPUT or INPUT_PULLUP
* \par Output
* None
* \return
* Digital input value
* \par Others
* None
*/
bool dRead2(uint8_t mode = INPUT);
/**
* \par Function
* dpRead1
* \par Description
* Read the digital input value on slot1 of current RJ25 object's port, the input
* mode set as INPUT_PULLUP.
* \par Output
* None
* \return
* Digital input value
* \par Others
* None
*/
bool dpRead1(void);
/**
* \par Function
* dpRead2
* \par Description
* Read the digital input value on slot2 of current RJ25 object's port, the input
* mode set as INPUT_PULLUP.
* \par Output
* None
* \return
* Digital input value
* \par Others
* None
*/
bool dpRead2(void);
/**
* \par Function
* dWrite1
* \par Description
* Set the digital output value on slot1 of current RJ25 object's port
* \param[in]
* value - digital output value HIGH or LOW
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void dWrite1(bool value);
/**
* \par Function
* dWrite2
* \par Description
* Set the digital output value on slot2 of current RJ25 object's port
* \param[in]
* value - digital output value HIGH or LOW
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void dWrite2(bool value);
/**
* \par Function
* aRead1
* \par Description
* Read the analog value on slot1 of current RJ25 object's port
* \par Output
* None
* \return
* Analog value from 0-1023
* \par Others
* None
*/
int16_t aRead1(void);
/**
* \par Function
* aRead2
* \par Description
* Read the analog value on slot2 of current RJ25 object's port
* \par Output
* None
* \return
* Analog value from 0-1023
* \par Others
* None
*/
int16_t aRead2(void);
/**
* \par Function
* aWrite1
* \par Description
* Set the PWM output value on slot1 of current RJ25 object's port
* \param[in]
* value - Analog value between 0 to 255
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void aWrite1(int16_t value);
/**
* \par Function
* aWrite2
* \par Description
* Set the PWM output value on slot2 of current RJ25 object's port
* \param[in]
* value - Analog value between 0 to 255
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void aWrite2(int16_t value);
/**
* \par Function
* reset
* \par Description
* Reset the RJ25 available PIN by its port
* \param[in]
* port - RJ25 port from PORT_1 to M2
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void reset(uint8_t port);
/**
* \par Function
* reset
* \par Description
* Reset the RJ25 available PIN by its port and slot
* \param[in]
* port - RJ25 port from PORT_1 to M2
* \param[in]
* slot - SLOT1 or SLOT2
* \par Output
* None
* \return
* None
* \par Others
* None
*/
void reset(uint8_t port, uint8_t slot);
/**
* \par Function
* pin1
* \par Description
* Return the arduino pin number of current RJ25 object's slot1
* \par Output
* None
* \return
* The PIN number of arduino
* \par Others
* None
*/
uint8_t pin1(void);
/**
* \par Function
* pin2
* \par Description
* Return the arduino pin number of current RJ25 object's slot2
* \par Output
* None
* \return
* The PIN number of arduino
* \par Others
* None
*/
uint8_t pin2(void);
/**
* \par Function
* pin
* \par Description
* Return the arduino pin number of current RJ25 object's port, if the RJ25 module
* have one available PIN.
* \par Output
* None
* \return
* The PIN number of arduino
* \par Others
* None
*/
uint8_t pin(void);
/**
* \par Function
* pin
* \par Description
* Return the arduino pin number of current RJ25 object's port
* \param[in]
* port - RJ25 port from PORT_1 to M2
* \param[in]
* slot - SLOT1 or SLOT2
* \par Output
* None
* \return
* The PIN number of arduino
* \par Others
* None
*/
uint8_t pin(uint8_t port, uint8_t slot);
protected:
/**
* \par Description
* Variables used to store the slot1 gpio number
*/
uint8_t s1;
/**
* \par Description
* Variables used to store the slot2 gpio number
*/
uint8_t s2;
/**
* \par Description
* Variables used to store the port
*/
uint8_t _port;
/**
* \par Description
* Variables used to store the slot
*/
uint8_t _slot;
};
#endif // MEPORT_H_