diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 8c0fb64..7454180 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 13cde88..ffed3a2 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,5 @@ -#Wed Sep 29 10:37:08 CEST 2021 distributionBase=GRADLE_USER_HOME -distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip distributionPath=wrapper/dists -zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 91a7e26..c53aefa 100755 --- a/gradlew +++ b/gradlew @@ -1,79 +1,129 @@ -#!/usr/bin/env bash +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum -warn ( ) { +warn () { echo "$*" -} +} >&2 -die ( ) { +die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac -# For Cygwin, ensure paths are in UNIX format before anything is touched. -if $cygwin ; then - [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` -fi - -# Attempt to set APP_HOME -# Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi -done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >&- -APP_HOME="`pwd -P`" -cd "$SAVED" >&- - CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -82,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -90,75 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=$((i+1)) + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules -function splitJvmOpts() { - JVM_OPTS=("$@") -} -eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS -JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" - -exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index 8a0b282..107acd3 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @@ -8,20 +24,23 @@ @rem Set local scope for the variables with windows NT shell if "%OS%"=="Windows_NT" setlocal -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= - set DIRNAME=%~dp0 if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if "%ERRORLEVEL%" == "0" goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -35,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -45,34 +64,14 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windowz variants - -if not "%OS%" == "Windows_NT" goto win9xME_args -if "%@eval[2+2]" == "4" goto 4NT_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* -goto execute - -:4NT_args -@rem Get arguments from the 4NT Shell from JP Software -set CMD_LINE_ARGS=%$ - :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* :end @rem End local scope for the variables with windows NT shell diff --git a/scanner/build.gradle b/scanner/build.gradle index cea395b..53f4e15 100644 --- a/scanner/build.gradle +++ b/scanner/build.gradle @@ -1,7 +1,7 @@ apply plugin: 'com.android.library' android { - compileSdkVersion 31 + compileSdk 31 defaultConfig { minSdkVersion 18 @@ -19,6 +19,11 @@ android { testCoverageEnabled true } } + + /** Stops "DuplicateRelativeFileException: More than one file was found with OS independent path 'README.txt'" issue **/ + packagingOptions { + exclude 'README.txt' + } } dependencies { diff --git a/scanner/src/androidTest/java/no/nordicsemi/android/support/v18/scanner/ScanFilterTest.java b/scanner/src/androidTest/java/no/nordicsemi/android/support/v18/scanner/ScanFilterTest.java index 84a4b91..fc474ea 100644 --- a/scanner/src/androidTest/java/no/nordicsemi/android/support/v18/scanner/ScanFilterTest.java +++ b/scanner/src/androidTest/java/no/nordicsemi/android/support/v18/scanner/ScanFilterTest.java @@ -26,7 +26,6 @@ import org.junit.runner.RunWith; import androidx.test.ext.junit.runners.AndroidJUnit4; - import static com.google.common.truth.Truth.assertThat; @RunWith(AndroidJUnit4.class) @@ -117,6 +116,21 @@ public void testSetServiceDataFilter() { assertThat(filter.matches(scanResult)).isTrue(); filter = filterBuilder.setServiceData(serviceDataUuid, nonMatchData).build(); assertThat(filter.matches(scanResult)).isFalse(); + + filter = filterBuilder.setServiceData( + ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), + ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), + setServiceData).build(); + assertThat(filter.matches(scanResult)).isTrue(); + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), nonMatchData, mask).build(); + assertThat(filter.matches(scanResult)).isTrue(); + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), nonMatchData).build(); + assertThat(filter.matches(scanResult)).isFalse(); + + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), ParcelUuid.fromString("FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), setServiceData).build(); + assertThat(filter.matches(scanResult)).isFalse(); + filter = filterBuilder.setServiceData(ParcelUuid.fromString("75837467-2222-3333-4444-193749571524"), ParcelUuid.fromString("00000000-0000-0000-0000-000000000000"), setServiceData).build(); + assertThat(filter.matches(scanResult)).isTrue(); } @Test @@ -171,13 +185,28 @@ public void testReadWriteParcel() { final ParcelUuid serviceDataUuid = ParcelUuid.fromString("0000110B-0000-1000-8000-00805F9B34FB"); filter = filterBuilder.setServiceData(serviceDataUuid, serviceData).build(); testReadWriteParcelForFilter(filter); + + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), + ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), serviceData).build(); + testReadWriteParcelForFilter(filter); + filter = filterBuilder.setServiceData(serviceDataUuid, new byte[0]).build(); testReadWriteParcelForFilter(filter); + + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), + ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), new byte[0]).build(); + testReadWriteParcelForFilter(filter); + final byte[] serviceDataMask = new byte[]{ (byte) 0xFF, (byte) 0xFF }; filter = filterBuilder.setServiceData(serviceDataUuid, serviceData, serviceDataMask).build(); testReadWriteParcelForFilter(filter); + + filter = filterBuilder.setServiceData(ParcelUuid.fromString("0000110C-0000-1000-8000-00805F9B34FB"), + ParcelUuid.fromString("FFFFFFF0-FFFF-FFFF-FFFF-FFFFFFFFFFFF"), serviceData, serviceDataMask).build(); + testReadWriteParcelForFilter(filter); + final byte[] manufacturerData = new byte[]{ 0x02, 0x15 }; diff --git a/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanFilter.java b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanFilter.java index f47b746..d2c31a3 100644 --- a/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanFilter.java +++ b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanFilter.java @@ -28,6 +28,7 @@ import android.os.ParcelUuid; import android.os.Parcelable; +import java.util.ArrayList; import java.util.Arrays; import java.util.List; import java.util.UUID; @@ -35,6 +36,9 @@ import androidx.annotation.NonNull; import androidx.annotation.Nullable; +import static no.nordicsemi.android.support.v18.scanner.ScanRecordMatchers.matchesPartialData; +import static no.nordicsemi.android.support.v18.scanner.ScanRecordMatchers.matchesServiceUuids; + /** * Criteria for filtering result from Bluetooth LE scans. A {@link ScanFilter} allows clients to * restrict scan results to only those that are of interest to them. @@ -66,6 +70,8 @@ public final class ScanFilter implements Parcelable { @Nullable private final ParcelUuid serviceDataUuid; @Nullable + private final ParcelUuid serviceDataUuidMask; + @Nullable private final byte[] serviceData; @Nullable private final byte[] serviceDataMask; @@ -80,15 +86,16 @@ public final class ScanFilter implements Parcelable { private ScanFilter(@Nullable final String name, @Nullable final String deviceAddress, @Nullable final ParcelUuid uuid, @Nullable final ParcelUuid uuidMask, - @Nullable final ParcelUuid serviceDataUuid, @Nullable final byte[] serviceData, - @Nullable final byte[] serviceDataMask, final int manufacturerId, - @Nullable final byte[] manufacturerData, + @Nullable final ParcelUuid serviceDataUuid, @Nullable final ParcelUuid serviceDataUuidMask, + @Nullable final byte[] serviceData, @Nullable final byte[] serviceDataMask, + final int manufacturerId, @Nullable final byte[] manufacturerData, @Nullable final byte[] manufacturerDataMask) { this.deviceName = name; this.serviceUuid = uuid; this.serviceUuidMask = uuidMask; this.deviceAddress = deviceAddress; this.serviceDataUuid = serviceDataUuid; + this.serviceDataUuidMask = serviceDataUuidMask; this.serviceData = serviceData; this.serviceDataMask = serviceDataMask; this.manufacturerId = manufacturerId; @@ -122,6 +129,10 @@ public void writeToParcel(final Parcel dest, final int flags) { dest.writeInt(serviceDataUuid == null ? 0 : 1); if (serviceDataUuid != null) { dest.writeParcelable(serviceDataUuid, flags); + dest.writeInt(serviceDataUuidMask == null ? 0 : 1); + if (serviceDataUuidMask != null) { + dest.writeParcelable(serviceDataUuidMask, flags); + } dest.writeInt(serviceData == null ? 0 : 1); if (serviceData != null) { dest.writeInt(serviceData.length); @@ -178,19 +189,33 @@ public ScanFilter createFromParcel(final Parcel in) { } if (in.readInt() == 1) { ParcelUuid serviceDataUuid = in.readParcelable(ParcelUuid.class.getClassLoader()); + ParcelUuid serviceDataUuidMask = null; + if (in.readInt() == 1) { + serviceDataUuidMask = in.readParcelable(ParcelUuid.class.getClassLoader()); + } if (in.readInt() == 1) { final int serviceDataLength = in.readInt(); final byte[] serviceData = new byte[serviceDataLength]; in.readByteArray(serviceData); if (in.readInt() == 0) { - //noinspection ConstantConditions - builder.setServiceData(serviceDataUuid, serviceData); + if (serviceDataUuidMask != null) { + //noinspection ConstantConditions + builder.setServiceData(serviceDataUuid, serviceDataUuidMask, serviceData); + } else { + //noinspection ConstantConditions + builder.setServiceData(serviceDataUuid, serviceData); + } } else { final int serviceDataMaskLength = in.readInt(); final byte[] serviceDataMask = new byte[serviceDataMaskLength]; in.readByteArray(serviceDataMask); - //noinspection ConstantConditions - builder.setServiceData(serviceDataUuid, serviceData, serviceDataMask); + if (serviceDataUuidMask != null) { + //noinspection ConstantConditions + builder.setServiceData(serviceDataUuid, serviceDataUuidMask, serviceData, serviceDataMask); + } else { + //noinspection ConstantConditions + builder.setServiceData(serviceDataUuid, serviceData, serviceDataMask); + } } } } @@ -256,6 +281,11 @@ public ParcelUuid getServiceDataUuid() { return serviceDataUuid; } + @Nullable + public ParcelUuid getServiceDataUuidMask() { + return serviceDataUuidMask; + } + /** * Returns the manufacturer id. -1 if the manufacturer filter is not set. */ @@ -308,9 +338,10 @@ public boolean matches(@Nullable final ScanResult scanResult) { } // Service data match - if (serviceDataUuid != null && scanRecord != null) { - if (!matchesPartialData(serviceData, serviceDataMask, - scanRecord.getServiceData(serviceDataUuid))) { + if (serviceDataUuid != null && scanRecord != null && scanRecord.getServiceData() != null) { + List serviceDataUuids = new ArrayList(scanRecord.getServiceData().keySet()); + if (!matchesServiceUuids(serviceDataUuid, serviceDataUuidMask, serviceDataUuids) + || !matchesPartialData(serviceData, serviceDataMask, scanRecord.getServiceData(serviceDataUuid, serviceDataUuidMask))) { return false; } } @@ -327,79 +358,13 @@ public boolean matches(@Nullable final ScanResult scanResult) { return true; } - /** - * Check if the uuid pattern is contained in a list of parcel uuids. - */ - private static boolean matchesServiceUuids(@Nullable final ParcelUuid uuid, - @Nullable final ParcelUuid parcelUuidMask, - @Nullable final List uuids) { - if (uuid == null) { - return true; - } - if (uuids == null) { - return false; - } - - for (final ParcelUuid parcelUuid : uuids) { - final UUID uuidMask = parcelUuidMask == null ? null : parcelUuidMask.getUuid(); - if (matchesServiceUuid(uuid.getUuid(), uuidMask, parcelUuid.getUuid())) { - return true; - } - } - return false; - } - - // Check if the uuid pattern matches the particular service uuid. - private static boolean matchesServiceUuid(@NonNull final UUID uuid, - @Nullable final UUID mask, - @NonNull final UUID data) { - if (mask == null) { - return uuid.equals(data); - } - if ((uuid.getLeastSignificantBits() & mask.getLeastSignificantBits()) != - (data.getLeastSignificantBits() & mask.getLeastSignificantBits())) { - return false; - } - return ((uuid.getMostSignificantBits() & mask.getMostSignificantBits()) == - (data.getMostSignificantBits() & mask.getMostSignificantBits())); - } - - // Check whether the data pattern matches the parsed data. - @SuppressWarnings("BooleanMethodIsAlwaysInverted") - private boolean matchesPartialData(@Nullable final byte[] data, - @Nullable final byte[] dataMask, - @Nullable final byte[] parsedData) { - if (data == null) { - // If filter data is null it means it doesn't matter. - // We return true if any data matching the manufacturerId were found. - return parsedData != null; - } - if (parsedData == null || parsedData.length < data.length) { - return false; - } - if (dataMask == null) { - for (int i = 0; i < data.length; ++i) { - if (parsedData[i] != data[i]) { - return false; - } - } - return true; - } - for (int i = 0; i < data.length; ++i) { - if ((dataMask[i] & parsedData[i]) != (dataMask[i] & data[i])) { - return false; - } - } - return true; - } - @Override public String toString() { return "BluetoothLeScanFilter [deviceName=" + deviceName + ", deviceAddress=" + deviceAddress + ", mUuid=" + serviceUuid + ", uuidMask=" + serviceUuidMask - + ", serviceDataUuid=" + Objects.toString(serviceDataUuid) + ", serviceData=" - + Arrays.toString(serviceData) + ", serviceDataMask=" + + ", serviceDataUuid=" + Objects.toString(serviceDataUuid) + ", serviceDataUuidMask=" + serviceDataUuidMask + + ", serviceData=" + Arrays.toString(serviceData) + ", serviceDataMask=" + Arrays.toString(serviceDataMask) + ", manufacturerId=" + manufacturerId + ", manufacturerData=" + Arrays.toString(manufacturerData) + ", manufacturerDataMask=" + Arrays.toString(manufacturerDataMask) + "]"; @@ -411,6 +376,7 @@ public int hashCode() { Arrays.hashCode(manufacturerData), Arrays.hashCode(manufacturerDataMask), serviceDataUuid, + serviceDataUuidMask, Arrays.hashCode(serviceData), Arrays.hashCode(serviceDataMask), serviceUuid, serviceUuidMask); @@ -431,6 +397,7 @@ public boolean equals(final Object obj) { Objects.deepEquals(manufacturerData, other.manufacturerData) && Objects.deepEquals(manufacturerDataMask, other.manufacturerDataMask) && Objects.equals(serviceDataUuid, other.serviceDataUuid) && + Objects.equals(serviceDataUuidMask, other.serviceDataUuidMask) && Objects.deepEquals(serviceData, other.serviceData) && Objects.deepEquals(serviceDataMask, other.serviceDataMask) && Objects.equals(serviceUuid, other.serviceUuid) && @@ -457,6 +424,7 @@ public static final class Builder { private ParcelUuid uuidMask; private ParcelUuid serviceDataUuid; + private ParcelUuid serviceDataUuidMask; private byte[] serviceData; private byte[] serviceDataMask; @@ -515,6 +483,7 @@ public Builder setServiceUuid(@Nullable final ParcelUuid serviceUuid, return this; } + /** * Set filtering on service data. * @@ -527,6 +496,31 @@ public Builder setServiceData(@NonNull final ParcelUuid serviceDataUuid, throw new IllegalArgumentException("serviceDataUuid is null!"); } this.serviceDataUuid = serviceDataUuid; + this.serviceDataUuidMask = null; // clear service data uuid mask + this.serviceData = serviceData; + this.serviceDataMask = null; // clear service data mask + return this; + } + + /** + * Set filtering on service data. + * + * Set filter on partial service data uuid. The {@code serviceDataUuidMask} is the bit mask for the + * {@code serviceDataUuid}. Set any bit in the mask to 1 to indicate a match is needed for the + * bit in {@code serviceDataUuid}, and 0 to ignore that bit. + * + * @throws IllegalArgumentException If {@code serviceDataUuid} is null but + * {@code serviceDataUuidMask} is not {@code null}. + */ + public Builder setServiceData(@NonNull final ParcelUuid serviceDataUuid, + @Nullable final ParcelUuid serviceDataUuidMask, + @Nullable final byte[] serviceData) { + //noinspection ConstantConditions + if (serviceDataUuidMask != null && serviceDataUuid == null) { + throw new IllegalArgumentException("serviceDataUuid is null while serviceDataUuidMask is not null!"); + } + this.serviceDataUuid = serviceDataUuid; + this.serviceDataUuidMask = serviceDataUuidMask; this.serviceData = serviceData; this.serviceDataMask = null; // clear service data mask return this; @@ -562,6 +556,49 @@ public Builder setServiceData(@NonNull final ParcelUuid serviceDataUuid, } } this.serviceDataUuid = serviceDataUuid; + this.serviceDataUuidMask = null; // clear service data uuid mask + this.serviceData = serviceData; + this.serviceDataMask = serviceDataMask; + return this; + } + + /** + * Set partial filter on service data. For any bit in the mask, set it to 1 if it needs to + * match the one in service data, otherwise set it to 0 to ignore that bit. + *

