Awesome

5sControl is a video monitoring system with AI analysis and ERP Integration (Open Source) that helps companies improve productivity, eliminate waste, and enhance workplace safety using computer vision (CV) and machine learning (ML).

The platform generates detailed reports to provide insights on how processes can be optimized.

Plug-in your ML-algorithms or some of the Official 5s algorithms and get a ready-to-use software for manufacturing monitoring.

Project repositories

The connections between the project repositories are illustrated by the following diagram.

Please note that to ensure system stability and perfomance you can use one of the Official 5S algorithms instead of Your Algorithm.

5controlS Platform:

1. 5s-webserver
2. 5s-backend
3. 5s-frontend
4. 5s-algorithms-controller
5. 5s-onvif
6. 5s-onvif-finder

Official Algorithms:

1. min-max
2. idle-control
3. operation-control-js
4. machine-control
5. machine-control-js

Algorithms Servers:

1. inference-server-js

Documentation

Documentation for Developers

User Documentation

Installation Guide Pt.1

Installation Guide Pt.2

Installation

To run the application, you need to install Docker. You can do this by following the instructions specific to your system available at Docker Installation Guide.

Please follow the link and select the instructions that match your operating system to install Docker.

To clone the project, use the following Git command:

git@github.com:5sControl/5s-algorithms-controller.git

Install Dependencies:

Install all project dependencies, run the following command using npm:

npm install

Create a .env File:

In the root directory of your project, create a file named .env. You can do this manually or by using command-line text editors like touch or echo (for Unix-based systems) or any text editor of your choice.

For Unix-based systems using the touch command:

touch .env

Environment Variables:

You can reference an example of the environment variables in the .env.example file. Here is how they should be defined:

• IP: The address of your host. Example: '192.168.1.101'
• ALGORITHMS_SOURCE_IMAGES_DIST: The location where you will store algorithm images. Example: '/media/server/static/images'
• ALGORITHMS_SOURCE_DEBUG_DIST: The location where debug photos are stored. Example: '/media/server/static/debug'
• ALGORITHMS_TARGET_IMAGES_DIST: The mount point for algorithm images in Docker. Example: '/var/www/5scontrol/images'
• ALGORITHMS_TARGET_DEBUG_DIST: The mount point for debug photos in Docker. Example: '/var/www/5scontrol/debug'

Make sure to create your .env file and define these variables with the appropriate values for your project.

Running the Application:

• For development, use the following command: npm run dev.

• For start, use the following command: npm run start.

Contributing

Thank you for considering contributing to 5sControl. We truly believe that we can build an outstanding product together!

We welcome a variety of ways to contribute. Read below to learn how you can take part in improving 5controlS.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Code contributing

If you want to contribute, read our contributing guide to learn about our development process and pull requests workflow.

We also have a list of good first issues that will help you make your first step to beсoming a 5S contributor.

License

GNU GPL-3.0

5sControl uses third party libraries that are distributed under their own terms (see LICENSE-3RD-PARTY.md).<br>