Skip to content

Commit 6f34ecd

Browse files
committed
Small improvements in documentation here and there.
1 parent 6484401 commit 6f34ecd

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

bluetooth/src/main/java/org/cloudbus/foggatewaylib/bluetooth/BluetoothLeNotifyProvider.java

+2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ public void execute(long requestID, VoidData... input) {
5252

5353
/**
5454
* Called when the characteristic value changes, provides the output to be published.
55+
* You can retrieve the value of the characteristic from within the method through
56+
* {@link BluetoothGattCharacteristic#getValue()} (or equivalent).
5557
*
5658
* @param gatt the GATT server in which the change occurred.
5759
* @param characteristic the updated characteristic.

bluetooth/src/main/java/org/cloudbus/foggatewaylib/bluetooth/BluetoothLeReadProvider.java

+2
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ public void execute(long requestID, VoidData... input) {
5353

5454
/**
5555
* Called when the characteristic value is read, provides the output to be published.
56+
* You can retrieve the value of the characteristic from within the method through
57+
* {@link BluetoothGattCharacteristic#getValue()} (or equivalent).
5658
*
5759
* @param gatt the GATT server in which the read occurred.
5860
* @param characteristic the read characteristic.

core-java/src/main/java/org/cloudbus/foggatewaylib/core/ExecutionManager.java

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
* Orchestrator and manager of the other components ({@link Store}, {@link Provider},
1515
* {@link Chooser}, {@link Trigger}).
1616
*
17+
* In order to be used, each component should be registered withing the {@link ExecutionManager}
18+
* using one of the {@code add*} methods.
19+
*
1720
* @see Store
1821
* @see Provider
1922
* @see Chooser

0 commit comments

Comments
 (0)