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

Allow filtering by company ID only #855

Merged
merged 7 commits into from
Feb 7, 2025
+149 −20
Merged

Allow filtering by company ID only #855

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bfc026e
Fix filtering by only company ID
twyatt Feb 6, 2025
06e97fa
Bump Android compile SDK to `35` for `VANILLA_ICE_CREAM` constant
twyatt Feb 6, 2025
b10b198
Fallback to flow based scan filter when only company ID provided pre …
twyatt Feb 6, 2025
6489014
`./gradlew formatKotlin`
twyatt Feb 6, 2025
9079e88
Update README re: filters
twyatt Feb 6, 2025
c827aff
Provide empty `ByteArray` for manufacturer data (when null) pre Andro…
twyatt Feb 7, 2025
dc2eb6c
Merge branch 'main' into twyatt/companyId-only-filter
twyatt Feb 7, 2025
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
14 changes: 10 additions & 4 deletions kable-core/src/commonMain/kotlin/Filter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ public sealed class Filter {
*/
public val id: Int,

public val data: ByteArray,
/** Must be non-`null` if [dataMask] is non-`null`. */
Copy link
Contributor

@Phoenix7351 Phoenix7351 Feb 6, 2025 •
edited by twyatt
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Gonna check to make sure Topaz's decode covers this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't covered. Will add.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have this for serviceData too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kable doesn't (yet) support service data filtering. 🙈
When I do get around to implementing it, then yes, it looks like it would need similar treatment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #857 to track.

public val data: ByteArray? = null,

/**
* For any bit in the mask, set it to 1 if advertisement manufacturer data needs to match the corresponding bit
Expand All @@ -112,16 +113,20 @@ public sealed class Filter {
public val dataMask: ByteArray? = null,
) : Filter() {

public constructor(id: ByteArray, data: ByteArray, dataMask: ByteArray? = null) : this(id.toShort(), data, dataMask)
public constructor(id: ByteArray, data: ByteArray? = null, dataMask: ByteArray? = null) : this(id.toShort(), data, dataMask)

init {
require(id >= 0) { "Company identifier cannot be negative, was $id" }
require(id <= 65535) { "Company identifier cannot be more than 16-bits (65535), was $id" }
if (dataMask != null) requireDataAndMaskHaveSameLength(data, dataMask)
if (data != null && data.isEmpty()) throw IllegalArgumentException("If data is present (non-null), it must be non-empty")
if (dataMask != null) {
requireNotNull(data) { "Data is null but must be non-null when dataMask is non-null" }
requireDataAndMaskHaveSameLength(data, dataMask)
}
}

override fun toString(): String =
"ManufacturerData(id=$id, data=${data.toHexString()}, dataMask=${dataMask?.toHexString()})"
"ManufacturerData(id=$id, data=${data?.toHexString()}, dataMask=${dataMask?.toHexString()})"
}
}

Expand All @@ -144,6 +149,7 @@ internal fun Filter.Name.matches(name: String?): Boolean {
}

internal fun Filter.ManufacturerData.matches(data: ByteArray?): Boolean {
if (this.data == null) return true
if (data == null) return false
if (dataMask == null) return this.data.contentEquals(data)
val lastMaskIndex = dataMask.indexOfLast { it != 0.toByte() }
Expand Down
114 changes: 114 additions & 0 deletions kable-core/src/commonTest/kotlin/FilterPredicateTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.juul.kable
import com.juul.kable.Filter.Name.Exact
import com.juul.kable.Filter.Name.Prefix
import kotlin.test.Test
import kotlin.test.assertFailsWith
import kotlin.test.assertFalse
import kotlin.test.assertTrue
import kotlin.uuid.Uuid
Expand Down Expand Up @@ -244,6 +245,119 @@ class FilterPredicateTests {
),
)
}

@Test
fun manufacturerDataFilter_nullDataWithNullDataMask_isAllowed() {
ManufacturerDataFilter(
id = 1,
data = null,
dataMask = null,
)
}

@Test
fun manufacturerDataFilter_nullDataWithEmptyDataMask_throwsIllegalArgumentException() {
assertFailsWith<IllegalArgumentException> {
ManufacturerDataFilter(
id = 1,
data = null,
dataMask = byteArrayOf(),
)
}
}

@Test
fun manufacturerDataFilter_nullDataWithNonNullDataMask_throwsIllegalArgumentException() {
assertFailsWith<IllegalArgumentException> {
ManufacturerDataFilter(
id = 1,
data = null,
dataMask = byteArrayOf(0xFF.toByte(), 0xFF.toByte()),
)
}
}

@Test
fun manufacturerDataFilter_emptyData_throwsIllegalArgumentException() {
assertFailsWith<IllegalArgumentException> {
ManufacturerDataFilter(
id = 1,
data = byteArrayOf(),
)
}
}

@Test
fun matches_manufacturerDataFilterWithNullDataVsEmptyData_isTrue() {
val predicate = ManufacturerDataFilter(
id = 1,
data = null,
dataMask = null,
).toPredicate()

assertTrue(
predicate.matches(
manufacturerData = ManufacturerData(
code = 1,
data = byteArrayOf(),
),
),
)
}

@Test
fun matches_manufacturerDataFilterWithNullDataVsData_isTrue() {
val predicate = ManufacturerDataFilter(
id = 1,
data = null,
dataMask = null,
).toPredicate()

assertTrue(
predicate.matches(
manufacturerData = ManufacturerData(
code = 1,
data = byteArrayOf(0xFF.toByte(), 0xFF.toByte()),
),
),
)
}

@Test
fun matches_manufacturerDataFilterWithoutDataMaskVsData_isTrue() {
val predicate = ManufacturerDataFilter(
id = 1,
data = byteArrayOf(0xFF.toByte(), 0xFF.toByte()),
dataMask = null,
).toPredicate()

assertTrue(
predicate.matches(
manufacturerData = ManufacturerData(
code = 1,
data = byteArrayOf(0xFF.toByte(), 0xFF.toByte()),
),
),
)
}

@Test
fun matches_manufacturerDataFilterWithoutDataMaskVsDifferentData_isFalse() {
val predicate = ManufacturerDataFilter(
id = 1,
data = byteArrayOf(0xF0.toByte(), 0x0D.toByte()),
dataMask = null,
).toPredicate()

assertFalse(
predicate.matches(
manufacturerData = ManufacturerData(
code = 1,
data = byteArrayOf(0x12, 0x34),
),
),
)
}
}

private fun Filter.toPredicate() = FilterPredicate(listOf(this))
4 changes: 3 additions & 1 deletion kable-core/src/jsMain/kotlin/BluetoothLEScanOptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ private fun FilterPredicate.toBluetoothLEScanFilterInit(): BluetoothLEScanFilter
private fun toBluetoothManufacturerDataFilterInit(filter: Filter.ManufacturerData) =
jso<BluetoothManufacturerDataFilterInit> {
companyIdentifier = filter.id
dataPrefix = filter.data
if (filter.data != null) {
dataPrefix = filter.data
}
if (filter.dataMask != null) {
mask = filter.dataMask
}
Expand Down