Native BLE Peripheral in React Native
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)
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.
npm install github:heroims/react-native-ble-peripheral --save
- In
AndroidManifest.xmladd:
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>react-native link- In
android/settings.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
...
dependencies {
/* YOUR DEPENDENCIES HERE */
compile project(':react-native-ble-peripheral') // <--- add this
}
- Register Module (in MainApplication.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
);
}
......
}- In
iOS/Info.plist↓ Add this
<key>NSBluetoothAlwaysUsageDescription</key>
<string></string>
import BLEPeripheral from 'react-native-ble-peripheral'BLEPeripheral.addService(UUID:string, primary:boolean)
BLEPeripheral.addService('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', true) //for primary service
BLEPeripheral.addService('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', false) //for non primary serviceBLEPeripheral.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
Permissions:
- 1 - Readable
- 2 - Readable Encrypted
- 4 - Readable Encrypted MITM (Man-in-the-middle) Protection
- 16 - Writable
- 32 - Writable Encrypted
- 64 - Writable Encrypted MITM Protection
- 128 - Writable Signed
- 256 - Writable Signed MITM
Properties:
- 1 - Broadcastable
- 2 - Readable
- 4 - Writable without response
- 8 - Writable
- 16 - Supports notification
- 32 - Supports indication
- 64 - Signed Write
- 128 - Extended properties
Permissions:
- 0x01 - Readable
- 0x02 - Writeable
- 0x04 - Read Encryption
- 0x08 - Write Encryption
Properties:
- 0x01 - Broadcastable
- 0x02 - Readable
- 0x04 - Writable without response
- 0x08 - Writable
- 0x10 - Supports notification
- 0x20 - Supports indication
- 0x40 - Signed Write
- 0x80 - Extended properties
- 0x100 - Notify Encryption(AVAILABLE(10_9, 6_0))
- 0x200 - Indicate Encryption(AVAILABLE(10_9, 6_0))
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 propertyBLEPeripheral.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
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 givennote:use this only after adding services and characteristics
BLEPeripheral.start()
.then(res => {
console.log(res)
}).catch(error => {
console.log(error)
})In case of error, these are the error codes:
- 1 - Failed to start advertising as the advertise data to be broadcasted is larger than 31 bytes.
- 2 - Failed to start advertising because no advertising instance is available.
- 3 - Failed to start advertising as the advertising is already started.
- 4 - Operation failed due to an internal error.
- 5 - This feature is not supported on this platform.
BLEPeripheral.stop()const BLEPeripheralManagerEmitter = new NativeEventEmitter(BLEPeripheral);
BLEPeripheralManagerEmitter.addListener('onWarning',(warning) => {
console.log(warning)
});
BLEPeripheralManagerEmitter.addListener('didReceiveWrite',([err,characteristic])=>{
if (err){
console.log(err);
}
else{
console.log('char uuid:'+characteristic.uuid);
console.log('char value:' + byteToString(characteristic.value));
var tmpReceiveStr=characteristic.value.toString();
console.log('char force value:' + tmpReceiveStr);
}
})BLEPeripheral.setName(name:string)
This method sets the name of the device broadcast, before calling start.
BLEPeripheral.setName('RNBLETEST')DOCs and project is under development Any help would be welcome... feel free to contact me