Skip to content

Commit 4bcc75c

Browse files
author
dbaba
committed
Update README
1 parent fdc54c2 commit 4bcc75c

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
node-red-contrib-generic-ble
22
===
33

4-
A Node-RED node for providing access to generic BLE devices via GATT.
4+
A Node-RED node for providing access to generic BLE peripheral devices via GATT.
5+
6+
As of v4.0.0, this node is optmized for Linux with BlueZ 5.
57

68
Supported operations are as follows:
79

@@ -10,9 +12,18 @@ Supported operations are as follows:
1012
- Write without Response
1113
- Notify
1214

15+
In this version, the node status values are as follows:
16+
17+
- `missing` the configured BLE peripheral device is missing. When the device is discovered, the state transitions to `disconnected`. The `disconnected` device may transiton to `missing` again when RSSI is invalidated (Linux only)
18+
- `disconnected` when the configured BLE peripheral device is found but not conncted
19+
- `connecting` when the configured BLE peripheral device is being connecting
20+
- `connected` when the configured BLE peripheral device is connected
21+
- `disconnecting` when the configured BLE peripheral device is being disconnecting
22+
- `error` when unexpected error occurs
23+
1324
# How to use
1425

15-
## How to configure a new BLE peripheral
26+
## How to configure a new BLE peripheral device
1627

1728
At first, drag either a `generic ble in` node or a `generic ble out` node to the workspace from the node palette and double-click the node. And you can find the following dialog. Here, click the pencil icon (`1`) to add a new BLE peripheral or edit the existing one.
1829

@@ -149,11 +160,22 @@ See `info` tab for detail on the editor UI.
149160

150161
# Example Flow
151162

152-
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.
163+
You can import [the example flow](examples/01-read-write.json) on Node-RED UI.
153164

154-
# How to install
165+
# Installation Note (Linux)
155166

156-
This will take approx. 3 minutes on Raspberry Pi 3.
167+
The Node-RED process owner must belong to `bluetooth` group.
168+
For example, if you're going to run the process by `pi` user, run the following command.
169+
170+
```
171+
sudo usermod -G bluetooth -a pi
172+
```
173+
174+
Then reboot the OS so that the policy changes take effect.
175+
176+
```
177+
sudo reboot
178+
```
157179

158180
## Node-RED users
159181

@@ -189,4 +211,3 @@ $ NODE_ENV=development npm run build
189211
# package
190212
$ NODE_ENV=development npm pack
191213
```
192-

0 commit comments

Comments
 (0)