Skip to content

Commit

Permalink
Merge branch 'v3.x', qquashed commit of the following:
Browse files Browse the repository at this point in the history 
commit 60d909a
Author: Sébastien ESTIENNE <sebastien.estienne@orange.com>
Date:   Mon Sep 12 10:48:25 2022 +0200

    release(v3.8.2)

commit 5c8e084
Author: sestienne <55140956+sestienne@users.noreply.github.com>
Date:   Mon Sep 12 10:30:24 2022 +0200

    build(android): updated AltBeacon library to 2.19.4 to be compliant with android 12

    Apps targeting Android 12 and higher are required to specify an explicit value for `android:exported` when the corresponding component has an intent filter defined. See https://developer.android.com/guide/topics/manifest/activity-element#exported for details.

commit de97d22
Author: sestienne <55140956+sestienne@users.noreply.github.com>
Date:   Mon Sep 12 10:22:49 2022 +0200

    fix(build) : Migrate gradle configuration to be compatible with gradle 7

    Compile & runtime configurations are no more supported
    More information can be found on gradle website : https://docs.gradle.org/current/userguide/upgrading_version_6.html

commit 270ffbb
Author: AustinHaigh <AustinHaigh@users.noreply.github.com>
Date:   Mon May 13 13:02:22 2019 -1000

    docs: disable request for bt permission

commit 1336c1c
Author: AustinHaigh <AustinHaigh@users.noreply.github.com>
Date:   Mon May 13 12:54:34 2019 -1000

    feat: add config option to request BT permissions

commit bc6d0c7
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sun May 12 12:52:37 2019 -0700

    chore(release): v3.8.1 hotfix for plugin id issues in package

commit f153474
Author: AustinHaigh <AustinHaigh@users.noreply.github.com>
Date:   Sun May 12 09:02:55 2019 -1000

    docs: add documentation for ARMA filter

commit 725ad2b
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 16:51:26 2019 -0700

    docs: readme gets release checklist

commit f137178
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 16:38:14 2019 -0700

    chore: v3.8.0 release

commit 96a86d2
Author: Juergen Kienhoefer <juergen@aircable.net>
Date:   Fri May 10 15:50:52 2019 -0700

    fix(android): petermetz#417 startAdvertising does not honor MeasuredPower

commit fcbe463
Author: AustinHaigh <AustinHaigh@users.noreply.github.com>
Date:   Wed May 8 10:43:33 2019 -1000

    docs: add commitlint info to README.md

commit 40abc3b
Author: AustinHaigh <AustinHaigh@users.noreply.github.com>
Date:   Wed May 8 10:00:13 2019 -1000

    feat: add ARMA filter support for distance calcs

commit f2fe545
Author: Shane McCarron <halindrome@gmail.com>
Date:   Tue Apr 9 07:49:03 2019 -0500

    build(android): updated to latest published altbeacon library

commit f096cb1
Author: Martin S. Kyukov <mkyukov@gmail.com>
Date:   Mon Mar 25 14:52:27 2019 +0100

    build: remove git+ from repo url

    If the git+ is present, when removing adding platforms, cordova cannot find the plugin because the repository gives an error. Removing git+ from line 14 fixes the issue.

commit fa02d06
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 15:23:53 2019 -0700

    build: husky dev dep. for instant commit message validation

    Without this I had to wait for the CI server to tell me that I had an uppercase typo in the commit message.

commit 9e221fe
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 15:20:16 2019 -0700

    fix(ios): equality check for location manager corrected

commit 0fa7553
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 15:10:45 2019 -0700

    fix(build): upgrades commitlint  CLI due to vulnerability

commit 7a0472a
Author: Peter Metz <peter.metz@unarin.com>
Date:   Sat May 11 01:00:01 2019 -0700

    fix(ios): location manager no longer handles other instances messages

    This is to avoid conflicts with other plugins which the developer may have installed for their project.

commit 16beb23
Author: Shane McCarron <halindrome@gmail.com>
Date:   Wed Dec 5 18:55:47 2018 -0600

    build(android): updated AltBeacon library to 2.15.2

commit 3d94fc7
Merge: 9b29069 16581c5
Author: Darrel O'Pry <dopry@users.noreply.github.com>
Date:   Wed Jul 25 20:56:29 2018 -0400

    Merge pull request petermetz#389 from dopry/circleci_basic

    chore: add circleci and commitlint validation

commit 16581c5
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Wed Jul 25 18:49:53 2018 -0400

    chore: remove spurious characters from README.md

