Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The code for all the services can be found at https://bitbucket.org/socialroboticshub/processing/src/master/ . Creating a new service can be done as follows, and then included in the repository by opening a Pull Request:

Summarised Steps

  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/cbsr/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 CBSRFactory in the service’s folder, and override the superclass’s methods

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

  6. update the https://bitbucket.org/socialroboticshub/processing/src/master/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/ folder by running the deploy_to_docker.sh file

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

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

  10. 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

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

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

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

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

  15. use the service in a new file

...