blueboxweb / Developerzy

Dokumentacja integracji

Od pierwszego osadzenia do obsługi konfiguracji. Instrukcje dla developerów, agencji i osób przygotowujących wdrożenie.

Zacznij od przykładu ↓
Na tej stronie

01 / START

Wybierz sposób osadzania.

BlueBox przygotowuje cyfrowego bliźniaka z materiałów Twojej maszyny i przekazuje adresy oraz identyfikatory do wdrożenia. Poniższe przykłady korzystają z naszych publicznych modeli demonstracyjnych.

Nie musisz przebudowywać całej strony. Potrzebujesz możliwości dodania iframe lub własnego JavaScriptu oraz zgody w polityce bezpieczeństwa witryny.

02 / HTML

Wklej. Otwórz. Gotowe.

  1. Dodaj blok HTML w miejscu, w którym ma pojawić się maszyna.
  2. Wklej poniższy kod i zapisz stronę.
  3. Otwórz stronę na komputerze i telefonie. Sprawdź obracanie widoku oraz ruch maszyny.
HTML · iframe
<iframe
  src="https://blueboxsimulation.com/blueboxweb/twin/embed?machine=jubilee-solder&lang=pl&presentation=scene"
  title="Cyfrowy bliźniak robota lutowniczego"
  loading="lazy"
  style="display:block;width:100%;height:460px;border:0"
></iframe>

presentation=scene pokazuje samą scenę 3D. Usuń ten parametr, aby pokazać sterowanie, informacje i dostępne opcje konfiguracji. lang=pl / lang=en wybiera język; cfg pozwala przekazać wybraną konfigurację.

Ten kod w praktyce

Otwórz osobno ↗

Dla pełnego interfejsu przeznacz więcej wysokości, np. 720 px na komputerze i 1100 px na telefonie, lub pozostaw przewijanie wewnątrz iframe. Widoczny odnośnik do źródeł zachowuje informacje o autorach modeli demo.

03 / JAVASCRIPT

Komponent w Twoim układzie.

Załaduj moduł raz na stronie. Następnie dodaj element bluebox-twin dla każdej przygotowanej maszyny. Wewnętrzny arkusz stylów jest odseparowany przez Shadow DOM.

HTML · web component
<script type="module"
  src="https://blueboxsimulation.com/blueboxweb/twin/bluebox-twin.js"></script>

<bluebox-twin
  machine="router5"
  brand="bluebox-pl"
  lang="pl"
  base="https://blueboxsimulation.com/blueboxweb/twin/"
  share-url="https://blueboxsimulation.com/blueboxweb/pl/maszyny/router5?cfg={cfg}"
  style="display:block;height:720px"
></bluebox-twin>

<a href="https://blueboxsimulation.com/blueboxweb/pl/maszyny/router5#product-documents"
  target="_blank" rel="noopener">Źródła i licencje modelu</a>

Na wąskim ekranie pełny interfejs rośnie w pionie. Dla samej sceny ustaw presentation="scene", tabindex="0" i opis aria-label, a kontenerowi nadaj konkretną wysokość. Spacja zatrzymuje i wznawia ruch aktywnej sceny. Przy preferencji ograniczonego ruchu scena startuje w pauzie.

React / Next.js

W komponencie klienckim załaduj moduł i utwórz element po zamontowaniu strony, np. w useEffect. Atrybuty ustaw przed dodaniem go do DOM; podczas cleanup usuń element. Unikaj ładowania runtime 3D podczas renderowania serwerowego.

04 / EVENTS

Reaguj na konfigurację.

Podepnij nasłuchiwanie przed dodaniem komponentu do DOM lub załadowaniem modułu. twinready oznacza gotowy model, twinerror błąd ładowania, a configchange przekazuje konfigurację w event.detail.cfg. Dla konfigurowalnej maszyny zdarzenie pojawia się także przy pierwszym załadowaniu.

JavaScript · events
const twin = document.querySelector('bluebox-twin');

twin.addEventListener('twinready', () => {
  console.log('Ready');
});

