Merge pull request ParticulaCode#7 from Geek5510/main

ParticulaCode · web-flow · commit b998bb94ecba · 2022-08-04T15:49:09.000+03:00
Added disconnecting event, support for reconnecting and made connecting errors catchable
diff --git a/README.md b/README.md
@@ -93,6 +93,13 @@ Requests:
   getBatteryLevel()
 ```
 
+```javascript
+ /**
+  * Attempts to recconect to dice's bluetooth device, incase the device is already connected 
+  * If the reconnection was successful an onDiceConnected event will follow
+ **/
+ attemptReconnect()
+
 ```javascript
   /**
   * Sets the die type for the die value calculations, Use GoDice.diceTypes.X for die type.
@@ -102,7 +109,22 @@ Requests:
   */
   setDieType(GoDice.diceTypes)
 ```
-   
+
+```javascript
+  /**
+   * In order to catch error on the requestDevice and attemptReconnect methods use an async function and await the die's methods
+   * Note: awaiting inside of the function will block it's execution
+   * Example:
+   */
+ async function openConnectionDialog() {
+	const newDice = new GoDice();
+	try {
+		await newDice.requestDevice();
+	} catch {
+		console.log("Error on connecting die")
+	}
+ }
+ ```
    
 Responses:   
 ----------
@@ -122,8 +144,26 @@ GoDice.prototype.onDiceConnected = (diceId, diceInstance) => {
   // die unique identifier
   let dieClass = diceInstance;		
 };
-```    
+```
+
+```javascript
+ /**
+  * To recognize when a die has disconneted, override the function "onDiceDisconnected" in the GoDice class, with the following parameter:
+  * @param {string} diceID - the die unique identifier	 
+  * @param {GoDice class} diceInstance - the die class instance	 
+  */
+
+// example:
   
+GoDice.prototype.onDiceDisconnected = (diceId, diceInstance) => {  
+  // die unique identifier
+  let dieIdentifier = diceID;
+	
+  // die unique identifier
+  let dieClass = diceInstance;		
+};
+```
+
  ```javascript
  /**
   * To recognize the battery level, override the function "onBatteryLevel" in the GoDice class, with the following parameter:
diff --git a/godice.js b/godice.js
@@ -237,22 +237,23 @@ class GoDice {
 	onTiltStable(){};
 	onMoveStable(){};
 	onDiceConnected(){};
+	onDiceDisconnected(){};
 
 	/******* API functions *******/
 
 	/**
 	 * Request for the die battery, that should follow by corresponding "BatteryLevel" event (response).
 	 */
 	getBatteryLevel() {
-		console.log(this)
+		console.debug(this)
 		this.sendMessage([this.messageIdentifiers.BATTERY_LEVEL]);
 	}
 
 	/**
 	 * Request for the die color, that should follow by corresponding "DiceColor" event (response).
 	 */
 	getDiceColor() {
-		console.log(this)
+		console.debug(this)
 		this.sendMessage([this.messageIdentifiers.DICE_COLOUR]);
 	}
 	
@@ -269,13 +270,30 @@ class GoDice {
 			filters: [{ namePrefix: 'GoDice_' }],
 			optionalServices: ['6e400001-b5a3-f393-e0a9-e50e24dcca9e']
 		})
-			.then(device => {				
+			.then(async device => {				
 				this.GlobalDeviceId = device.id.toString();				
-				this.bluetoothDevice = device;				
-				this.bluetoothDevice.addEventListener('gattserverdisconnected', this.onDisconnected);				
-				this.connectDeviceAndCacheCharacteristics();				
+				this.bluetoothDevice = device;
+				var _self = this
+				this.bluetoothDevice.addEventListener('gattserverdisconnected', function() {
+					_self.onDiceDisconnected(_self.GlobalDeviceId, _self)
+				})
+				await this.connectDeviceAndCacheCharacteristics();				
 			});
 	}
+	
+	/**
+	 * Attempts to reconnect to the device incase of disconnect
+	 */
+	async attemptReconnect() {
+		if (this.bluetoothDevice) {
+			// This object's device exists
+			if (this.bluetoothDevice.gatt.connected) {
+				console.debug(this.GlobalDeviceId + "'s Bluetooth device is already connected")
+			} else {
+				await this.connectDeviceAndCacheCharacteristics()
+			}
+		}
+	}
 
 	/**
 	 * Turn On/Off RGB LEDs, will turn off if led1 and led2 are null
@@ -548,7 +566,4 @@ class GoDice {
 		this.bluetoothDevice = null;
 	}
 
-	onDisconnected(event) {
-		console.debug('> Bluetooth Device disconnected:' + event);
-	}
 }
