# @criveroib/react-native-ibeacon-simulator

> A cool package for simulate your iOS devices as beacon (compatible with RN 0.59.x)

Latest version **2.0.5** (published 2023-01-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @criveroib/react-native-ibeacon-simulator
pnpm add @criveroib/react-native-ibeacon-simulator
yarn add @criveroib/react-native-ibeacon-simulator
bun add @criveroib/react-native-ibeacon-simulator
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2023-01-23 |
| First published | 2023-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 40.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | William Tran |
| Maintainers | criveroib |
| Keywords | react-native, react, bluetooth, ibeacon, beacon simulator |

## Links

- npm: https://www.npmjs.com/package/@criveroib/react-native-ibeacon-simulator
- Repository: https://github.com/carlosriveroib/react-native-ibeacon-simulator
- Homepage: https://github.com/carlosriveroib/react-native-ibeacon-simulator#readme
- Issues: https://github.com/carlosriveroib/react-native-ibeacon-simulator
- npm.io page: https://npm.io/package/@criveroib/react-native-ibeacon-simulator

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.5 (latest) — 2023-01-23
- 2.0.4 — 2023-01-23

## README

React Native Module that broadcasts an iBeacon uuid.

# Setup

```
npm install --save @criveroib/react-native-ibeacon-simulator
```

Please don't try to use react-native link at your RN 0.60.X project

# Setup Android

Add project to `android/settings.gradle`:

```
rootProject.name = 'MyApp'

include ':@criveroib_react-native-ibeacon-simulator'
project(':@criveroib_react-native-ibeacon-simulator').projectDir = new File(rootProject.projectDir, '../node_modules/@criveroib/react-native-ibeacon-simulator/android')

include ':app'
```

Add in `MainApplication.java`:

```
package com.myapp;

import com.ibeacon.simulator.BeaconBroadcastPackage;
```

# Setup iOS

Add in your `Podfile`

```
pod 'BeaconBroadcast', :path => '../node_modules/@criveroib/react-native-ibeacon-simulator'
```

Then run `pod install`

# Usage

Import in your project:

```
`import BeaconBroadcast from '@criveroib/react-native-ibeacon-simulator'`
```

# API

Start iBeacon on device:

### uuid: String

You can get from here http://openuuid.net/

### identifier: String

### minor and major:

are integer values between 0 and 65535.

### Start Broadcasting iBeacon:

`BeaconBroadcast.startAdvertisingBeaconWithString(uuid, identifier, major, minor)`

### Stop Broadcasting iBeacon:

`BeaconBroadcast.stopAdvertisingBeacon()`

# iOS

```
BeaconBroadcast.stopAdvertisingBeacon()
BeaconBroadcast.startAdvertisingBeaconWithString(uuid, identifier, major, minor)
```

# Android

```
BeaconBroadcast.checkTransmissionSupported()
.then(() => {
  BeaconBroadcast.stopAdvertisingBeacon()
  BeaconBroadcast.startAdvertisingBeaconWithString(uuid, identifier, major, minor)
})
.catch((e) => {
  /* handle return errors */
  - NOT_SUPPORTED_MIN_SDK
  - NOT_SUPPORTED_BLE
  - DEPRECATED_NOT_SUPPORTED_MULTIPLE_ADVERTISEMENTS
  - NOT_SUPPORTED_CANNOT_GET_ADVERTISER
  - NOT_SUPPORTED_CANNOT_GET_ADVERTISER_MULTIPLE_ADVERTISEMENTS
})
```

# Contributors

- William Tran [https://github.com/williamtran29]
- Dennis Borshchevski [https://github.com/dennis-b]
- Harvey Connor [https://github.com/harveyconnor]
- Manuel Muñoz [https://github.com/jaidis]
- Carlos Rivero [https://github.com/carlosriveroib]

# Features WIP

- [x] Create beacon
- [ ] Allow peripherals to connect to beacon
- [ ] Read/write characteristics to beacon
- [ ] Read/write characteristics to central

# TODO

- [ ] Create a types file for the class

---
_Source: https://npm.io/package/@criveroib/react-native-ibeacon-simulator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._