Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/android streaming #193

Merged
merged 12 commits into from
Dec 21, 2024
Merged

Feature/android streaming #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1824bad
add event support
dangfan Dec 21, 2024
4b177f0
add docs for tag event stream support
dangfan Dec 21, 2024
c6bda22
fix format
dangfan Dec 21, 2024
601f303
fix #16, close #179
dangfan Dec 21, 2024
adcf850
fix webusb interop by dropping ondisconnect
dangfan Dec 21, 2024
3febb2c
Add onDisconnect back to webusb interop
Harry-Chen Dec 21, 2024
84ee80c
add additional description about NFC event stream.
dangfan Dec 21, 2024
dbe64ab
update the example
dangfan Dec 21, 2024
98802be
Fix Kotlin syntax in Android example
Harry-Chen Dec 21, 2024
cf05a25
doc: separate streaming to example dir
Harry-Chen Dec 21, 2024
1c4aeb4
doc: update CHANGELOG
Harry-Chen Dec 21, 2024
e02e2e2
Run dart format
Harry-Chen Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,11 @@ This is a release candidate for 3.6.0. Please test it and report any issues.
* Related issues / PRs: #179 #184, #186, #187
* Now requiring Java 17, Gradle 8.9, MinSDKVer 26, AGP 8.7, Kotlin 2.1.0
* Add Swift package manager support for iOS plugin, bump dependencies

## 3.6.0-rc.3

This is a release candidate for 3.6.0. Please test it and report any issues.

