Commit d2ca2420 authored by Gonçalo Leal's avatar Gonçalo Leal
Browse files

new structure

parent 826151cb
No related merge requests found
Pipeline #4238 failed
Showing with 128 additions and 5 deletions
+128 -5
# stages:
# - sync
# - build
# - test
# - docs
# sync-esp32-component:
# stage: sync
# script:
# - mkdir -p devices/esp32/components/proto/include
# - mkdir -p devices/esp32/components/proto/src
# - cp proto/esp32-component/proto.c devices/esp32/components/proto/src/
# - cp proto/esp32-component/proto.h devices/esp32/components/proto/include/
# rules:
# - changes:
# - proto/**
# - devices/esp32/**
# build-esp32:
# stage: build
# image: espressif/idf:release-v5.1
# script:
# - cd devices/esp32
# - idf.py build
# needs: [sync-esp32-component]
# build-csharp-dll:
# stage: build
# image: mcr.microsoft.com/dotnet/sdk:7.0
# script:
# - cd proto/csharp-wrapper
# - dotnet build -c Release
# build-go-wrapper:
# stage: build
# image: golang:1.21
# script:
# - cd proto/go-wrapper
# - go build
# build-docs:
# stage: docs
# image: python:3.11
# script:
# - pip install mkdocs
# - mkdocs build
# artifacts:
# paths:
# - site
\ No newline at end of file
# Title
# Tour Orchestrator
Project Overview
**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.
## Structure
---
what's inside this repo and how to find what I want
\ No newline at end of file
## 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
\ No newline at end of file
# Cloud Services
coming soon...
\ No newline at end of file
# Tour Controller
This is the central controller for orchestrating all device communications and syncing on-site.
# Devices
\ No newline at end of file
# Devices
This folder contains code and firmware for physical hardware devices used in the system.
\ No newline at end of file
# ESP32
## Features
## Requirements
## Build
\ No newline at end of file
# Audio
## Features
## Requirements
## Build
\ No newline at end of file
# Unity AR
## Features
## Requirements
## Build
File moved
# Devices
\ No newline at end of file
File moved
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment