Skip to content
Snippets Groups Projects
README.md 1.69 KiB
Newer Older
  • Learn to ignore specific revisions
  • Gonçalo Leal's avatar
    Gonçalo Leal committed
    # Tour Orchestrator
    
    Gonçalo Leal Silva's avatar
    Gonçalo Leal Silva committed
    
    
    Gonçalo Leal's avatar
    Gonçalo Leal committed
    **Tour Orchestrator** is an open-source platform for orchestrating complex, synchronized experiences across embedded devices, edge systems, and AR environments.  
    Built for creators, engineers, and technologists who need plug-and-play, offline-capable control over diverse platforms.
    
    Gonçalo Leal Silva's avatar
    Gonçalo Leal Silva committed
    
    
    Gonçalo Leal's avatar
    Gonçalo Leal committed
    ---
    
    Gonçalo Leal Silva's avatar
    Gonçalo Leal Silva committed
    
    
    Gonçalo Leal's avatar
    Gonçalo Leal committed
    ## Monorepo Structure
    
    ```bash
    project-root/
    
    ├── proto/                  # 🔧 Shared C-based protocol library (submodule)
    │   ├── include/            #    Header files
    │   ├── src/                #    Source files
    │   ├── esp32-component/    #    ESP-IDF-ready wrapper
    │   ├── go-wrapper/         #    Golang bindings
    │   └── csharp-wrapper/     #    C# P/Invoke DLL
    
    ├── devices/
    │   ├── esp32/              # 📟 Firmware for ESP32 boards (ESP-IDF)
    │   ├── go-audio-device/    #    Example of a device written in GO
    │   └── unity-ar-device/    #    Example of a device based in unity
    
    ├── controller/             # 🧠 Central control software
    ├── edge/                   # 🌐 Future edge computing services
    ├── cloud/                  # ☁️  Future cloud services
    
    ├── docs/                   # 📚 Project documentation (MkDocs-powered)
    └── .gitlab-ci.yml          # 🔁 CI/CD pipeline
    ```
    
    ## Main Features
    
    - Control and sync lights, AR headsets, eletronics, etc.
    - Compatible with Open Sound Control (OSC)
    - Unified messages protocol across platforms (esp32, raspberry pi, nvidia jetson, hololens 2)
    - Micro-services architecture with services running on cloud and edge to improve performance
    
    ## Core Concepts
    
    ## Getting Started
    
    ### Requirements
    
    ## CI/CD
    
    ## Docs
    
    ## License