-
Notifications
You must be signed in to change notification settings - Fork 577
/
phonegap-nfc.js
912 lines (758 loc) · 28.1 KB
/
phonegap-nfc.js
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
/*jshint bitwise: false, camelcase: false, quotmark: false, unused: vars, esversion: 6, browser: true*/
/*global cordova, console, require */
function handleNfcFromIntentFilter() {
// This was historically done in cordova.addConstructor but broke with PhoneGap-2.2.0.
// We need to handle NFC from an Intent that launched the application, but *after*
// the code in the application's deviceready has run. After upgrading to 2.2.0,
// addConstructor was finishing *before* deviceReady was complete and the
// ndef listeners had not been registered.
// It seems like there should be a better solution.
if (cordova.platformId === "android" || cordova.platformId === "windows") {
setTimeout(
function () {
cordova.exec(
function () {
console.log("Initialized the NfcPlugin");
},
function (reason) {
console.log("Failed to initialize the NfcPlugin " + reason);
},
"NfcPlugin", "init", []
);
}, 10
);
}
}
document.addEventListener('deviceready', handleNfcFromIntentFilter, false);
var ndef = {
// see android.nfc.NdefRecord for documentation about constants
// http://developer.android.com/reference/android/nfc/NdefRecord.html
TNF_EMPTY: 0x0,
TNF_WELL_KNOWN: 0x01,
TNF_MIME_MEDIA: 0x02,
TNF_ABSOLUTE_URI: 0x03,
TNF_EXTERNAL_TYPE: 0x04,
TNF_UNKNOWN: 0x05,
TNF_UNCHANGED: 0x06,
TNF_RESERVED: 0x07,
RTD_TEXT: [0x54], // "T"
RTD_URI: [0x55], // "U"
RTD_SMART_POSTER: [0x53, 0x70], // "Sp"
RTD_ALTERNATIVE_CARRIER: [0x61, 0x63], // "ac"
RTD_HANDOVER_CARRIER: [0x48, 0x63], // "Hc"
RTD_HANDOVER_REQUEST: [0x48, 0x72], // "Hr"
RTD_HANDOVER_SELECT: [0x48, 0x73], // "Hs"
/**
* Creates a JSON representation of a NDEF Record.
*
* @tnf 3-bit TNF (Type Name Format) - use one of the TNF_* constants
* @type byte array, containing zero to 255 bytes, must not be null
* @id byte array, containing zero to 255 bytes, must not be null
* @payload byte array, containing zero to (2 ** 32 - 1) bytes, must not be null
*
* @returns JSON representation of a NDEF record
*
* @see Ndef.textRecord, Ndef.uriRecord and Ndef.mimeMediaRecord for examples
*/
record: function (tnf, type, id, payload) {
// handle null values
if (!tnf) { tnf = ndef.TNF_EMPTY; }
if (!type) { type = []; }
if (!id) { id = []; }
if (!payload) { payload = []; }
// convert strings to arrays
if (!(type instanceof Array)) {
type = nfc.stringToBytes(type);
}
if (!(id instanceof Array)) {
id = nfc.stringToBytes(id);
}
if (!(payload instanceof Array)) {
payload = nfc.stringToBytes(payload);
}
return {
tnf: tnf,
type: type,
id: id,
payload: payload
};
},
/**
* Helper that creates an NDEF record containing plain text.
*
* @text String of text to encode
* @languageCode ISO/IANA language code. Examples: “fi”, “en-US”, “fr- CA”, “jp”. (optional)
* @id byte[] (optional)
*/
textRecord: function (text, languageCode, id) {
var payload = textHelper.encodePayload(text, languageCode);
if (!id) { id = []; }
return ndef.record(ndef.TNF_WELL_KNOWN, ndef.RTD_TEXT, id, payload);
},
/**
* Helper that creates a NDEF record containing a URI.
*
* @uri String
* @id byte[] (optional)
*/
uriRecord: function (uri, id) {
var payload = uriHelper.encodePayload(uri);
if (!id) { id = []; }
return ndef.record(ndef.TNF_WELL_KNOWN, ndef.RTD_URI, id, payload);
},
/**
* Helper that creates a NDEF record containing an absolute URI.
*
* An Absolute URI record means the URI describes the payload of the record.
*
* For example a SOAP message could use "http://schemas.xmlsoap.org/soap/envelope/"
* as the type and XML content for the payload.
*
* Absolute URI can also be used to write LaunchApp records for Windows.
*
* See 2.4.2 Payload Type of the NDEF Specification
* http://www.nfc-forum.org/specs/spec_list#ndefts
*
* Note that by default, Android will open the URI defined in the type
* field of an Absolute URI record (TNF=3) and ignore the payload.
* BlackBerry and Windows do not open the browser for TNF=3.
*
* To write a URI as the payload use ndef.uriRecord(uri)
*
* @uri String
* @payload byte[] or String
* @id byte[] (optional)
*/
absoluteUriRecord: function (uri, payload, id) {
if (!id) { id = []; }
if (!payload) { payload = []; }
return ndef.record(ndef.TNF_ABSOLUTE_URI, uri, id, payload);
},
/**
* Helper that creates a NDEF record containing an mimeMediaRecord.
*
* @mimeType String
* @payload byte[]
* @id byte[] (optional)
*/
mimeMediaRecord: function (mimeType, payload, id) {
if (!id) { id = []; }
return ndef.record(ndef.TNF_MIME_MEDIA, nfc.stringToBytes(mimeType), id, payload);
},
/**
* Helper that creates an NDEF record containing an Smart Poster.
*
* @ndefRecords array of NDEF Records
* @id byte[] (optional)
*/
smartPoster: function (ndefRecords, id) {
var payload = [];
if (!id) { id = []; }
if (ndefRecords)
{
// make sure we have an array of something like NDEF records before encoding
if (ndefRecords[0] instanceof Object && ndefRecords[0].hasOwnProperty('tnf')) {
payload = ndef.encodeMessage(ndefRecords);
} else {
// assume the caller has already encoded the NDEF records into a byte array
payload = ndefRecords;
}
} else {
console.log("WARNING: Expecting an array of NDEF records");
}
return ndef.record(ndef.TNF_WELL_KNOWN, ndef.RTD_SMART_POSTER, id, payload);
},
/**
* Helper that creates an empty NDEF record.
*
*/
emptyRecord: function() {
return ndef.record(ndef.TNF_EMPTY, [], [], []);
},
/**
* Helper that creates an Android Application Record (AAR).
* http://developer.android.com/guide/topics/connectivity/nfc/nfc.html#aar
*
*/
androidApplicationRecord: function(packageName) {
return ndef.record(ndef.TNF_EXTERNAL_TYPE, "android.com:pkg", [], packageName);
},
/**
* Encodes an NDEF Message into bytes that can be written to a NFC tag.
*
* @ndefRecords an Array of NDEF Records
*
* @returns byte array
*
* @see NFC Data Exchange Format (NDEF) http://www.nfc-forum.org/specs/spec_list/
*/
encodeMessage: function (ndefRecords) {
var encoded = [],
tnf_byte,
type_length,
payload_length,
id_length,
i,
mb, me, // messageBegin, messageEnd
cf = false, // chunkFlag TODO implement
sr, // boolean shortRecord
il; // boolean idLengthFieldIsPresent
for(i = 0; i < ndefRecords.length; i++) {
mb = (i === 0);
me = (i === (ndefRecords.length - 1));
sr = (ndefRecords[i].payload.length < 0xFF);
il = (ndefRecords[i].id.length > 0);
tnf_byte = ndef.encodeTnf(mb, me, cf, sr, il, ndefRecords[i].tnf);
encoded.push(tnf_byte);
type_length = ndefRecords[i].type.length;
encoded.push(type_length);
if (sr) {
payload_length = ndefRecords[i].payload.length;
encoded.push(payload_length);
} else {
payload_length = ndefRecords[i].payload.length;
// 4 bytes
encoded.push((payload_length >> 24));
encoded.push((payload_length >> 16));
encoded.push((payload_length >> 8));
encoded.push((payload_length & 0xFF));
}
if (il) {
id_length = ndefRecords[i].id.length;
encoded.push(id_length);
}
encoded = encoded.concat(ndefRecords[i].type);
if (il) {
encoded = encoded.concat(ndefRecords[i].id);
}
encoded = encoded.concat(ndefRecords[i].payload);
}
return encoded;
},
/**
* Decodes an array bytes into an NDEF Message
*
* @bytes an array bytes read from a NFC tag
*
* @returns array of NDEF Records
*
* @see NFC Data Exchange Format (NDEF) http://www.nfc-forum.org/specs/spec_list/
*/
decodeMessage: function (ndefBytes) {
var bytes = ndefBytes.slice(0), // clone since parsing is destructive
ndef_message = [],
tnf_byte,
header,
type_length = 0,
payload_length = 0,
id_length = 0,
record_type = [],
id = [],
payload = [];
while(bytes.length) {
tnf_byte = bytes.shift();
header = ndef.decodeTnf(tnf_byte);
type_length = bytes.shift();
if (header.sr) {
payload_length = bytes.shift();
} else {
// next 4 bytes are length
payload_length = ((0xFF & bytes.shift()) << 24) |
((0xFF & bytes.shift()) << 26) |
((0xFF & bytes.shift()) << 8) |
(0xFF & bytes.shift());
}
if (header.il) {
id_length = bytes.shift();
}
record_type = bytes.splice(0, type_length);
id = bytes.splice(0, id_length);
payload = bytes.splice(0, payload_length);
ndef_message.push(
ndef.record(header.tnf, record_type, id, payload)
);
if (header.me) { break; } // last message
}
return ndef_message;
},
/**
* Decode the bit flags from a TNF Byte.
*
* @returns object with decoded data
*
* See NFC Data Exchange Format (NDEF) Specification Section 3.2 RecordLayout
*/
decodeTnf: function (tnf_byte) {
return {
mb: (tnf_byte & 0x80) !== 0,
me: (tnf_byte & 0x40) !== 0,
cf: (tnf_byte & 0x20) !== 0,
sr: (tnf_byte & 0x10) !== 0,
il: (tnf_byte & 0x8) !== 0,
tnf: (tnf_byte & 0x7)
};
},
/**
* Encode NDEF bit flags into a TNF Byte.
*
* @returns tnf byte
*
* See NFC Data Exchange Format (NDEF) Specification Section 3.2 RecordLayout
*/
encodeTnf: function (mb, me, cf, sr, il, tnf) {
var value = tnf;
if (mb) {
value = value | 0x80;
}
if (me) {
value = value | 0x40;
}
// note if cf: me, mb, li must be false and tnf must be 0x6
if (cf) {
value = value | 0x20;
}
if (sr) {
value = value | 0x10;
}
if (il) {
value = value | 0x8;
}
return value;
},
/**
* Convert TNF to String for user friendly display
*
*/
tnfToString: function (tnf) {
var value = tnf;
switch (tnf) {
case ndef.TNF_EMPTY:
value = "Empty";
break;
case ndef.TNF_WELL_KNOWN:
value = "Well Known";
break;
case ndef.TNF_MIME_MEDIA:
value = "Mime Media";
break;
case ndef.TNF_ABSOLUTE_URI:
value = "Absolute URI";
break;
case ndef.TNF_EXTERNAL_TYPE:
value = "External";
break;
case ndef.TNF_UNKNOWN:
value = "Unknown";
break;
case ndef.TNF_UNCHANGED:
value = "Unchanged";
break;
case ndef.TNF_RESERVED:
value = "Reserved";
break;
}
return value;
}
};
// nfc provides javascript wrappers to the native phonegap implementation
var nfc = {
multiCallbackTest: function(success, failure) {
cordova.exec(success, failure, "NfcPlugin", "multiCallbackTest", []);
},
// multiCallbackTest: function(success, failure) {
// //cordova.exec(success, failure, "NfcPlugin", "multiCallbackTest", []);
// setInterval(failure, 10000, 'Test from JavaScript!');
// },
addTagDiscoveredListener: function (callback, win, fail) {
document.addEventListener("tag", callback, false);
cordova.exec(win, fail, "NfcPlugin", "registerTag", []);
},
addMimeTypeListener: function (mimeType, callback, win, fail) {
document.addEventListener("ndef-mime", callback, false);
cordova.exec(win, fail, "NfcPlugin", "registerMimeType", [mimeType]);
},
addNdefListener: function (callback, win, fail) {
document.addEventListener("ndef", callback, false);
cordova.exec(win, fail, "NfcPlugin", "registerNdef", []);
},
addNdefFormatableListener: function (callback, win, fail) {
document.addEventListener("ndef-formatable", callback, false);
cordova.exec(win, fail, "NfcPlugin", "registerNdefFormatable", []);
},
write: function (ndefMessage, win, fail, options) {
if (cordova.platformId === "ios") {
cordova.exec(win, fail, "NfcPlugin", "writeTag", [ndefMessage, options]);
} else {
cordova.exec(win, fail, "NfcPlugin", "writeTag", [ndefMessage]);
}
},
makeReadOnly: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "makeReadOnly", []);
},
share: function (ndefMessage, win, fail) {
cordova.exec(win, fail, "NfcPlugin", "shareTag", [ndefMessage]);
},
unshare: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "unshareTag", []);
},
handover: function (uris, win, fail) {
// if we get a single URI, wrap it in an array
if (!Array.isArray(uris)) {
uris = [ uris ];
}
cordova.exec(win, fail, "NfcPlugin", "handover", uris);
},
stopHandover: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "stopHandover", []);
},
erase: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "eraseTag", [[]]);
},
enabled: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "enabled", [[]]);
},
removeTagDiscoveredListener: function (callback, win, fail) {
document.removeEventListener("tag", callback, false);
cordova.exec(win, fail, "NfcPlugin", "removeTag", []);
},
removeMimeTypeListener: function(mimeType, callback, win, fail) {
document.removeEventListener("ndef-mime", callback, false);
cordova.exec(win, fail, "NfcPlugin", "removeMimeType", [mimeType]);
},
removeNdefListener: function (callback, win, fail) {
document.removeEventListener("ndef", callback, false);
cordova.exec(win, fail, "NfcPlugin", "removeNdef", []);
},
showSettings: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "showSettings", []);
},
// iOS only - scan for NFC NDEF tag using NFCNDEFReaderSession
scanNdef: function (options) {
return new Promise(function(resolve, reject) {
cordova.exec(resolve, reject, "NfcPlugin", "scanNdef", [options]);
});
},
// iOS only - scan for NFC Tag using NFCTagReaderSession
scanTag: function (options) {
return new Promise(function(resolve, reject) {
cordova.exec(resolve, reject, "NfcPlugin", "scanTag", [options]);
});
},
// iOS only - cancel NFC scan session
cancelScan: function () {
return new Promise(function(resolve, reject) {
cordova.exec(resolve, reject, "NfcPlugin", "cancelScan", []);
});
},
// iOS only - deprecated use scanNdef or scanTag
beginSession: function (win, fail) {
// cordova.exec(win, fail, "NfcPlugin", "beginSession", []);
cordova.exec(win, fail, "NfcPlugin", "beginSession", []);
},
// iOS only - deprecated use cancelScan
invalidateSession: function (win, fail) {
cordova.exec(win, fail, "NfcPlugin", "invalidateSession", []);
},
// connect to begin transceive
connect: function(tech, timeout) {
return new Promise(function(resolve, reject) {
cordova.exec(resolve, reject, 'NfcPlugin', 'connect', [tech, timeout]);
});
},
// close transceive connection
close: function() {
return new Promise(function(resolve, reject) {
cordova.exec(resolve, reject, 'NfcPlugin', 'close', []);
});
},
// data - ArrayBuffer or string of hex data for transcieve
// the results of transceive are returned in the promise success as an ArrayBuffer
transceive: function(data) {
return new Promise(function(resolve, reject) {
var buffer;
if (typeof data === 'string') {
buffer = util.hexStringToArrayBuffer(data);
} else if (data instanceof ArrayBuffer) {
buffer = data;
} else if (data instanceof Uint8Array) {
buffer = data.buffer;
} else {
reject("Expecting an ArrayBuffer or String");
}
cordova.exec(resolve, reject, 'NfcPlugin', 'transceive', [buffer]);
});
},
// Android NfcAdapter.enableReaderMode flags
FLAG_READER_NFC_A: 0x1,
FLAG_READER_NFC_B: 0x2,
FLAG_READER_NFC_F: 0x4,
FLAG_READER_NFC_V: 0x8,
FLAG_READER_NFC_BARCODE: 0x10,
FLAG_READER_SKIP_NDEF_CHECK: 0x80,
FLAG_READER_NO_PLATFORM_SOUNDS: 0x100,
// Android NfcAdapter.enabledReaderMode
readerMode: function(flags, readCallback, errorCallback) {
cordova.exec(readCallback, errorCallback, 'NfcPlugin', 'readerMode', [flags]);
},
disableReaderMode: function(successCallback, errorCallback) {
cordova.exec(successCallback, errorCallback, 'NfcPlugin', 'disableReaderMode', []);
}
};
var util = {
// i must be <= 256
toHex: function (i) {
var hex;
if (i < 0) {
i += 256;
}
hex = i.toString(16);
// zero padding
if (hex.length === 1) {
hex = "0" + hex;
}
return hex;
},
toPrintable: function(i) {
if (i >= 0x20 & i <= 0x7F) {
return String.fromCharCode(i);
} else {
return '.';
}
},
bytesToString: function(bytes) {
// based on http://ciaranj.blogspot.fr/2007/11/utf8-characters-encoding-in-javascript.html
var result = "";
var i, c, c1, c2, c3;
i = c = c1 = c2 = c3 = 0;
// Perform byte-order check.
if( bytes.length >= 3 ) {
if( (bytes[0] & 0xef) == 0xef && (bytes[1] & 0xbb) == 0xbb && (bytes[2] & 0xbf) == 0xbf ) {
// stream has a BOM at the start, skip over
i = 3;
}
}
while ( i < bytes.length ) {
c = bytes[i] & 0xff;
if ( c < 128 ) {
result += String.fromCharCode(c);
i++;
} else if ( (c > 191) && (c < 224) ) {
if ( i + 1 >= bytes.length ) {
throw "Un-expected encoding error, UTF-8 stream truncated, or incorrect";
}
c2 = bytes[i + 1] & 0xff;
result += String.fromCharCode( ((c & 31) << 6) | (c2 & 63) );
i += 2;
} else {
if ( i + 2 >= bytes.length || i + 1 >= bytes.length ) {
throw "Un-expected encoding error, UTF-8 stream truncated, or incorrect";
}
c2 = bytes[i + 1] & 0xff;
c3 = bytes[i + 2] & 0xff;
result += String.fromCharCode( ((c & 15) << 12) | ((c2 & 63) << 6) | (c3 & 63) );
i += 3;
}
}
return result;
},
stringToBytes: function(string) {
// based on http://ciaranj.blogspot.fr/2007/11/utf8-characters-encoding-in-javascript.html
var bytes = [];
for (var n = 0; n < string.length; n++) {
var c = string.charCodeAt(n);
if (c < 128) {
bytes[bytes.length]= c;
} else if((c > 127) && (c < 2048)) {
bytes[bytes.length] = (c >> 6) | 192;
bytes[bytes.length] = (c & 63) | 128;
} else {
bytes[bytes.length] = (c >> 12) | 224;
bytes[bytes.length] = ((c >> 6) & 63) | 128;
bytes[bytes.length] = (c & 63) | 128;
}
}
return bytes;
},
bytesToHexString: function (bytes) {
var dec, hexstring, bytesAsHexString = "";
for (var i = 0; i < bytes.length; i++) {
if (bytes[i] >= 0) {
dec = bytes[i];
} else {
dec = 256 + bytes[i];
}
hexstring = dec.toString(16);
// zero padding
if (hexstring.length === 1) {
hexstring = "0" + hexstring;
}
bytesAsHexString += hexstring;
}
return bytesAsHexString;
},
// This function can be removed if record.type is changed to a String
/**
* Returns true if the record's TNF and type matches the supplied TNF and type.
*
* @record NDEF record
* @tnf 3-bit TNF (Type Name Format) - use one of the TNF_* constants
* @type byte array or String
*/
isType: function(record, tnf, type) {
if (record.tnf === tnf) { // TNF is 3-bit
var recordType;
if (typeof(type) === 'string') {
recordType = type;
} else {
recordType = nfc.bytesToString(type);
}
return (nfc.bytesToString(record.type) === recordType);
}
return false;
},
/**
* Convert an ArrayBuffer to a hex string
*
* @param {ArrayBuffer} buffer
* @returns {srting} - hex representation of bytes e.g. 000407AF
*/
arrayBufferToHexString: function(buffer) {
function toHexString(byte) {
return ('0' + (byte & 0xFF).toString(16)).slice(-2);
}
var typedArray = new Uint8Array(buffer);
var array = Array.from(typedArray); // need to convert to [] so our map result is not typed
var parts = array.map(function(i) { return toHexString(i) });
return parts.join('');
},
/**
* Convert a hex string to an ArrayBuffer.
*
* @param {string} hexString - hex representation of bytes
* @return {ArrayBuffer} - The bytes in an ArrayBuffer.
*/
hexStringToArrayBuffer: function(hexString) {
// remove any delimiters - space, dash, or colon
hexString = hexString.replace(/[\s-:]/g, '');
// remove the leading 0x
hexString = hexString.replace(/^0x/, '');
// ensure even number of characters
if (hexString.length % 2 != 0) {
console.log('WARNING: expecting an even number of characters in the hexString');
}
// check for some non-hex characters
var bad = hexString.match(/[G-Z\s]/i);
if (bad) {
console.log('WARNING: found non-hex characters', bad);
}
// split the string into pairs of octets
var pairs = hexString.match(/[\dA-F]{2}/gi);
// convert the octets to integers
var ints = pairs.map(function(s) { return parseInt(s, 16) });
var array = new Uint8Array(ints);
return array.buffer;
}
};
// this is a module in ndef-js
var textHelper = {
decodePayload: function (data) {
var languageCodeLength = (data[0] & 0x3F), // 6 LSBs
languageCode = data.slice(1, 1 + languageCodeLength),
utf16 = (data[0] & 0x80) !== 0; // assuming UTF-16BE
// TODO need to deal with UTF in the future
if (utf16) {
console.log('WARNING: utf-16 data may not be handled properly for', languageCode);
}
// Use TextDecoder when we have enough browser support
// new TextDecoder('utf-8').decode(data.slice(languageCodeLength + 1));
// new TextDecoder('utf-16').decode(data.slice(languageCodeLength + 1));
return util.bytesToString(data.slice(languageCodeLength + 1));
},
// encode text payload
// @returns an array of bytes
encodePayload: function(text, lang, encoding) {
// ISO/IANA language code, but we're not enforcing
if (!lang) { lang = 'en'; }
var encoded = util.stringToBytes(lang + text);
encoded.unshift(lang.length);
return encoded;
}
};
// this is a module in ndef-js
var uriHelper = {
// URI identifier codes from URI Record Type Definition NFCForum-TS-RTD_URI_1.0 2006-07-24
// index in array matches code in the spec
protocols: [ "", "http://www.", "https://www.", "http://", "https://", "tel:", "mailto:", "ftp://anonymous:anonymous@", "ftp://ftp.", "ftps://", "sftp://", "smb://", "nfs://", "ftp://", "dav://", "news:", "telnet://", "imap:", "rtsp://", "urn:", "pop:", "sip:", "sips:", "tftp:", "btspp://", "btl2cap://", "btgoep://", "tcpobex://", "irdaobex://", "file://", "urn:epc:id:", "urn:epc:tag:", "urn:epc:pat:", "urn:epc:raw:", "urn:epc:", "urn:nfc:" ],
// decode a URI payload bytes
// @returns a string
decodePayload: function (data) {
var prefix = uriHelper.protocols[data[0]];
if (!prefix) { // 36 to 255 should be ""
prefix = "";
}
return prefix + util.bytesToString(data.slice(1));
},
// shorten a URI with standard prefix
// @returns an array of bytes
encodePayload: function (uri) {
var prefix,
protocolCode,
encoded;
// check each protocol, unless we've found a match
// "urn:" is the one exception where we need to keep checking
// slice so we don't check ""
uriHelper.protocols.slice(1).forEach(function(protocol) {
if ((!prefix || prefix === "urn:") && uri.indexOf(protocol) === 0) {
prefix = protocol;
}
});
if (!prefix) {
prefix = "";
}
encoded = util.stringToBytes(uri.slice(prefix.length));
protocolCode = uriHelper.protocols.indexOf(prefix);
// prepend protocol code
encoded.unshift(protocolCode);
return encoded;
}
};
// added since WP8 must call a named function, also used by iOS
// TODO consider switching NFC events from JS events to using the PG callbacks
function fireNfcTagEvent(eventType, tagAsJson) {
setTimeout(function () {
var e = document.createEvent('Events');
e.initEvent(eventType, true, false);
e.tag = JSON.parse(tagAsJson);
console.log(e.tag);
document.dispatchEvent(e);
}, 10);
}
// textHelper and uriHelper aren't exported, add a property
ndef.uriHelper = uriHelper;
ndef.textHelper = textHelper;
// create aliases
nfc.bytesToString = util.bytesToString;
nfc.stringToBytes = util.stringToBytes;
nfc.bytesToHexString = util.bytesToHexString;
// kludge some global variables for plugman js-module support
// eventually these should be replaced and referenced via the module
window.nfc = nfc;
window.ndef = ndef;
window.util = util;
window.fireNfcTagEvent = fireNfcTagEvent;
// This channel receives nfcEvent data from native code
// and fires JavaScript events.
require('cordova/channel').onCordovaReady.subscribe(function() {
require('cordova/exec')(success, null, 'NfcPlugin', 'channel', []);
function success(message) {
if (!message.type) {
console.log(message);
} else {
console.log("Received NFC data, firing '" + message.type + "' event");
var e = document.createEvent('Events');
e.initEvent(message.type);
e.tag = message.tag;
document.dispatchEvent(e);
}
}
});