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

To install, do the following

The first thing to do is to clone the repository:

git clone https://github.com/5sControl/5s-backend.git
cd 5s-backend

Create a virtual environment to install dependencies in and activate it:

python3 -m venv venv
source venv/bin/activate

Note the (venv) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up by venv.

Then install the dependencies:

pip install -r requirements.txt

Create .env file in 5s-backend root folder:

touch .env

All variables and how they should look can be seen in the file .env.example

Your secret key should be in .env file like this:

SECRET_KEY = asddsad231jsfjp32ojrjpfjsdoivzoidvhoxic

Debug mode enabled DEBUG=True

DEBUG=True

Create an IP variable. This is the IP address of your machine in the network

IP=192.168.1.101
SERVER_URL=http://192.168.1.101
PRODUCTION=False
LICENSE_ACTIVE=False

Add connection parameters to the DB:

DB_ENGINE=django.db.backends.postgresql
DB_NAME=your name db
DB_USER=your username db
DB_PASSWORD=your password db
DB_HOST=your host db
DB_PORT=your port db

ONVIF_SERVICE_URL=onvif-service
ONVIFFINDER_SERVICE_URL=onviffinder-service
ALGORITHMS_CONTROLLER_SERVICE_URL=algorithms-controller-service
DJANGO_SERVICE_URL=django-service
NGROK_URL=https://ngrok-free.app/

Execute the command that will create migrations in the DB, superuser and start the server

make all

If the command is executed successfully, you will see in the terminal navigate to http://127.0.0.1:8000/

You can go to the address

http://127.0.0.1:8000/api/swagger/

Swagger will open where you will see a list of available URLs.

Documentation

Documentation for Developers

User Documentation

Installation Guide Pt.1

Installation Guide Pt.2

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