twin.addEventListener('twinerror', () => {
  // Show a loading error and a retry action.
});

twin.addEventListener('configchange', event => {
  console.log(event.detail.cfg);
});

Te zdarzenia dotyczą komponentu JavaScript. Iframe na innej domenie nie udostępnia ich stronie nadrzędnej. Obecnie nie ma API postMessage ani publicznych metod start/pauza/kamera; służą do tego widoczne kontrolki i klawiatura sceny.

05 / REFERENCE

Parametry komponentu.

AtrybutDziałanie
machineID przygotowanej maszyny, np. router5. Każdy projekt otrzymuje własne ustalone ID.
brandID przygotowanej marki. W demo: bluebox-pl lub bluebox-en.
baseAdres katalogu plików z końcowym /. Na innej domenie użyj pełnego adresu HTTPS.
langpl lub en. Domyślnie język przygotowanej marki.
cfgZakodowana konfiguracja. Zmiana atrybutu aktualizuje model zgodnie z regułami maszyny.
presentationscene: sam widok 3D. Pomiń, aby pokazać pełny interfejs.
share-urlPełny adres karty maszyny z dosłownym znacznikiem {cfg}. Ustaw przed dodaniem elementu do strony.
catalog-urlOpcjonalny odnośnik do listy maszyn. Ustaw przed dodaniem elementu do strony.

Zmiany machine, brand, base, lang i presentation ponownie ładują bliźniaka. Nieznane lub niezgodne wartości cfg są normalizowane przez reguły konkretnej maszyny.

06 / HANDOFF

Co przygotować do wdrożenia?

Konstruktor / osoba od maszyny

  • Pliki CAD, jednostki i oznaczenie części ruchomych.
  • Osie i zakresy ruchu, opis cyklu oraz materiały pokazujące rzeczywisty proces.
  • Warianty wyposażenia i reguły wyboru, jeśli model ma być konfigurowalny.

Developer / agencja

  • Adres i technologia strony, dostęp do bloku HTML lub kodu oraz wymagania CSP.
  • Miejsce osadzenia, docelowe wymiary, język i sposób otwierania zapytań.
  • Test na docelowych urządzeniach przed publikacją.

Marketing / właściciel produktu

Wskaż proces, który kupujący powinien zrozumieć, zatwierdź nazwy i informacje o produkcie oraz ustal osobę odbierającą zapytania. Agencja może dalej prowadzić stronę; BlueBox dostarcza uzgodnioną część interaktywną.

Sprawdź orientacyjny koszt swojego projektu ↗

07 / TROUBLESHOOTING

Gdy coś nie działa.

Puste miejsce zamiast modelu

Sprawdź wysokość kontenera, włączony JavaScript i obsługę WebGL w przeglądarce. W konsoli i zakładce Network sprawdź, czy moduł JS, JSON, model GLB i oświetlenie HDR są pobierane. Zweryfikuj machine, brand oraz końcowy / w base. Przy twinerror pokaż komunikat i możliwość ponowienia.

CSP i osadzanie na innej domenie

Dla iframe polityka frame-src witryny musi dopuszczać https://blueboxsimulation.com. Komponent wymaga odpowiednich script-src, connect-src, img-src i stylów Shadow DOM; korzysta też z fonts.googleapis.com i fonts.gstatic.com. Ustal konkretne reguły z developerem strony. Publiczne zasoby /blueboxweb/twin/* udostępniają CORS bez poświadczeń.

WordPress, CMS albo starsza strona HTML?

Użyj bloku własnego HTML lub szablonu pozwalającego na iframe. Niektóre edytory usuwają skrypty lub iframe zależnie od uprawnień — wtedy potrzebna jest osoba administrująca witryną. Możliwość dodania kodu i polityka bezpieczeństwa mają większe znaczenie niż framework.

Ten przewodnik opisuje osadzanie przygotowanych modeli. Nie udostępnia źródłowych plików CAD, połączenia z PLC, ERP lub CRM ani publicznego edytora maszyn.

Pomoc przy integracji: tomasz@blueboxsimulation.com