commit 76fb1c1
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Wed Jul 25 17:19:37 2018 -0400

    chore: add circleci and commitlint validation

commit 9b29069
Author: Darrel O'Pry <dopry@users.noreply.github.com>
Date:   Mon Jul 23 14:16:47 2018 -0400

    chore: create issue_template.md

commit 4a53a27
Merge: 1a637b8 4c8ed86
Author: Darrel O'Pry <dopry@users.noreply.github.com>
Date:   Mon Jul 23 13:58:53 2018 -0400

    Merge pull request petermetz#379 from dopry/altbeacon_2_14

    chore: upgrade altbeacon to 2.14

commit 4c8ed86
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Sat Jun 23 00:05:16 2018 -0400

    chore: upgrade altbeacon to 2.14

    require directly from jcenter so a local copy is no longer necessary.

commit 1a637b8
Merge: 928f9f4 7f5830b
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Thu Jun 14 19:43:48 2018 -0400

    Merge branch 'alt_beacon_2_13_1' into petermetz_v3.x

commit 7f5830b
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Mon Apr 23 20:53:52 2018 -0400

    chore: remove configuration inherited altbeacon AndroidManifest.xml

    Since AltBeacon is included as an dependency in grade through the `<framework />` tag
    its AndroidManifest.xml is included during builds. The plugin no longer needs to reconstruct the
    manifest simplifying manifest maintenance.

commit 9d0b818
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Fri Apr 13 16:54:50 2018 -0400

    chore: upgrade altbeacon to 2.13.1

    see: https://github.com/AltBeacon/android-beacon-library/releases

    2.13.1 Changelog

    * fix: incorrect immediateScanJobId meta-data name in manifest causing crash

    2.13 Changelog

    * feat: Add BluetoothMedic to fix crashing bluetooth stacks
    * feat: Allow configuring job ids
    * fix: Allow scans with screen off on Android 8.1

commit 928f9f4
Merge: 5f088cb 80e2f4b
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Thu Jun 14 19:41:58 2018 -0400

    Merge branch 'beacons_crashing_android_8_1' into petermetz_v3.x

commit 80e2f4b
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Mon Apr 23 19:12:00 2018 -0400

    fix: add new permissions required for android 8

    In testing errors were thrown without these permissions.

    * BIND_JOB_SERVICE

    ```
    Unhandled Promise rejection: No such service
    ComponentInfo{com.sprygroup.automata/org.altbeacon.beacon.service.ScanJob} ; Zone: <root> ; Task: ; Value:
    No such service ComponentInfo{com.sprygroup.automata/org.altbeacon.beacon.service.ScanJob}
    ```

    * RECEIVE_BOOT_COMPLETED

    ```
    Unhandled Promise rejection: Error: requested job be persisted without holding
    RECEIVE_BOOT_COMPLETED permission. ; Zone: <root> ; Task: ; Value: Error: requested job be persisted without
    holding RECEIVE_BOOT_COMPLETED permission.
    ```

commit 5dc13b5
Author: Darrel O'Pry <darrel.opry@spry-group.com>
Date:   Fri Apr 13 16:30:09 2018 -0400

    fix: add reference to com.android.support.support-core-utils

    * including only core-utils to streamline size, 1.23MB smaller than support-v4
       in demo:  v4 size:  12.10MB, core-utils size: 10.87Mb

commit 5f088cb
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Sun Apr 22 20:45:55 2018 -0700

    release(v3.6.1)

commit 0e16c6a
Author: João Gonçalves <chuckynes@gmail.com>
Date:   Thu Jan 11 17:23:04 2018 +0000

    Removed eager queue resume

commit 202001f
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 23:07:41 2017 -0800

    release(v3.6.0)

commit 4553ee7
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 22:45:16 2017 -0800

    feat(BeaconRegion.js): On Android wild-card UUIDs are now allowed. iOS is still a no-go.

commit 094e449
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 21:45:07 2017 -0800

    release(v.3.5.6)

commit 98bbc57
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 21:29:22 2017 -0800

    patch(plugin.xml): fixes petermetz#322

    iOS 11 requires a new key in the plist for the messages regarding permissions. plugin.xml now declares this along with the others.

commit ecd7b11
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 20:57:17 2017 -0800

    release(v3.5.5)

commit a2d5da3
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 20:57:05 2017 -0800

    build(altbeacon.jar): upgrades AltBeacon to v2.12.4