* All 3.6.0-rc.2 changes are included
* Fix WebUSB interop on Web
* Add support for foreground polling on Android (#16, #179)
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,7 @@ Refer to the [documentation](https://pub.dev/documentation/flutter_nfc_kit/) for
### Error codes

We use error codes with similar meaning as HTTP status code. Brief explanation and error cause in string (if available) will also be returned when an error occurs.

### Operation Mode

We provide two operation modes: polling (default) and event streaming. Both can give the same `NFCTag` object. Please see [example](example/example.md) for more details.
322 changes: 178 additions & 144 deletions android/src/main/kotlin/im/nfc/flutter_nfc_kit/FlutterNfcKitPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import android.nfc.NdefMessage
import android.nfc.NdefRecord
import android.nfc.NfcAdapter
import android.nfc.NfcAdapter.*
import android.nfc.Tag
import android.nfc.tech.*
import android.os.Handler
import android.os.HandlerThread
Expand All @@ -24,6 +25,9 @@ import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.MethodChannel
import io.flutter.plugin.common.MethodChannel.MethodCallHandler
import io.flutter.plugin.common.MethodChannel.Result
import io.flutter.plugin.common.EventChannel
import io.flutter.plugin.common.EventChannel.EventSink
import io.flutter.plugin.common.EventChannel.StreamHandler
import org.json.JSONArray
import org.json.JSONObject
import java.io.IOException
Expand All @@ -45,6 +49,16 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {

private lateinit var nfcHandlerThread: HandlerThread
private lateinit var nfcHandler: Handler
private lateinit var methodChannel: MethodChannel
private lateinit var eventChannel: EventChannel
private var eventSink: EventSink? = null

public fun handleTag(tag: Tag) {
val result = parseTag(tag)
Handler(Looper.getMainLooper()).post {
eventSink?.success(result)
}
}

private fun TagTechnology.transceive(data: ByteArray, timeout: Int?): ByteArray {
if (timeout != null) {
Expand Down Expand Up @@ -79,18 +93,178 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
result.error("500", "Failed to post job to NFC Handler thread.", null)
}
}

private fun parseTag(tag: Tag): String {
// common fields
val type: String
val id = tag.id.toHexString()
val standard: String
// ISO 14443 Type A
var atqa = ""
var sak = ""
// ISO 14443 Type B
var protocolInfo = ""
var applicationData = ""
// ISO 7816
var historicalBytes = ""
var hiLayerResponse = ""
// NFC-F / Felica
var manufacturer = ""
var systemCode = ""
// NFC-V
var dsfId = ""
// NDEF
var ndefAvailable = false
var ndefWritable = false
var ndefCanMakeReadOnly = false
var ndefCapacity = 0
var ndefType = ""

if (tag.techList.contains(NfcA::class.java.name)) {
val aTag = NfcA.get(tag)
atqa = aTag.atqa.toHexString()
sak = byteArrayOf(aTag.sak.toByte()).toHexString()
tagTechnology = aTag
when {
tag.techList.contains(IsoDep::class.java.name) -> {
standard = "ISO 14443-4 (Type A)"
type = "iso7816"
val isoDep = IsoDep.get(tag)
tagTechnology = isoDep
historicalBytes = isoDep.historicalBytes.toHexString()
}
tag.techList.contains(MifareClassic::class.java.name) -> {
standard = "ISO 14443-3 (Type A)"
type = "mifare_classic"
with(MifareClassic.get(tag)) {
tagTechnology = this
mifareInfo = MifareInfo(
this.type,
size,
MifareClassic.BLOCK_SIZE,
blockCount,
sectorCount
)
}
}
tag.techList.contains(MifareUltralight::class.java.name) -> {
standard = "ISO 14443-3 (Type A)"
type = "mifare_ultralight"
with(MifareUltralight.get(tag)) {
tagTechnology = this
mifareInfo = MifareInfo.fromUltralight(this.type)
}
}
else -> {
standard = "ISO 14443-3 (Type A)"
type = "unknown"
}
}
} else if (tag.techList.contains(NfcB::class.java.name)) {
val bTag = NfcB.get(tag)
protocolInfo = bTag.protocolInfo.toHexString()
applicationData = bTag.applicationData.toHexString()
if (tag.techList.contains(IsoDep::class.java.name)) {
type = "iso7816"
standard = "ISO 14443-4 (Type B)"
val isoDep = IsoDep.get(tag)
tagTechnology = isoDep
hiLayerResponse = isoDep.hiLayerResponse.toHexString()
} else {
type = "unknown"
standard = "ISO 14443-3 (Type B)"
tagTechnology = bTag
}
} else if (tag.techList.contains(NfcF::class.java.name)) {
standard = "ISO 18092 (FeliCa)"
type = "iso18092"
val fTag = NfcF.get(tag)
manufacturer = fTag.manufacturer.toHexString()
systemCode = fTag.systemCode.toHexString()
tagTechnology = fTag
} else if (tag.techList.contains(NfcV::class.java.name)) {
standard = "ISO 15693"
type = "iso15693"
val vTag = NfcV.get(tag)
dsfId = vTag.dsfId.toHexString()
tagTechnology = vTag
} else {
type = "unknown"
standard = "unknown"
}

// detect ndef
if (tag.techList.contains(Ndef::class.java.name)) {
val ndefTag = Ndef.get(tag)
ndefTechnology = ndefTag
ndefAvailable = true
ndefType = ndefTag.type
ndefWritable = ndefTag.isWritable
ndefCanMakeReadOnly = ndefTag.canMakeReadOnly()
ndefCapacity = ndefTag.maxSize
}

val jsonResult = JSONObject(mapOf(
"type" to type,
"id" to id,
"standard" to standard,
"atqa" to atqa,
"sak" to sak,
"historicalBytes" to historicalBytes,
"protocolInfo" to protocolInfo,
"applicationData" to applicationData,
"hiLayerResponse" to hiLayerResponse,
"manufacturer" to manufacturer,
"systemCode" to systemCode,
"dsfId" to dsfId,
"ndefAvailable" to ndefAvailable,
"ndefType" to ndefType,
"ndefWritable" to ndefWritable,
"ndefCanMakeReadOnly" to ndefCanMakeReadOnly,
"ndefCapacity" to ndefCapacity,
))

if (mifareInfo != null) {
with(mifareInfo!!) {
jsonResult.put("mifareInfo", JSONObject(mapOf(
"type" to typeStr,
"size" to size,
"blockSize" to blockSize,
"blockCount" to blockCount,
"sectorCount" to sectorCount
)))
}
}

return jsonResult.toString()
}
}

override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
nfcHandlerThread = HandlerThread("NfcHandlerThread")
nfcHandlerThread.start()
nfcHandler = Handler(nfcHandlerThread.looper)

val channel = MethodChannel(flutterPluginBinding.binaryMessenger, "flutter_nfc_kit")
channel.setMethodCallHandler(this)
methodChannel = MethodChannel(flutterPluginBinding.binaryMessenger, "flutter_nfc_kit/method")
methodChannel.setMethodCallHandler(this)

eventChannel = EventChannel(flutterPluginBinding.binaryMessenger, "flutter_nfc_kit/event")
eventChannel.setStreamHandler(object : EventChannel.StreamHandler {
override fun onListen(arguments: Any?, events: EventChannel.EventSink?) {
if (events != null) {
eventSink = events
}
}

override fun onCancel(arguments: Any?) {
// No need to do anything here
}
})
}

override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) {
methodChannel.setMethodCallHandler(null)
eventChannel.setStreamHandler(null)
nfcHandlerThread.quitSafely()
}

