@stoprocent/bleno 0.7.0 → 0.7.1

package/README.md

@@ -5,7 +5,7 @@
 
 A Node.js module for implementing BLE (Bluetooth Low Energy) peripherals.
 
-Need a BLE central module? See [noble](https://github.com/abandonware/noble).
+Need a BLE central module? See [noble](https://github.com/stoprocent/noble).
 
 __Note:__ Starting with version 0.6 bleno is basing on ES6 classes and supports Node.js 14.x and higher only. For older versions of Node.js use bleno 0.5.x. 
 
@@ -13,6 +13,40 @@ __Note:__ macOS / Mac OS X, Linux, FreeBSD and Windows are currently the only su
 
 ## Prerequisites
 
+#### UART (Any OS)
+
+Please refer to [https://github.com/stoprocent/node-bluetooth-hci-socket#uartserial-any-os](https://github.com/stoprocent/node-bluetooth-hci-socket#uartserial-any-os)
+
+##### Example 1 (UART port spcified as enviromental variable)
+
+```bash
+$ export BLUETOOTH_HCI_SOCKET_UART_PORT=/dev/tty...
+$ export BLUETOOTH_HCI_SOCKET_UART_BAUDRATE=1000000
+```
+
+__NOTE:__ `BLUETOOTH_HCI_SOCKET_UART_BAUDRATE` defaults to `1000000` so only needed if different.
+
+```javascript
+const bleno = require('@stoprocent/bleno');
+```
+
+##### Example 2 (UART port spcified in `bindParams`)
+
+```bash
+$ export BLUETOOTH_HCI_SOCKET_FORCE_UART=1
+```
+
+```javascript
+const bleno = require('@stoprocent/bleno/with-custom-binding') ( { 
+  bindParams: { 
+    uart: { 
+      port: '/dev/tty...', 
+      baudRate: 1000000
+    } 
+  } 
+} );
+```
+
 ### OS X
 
  * install the XCode command line tools via `xcode-select --install`
@@ -82,7 +116,7 @@ Make sure you have read and write permissions on the ```/dev/usb/*``` device tha
 ## Install
 
 ```sh
-npm install bleno@npm:@abandonware/bleno
+npm install bleno@npm:@stoprocent/bleno
 ```
 
 ## Usage
@@ -91,10 +125,19 @@ npm install bleno@npm:@abandonware/bleno
 var bleno = require('bleno');
 ```
 
-See [examples folder](https://github.com/sandeepmistry/bleno/blob/master/examples) for code examples.
+See [examples folder](https://github.com/stoprocent/bleno/blob/master/examples) for code examples.
 
 ### Actions
 
+#### Set address
+
+```javascript
+bleno.setAddress('00:11:22:33:44:55'); // set adapter's mac address
+```
+__NOTE:__ Curently this feature is only supported on HCI as it's using vendor specific commands. Source of the commands is based on the [BlueZ bdaddr.c](https://github.com/pauloborges/bluez/blob/master/tools/bdaddr.c).
+__NOTE:__ `bleno.state` must be `poweredOn` before address can be set. `bleno.on('stateChange', callback(state));` can be used to listen for state change events.
+
+
 #### Advertising
 
 ##### Start advertising

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stoprocent/bleno",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "A Node.js module for implementing BLE (Bluetooth Low Energy) peripherals",
   "main": "./index.js",
   "types": "./index.d.ts",