commit 47ff8de
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 11:28:22 2017 -0800

    docs(FAQ.md): explanation for configuration changes in managed services

commit b162696
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Dec 25 11:02:02 2017 -0800

    release(v5.3.4)

commit 0239309
Author: KIHARA Hideto <deton@m1.interq.or.jp>
Date:   Sat Dec 23 12:40:36 2017 +0900

    Fix cordova build error on cordova-android@7.0.0

commit a9e47ac
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Fri Dec 22 22:19:53 2017 -0800

    release(v3.5.3)

commit fd39a69
Author: Michael de Wit <michael@drillster.com>
Date:   Tue Nov 7 10:15:56 2017 +0100

    Remove allowsBackgroundLocationUpdates from iOS LocationManager

commit cd57ea7
Author: Martin Grubinger <martin.grubinger@gmail.com>
Date:   Thu Sep 14 17:44:06 2017 +0200

    Update README.md

    add description on required background mode for advertising on iOS.
    fix typo in startAdvertising sample code.

commit 2eb091c
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Fri Sep 8 23:03:47 2017 -0700

    release(v3.5.2)

commit 477e59d
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Fri Sep 8 23:02:46 2017 -0700

    feat(android): BLE stop advertising implemented

commit 3bb2600
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Wed Aug 23 19:40:33 2017 -0700

    v3.5.1

commit bee8354
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Wed Aug 23 19:37:23 2017 -0700

    patch(android): fixing silly merge mistake

commit e3fe3d5
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Wed Aug 23 00:22:44 2017 -0700

    v3.5.0

commit a1ecd80
Merge: be63d3b 1f4b83b
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Wed Aug 23 00:06:28 2017 -0700

    Merge pull request petermetz#305 from 'CorvexConnectedSafety-lib2.11' into v3.x

commit 1f4b83b
Author: Shane McCarron <halindrome@gmail.com>
Date:   Wed Jul 5 09:44:37 2017 -0500

    Updated to version 1.11

    Added option to enable long scanning

commit 1f679d3
Author: Shane McCarron <halindrome@gmail.com>
Date:   Sat Jun 17 11:49:28 2017 -0500

    Upgraded altbeacon to 2.10

commit 90f4e7b
Author: Shane McCarron <halindrome@gmail.com>
Date:   Fri Jun 9 15:04:05 2017 -0500

    Added ability to set FORGROUND_SCAN_PERIOD from config.xml

commit e3fe391
Author: Shane McCarron <halindrome@gmail.com>
Date:   Fri Jun 9 09:31:31 2017 -0500

    Downgraded to 2.9.2

commit be63d3b
Author: Vincenzo Luongo <luongo.vincenzo.92@gmail.com>
Date:   Wed May 11 17:34:20 2016 +0200

    implemented beacontrasmit protocol with android >= 5.0

    implemented beacontrasmit protocol and valid with android >= 5.0

commit 9ff56b3
Author: Szekeres Bálint <szekeres.balint@hps.hu>
Date:   Wed Jan 25 14:03:20 2017 +0100

    added NSBluetoothPeripheralUsageDescription to plist file