+ * The {@code serviceDataMask} must have the same length of the {@code serviceData}. + * + * Also set filter on partial service data uuid. The {@code serviceDataUuidMask} is the bit mask for the + * {@code serviceDataUuid}. Set any bit in the mask to 1 to indicate a match is needed for the + * bit in {@code serviceDataUuid}, and 0 to ignore that bit. + * + * @throws IllegalArgumentException If {@code serviceDataUuid} is null but + * {@code serviceDataUuidMask} is not {@code null} or + * {@code serviceDataMask} is {@code null} while {@code serviceData} is not or + * {@code serviceDataMask} and {@code serviceData} has different length. + */ + public Builder setServiceData(@NonNull final ParcelUuid serviceDataUuid, + @Nullable final ParcelUuid serviceDataUuidMask, + @Nullable final byte[] serviceData, + @Nullable final byte[] serviceDataMask) { + //noinspection ConstantConditions + if (serviceDataUuidMask != null && serviceDataUuid == null) { + throw new IllegalArgumentException("serviceDataUuid is null while serviceDataUuidMask is not null!"); + } + if (serviceDataMask != null) { + if (serviceData == null) { + throw new IllegalArgumentException( + "serviceData is null while serviceDataMask is not null"); + } + // Since the serviceDataMask is a bit mask for serviceData, the lengths of the two + // byte array need to be the same. + if (serviceData.length != serviceDataMask.length) { + throw new IllegalArgumentException( + "size mismatch for service data and service data mask"); + } + } + this.serviceDataUuid = serviceDataUuid; + this.serviceDataUuidMask = serviceDataUuidMask; this.serviceData = serviceData; this.serviceDataMask = serviceDataMask; return this; @@ -627,7 +664,7 @@ public Builder setManufacturerData(final int manufacturerId, */ public ScanFilter build() { return new ScanFilter(deviceName, deviceAddress, serviceUuid, uuidMask, - serviceDataUuid, serviceData, serviceDataMask, + serviceDataUuid, serviceDataUuidMask, serviceData, serviceDataMask, manufacturerId, manufacturerData, manufacturerDataMask); } } diff --git a/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecord.java b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecord.java index 3818756..7d2700a 100644 --- a/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecord.java +++ b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecord.java @@ -138,6 +138,49 @@ public byte[] getServiceData(@NonNull final ParcelUuid serviceDataUuid) { return serviceData.get(serviceDataUuid); } + /** + * Returns the service data byte array associated with the {@code serviceDataUuid}. Returns + * {@code null} if the {@code serviceDataUuid} is not found. + * If {@code serviceDataUuid} and {@code serviceDataUuidMask} combination matches with more than 1 + * uuid in the serviceDataUuids list, ensure that the provided mask is specific enough to differentiate + * between two very similar uuids (i.e. provide as many 1s/Fs as possible). + */ + @Nullable + public byte[] getServiceData(@NonNull final ParcelUuid serviceDataUuid, + @Nullable final ParcelUuid serviceDataUuidMask) { + //noinspection ConstantConditions + if (serviceDataUuid == null || serviceData == null) { + return null; + } else { + if(serviceDataUuidMask == null) { + return getServiceData(serviceDataUuid); + } + } + + byte[] data = null; + int count = 0; + StringBuilder logging = new StringBuilder(); + for (Map.Entry entry: serviceData.entrySet()) { + if(ScanRecordMatchers.matchesServiceUuid(serviceDataUuid.getUuid(), serviceDataUuidMask.getUuid(), entry.getKey().getUuid())) { + data = entry.getValue(); + logging.append("serviceDataUuid "); + logging.append(count); + logging.append(" = "); + logging.append(entry.getKey().getUuid()); + logging.append(", "); + count++; + } + } + + if(count > 1) { + Log.e("ScanRecord", count + " similar service data uuids were found in this ScanRecord; " + + "please provide more specific uuid mask or tackle duplication. " + + "ScanRecord data: " + logging); + } + + return data; + } + /** * Returns the transmission power level of the packet in dBm. Returns {@link Integer#MIN_VALUE} * if the field is not set. This value can be used to calculate the path loss of a received diff --git a/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecordMatchers.java b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecordMatchers.java new file mode 100644 index 0000000..ff27c75 --- /dev/null +++ b/scanner/src/main/java/no/nordicsemi/android/support/v18/scanner/ScanRecordMatchers.java @@ -0,0 +1,78 @@ +package no.nordicsemi.android.support.v18.scanner; + +import android.os.ParcelUuid; + +import androidx.annotation.NonNull; +import androidx.annotation.Nullable; + +import java.util.List; +import java.util.UUID; + +final class ScanRecordMatchers { + + /** + * Check if the uuid pattern is contained in a list of parcel uuids. + */ + static boolean matchesServiceUuids(@Nullable final ParcelUuid uuid, + @Nullable final ParcelUuid parcelUuidMask, + @Nullable final List uuids) { + if (uuid == null) { + return true; + } + if (uuids == null) { + return false; + } + + for (final ParcelUuid parcelUuid : uuids) { + final UUID uuidMask = parcelUuidMask == null ? null : parcelUuidMask.getUuid(); + if (matchesServiceUuid(uuid.getUuid(), uuidMask, parcelUuid.getUuid())) { + return true; + } + } + return false; + } + + // Check if the uuid pattern matches the particular service uuid. + static boolean matchesServiceUuid(@NonNull final UUID uuid, + @Nullable final UUID mask, + @NonNull final UUID data) { + if (mask == null) { + return uuid.equals(data); + } + if ((uuid.getLeastSignificantBits() & mask.getLeastSignificantBits()) != + (data.getLeastSignificantBits() & mask.getLeastSignificantBits())) { + return false; + } + return ((uuid.getMostSignificantBits() & mask.getMostSignificantBits()) == + (data.getMostSignificantBits() & mask.getMostSignificantBits())); + } + + // Check whether the data pattern matches the parsed data. + @SuppressWarnings("BooleanMethodIsAlwaysInverted") + static boolean matchesPartialData(@Nullable final byte[] data, + @Nullable final byte[] dataMask, + @Nullable final byte[] parsedData) { + if (data == null) { + // If filter data is null it means it doesn't matter. + // We return true if any data matching the manufacturerId were found. + return parsedData != null; + } + if (parsedData == null || parsedData.length < data.length) { + return false; + } + if (dataMask == null) { + for (int i = 0; i < data.length; ++i) { + if (parsedData[i] != data[i]) { + return false; + } + } + return true; + } + for (int i = 0; i < data.length; ++i) { + if ((dataMask[i] & parsedData[i]) != (dataMask[i] & data[i])) { + return false; + } + } + return true; + } +}