Introduction
Laptops/Computers are referred to as a device where a particular device is compromised of sensors and actuators. provide a large number of functionalities for the SIC framework. They can be used as stand-alone devices, as emulators for Pepper/Nao robots , or as Tablets/Phones/Browsers .
In order to collect and send data to and from the SIC framework, drivers have been provided to emulate the various sensors and actuators used in SIC.
...
The following sensors and actuators have been provided in the following format: Sensor/Actuator - driver name where each driver is a JAR file(if applicable).
Microphone -
computer-microphone.jar
...
Camera -
computer-
...
camera.jar
...
Browser -
computer-
...
Dependencies
The independent usage of sensors and actuators does not have any dependencies besides running the respective drivers themselves. However, there are two cases where you might have dependencies:
Communication with robot/s: Considering that the intention is to emulate a robot’s responses on your device, and not use an actual robot, you must first launch
computer-robot
. Thereafter depending on the context of your usage, you might need to run the required sensors/actuators drivers. This is not required if you working with robots such as Pepper/Nao.Using a web browser: In order to do so, you must launch
computer-browser
as well as the webserver service. Depending on the context of your usage, you might need to run the required sensors/actuators for that particular use case.
How to Use
An example will be used to demonstrate where these drivers come in handy. Assume one wishes to use sentiment analysis strictly on a laptop/computer, in order to do so you will need to launch the following JAR files to communicate with the SIC framework: computer-microphone
and computer-robot
. Kindly note there are other services required to run the sentiment-analysis service, for more information please visit the service page.
...
browser.jar
the driver automatically launches a Chrome window that displays the page as rendered by the
webserver
service. See Tablets/Phones/Browsers for more information.
Speaker -
computer-speaker.jar
can be used for generic audio playing, as well as text-to-speech with eSpeak
Robot -
computer-robot.jar
can be used for emulating Pepper/Nao robots
The drivers are run from the https://bitbucket.org/socialroboticshub/docker/src/master/sic-local/ folder and have been provided as a JAR in the format computer-*. To use these JARs, you need to have run them, Java 8 or later is required to be installed on your machine. Launch one of the local devices by either double-clicking or using the BAT (Windows) or SH (Linux/Mac) file. With a locally running SIC framework you can always just press OK in the initial dialog dialogbox that appears. The full list of available drivers is as follows:
computer-browser
: automatically launches a Chrome window that displays the page as rendered by the webserver service. See Tablets/Phones/Browsers for more information.computer-camera
: can feed the video of the webcam on your machine into the framework.computer-microphone
: can feed the audio of the microphone on your machine into the framework.computer-robot
: emulates the responses (mainly events) that a Nao or Pepper robot would generate.computer-speakers
: uses eSpeak for local text-to-speech and plays generic audio too.
Limitations
The available drivers work as intended on Linux and Windows. Currently, the drivers do not function as intended on Macintosh
Dependencies
The independent usage of sensors and actuators does not have any dependencies by themselves. Instead, services are dependent on them. So, depending on the services run, the necessarily sensor/actuator should be used.
How to Use
An example will be used to demonstrate how these drivers are used. Assume https://bitbucket.org/socialroboticshub/connectors/src/master/python/tts_example.py needs to be run.
start Docker with the required
text_to_speech
servicestart
computer-robot.jar
,computer-speakers.jar
the https://bitbucket.org/socialroboticshub/connectors/src/master/python/tts_example.py emulates Text-to-Speech on a robot; hence we need to use both a robot emulator and the speakers as actuators
run https://bitbucket.org/socialroboticshub/connectors/src/master/python/tts_example.py
Limitations
The available drivers have been tested on Windows 10 and Ubuntu 22.04. MacOS can also be used, but has not been as extensively tested and compatibility and support for it are limited (colloquially: most of the time they should work on MacOS too, but sometimes there are cryptic bugs that makes them unusable).