Source

FingerCommLib / FingerCommLib / FingerCommLib.cs

  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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO.Ports;

namespace Tuldok
{
    public class FingerCommLib : IDisposable
    {
        #region Fields

        SerialPort ComPort = new SerialPort("COM1", 19200, Parity.None, 8, StopBits.One);
        int userNumber;
        UserPrivilege priviledge;

        /// <summary>
        /// Response Codes from the Device
        /// </summary>
        public enum Q3Response
        {
            ACK_SUCCESS = 0x00,
            ACK_FAIL = 0x01,
            ACK_FULL = 0x04,
            ACK_NOUSER = 0x05,
            ACK_USER_EXIST = 0x07,
            ACK_TIMEOUT = 0x08
        }

        public enum RepeatMode
        {
            AllowRepeat = 0,
            NoRepeat = 1
        }

        /// <summary>
        /// Enum for user priveledge... mukhang built in yata yung user levels sa device,
        /// pwede sigurong ma-exploit yung property na ito hehe.
        /// </summary>
        public enum UserPrivilege
        {
            One = 1,
            Two = 2,
            Three = 3
        }

        #endregion

        #region Constructor/Destructor

        public FingerCommLib()
        {
            ComPort.DataReceived += new SerialDataReceivedEventHandler(ComPort_DataReceived);
            ComPort.Open();
        }

        ~FingerCommLib()
        {
            Dispose();
        }

        #endregion

        #region Receiving Methods

        /// <summary>
        /// Handles the asynchronous data receipts
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        void ComPort_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            byte[] rdata = new byte[8];

            ComPort.Read(rdata, 0, 8);

            switch (rdata[1])
            {
                case 0x2C:
                    ReceiveHibernate();
                    break;
                case 0x2D:
                    ReceiveReadPattern(rdata);
                    break;
                case 0x01:
                    ReceiveAddUser(rdata);
                    break;
                case 0x02:
                    ReceiveAddUser2(rdata);
                    break;
                case 0x03:
                    ReceiveAddUser3(rdata);
                    break;
                case 0x04:
                    ReceiveDeleteUser(rdata);
                    break;
                case 0x05:
                    ReceiveDeleteAllUsers(rdata);
                    break;
                case 0x09:
                    ReceiveGetUsersCount(rdata);
                    break;
                case 0x0B:
                    ReceiveVerifyFingerPrint(rdata);
                    break;
                case 0x0C:
                    ReceiveSearchUser(rdata);
                    break;
                case 0x0A:
                    ReceiveGetUserPriviledge(rdata);
                    break;
            }

        }

        /// <summary>
        /// Function that is called when hibernation is a success
        /// </summary>
        private void ReceiveHibernate()
        {
            // TODO: Put code here to handle a successfull hibernation event
        }

