srbphysicalfeedbackjs v1.0.5

SRBPhysicalFeedbackJS

\ \

Motivation

In modern web browser, there are already few ways to communicate with the user. Classical ways are for example:

• showing a popup with relevant information
• displaying message toasts, which are small messages, displayed only for a few seconds and disappear automatically

However, we know many other types of feedback from native applications. The haptic/physical types are particularly interesting. One of the most common is vibrating your smartphone when you receive text messages. Last but not least, the message tone.

In pure web applications, haptic/physical feedback is rarely used. That's why we created this library. There are many business applications where providing haptic feedback would be very helpful. Vibration or sound feedback is a very good way to increase the user experience, especially in business processes where loud background noise or poor visibility of the screen impairs usability.

Important technical background:

• The library can't vibrate devices, that have no vibration unit installed ;)
• For soundfeedback, you can use any type of speaker that the device supports ( Bluetooth speaker, headphones, ... )
• Check if your browser supports vibrating a compatible device: https://caniuse.com/vibration
• Check if your browser supports playing audio via JavaScript: https://caniuse.com/audio

Demo

If you check out this project, there is a "demo" app to see how the library works. Simply clone the repo and run npm run test in the demo folder ( npm install required to install all necessary packages ).

You can also use this link to see a working example: https://srbconsultingteam.github.io/SRBPhysicalFeedbackJS/demo/webapp/index.html

Getting started

Initialize the SRBPhysicalFeedbackJS via the NPM CDN:

For initializing the library via CDN, simply copy and paste the following in the index file of the HTML5 app:

<script src="https://npmcdn.com/srbphysicalfeedbackjs/src/SRBPhysicalFeedback.js"></script>

Or use the minified version

<script src="https://npmcdn.com/srbphysicalfeedbackjs/src/SRBPhysicalFeedback.min.js"></script>

Initialize SRBPhysicalFeedbackJS via downloading the latest version:

Download the latest minified version from here. Place that file into a directory of the app's folder structure, where it can access that file. For UI5 apps, using the index.html bootrapping, instantiate the Library like below via

<script src="/path/to/SRBPhysicalFeedback.min.js"></script>

For UI5 apps, not using the index.html startup logic, paste the following in the ressources section of the manifest file:

"resources": { "js": [ { "uri": "path/to/SRBPhysicalFeedback.min.js" } ] }

Initialize the Library temporarily via the browsers console. Just copy, paste and execute the following snippet in the browsers console:

var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://npmcdn.com/srbphysicalfeedbackjs/src/SRBPhysicalFeedback.min.js";
script.addEventListener("load", function () {
  alert("Playing sound pattern C");
  SRBPhysicalFeedback.soundFeedback("C");
  alert("Now vibrating pattern A");
  SRBPhysicalFeedback.vibrationFeedback("A");
});

document.head.appendChild(script);

Documentation

The documentation on this page is just an overview of the most relevant functions and features. Consider reading the JSDoc page!

Supported devices

Please also note your device details if you tested it, and create an issue with the information from the table above!

Device: Device name OS: Operating system Browser: Browser and version Sound supported: yes/no Vibration supported: yes/no