Page Comparison

This page offers an overview about what a service could be (or not) and the (detailed) steps of how to integrate it into the SIC Framework. The code for all the existing services can be found at https://bitbucket.org/socialroboticshub/processing/src/master/.

What Is (Not) a Service?

Do’s

A service is required to:

• use input from a device and/or another service

• do more than 1 line of code in processing

• give output that is useful for another service and/or an application

Additionally, it should be reusable/generic (i.e. more than 1 specific application can make use of the service).

Do’nts

A service should only relate to the software aspect of the SIC framework. An example of what would NOT count as a service is integrating both a third-party device (e.g.: smartwatch) and the data collected from it into an application. In this case, the device should be added separately as one, and the data collection and processing should be turned into a service itself.

Summary How to Add a Service to the SIC Framework

...

Summary How to Add a Service to the SIC Framework

1. create a new folder in https://bitbucket.org/socialroboticshub/processing/src/master/ with the name of the service

2. copy the certificate file https://bitbucket.org/socialroboticshub/docker/src/master/sic/beamforming/cert.pem from any of the other services' folders into the service’s folder

3. copy any additional files that the services may need into the service’s folder

4. create a factory file inheriting from the SICfactory in the service’s folder, and override the superclass’s methods

5. create a service file inheriting from SICservice in the service’s folder, and override the superclass’s methods

6. update the https://bitbucket.org/socialroboticshub/processing/src/master/ with the name of the servicecopy the certificate file deploy_to_docker.sh file in the root folder with the new service files

7. deploy the new service to the https://bitbucket.org/socialroboticshub/docker/src/master/sic/beamforming/cert.pem from any of the other services' folders into the service’s folder

8. copy any additional files that the services may need into the service’s folder

9. create a factory file inheriting from the SICfactory in the service’s folder, and override the superclass’s methods

10. create a service file inheriting from SICservice in the service’s folder, and override the superclass’s methods

11. update the https: folder by running the deploy_to_docker.sh file

12. update the https://bitbucket.org/socialroboticshub/docker/src/master/docker-compose.yml file in the docker folder with the new service

13. update the https://bitbucket.org/socialroboticshub/processingdocker/src/master/deploy_to_docker.shDockerfile.python3 file in the root docker folder with the new service filesdeploy the new service to service’s dependencies

14. update the topics in the constructor of the Abstract Connector from the https://bitbucket.org/socialroboticshub/dockerconnectors/src/master/python/social_interaction_cloud/ folder by running the deploy_to_docker.sh file

15. update the https://bitbucket.org/socialroboticshub/docker/src/master/docker-compose.yml file in the docker folder with the new service

16. update the https://bitbucket.org/socialroboticshub/docker/src/master/Dockerfile.python3 file in the docker folder with the new service’s dependencies

17. update the topics in the constructor of the Abstract Connector from the https://bitbucket.org/socialroboticshub/connectors/src/master/python/social_interaction_cloud/ folder with the name of the new service

18. update the device listeners in enable_service in the Abstract Connector with the service

19. update the listened to channels in __listen in the Abstract Connector with the service

20. create the corresponding event handler method for the service in the Abstract Connector

21. create the corresponding event handler method for the service in the Basic Connector

22. use the service in a new file

The detailed explanation of these steps with a sentiment analysis example can be found below:

...

1. with the name of the new service

2. update the device listeners in enable_service in the Abstract Connector with the service

3. update the listened to channels in __listen in the Abstract Connector with the service

4. create the corresponding event handler method for the service in the Abstract Connector

5. create the corresponding event handler method for the service in the Basic Connector

6. use the service in a new file

The detailed explanation of these steps with a sentiment analysis example can be found below:

Detailed How to Add a (Sentiment) Service to the SIC Framework

There are two shared libraries that handle a lot of the common logic that is needed to interact with our framework: one for Python-based integrations and one for Java-based integrations (using Maven). In order to allow users to run services without worrying about compatibility and installations, Docker Compose is used.

If a service is not simply an alternative to an existing service, adding a new service will also require updates to the connectors (EIS and Python) in order to be fully integrated.

1. create a new folder in https://bitbucket.org/socialroboticshub/processing/src/master/ with the name of the service. sentiment_analysis (https://bitbucket.org/socialroboticshub/docker/src/master/sic/sentiment/ ) will be used as the example folder and service in this case

2. copy the certificate file https://bitbucket.org/socialroboticshub/docker/src/master/sic/beamforming/cert.pem from any of the other services' folders into the sentimentfolder

3. copy the https://bitbucket.org/socialroboticshub/docker/src/master/sic/sentiment/classifier.pickle into the sentiment folder

4. create a https://bitbucket.org/socialroboticshub/docker/src/master/sic/sentiment/sentiment_factory.py file in the sentiment folder

...