react-native-ble-peripheral - npm Package Compare versions

Comparing version 1.1.6 to 1.1.7

package.json

 {
   "name": "react-native-ble-peripheral",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "a simulator for a BLE peripheral, to help with testing BLE apps without an actual peripheral BLE device",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,135 @@
-# react-native-ble-peripheral
-a simulator for a BLE peripheral, to help with testing BLE apps without an actual peripheral BLE device
+# React Native BLE Peripheral
+Native BLE Peripheral in React Native (no support for IOS at the moment)
+
+## Welcome
+
+This is a simulator for a BLE peripheral, to help with testing BLE apps without an actual peripheral BLE device
+this project is not yet complete,
+for all ready parts see documentation below.
+(docs are not complete, feel free to improve them)
+
+## Realease notes
+- none
+    
+### Still missing
+- this project have no support for IOS what so ever
+
+if you would like to contribute to this project or suggest more future features you're welcome to so via an issue or pull request.
+
+### IOS support
+right now this package does not support IOS, so any one that wants to help and contribute the IOS support is more than welcome
+
+
+## Installation
+
+```bash
+npm install react-native-ble-peripheral --save
+or 
+yarn add react-native-ble-peripheral
+```
+npm page - https://www.npmjs.com/package/react-native-ble-peripheral
+## Add permissions
+* In `AndroidManifest.xml` add:
+```xml
+
+ <uses-permission android:name="android.permission.BLUETOOTH"/>
+ <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
+```
+## Project setup and initialization auto
+```bash
+react-native link
+```
+## Project setup and initialization manually 
+
+* In `android/settings.gradle`
+
+```gradle
+...
+include ':react-native-ble-peripheral'
+project(':react-native-ble-peripheral').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-ble-peripheral/android')
+
+```
+
+* In `android/app/build.gradle`
+
+```gradle
+...
+dependencies {
+    /* YOUR DEPENDENCIES HERE */
+   compile project(':react-native-ble-peripheral') // <--- add this
+}
+
+```
+
+* Register Module (in MainApplication.java)
+
+```java
+import com.himelbrand.forwardcalls.RNForwardCallsPackage;  // <--- import
+
+public class MainActivity extends ReactActivity {
+  ......
+
+  @Override
+  protected List<ReactPackage> getPackages() {
+      return Arrays.<ReactPackage>asList(
+          new MainReactPackage(),
+          new RNBLEPackage() // <--- Add this
+      );
+  }
+
+  ......
+
+}
+```
+
+
+## Usage
+
+#### Import
+
+```javascript
+import BLEPeripheral from 'react-native-ble-peripheral'
+```
+
+#### Add Service 
+BLEPeripheral.addService(UUID:string, primary:boolean)
+```javascript
+BLEPeripheral.addService('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', true) //for primary service
+BLEPeripheral.addService('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', false) //for non primary service
+```
+#### Add Characteristic
+BLEPeripheral.addCharacteristicToService(ServiceUUID:string, UUID:string, permissions:number, properties:number)
+
+https://developer.android.com/reference/android/bluetooth/BluetoothGattCharacteristic.html
+the link above is for permissions and properties constants info
+
+```javascript
+BLEPeripheral.addCharacteristicToService('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 16 | 1, 8) //this is a Characteristic with read and write permissions and notify property
+```
+#### Notify to devices
+BLEPeripheral.sendNotificationToDevices(ServiceUUID:string, CharacteristicUUID:string, data:byte[]) 
+note #1: in js it's not really a byte array, but an array of numbers
+note #2: the CharacteristicUUID must be of a Characteristic with notify property
+```javascript
+BLEPeripheral.sendNotificationToDevices('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', [0x10,0x01,0xA1,0x80]) //sends a notification to all connected devices that, using the char uuid given
+```
+
+#### start Advertising 
+note:use this only after adding services and characteristics
+```javascript
+ BLEPeripheral.start()
+  .then(res => {
+       console.log(res)
+  }).catch(error => {
+       console.log(error)
+  })
+```
+
+#### stop Advertising 
+```javascript
+ BLEPeripheral.stop()
+```
+
+DOCs and project is under development 
+Any help would be welcom...
+feel free to contact me

No alert changes

Improved metrics

Total package byte prevSize

76413

increased by5.74%

Lines of code

237

increased by4.41%

Number of lines in readme file

136

increased by4433.33%

No dependency changes