Smart Storage System

Overview

This is a versatile and customizable Storage System. It has the ability to combine multiple Storage Systems via the use of ESP32 (a cheap microcontroller) as controllers for the neopixels (indicators). It has a simple but useful WebUI and an API. The storage bins are compatible with Gridfinity 1x4 bins.

Features

• Gridfinity Compatible: Easily integrates with the Gridfinity storage system for modular storage.
• Parametric Design: Easily customizable bins.
• ESP32 Controlled: Scalable system using ESP32 as wireless controllers.
• Neopixels: Dynamic lighting indicators.
• Web UI to Manage Storage: User-friendly web interface for managing the items.
• API: Simple to use API.
• Node PCB: Simple ESP32-Wroom based PCB with the necessary connectors.

Media

Main Website

Add Item Menu

Video

API Endpoints

List Storage Items

• Endpoint: /api/list
• Method: GET
• Description: Retrieves a list of all storage items. Supports optional query parameters for filtering by category, node, and position.
• Query Parameters:
  • category (optional): Filter items by category.
  • node (optional): Filter items by node.
  • position (optional): Filter items by position.
  • id (optional): Filter items by ID:

Locate Item by ID (GET)

• Endpoint: /api/locateget
• Method: GET
• Description: Locates an item by its ID and sends a request to the corresponding node to locate the item.
• Query Parameters:
  • id (required): The ID of the item to locate.

List Nodes

• Endpoint: /api/nodes
• Method: GET
• Description: Retrieves a list of all nodes. Supports optional query parameter for filtering by ID.
• Query Parameters:
  • id (optional): Filter nodes by ID.

Add Storage Item

• Endpoint: /api/additem
• Method: POST
• Description: Adds a new storage item to the database.
• Request Body (JSON):

  {
    "name": "string",
    "description": "string",
    "category": "string",
    "quantity": "integer",
    "node": "integer",
    "position": "integer",
    "url": "string",
    "slots": "array"
  
  }

Add Node

• Endpoint: /api/addnode
• Method: POST
• Description: Adds a new node to the database or updates an existing node if the ID already exists.
• Request Body (JSON):

    {
      "id": "integer",
      "ip": "string",
      "positions": "integer"
    }

Delete Storage Item

• Endpoint: /api/delete
• Method: POST
• Description: Deletes a storage item by its ID.
• Request Body (JSON):

    {
      "id": "integer"
    }

Edit Storage Item

• Endpoint: /api/edit
• Method: POST
• Description: Edits an existing storage item by its ID.
• Request Body (JSON):

    {
    "id": "integer",
    "name": "string",
    "description": "string",
    "category": "string",
    "quantity": "integer",
    "node": "integer",
    "position": "integer",
    "url": "string",
    "slots": "array"
    }   

Move Storage Item

• Endpoint: /api/move
• Method: POST
• Description: Moves a storage item to a different node and position.
• Request Body (JSON):

    {
    "id": "integer",
    "node": "integer",
    "position": "integer"
    }

Locate Item by ID (POST)

• Endpoint: /api/locate
• Method: POST
• Description: Locates an item by its ID and sends a request to the corresponding node to locate the item.
• Request Body (JSON):

    {
    "id": "integer"
    }

Getting Started

Prerequisites

• PlatformIO installed on your development environment.
• ESP32 DevBoard or Node PCB .
• Neopixels (WS2812B) or Indicator PCB.
• Some wire.
• Edit Code/App/static/script.js server variable
• Edit Code/Node/include/.env with the correct settings

Docker (API + Website)

1. Clone the repository:

   git clone https://github.com/Pegoku/StorageSystem.git
   cd StorageSystem

2. Build and run the Docker containers:

docker compose up -d --build

API

1. Clone the repository:

   git clone https://github.com/Pegoku/StorageSystem.git
   cd StorageSystem/Code/Server

2. Create a Python virtual environment and install the requirements:

   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt

3. Run the main Python file:

   python3 main.py

API (Docker)

1. Clone the repository:

git clone https://github.com/Pegoku/StorageSystem.git
cd StorageSystem

2. Build and run the Docker container:

docker buildx build -t storagesystem:server -f server.Dockerfile .
docker run -p 5505:5505 -v ./database.db:/app/database.db storagesystem:server

3. The API should now be running and accessible at http://localhost:5505.

ESP32

1. Clone the repository:

   git clone https://github.com/Pegoku/StorageSystem.git
   cd StorageSystem

2. Install the required libraries and dependencies:

   platformio run

3. Connect your ESP32 to your computer.
4. Edit the include/.env.template file and rename it to include/.env.
5. Upload the firmware to the ESP32:

   platformio run --target upload

6. Open the serial monitor to check if the installation was successful:

   platformio device monitor

Website

1. Clone the repository:

   git clone https://github.com/Pegoku/StorageSystem.git
   cd StorageSystem/Code/App

2. Create a Python virtual environment and install the requirements:

   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt

3. Run the main Python file:

   python3 main.py

Website (Docker)

1. Clone the repository:

git clone https://github.com/Pegoku/StorageSystem.git
cd StorageSystem

2. Build and run the Docker container:

docker buildx build -t storagesystem:app -f app.Dockerfile .
docker run -p 5506:5506 storagesystem:app

3. The website should now be running and accessible at http://localhost:5506.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.