You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-6Lines changed: 27 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
1
node-red-contrib-generic-ble
2
2
===
3
3
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.
5
7
6
8
Supported operations are as follows:
7
9
@@ -10,9 +12,18 @@ Supported operations are as follows:
10
12
- Write without Response
11
13
- Notify
12
14
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
+
13
24
# How to use
14
25
15
-
## How to configure a new BLE peripheral
26
+
## How to configure a new BLE peripheral device
16
27
17
28
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.
18
29
@@ -149,11 +160,22 @@ See `info` tab for detail on the editor UI.
149
160
150
161
# Example Flow
151
162
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.
153
164
154
-
# How to install
165
+
# Installation Note (Linux)
155
166
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
+
```
157
179
158
180
## Node-RED users
159
181
@@ -189,4 +211,3 @@ $ NODE_ENV=development npm run build
0 commit comments