# bleacon

> A Node.js library for creating, discovering, and configuring iBeacons

Latest version **0.5.1** (published 2016-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install bleacon
pnpm add bleacon
yarn add bleacon
bun add bleacon
```

## 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.5.1 |
| Published | 2016-09-19 |
| First published | 2013-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 495 |
| Author | Sandeep Mistry |
| Maintainers | sandeepmistry |
| Keywords | ibeacon |

## Links

- npm: https://www.npmjs.com/package/bleacon
- Repository: https://github.com/sandeepmistry/node-bleacon
- Issues: https://github.com/sandeepmistry/node-bleacon/issues
- npm.io page: https://npm.io/package/bleacon

## Dependencies (5)

- [bleno](https://npm.io/package/bleno.md) ^0.4.1
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [noble](https://npm.io/package/noble.md) ^1.7.0
- [bignum](https://npm.io/package/bignum.md) ^0.11.0
- [noble-device](https://npm.io/package/noble-device.md) ^1.1.0

## Recent versions

- 0.5.1 (latest) — 2016-09-19
- 0.5.0 — 2016-09-17
- 0.4.0 — 2015-08-20
- 0.3.0 — 2015-07-30
- 0.2.3 — 2015-05-16
- 0.2.2 — 2015-03-14
- 0.2.1 — 2015-02-08
- 0.2.0 — 2014-01-02
- 0.1.2 — 2013-11-17
- 0.1.1 — 2013-11-13
- 0.1.0 — 2013-11-08
- 0.0.2 — 2013-10-03
- 0.0.1 — 2013-10-03

## README

# node-bleacon

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sandeepmistry/node-bleacon?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


A Node.js library for creating, discovering, and configuring iBeacons

## Prerequisites

 * See [noble prerequisites](https://github.com/sandeepmistry/noble#prerequisites) and [bleno prerequisites](https://github.com/sandeepmistry/bleno#prerequisites) for your platform

## Install

```sh
npm install bleacon
```

## Usage

```javascript
var Bleacon = require('bleacon');
```

### Start advertising

"Create" an iBeacon

```javascript
var uuid = 'e2c56db5dffb48d2b060d0f5a71096e0';
var major = 0; // 0 - 65535
var minor = 0; // 0 - 65535
var measuredPower = -59; // -128 - 127 (measured RSSI at 1 meter)

Bleacon.startAdvertising(uuid, major, minor, measuredPower);
```

### Stop advertising

Stop your iBeacon

```javascript
Bleacon.stopAdvertising();
```

### Start scanning

```javascript
var uuid = 'e2c56db5dffb48d2b060d0f5a71096e0';
var major = 0; // 0 - 65535
var minor = 0; // 0 - 65535

Bleacon.startScanning([uuid], [major], [minor]);
```

Examples

```javascript
Bleacon.startScanning(); // scan for any bleacons

Bleacon.startScanning(uuid); // scan for bleacons with a particular uuid

Bleacon.startScanning(uuid, major); // scan for bleacons with a particular uuid and major

Bleacon.startScanning(uuid, major, minor); // scan for bleacons with a particular uuid. major, and minor
```

### Stop scanning

```javascript
Bleacon.stopScanning();
```

### Events

```javascript
Bleacon.on('discover', function(bleacon) {
    // ...
});
```

```bleacon``` properties:

 * uuid
   * advertised uuid
 * major
   * advertised major
 * minor
   * advertised minor
 * measuredPower
   * advertised measured RSSI at 1 meter away
 * rssi
   * current RSSI
 * accuracy
   * +/- meters, based on measuredPower and RSSI
 * proximity
   * current proximity ('unknown', 'immediate', 'near', or 'far')

## Configuring

 * [Bleu Station](https://github.com/sandeepmistry/node-bleacon/tree/master/bleu-station)
 * [Estimote](https://github.com/sandeepmistry/node-bleacon/tree/master/estimote)

## iBeacon Advertisement format

__Note:__ not official, determined using [noble](https://github.com/sandeepmistry/noble), and the [AirLocate](http://adcdownload.apple.com/wwdc_2013/wwdc_2013_sample_code/ios_airlocate.zip) example.

Following data is in the manufacturer data section of the advertisment data

```
<company identifier (2 bytes)> <type (1 byte)> <data length (1 byte)> <uuid (16 bytes)> <major (2 bytes)> <minor (2 bytes)> <RSSI @ 1m>
```

Example:

```
4C00 02 15 585CDE931B0142CC9A1325009BEDC65E 0000 0000 C5
```

 * Apple [Company Identifier](https://www.bluetooth.org/en-us/specification/assigned-numbers/company-identifiers) (Little Endian)
 * data type, 0x02 => iBeacon
 * data length, 0x15 = 21
 * uuid: ```585CDE931B0142CC9A1325009BEDC65E```
 * major: ```0000```
 * minor: ```0000```
 * meaured power at 1 meter: ```0xc5``` = ```-59```

[![Analytics](https://ga-beacon.appspot.com/UA-56089547-1/sandeepmistry/node-bleacon?pixel)](https://github.com/igrigorik/ga-beacon)

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