gyropalm/vimpaact-logistics repository overview

⁠VIMPAACT DropShip Linux

An intelligent REST API using GyroPalm's VIMPAACT framework for logistics use-cases.

⁠Overview

The VIMPAACT framework is an innovative technology that provies GyroPalm Spectrum users with hands-free interfaces, robotic control, and data collection capabilities for manufacturing and logistics. As part of the framework, the VIMPAACT Logistics API equips users with advanced perception algorithms enabling dynamic 3D object measurement, mass inventory counting, automatic perspective transforms, etc.

⁠System Requirements

• An Ubuntu or Windows 64-bit machine with Docker installed
• About 1 GB of storage
• At least 2 GB RAM
• (Optional but recommended) A domains with SSL certificate

⁠Installation

Run the following to pull the image and start it on port 8000:

docker run -p 8000:8000 --restart=always gyropalm/vimpaact-logistics

What this will do is pull the latest version and tells Docker to keep running the server upon startup unless manually stopped.

⁠Usage

Visit http://localhost:8000 on your browser. If you are running a VPS, you can replace localhost with your IP address.

Please see the official Postman documentation for VIMPAACT Logistics API⁠ for details.

⁠License

This Docker image and its associated files ("the Work") is provided by GyroPalm for non-commercial purposes only. The term "non-commercial" means for research, experimentation, and evaluation. The Work and any derivative works thereof may only be utilized for non-commercial activities unless otherwise permitted by GyroPalm in written authorization.

Notwithstanding the foregoing, GyroPalm retains the exclusive right to use the Work and its derivative works for commercial purposes. This software is protected by patents and international copyright laws, safeguarding the intellectual property. Unauthorized commercial usage, reverse-engineering, or misuse of the Work is strongly prohibited and will lead to the revocation of this license. GyroPalm reserves the right to take necessary legal actions to protect its interests and enforce the terms of this license.

THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, OR NON-INFRINGEMENT. YOU BEAR THE RISK ARISING FROM ANY ACTIVITIES UNDERTAKEN UNDER THIS LICENSE. By using or downloading the Work, you agree to hold GyroPalm and the author harmless from any claims, damage, loss, liability, or other adverse effects that may arise from the utilization of the Work.

⁠Technical Details

These dependencies are used as part of the Docker image:

pip install fastapi uvicorn[standard] python-multipart opencv-contrib-python

Tested version: fastapi 0.110.0, uvicorn 0.28.0, python-multipart 0.0.9, opencv-python 4.7.0.72

⁠Running API server manually

The server should automatically start with the container. But for testing, you can run this command to manually start the server:

uvicorn fastapi_test:app --host 0.0.0.0 --port 8000

Then we need to expose this machine to the endpoint, logistics-api.vimpaact.com. Run these commands:

cd frp
chmod +x frpc
./frpc -c ./frpc.ini

Now you can visit logistics-api.vimpaact.com in your browser or Postman.