Table of Contents
The patrol robot system is an advanced system specially designed for remote monitoring and surveillance in various environments. The system is designed to provide real-time information on the status, location and activity of patrol robotic systems.
The system is also equipped with a range of advanced features including alarm management, data collection, data storage and data analysis. These capabilities allow the system to generate alerts based on predefined rules and analyze collected data to identify trends, anomalies and potential problems.
This project is built using several technologies, including:
-
ROS (Robot Operating System): A flexible framework for writing robot software. It's a collection of tools, libraries, and conventions that simplify the task of creating complex and robust robot behavior.
-
FastAPI: A modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
-
Celery: An asynchronous task queue/job queue based on distributed message passing. It is focused on real-time operation but supports scheduling as well.
-
Redis: An open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker.
-
MySQL: An open-source relational database management system.
These tools and technologies work together to form the backbone of our project, providing a robust, scalable, and efficient platform for our needs.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
To run this project, you need:
- Install Docker
Below is an example of how you can instruct your audience on installing and setting up your app.
- Clone the repo
git clone https://gitee.com/ZJCXJSLtd/patrol-robot-monitoring-system.git
- Navigate to the project directory
cd patrol-robot-monitoring-system - Build the images
docker compose build
Use this space to show useful examples of how a project can be used.
This project is developed based on ROS (Robot Operating System). Since the ROS official website does not provide the installation of the MacOS operating system, this image cannot run on the MacOS operating system.
- Start the services
docker compose up -d
- Check the services
docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 7c2ca2fd8071 app:latest "/ros_entrypoint.sh …" 7 minutes ago Up 5 minutes 0.0.0.0:8000->8000/tcp, 0.0.0.0:45150-45200->45150-45200/tcp app 3bee60956053 app:latest "/ros_entrypoint.sh …" 7 minutes ago Up 5 minutes 8000/tcp celery-worker 10138442f708 ros_core:latest "/ros_entrypoint.sh …" 7 minutes ago Up 6 minutes 0.0.0.0:11311->11311/tcp ros_core 3476189f0163 mysql:8.0 "docker-entrypoint.s…" 7 minutes ago Up 6 minutes 0.0.0.0:3306->3306/tcp, 33060/tcp db 541f457209b1 redis:latest "docker-entrypoint.s…" 7 minutes ago Up 6 minutes 0.0.0.0:6379->6379/tcp redis
- Init the database
./init_db.sh
- Visit the http://localhost:8000/docs to browser the APIs.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU General Public License v3.0. See LICENSE for more information.
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!