Skip to content

Commit 04c9f51

Browse files
author
Daisuke Baba
committed
Merge branch 'release/3.0.0'
2 parents 413efb4 + 24d287e commit 04c9f51

File tree

5 files changed

+8939
-763
lines changed

5 files changed

+8939
-763
lines changed

README.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Supported operations are as follows:
1010
- Write without Response
1111
- Notify
1212

13-
Read and Write operations are performed asynchronously and they're stored into the separate queues (read queue and write queue). Each queue has up to 10 operation requests. The parameter can be modified by providing an environmental variable `GENERIC_BLE_MAX_REQUESTS`.
14-
1513
# How to use
1614

1715
## How to configure a new BLE peripheral
@@ -153,20 +151,6 @@ See `info` tab for detail on the editor UI.
153151

154152
You can import [the example flow](examples/01.read-write.json) on Node-RED UI. You need to change Generic BLE config node named `nRF5x` or add a new config node for your device.
155153

156-
# Systemwide Configuration
157-
158-
These are environmental variables for systemwidely configuring this node:
159-
160-
| Variable | Description |
161-
|----------|-------------|
162-
| `GENERIC_BLE_CONNECTION_TIMEOUT_MS` | Connection Timeout in milliseconds. 5s by default |
163-
| `GENERIC_BLE_CONCURRENT_CONNECTIONS` | Number of Concurrent BLE connections. 1 by default |
164-
| `GENERIC_BLE_READ_WRITE_INTERVAL_MS` | Read/Write operation interval in milliseconds. 50ms by default |
165-
| `GENERIC_BLE_OPERATION_WAIT_MS` | Default waiting time for Read/Write/Notify response per characteristic. 500 by default |
166-
| `GENERIC_BLE_MAX_REQUESTS` | The length of Read/Write operation queues. 10 by default |
167-
168-
You can easily get started with importing the example flow from the menu icon > `Import` > `Examples` > `generic ble`.
169-
170154
# How to install
171155

172156
This will take approx. 3 minutes on Raspberry Pi 3.
@@ -181,14 +165,6 @@ npm install node-red-contrib-generic-ble
181165

182166
Then restart Node-RED process.
183167

184-
When you have trouble with connecting your BLE devices, reset your HCI socket by the following command.
185-
186-
```
187-
# STOP Node-RED first!!
188-
sudo hciconfig hci0 reset
189-
```
190-
And restart Node-RED.
191-
192168
## CANDY RED users
193169

194170
Run the following commands:
@@ -202,7 +178,6 @@ Then restart `candy-red` service.
202178
```
203179
sudo systemctl restart candy-red
204180
```
205-
The above command performs `hciconfig hci0 reset` as well. So you don't have to run `hciconfig` command separately.
206181

207182
# Appendix
208183

@@ -234,6 +209,12 @@ Set `GENERIC_BLE_TRACE=true` on starting Node-RED and you can find the precise l
234209

235210
# Revision History
236211

212+
* 3.0.0
213+
- Refactor entire architecture
214+
- Peripheral connections are retained until it disconnects
215+
- Characteristic subscriptions are retained while the ongoing flows are running (will be unsubscribed on stopping them though)
216+
- The max number of concurrent BLE connections is 5 or 6 according to [this document](https://github.com/noble/noble#maximum-simultaneous-connections)
217+
237218
* 2.0.4
238219
- Fix an issue where this node don't work with [email protected]
239220

0 commit comments

Comments
 (0)