# ember-cordova-beacon

> Range / Monitor beacons for ember cordova apps

Latest version **0.0.2** (published 2016-12-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-cordova-beacon
pnpm add ember-cordova-beacon
yarn add ember-cordova-beacon
bun add ember-cordova-beacon
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-12-27 |
| First published | 2016-12-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ryan Cook |
| Maintainers | ryanpatrickcook |
| Keywords | ember-addon, ember cordova, ember-cordova, cordova, phonegap, beacon, ibeacon, ember-cordova-beacon |

## Links

- npm: https://www.npmjs.com/package/ember-cordova-beacon
- npm.io page: https://npm.io/package/ember-cordova-beacon

## Dependencies (4)

- [rsvp](https://npm.io/package/rsvp.md) ^3.3.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.2
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^5.1.7
- [ember-cli-version-checker](https://npm.io/package/ember-cli-version-checker.md) ^1.1.6

## Recent versions

- 0.0.2 (latest) — 2016-12-27
- 0.0.1 — 2016-12-27

## README

# ember-cordova-beacon

This addon is built to work with [ember-cordova](https://github.com/isleofcode/ember-cordova) and uses [cordova-plugin-ibeacon](https://github.com/petermetz/cordova-plugin-ibeacon).

## Usage
Service Injection
```javascript
beaconService: Ember.inject.service('ember-cordova/beacon')
```

Begin ranging beacon
```javascript
 let uuid = '00000000-0000-0000-0000-000000000000';
 let identifier = 'somePlace';
 let major = 1;
 let minor = 2;
 this.get('beaconService').startRangingBeacon(identifier, uuid, major, minor);
```

Stop ranging all known beacons
```javascript
 this.get('beaconService').stopRangingBeacons();
```

Stop ranging beacon
```javascript
 let uuid = '00000000-0000-0000-0000-000000000000';
 let identifier = 'somePlace';
 let major = 1;
 let minor = 2;
 this.get('beaconService').stopRangingBeacon(identifier, uuid, major, minor);
```

Begin monitoring beacon
```javascript
 let uuid = '00000000-0000-0000-0000-000000000000';
 let identifier = 'somePlace';
 let major = 1;
 let minor = 2;
 this.get('beaconService').startMonitoringBeacon(identifier, uuid, major, minor);
```

Stop monitoring all known beacons
```javascript
 this.get('beaconService').stopMonitoringBeacons();
```

Stop monitoring beacon
```javascript
 let uuid = '00000000-0000-0000-0000-000000000000';
 let identifier = 'somePlace';
 let major = 1;
 let minor = 2;
 this.get('beaconService').stopMonitoringBeacon(identifier, uuid, major, minor);
```

Add callback events
```javascript
let service = this.get('beaconService');
service.on('didEnterRegion', function(beacon, result) { ... });
service.on('didExitRegion', function(beacon, result) { ... });
service.on('didStartMonitoringForRegion', function(beacon, result) { ... });
service.on('didDetermineStateForRegion', function(beacon, result) { ... });
service.on('didRangeBeaconInRegion', function(beacon) { ... });
```

Get monitored beacon regions
```javascript
this.get('beaconService').getMonitoredRegions().then(regions => { ... });
```

Log a message to the view
```javascript
this.get('beaconService').logToDom("HEY!");
```

Log a message to the device log
```javascript
this.get('beaconService').appendToDeviceLog("Logged!");
```

---
_Source: https://npm.io/package/ember-cordova-beacon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