        /// <summary>
        /// Function that is called after setting the repeat mode
        /// </summary>
        private void ReceiveReadPattern(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: Put code here to handle a failure to set/get data
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successful mode setting
            }
        }

        /// <summary>
        /// Function that is called after the first fingerprint sampling
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveAddUser(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successfull adduser

                AddFingerprint2(userNumber, priviledge);
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: Put code here to handle failure to add user
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FULL)
            {
                // TODO: Put code here to handle users full message
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_TIMEOUT)
            {
                // TODO: Put code here to handle data acquisition timeout
            }
        }

        /// <summary>
        /// Function that is called after the 2nd fingerprint sampling
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveAddUser2(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successfull 2nd add user

                AddFingerprint3(userNumber, priviledge);
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: Put code here to handle failure to 2nd add user
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FULL)
            {
                // TODO: Put code here to handle users full message
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_TIMEOUT)
            {
                // TODO: Put code here to handle data acquisition timeout
            }
        }

        /// <summary>
        /// Function that is called after the third fingerprint sampling
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveAddUser3(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successfull adduser

            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: Put code here to handle failure to add user
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FULL)
            {
                // TODO: Put code here to handle users full message
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_TIMEOUT)
            {
                // TODO: Put code here to handle data acquisition timeout
            }
        }

        /// <summary>
        /// Function that is called when a user delete request is sent
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveDeleteUser(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successful user deletion
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: put code to handle deletion failure
            }
        }

        /// <summary>
        /// Function that is called when a delete all users request is sent
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveDeleteAllUsers(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: Put code here to handle successful user deletion
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: put code to handle deletion failure
            }
        }

        /// <summary>
        /// Function that gets called when a user count is requested
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveGetUsersCount(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: put code to handle user count 
                int users = (((int)data[2]) << 8) + (int)data[3];
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: put code to handle failure
            }
        }

        /// <summary>
        /// Function that gets called when verification of user fingerprint is requested
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveVerifyFingerPrint(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_SUCCESS)
            {
                // TODO: put code to handle verification success
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_FAIL)
            {
                // TODO: put code to handle verification failure
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_TIMEOUT)
            {
                // TODO: put code to handle device timeout
            }
        }

        /// <summary>
        /// Function that is called when a fingerprint is searched in the device
        /// </summary>
        /// <param name="data"></param>
        private void ReceiveSearchUser(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_NOUSER)
            {
                // TODO: put code to handle no user found
            }
            else if ((Q3Response)data[4] == Q3Response.ACK_TIMEOUT)
            {
                // TODO: put code to handle device timeout
            }
            else
            {
                // TODO: put code to handle if user is found
                int users = (((int)data[2]) << 8) + (int)data[3];
                UserPrivilege priviledge = (UserPrivilege)data[4];
            }
        }

        private void ReceiveGetUserPriviledge(byte[] data)
        {
            if ((Q3Response)data[4] == Q3Response.ACK_NOUSER)
            {
                // TODO: put code to handle no user found
            }
            else
            {
                // TODO: put code to get user priviledge level
                UserPrivilege priviledge = (UserPrivilege)data[4];
            }
        }

        #endregion

        #region Sender Methods

        /// <summary>
        /// Function to make the device go into hibernation
        /// </summary>
        public void Hibernate()
        {
            byte[] sendData = new byte[8] { 0xF5, 0x2C, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF5 };

            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Sets the read pattern
        /// </summary>
        /// <param name="repeatMode"></param>
        public void SetReadPattern(RepeatMode repeatMode)
        {
            byte[] sendData = new byte[8] { 0xF5, 0x2D, 0x00, (byte)repeatMode, 0x00, 0x00, 0x00, 0xF5 };

            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to add fingerprints to the device memory
        /// </summary>
        public void AddFingerprint(int userNumber, UserPrivilege priviledge)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x01, highorder, loworder, (byte)priviledge, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);
            this.userNumber = userNumber;
            this.priviledge = priviledge;

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function that should be called after the first trial
        /// </summary>
        /// <param name="userNumber"></param>
        /// <param name="priviledge"></param>
        private void AddFingerprint2(int userNumber, UserPrivilege priviledge)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x02, highorder, loworder, (byte)priviledge, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        ///  Function that should be called after the second trial
        /// </summary>
        /// <param name="userNumber"></param>
        /// <param name="priviledge"></param>
        private void AddFingerprint3(int userNumber, UserPrivilege priviledge)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x03, highorder, loworder, (byte)priviledge, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to delete a user from the device database
        /// </summary>
        /// <param name="userNumber"></param>
        public void DeleteUser(int userNumber)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x04, highorder, loworder, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to delete all users from the device database
        /// </summary>
        public void DeleteAllUsers()
        {
            byte[] sendData = new byte[8] { 0xF5, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to get the total number of users
        /// </summary>
        public void GetUsersCount()
        {
            byte[] sendData = new byte[8] { 0xF5, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to verify the fingerprint of a user
        /// </summary>
        /// <param name="userNumber"></param>
        public void VerifyFingerprint(int userNumber)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x0B, highorder, loworder, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to search user's fingerprint from the device
        /// </summary>
        public void SearchUser()
        {
            byte[] sendData = new byte[8] { 0xF5, 0x0C, 0x00, 0x00, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        /// <summary>
        /// Function to get the user's priviledge level
        /// </summary>
        /// <param name="userNumber"></param>
        public void GetUserPriviledge(int userNumber)
        {
            byte highorder = (byte)(userNumber >> 8);
            byte loworder = (byte)(userNumber & 0xFF);
            byte[] sendData = new byte[8] { 0xF5, 0x0A, highorder, loworder, 0x00, 0x00, 0x00, 0xF5 };
            sendData[6] = checksum(sendData, 1, 5);

            ComPort.Write(sendData, 0, 8);
        }

        #endregion

        #region Helper Methods

        /// <summary>
        /// Function to compute the checksum of a packet
        /// </summary>
        /// <param name="data"></param>
        /// <param name="start"></param>
        /// <param name="end"></param>
        /// <returns></returns>
        private byte checksum(byte[] data, int start, int end)
        {
            byte cksum = 0;
            for (int i = start; i <= end; i++)
                cksum ^= data[i];

            return cksum;
        }

        #endregion

        #region Interface Methods

        public void Dispose()
        {
            ComPort.Close();
        }

        #endregion
    }
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.