Add another special LED function to the API

amitdor1984 · amitdor1984 · commit 14cf179e95e6 · 2022-07-11T17:08:07.000+03:00
diff --git a/README.md b/README.md
@@ -55,6 +55,17 @@ Message:
  */                          
  setLed(led1, led2);
 ```
+```javascript
+/**
+ * Pulses LEDs for a defined time and color
+ * @param {number} pulseCount - an integer of how many times the pulse will repeat (max 255)
+ * @param {number} onTime - how much time should the LED be ON each pulse (units of 10ms, max 255) 
+ * @param {number} offTime - how much time should the LED be OFF each pulse (units of 10ms, max 255)
+ * @param {Array}  RGB - an array to control both LEDs color's in the following format '[R, G, B]' 
+ *                 where R, G and B are number in the range of 0-255
+ */
+ pulseLed(pulseCount, onTime, offTime, RGB)
+```
 
 Requests:
 ---------
@@ -96,7 +107,7 @@ Requests:
 Responses:   
 ----------
 ```javascript
-/**
+ /**
   * To recognize connected die, override the function "onDiceConnected" in the GoDice class, with the following parameter:
   * @param {string} diceID - the die unique identifier	 
   * @param {GoDice class} diceInstance - the die class instance	 
diff --git a/godice.js b/godice.js
@@ -9,6 +9,7 @@ class GoDice {
 		BATTERY_LEVEL: 3,
 		DICE_COLOUR: 23,
 		SET_LED: 8,
+		SET_LED_TOGGLE: 16,
 	}
 	
 	diceColour = {
@@ -278,10 +279,11 @@ class GoDice {
 
 	/**
 	 * Turn On/Off RGB LEDs, will turn off if led1 and led2 are null
-	 * @param {Array} led1 - an array to control the 1st LED in the following format '[R,G,B]'
-	 *                                where R,G and B are numbers in the range of 0-255
-	 * @param {Array} led2 - an array to control the 2nd LED in the following format '[R,G,B]'
-	 *                                where R,G and B are numbers in the range of 0-255
+	 * @param {Array} led1 - an array to control the 1st LED in the following format '[R, G, B]'
+	 *                       where R,G and B are numbers in the range of 0-255
+	 *
+	 * @param {Array} led2 - an array to control the 2nd LED in the following format '[R, G, B]'
+	 *                       where R,G and B are numbers in the ran	ge of 0-255
 	 */
 	setLed(led1, led2) {
 		console.log(led1, led2)
@@ -296,6 +298,22 @@ class GoDice {
 		console.debug("messageArray", messageArray);
 		this.sendMessage(messageArray);
 	}
+	
+	/**
+	 * Pulses LEDs for set time and color
+	 * @param {number} pulseCount - an integer of how many times the pulse will repeat (max 255)
+	 * @param {number} onTime 	- how much time should the LED be ON each pulse (units of 10ms, max 255) 
+	 * @param {number} offTime 	- how much time should the LED be OFF each pulse (units of 10ms, max 255)
+	 * @param {Array}  RGB  - an array to control both LEDs color's in the following format '[R, G, B]' 
+	 * 						 where R, G and B are number in the range of 0-255
+	 */
+	pulseLed(pulseCount, onTime, offTime, RGB) {
+		if (RGB.length === 3) {
+			let rgbColor = RGB.map((i) => Math.max(Math.min(i, 255), 0));
+			const messageArray = [this.messageIdentifiers.SET_LED_TOGGLE, pulseCount, onTime, offTime, ...rgbColor, 1, 0]
+			this.sendMessage(messageArray);
+		}
+	}
 
 	/******* Internal Helper Functions *******/
 
@@ -442,7 +460,7 @@ class GoDice {
 				const diceCurrentNumber = this.getDieValue(data, 1);
 				const xyzArray = this.getXyzFromBytes(data, 1)
 				this.rolledValue = diceCurrentNumber;
-				this.onStable(deviceId, diceCurrentNumber, xyzArray);				
+				this.onStable(deviceId, diceCurrentNumber, xyzArray);
 			}
 
 			if (firstByte === 70 && secondByte === 83) {
diff --git a/index.html b/index.html
@@ -34,7 +34,7 @@ <h3 id="gocube-message"></h3>
 .dice-wrapper{
 	display: inline-block;
     width: 215px;
-    height: 420px;
+    height: 490px;
     border: 1px solid gray;
     border-radius: 5px;
     margin-right: 5px;
diff --git a/main.js b/main.js
@@ -71,7 +71,14 @@ GoDice.prototype.onDiceConnected = (diceId, diceInstance) => {
 	ledOffButton.onclick = diceInstance.setLed.bind(diceInstance, [0], [0])
 	ledOffButton.textContent = 'Switch Off Led';
 	diceHtmlEl.append(ledOffButton)
-
+	
+	// Pulse Led
+	const ledPulseButton = document.createElement('button');
+	ledPulseButton.className = 'btn btn-outline-primary';
+	ledPulseButton.onclick = diceInstance.pulseLed.bind(diceInstance, 5, 30, 20, [0, 0, 255])
+	ledPulseButton.textContent = "Pulse"
+	diceHtmlEl.append(ledPulseButton)
+	
 	// get Dice color to use goDice.getDiceColor(diceID) function
 	const getDiceColorButton = document.createElement('button');
 	getDiceColorButton.className = 'btn btn-outline-primary';
