Skip to content

Commit a0e6e05

Browse files
committed
Merge pull request #128 from okadan/v4.0.0
v4.0.0 release
2 parents effaff0 + 2e06133 commit a0e6e05

File tree

193 files changed

+15310
-4511
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

193 files changed

+15310
-4511
lines changed

.gitignore

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,7 @@
1-
# Miscellaneous
2-
*.class
3-
*.log
4-
*.pyc
5-
*.swp
6-
.DS_Store
7-
.atom/
8-
.buildlog/
9-
.history
10-
.svn/
11-
migrate_working_dir/
12-
13-
# IntelliJ related
14-
*.iml
15-
*.ipr
16-
*.iws
17-
.idea/
18-
19-
# The .vscode folder contains launch configuration and tasks you configure in
20-
# VS Code which you may wish to be included in version control, so this line
21-
# is commented out by default.
22-
#.vscode/
23-
24-
# Flutter/Dart/Pub related
25-
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
26-
/pubspec.lock
27-
**/doc/api/
1+
# https://dart.dev/guides/libraries/private-files
2+
# Created by `dart pub`
283
.dart_tool/
29-
.packages
30-
build/
4+
5+
# Avoid committing pubspec.lock for library packages; see
6+
# https://dart.dev/guides/libraries/private-files#pubspeclock.
7+
pubspec.lock

README.md

Lines changed: 10 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,13 @@
1-
# nfc_manager
1+
# flutter-nfc-manager
22

3-
Flutter plugin for accessing the NFC features on Android and iOS.
3+
The Dart workspace containing packages related to NFC features for Flutter.
44

5-
Note: This plugin depends on `NFCTagReaderSession` (requires iOS 13.0 or later) and `NfcAdapter#enableReaderMode` (requires Android API level 19 or later).
5+
## Packages
66

7-
## Setup
8-
9-
**Android Setup**
10-
11-
* Add [android.permission.NFC](https://developer.android.com/reference/android/Manifest.permission.html#NFC) to your `AndroidManifest.xml`.
12-
13-
**iOS Setup**
14-
15-
* Add [Near Field Communication Tag Reader Session Formats Entitlements](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_nfc_readersession_formats) to your entitlements.
16-
17-
* Add [NFCReaderUsageDescription](https://developer.apple.com/documentation/bundleresources/information_property_list/nfcreaderusagedescription) to your `Info.plist`.
18-
19-
* Add [com.apple.developer.nfc.readersession.felica.systemcodes](https://developer.apple.com/documentation/bundleresources/information_property_list/systemcodes) and [com.apple.developer.nfc.readersession.iso7816.select-identifiers](https://developer.apple.com/documentation/bundleresources/information_property_list/select-identifiers) to your `Info.plist` as needed.
20-
21-
## Usage
22-
23-
**Handling Session**
24-
25-
```dart
26-
// Check availability
27-
bool isAvailable = await NfcManager.instance.isAvailable();
28-
29-
// Start Session
30-
NfcManager.instance.startSession(
31-
onDiscovered: (NfcTag tag) async {
32-
// Do something with an NfcTag instance.
33-
},
34-
);
35-
36-
// Stop Session
37-
NfcManager.instance.stopSession();
38-
```
39-
40-
**Handling Platform Tag**
41-
42-
The following platform-tag-classes are available:
43-
44-
* Ndef
45-
* FeliCa (iOS only)
46-
* Iso7816 (iOS only)
47-
* Iso15693 (iOS only)
48-
* MiFare (iOS only)
49-
* NfcA (Android only)
50-
* NfcB (Android only)
51-
* NfcF (Android only)
52-
* NfcV (Android only)
53-
* IsoDep (Android only)
54-
* MifareClassic (Android only)
55-
* MifareUtralight (Android only)
56-
* NdefFormatable (Android only)
57-
58-
Obtain an instance by calling the factory constructor `from` on the class. For example:
59-
60-
```dart
61-
Ndef? ndef = Ndef.from(tag);
62-
63-
if (ndef == null) {
64-
print('Tag is not compatible with NDEF');
65-
return;
66-
}
67-
68-
// Do something with an Ndef instance
69-
```
70-
71-
Please see the [API Doc](https://pub.dev/documentation/nfc_manager/latest/) for more details.
72-
73-
## Real-World-App
74-
75-
See [this repo](https://github.com/okadan/flutter-nfc-manager-app) which is a Real-World-App demonstrates how to use this plugin.
7+
|Name|Description|
8+
|-|-|
9+
|[ndef_record](https://github.com/okadan/flutter-nfc-manager/packages/ndef_record)|Provides an implementation of the NFC Data Exchange Format (NDEF).|
10+
|[nfc_manager](https://github.com/okadan/flutter-nfc-manager/packages/nfc_manager)|Provides access to NFC features on Android and iOS.|
11+
|[nfc_manager_ndef](https://github.com/okadan/flutter-nfc-manager/packages/nfc_manager_ndef)|Provides NDEF abstraction using `nfc_manager` plugin.|
12+
|[nfc_manager_felica](https://github.com/okadan/flutter-nfc-manager/packages/nfc_manager_felica)|Provides FeliCa abstraction using `nfc_manager` plugin.|
13+
|and more...||

android/build.gradle

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)