Expand Down Expand Up @@ -418,148 +592,8 @@ class FlutterNfcKitPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
val pollHandler = NfcAdapter.ReaderCallback { tag ->
pollingTimeoutTask?.cancel()

// common fields
val type: String
val id = tag.id.toHexString()
val standard: String
// ISO 14443 Type A
var atqa = ""
var sak = ""
// ISO 14443 Type B
var protocolInfo = ""
var applicationData = ""
// ISO 7816
var historicalBytes = ""
var hiLayerResponse = ""
// NFC-F / Felica
var manufacturer = ""
var systemCode = ""
// NFC-V
var dsfId = ""
// NDEF
var ndefAvailable = false
var ndefWritable = false
var ndefCanMakeReadOnly = false
var ndefCapacity = 0
var ndefType = ""

if (tag.techList.contains(NfcA::class.java.name)) {
val aTag = NfcA.get(tag)
atqa = aTag.atqa.toHexString()
sak = byteArrayOf(aTag.sak.toByte()).toHexString()
tagTechnology = aTag
when {
tag.techList.contains(IsoDep::class.java.name) -> {
standard = "ISO 14443-4 (Type A)"
type = "iso7816"
val isoDep = IsoDep.get(tag)
tagTechnology = isoDep
historicalBytes = isoDep.historicalBytes.toHexString()
}
tag.techList.contains(MifareClassic::class.java.name) -> {
standard = "ISO 14443-3 (Type A)"
type = "mifare_classic"
with(MifareClassic.get(tag)) {
tagTechnology = this
mifareInfo = MifareInfo(
this.type,
size,
MifareClassic.BLOCK_SIZE,
blockCount,
sectorCount
)
}
}
tag.techList.contains(MifareUltralight::class.java.name) -> {
standard = "ISO 14443-3 (Type A)"
type = "mifare_ultralight"
with(MifareUltralight.get(tag)) {
tagTechnology = this
mifareInfo = MifareInfo.fromUltralight(this.type)
}
}
else -> {
standard = "ISO 14443-3 (Type A)"
type = "unknown"
}
}
} else if (tag.techList.contains(NfcB::class.java.name)) {
val bTag = NfcB.get(tag)
protocolInfo = bTag.protocolInfo.toHexString()
applicationData = bTag.applicationData.toHexString()
if (tag.techList.contains(IsoDep::class.java.name)) {
type = "iso7816"
standard = "ISO 14443-4 (Type B)"
val isoDep = IsoDep.get(tag)
tagTechnology = isoDep
hiLayerResponse = isoDep.hiLayerResponse.toHexString()
} else {
type = "unknown"
standard = "ISO 14443-3 (Type B)"
tagTechnology = bTag
}
} else if (tag.techList.contains(NfcF::class.java.name)) {
standard = "ISO 18092 (FeliCa)"
type = "iso18092"
val fTag = NfcF.get(tag)
manufacturer = fTag.manufacturer.toHexString()
systemCode = fTag.systemCode.toHexString()
tagTechnology = fTag
} else if (tag.techList.contains(NfcV::class.java.name)) {
standard = "ISO 15693"
type = "iso15693"
val vTag = NfcV.get(tag)
dsfId = vTag.dsfId.toHexString()
tagTechnology = vTag
} else {
type = "unknown"
standard = "unknown"
}

// detect ndef
if (tag.techList.contains(Ndef::class.java.name)) {
val ndefTag = Ndef.get(tag)
ndefTechnology = ndefTag
ndefAvailable = true
ndefType = ndefTag.type
ndefWritable = ndefTag.isWritable
ndefCanMakeReadOnly = ndefTag.canMakeReadOnly()
ndefCapacity = ndefTag.maxSize
}

val jsonResult = JSONObject(mapOf(
"type" to type,
"id" to id,
"standard" to standard,
"atqa" to atqa,
"sak" to sak,
"historicalBytes" to historicalBytes,
"protocolInfo" to protocolInfo,
"applicationData" to applicationData,
"hiLayerResponse" to hiLayerResponse,
"manufacturer" to manufacturer,
"systemCode" to systemCode,
"dsfId" to dsfId,
"ndefAvailable" to ndefAvailable,
"ndefType" to ndefType,
"ndefWritable" to ndefWritable,
"ndefCanMakeReadOnly" to ndefCanMakeReadOnly,
"ndefCapacity" to ndefCapacity,
))

if (mifareInfo != null) {
with(mifareInfo!!) {
jsonResult.put("mifareInfo", JSONObject(mapOf(
"type" to typeStr,
"size" to size,
"blockSize" to blockSize,
"blockCount" to blockCount,
"sectorCount" to sectorCount
)))
}
}

result.success(jsonResult.toString())
val jsonResult = parseTag(tag)
result.success(jsonResult)
}

nfcAdapter.enableReaderMode(activity.get(), pollHandler, technologies, null)
Expand Down
1 change: 0 additions & 1 deletion example/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
/build/

# Web related
lib/generated_plugin_registrant.dart

# Exceptions to above rules.
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
Loading
Loading