Skip to content

Commit 4f07fa3

Browse files
author
Daisuke Baba
committed
Update help contents
1 parent 9bc1414 commit 4f07fa3

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

src/locales/en-US/generic-ble.html

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<script type="text/x-red" data-help-name="Generic BLE in">
2-
<p>Emits read characteristic values and/or notified characteristic values.</p>
2+
<p>Emits read characteristic values and/or notified characteristic values. Accepts connect/disconnect requests as well.</p>
33
<h3>Outputs</h3>
44
<p>
55
The output object is contained in <code>msg.payload</code> property. Its structure is as follows:
@@ -20,24 +20,22 @@ <h3>Outputs</h3>
2020
</p>
2121
<h3>Inputs</h3>
2222
<p>
23-
Expects a message used for triggering <code>Read</code> operation or subscribing <code>Notify</code> events.
23+
Expects a message used for peripheral connecting/disconnecting operation, triggering <code>Read</code> operation, or subscribing <code>Notify</code> events.
2424
<dl>
2525
<dt>For <code>Connect</code> operation:</dt>
2626
<dd>
2727
In order to connect a peripheral device, set <code>msg.topic</code> to <code>connect</code>.
28-
<code>msg.payload</code> is always ignored.
28+
<code>msg.payload</code> is always ignored. This operation doesn't emit anything from the Output port.
2929
</dd>
3030
<dt>For <code>Disonnect</code> operation:</dt>
3131
<dd>
3232
In order to disconnect a peripheral device, set <code>msg.topic</code> to <code>disconnect</code>.
33-
<code>msg.payload</code> is always ignored.
33+
<code>msg.payload</code> is always ignored. This operation doesn't emit anything from the Output port.
3434
</dd>
3535
<dt>For <code>Read</code> operation:</dt>
3636
<dd>
3737
You can set one or more characteristic uuids separated by comma (CSV) to query to <code>msg.topic</code>.
3838
However, leave <code>msg.topic</code> empty if you want to query all readable characteristics.
39-
40-
<b>Note that the Read operation to the subscribing uuids cancels the subscriptions.</b>
4139
</dd>
4240
<dt>For subscribing <code>Notify</code> events:</dt>
4341
<dd>
@@ -61,13 +59,26 @@ <h3>Inputs</h3>
6159

6260
<script type="text/x-red" data-help-name="Generic BLE out">
6361
<p>
64-
Writes characteristic values associated with given characteristic UUIDs.
62+
Writes characteristic values associated with given characteristic UUIDs. Accepts connect/disconnect requests as well.
6563
</p>
6664
<h3>Inputs</h3>
6765
<p>
66+
Expects a message used for peripheral connecting/disconnecting operation, or triggering <code>Write</code> operation.
67+
<dl>
68+
<dt>For <code>Connect</code> operation:</dt>
69+
<dd>
70+
In order to connect a peripheral device, set <code>msg.topic</code> to <code>connect</code>.
71+
<code>msg.payload</code> is always ignored.
72+
</dd>
73+
<dt>For <code>Disonnect</code> operation:</dt>
74+
<dd>
75+
In order to disconnect a peripheral device, set <code>msg.topic</code> to <code>disconnect</code>.
76+
<code>msg.payload</code> is always ignored.
77+
</dd>
78+
<dt>For <code>Write</code> operation:</dt>
79+
<dd>
6880
In order to write characteristic values,
6981
the following structure object is required in <code>msg.payload</code> property.
70-
</p>
7182
<pre>
7283
{
7384
"[writable characteristics UUID 1]": (value),
@@ -89,19 +100,9 @@ <h3>Inputs</h3>
89100
<li><code>int</code> value</li>
90101
</ul>
91102
This node translates these values into a Buffer object.
92-
93-
This node accepts the peripheral connecting/disconnecting command as well.
94-
<dt>For <code>Connect</code> operation:</dt>
95-
<dd>
96-
In order to connect a peripheral device, set <code>msg.topic</code> to <code>connect</code>.
97-
<code>msg.payload</code> is always ignored.
98-
</dd>
99-
<dt>For <code>Disonnect</code> operation:</dt>
100-
<dd>
101-
In order to disconnect a peripheral device, set <code>msg.topic</code> to <code>disconnect</code>.
102-
<code>msg.payload</code> is always ignored.
103-
</dd>
104103
</p>
104+
</dd>
105+
</dl>
105106
</script>
106107

107108
<script type="text/x-red" data-help-name="Generic BLE">

0 commit comments

Comments
 (0)