Configuration ‐ UI Module - ChrisMavrommatis/Binacle.Net GitHub Wiki

The UI Module provides a user-friendly interface for interacting with Binacle.Net, allowing users to explore its features visually. This makes it easier to demonstrate and understand the system’s capabilities without making direct API calls.

[!Note] This module is disabled by default.

⚙️ Configuration

All configuration files for the UI Module are located in the /app/Config_Files/UiModule directory.

📑 Directory Structure

app
└── Config_Files
    └── UiModule
        └── ConnectionStrings.json

📦 Packing Demo

The Packing Demo allows users to interact with the packing process visually by submitting bin and item data and observing how items are packed into bins.

• 🔹 Step-by-step Interaction: Users can navigate through the packing process, handling items one by one.
• 🔹 Real-time Visualization: Watch as each item is placed inside the bins in real-time.

📜 Protocol Decoder

The Protocol Decoder enables users to decode ViPaq-encoded packing data and visualize the container layouts interactively. It helps analyze packing arrangements and navigate through the layout easily.

• 📌 To obtain ViPaq data, use Version 3 of the API.
• 📖 For more details on ViPaq, refer to the ViPaq Protocol.

🔧 Activating the UI Module

To enable the UIModule, set the environment variable:

UI_MODULE=True

🛠️ Configuration

The UI Module attempts to auto-detect the Binacle.Net API URL by default. However, in some cases—particularly when using proxies or forwarding services—automatic detection may fail, leading to issues with the Packing Demo or API communication.

If automatic detection fails, you can manually specify the API endpoint for BinacleApi in the ConnectionStrings.json file.

Default configuration:

{
  "ConnectionStrings": {
    "BinacleApi": "endpoint=https://localhost:8080/"
  }
}

🔗 For more details on how to configure connection strings, refer to the Connection String Fallbacks section.