commit c8a4052
Author: Joanna SanDretto <josandretto@gmail.com>
Date:   Wed Aug 23 01:44:28 2017 -0500

    Updating altbeacon library to version 2.9.2 (petermetz#277)

    * updating altbeacon library

    * Updating albeacon library to 2.9.2

commit 73c3cb6
Author: Julián Mesa Llopis <jmesa@sistel.es>
Date:   Wed Aug 23 08:10:35 2017 +0200

    Added SampleExpirationMilliseconds parameter. (petermetz#258)

    Adjusting the averaging filter time

commit 93562ce
Author: Rodrigo Graça <rodrigograca1993@gmail.com>
Date:   Mon Jun 13 16:16:20 2016 +0100

    Remove empty space

    There's two examples:
    "Start monitoring a single iBeacon" and "Start ranging a single iBeacon"
    They are pretty much the same thing except two diferences, one has "startMonitoringForRegion" and the other "startRangingBeaconsInRegion", and one had two more line breaks, this PR fixes that...

commit 77619d1
Merge: 4a432e2 4f1d3de
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Tue Aug 22 22:47:32 2017 -0700

    Merge pull request petermetz#237 from 'olegdizus-v3.x' into v3.x

commit 4f1d3de
Author: Oleg Dizus <olegdizus@gmail.com>
Date:   Fri May 20 11:28:37 2016 +0300

    Added foregroundScanPeriod parameter (+2 squashed commits)
    Squashed commits:
    [8e6fa83] Addd
    [0ab3144] Set foreground scan period

commit 4a432e2
Merge: 4d9aca1 c51a010
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Sat Apr 23 17:09:29 2016 +0100

    Merge pull request petermetz#225 from machty/patch-2

    Fix illegal console.error usage in README

commit c51a010
Author: Alex Matchneer <machty@gmail.com>
Date:   Fri Apr 22 15:37:57 2016 -0400

    Fix illegal console.error usage in README

    Passing `console.error` as a standalone function without calling `.bind()` on it first results in an `Illegal invocation` when you eventually call it. I opted instead to just wrap in a function for some of the mobile browsers that still don't implement `Function.bind`

commit 4d9aca1
Merge: 0bba495 b4ba3fe
Author: Peter (Somogyvari) Metz <peter.metz@unarin.com>
Date:   Mon Apr 4 09:20:07 2016 +0200

    Merge pull request petermetz#217 from Ritzlgrmft/patch-1

    Update FAQ.md

commit b4ba3fe
Author: Markus Wagner <me@markus.onmicrosoft.com>
Date:   Mon Apr 4 08:25:24 2016 +0200

    Update FAQ.md

    Empty lines added, because otherwise the preference was not displayed
  • Loading branch information
@SebastienEstienne
SebastienEstienne committed Sep 12, 2022
1 parent 0bba495 commit de2a410
Show file tree
Hide file tree
Showing 14 changed files with 2,029 additions and 117 deletions.
51 changes: 51 additions & 0 deletions .circleci/config.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Javascript Node CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-javascript/ for more details
#
version: 2

aliases:
x-ignore-master: &x-ignore-master
filters:
branches:
ignore: master

x-only-master: &x-only-master
filters:
branches:
only: master


jobs:
lint:
docker:
- image: circleci/node:8.9
steps:
- checkout
- restore_cache:
keys:
- npm-{{ checksum "package-lock.json" }}-{{ arch }}
- npm-
- run: npm install
- save_cache:
paths:
- node_modules
key: npm-{{ checksum "package-lock.json" }}-{{ arch }}
- run:
command: |
LAST_TAG=`git describe --tags --abbrev=0`
echo commitlint --from ${LAST_TAG}
npx commitlint --from ${LAST_TAG}
workflows:
version: 2
pullrequest:
jobs:
- lint:
<<: *x-ignore-master

master:
jobs:
- lint:
<<: *x-only-master
8 changes: 8 additions & 0 deletions .github/issue_template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Please include the following to help us address your issue.

1. Expected behavior and actual behavior.
2. Steps to reproduce the problem.
3. cordova-android version
4. cordova-ios version
5. cordova-plugin-ibeacon version
6. If running on a device, device model and os version.
3 changes: 2 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ Thumbs.db

.idea/

nbproject/
nbproject/
node_modules/
69 changes: 63 additions & 6 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,60 @@
# 3.8.2
- build(android): updated AltBeacon library to 2.19.4 (to be compliant with android 12)
- fix(build) : Migrate gradle configuration to be compatible with gradle 7

# 3.8.1
- Fixing botched plugin id in release of v3.8.0.

# 3.8.0

- 40abc3b feat: add ARMA filter support for distance calcs
- f2fe545 build(android): updated to latest published altbeacon library
- 0fa7553 fix(build): upgrades commitlint CLI due to vulnerability
- 7a0472a fix(ios): location manager no longer handles other instances messages

# 3.6.1

* Fixes: https://github.com/petermetz/cordova-plugin-ibeacon/issues/259

# 3.6.0

* Android now allows the usage of wildcard UUIDs by passing in `cordova.plugins.locationManager.BeaconRegion.WILDCARD_UUID`
as the UUID of a BeaconRegion (constructor)

# 3.5.6

* iOS 11 .plist compatibility added (`NSLocationAlwaysAndWhenInUseUsageDescription`)
- https://github.com/petermetz/cordova-plugin-ibeacon/issues/322

# 3.5.5

* Fixes: https://github.com/petermetz/cordova-plugin-ibeacon/issues/323
- Upgrades to the latest stable AltBeacon library at present (v2.12.4)

# 3.5.4

* Fix: Cordova Android 7.0.0 build issues averted:
- https://github.com/petermetz/cordova-plugin-ibeacon/pull/337

# 3.5.3

* Fix: WKWebView crash no longer happens
- https://github.com/petermetz/cordova-plugin-ibeacon/pull/326

# 3.5.2

* Feature: Stop advertising as iBeacon is now implemented on the Android platform as well.

# 3.5.1

* Hot-fix: syntax errors fixed in Android

# 3.5.0

* Upgraded AltBeacon to v2.11
* iBeacon advertising added for Android: https://github.com/petermetz/cordova-plugin-ibeacon/pull/282/commits/85967c962acd0ba50b5f1ccce89c3e28873e4530
* Smaller fixes/updates

# 3.4.1

## Backwards Compatibility
Expand All @@ -6,7 +63,7 @@
# 3.4.0

## Features
* New Feature: You can now configure the foreground scan between period (Android) directly from
* New Feature: You can now configure the foreground scan between period (Android) directly from
the config.xml file of your Cordova project.
* Dependency updated: AltBeacon jar is now on version 2.7.1.
* Important for contributors: The Android source code has been reformatted with Android Studio, the
Expand All @@ -31,16 +88,16 @@ that have no other changes contained in them.

## Breaking Changes

* Klass dependency has been removed. Therefore ```cordova.plugins.LocationManager.Delegate``` entity no longer supports
* Klass dependency has been removed. Therefore ```cordova.plugins.LocationManager.Delegate``` entity no longer supports
implements and any callbacks mys override the default callbacks directly. See ```ReadMe.md``` for examples of how to use
Delegate since this change

# 3.1.1

## Fixed bugs

* Fixed a bug when installing the plugin sometimes resulted in broken Javascript source files that contained syntax
errors and stopped apps from working after the plugin has been added to the project.
* Fixed a bug when installing the plugin sometimes resulted in broken Javascript source files that contained syntax
errors and stopped apps from working after the plugin has been added to the project.

# 3.1.0

Expand All @@ -59,7 +116,7 @@ errors and stopped apps from working after the plugin has been added to the proj

## Breaking Changes

* The plugin received a new ID. Previously it was ```org.apache.cordova.ibeacon``` and now it runs as
* The plugin received a new ID. Previously it was ```org.apache.cordova.ibeacon``` and now it runs as
```com.unarin.cordova.beacon```. To perform an upgrade from earlier versions with the old ID, you'll have to remove
and add the plugin again with the cordova cli commands: ```cordova plugin rm org.apache.cordova.ibeacon``` and then
```cordova plugin add com.unarin.cordova.beacon``` to get the latest version. You can have a look at the PhoneGap Build
Expand All @@ -73,7 +130,7 @@ submission [here](https://build.phonegap.com/plugins/986).
# 2.0.0 (06.07.2014)
* Redesigned to use **Promise** .then() .fail(), .done() for method callbacks
* Singleton **Delegate** object implementation for event handling
* Android support added
* Android support added
* Monitoring and Ranging support for iOS and Android

# 1.0.0 (05.04.2014)
Expand Down
22 changes: 16 additions & 6 deletions FAQ.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
# iBeacon Cordova Plugin - Frequently Asked Questions

### How do I debug notifications in the background?
## How do I debug notifications in the background?

Enable the debug logging and inspect the console logs of your device through XCode.


### I would like to customise how frequently the AltBeacon library scans for proximity devices (beacons). How do I do that?
## I would like to customise how frequently the AltBeacon library scans for proximity devices (beacons). How do I do that?

Introduce an Android specific preference in your config.xml, something like this:

<preference name="com.unarin.cordova.beacon.android.altbeacon.ForegroundBetweenScanPeriod" value="5000" />

This will ensure that the AltBeacon library will wait five seconds in-between foreground scans.
The default is 0 for the mentioned configuration value.

### 'NSInternalInconsistencyException' Exception at Application Startup: ```Assertion failure in -[CLLocationManager setAllowsBackgroundLocationUpdates:]```
## How do I configure the permissions when working with a managed service (Phonegap Build, Ionic Cloud, etc.)

The newer versins of the cordova CLI come with features to help you do that:

```xml
<edit-config file="*-Info.plist" target="UIBackgroundModes" mode="merge">
<array>
<string>location</string>
</array>
</edit-config>
```

This most likely happens because you forgot to enable the ```Background Modes``` capability by switching
it to ```ON``` and then ticking ```Location updates``` as well. The messages and the stack trace may lead
you to think that this is something to do with the UIWebView/WKWebView that you are using, but it is not.
https://github.com/petermetz/cordova-plugin-ibeacon/issues/310#issuecomment-329564186
Loading

0 comments on commit de2a410

Please sign in to comment.