Prejsť na hlavný obsah

Factory Agent – dokumentácia kódu generovaná pomocou AI

Prehľad opisu kódu vo Factory Agent​

Factory Agent poskytuje dokumentáciu kódu generovanú pomocou AI priamo v platforme SDA, čím inžinierskym tímom uľahčuje pochopenie, údržbu a riešenie problémov automatizačných projektov. Factory Agent, dostupný prostredníctvom zobrazenia Project View, automaticky analyzuje štruktúru projektu, logiku, premenné a artefakty kódu a vytvára prehľadnú dokumentáciu čitateľnú pre človeka.

Táto funkcia pomáha tímom zrýchliť zaškolenie, znížiť medzery v znalostiach a zlepšiť dlhodobú udržiavateľnosť – najmä v prostrediach, kde nepísané znalosti alebo staršie kódové základne komplikujú udržiavanie ručne písanej dokumentácie. Výstupy Factory Agent sa generujú na požiadanie, čím sa zaisťuje, že dokumentácia odráža najaktuálnejšiu verziu projektu uloženú v SDA.

Okrem dokumentácie Factory Agent podporuje aj porovnávanie kódu s asistenciou AI pre rovnakú množinu podporovaných výrobcov. Táto funkcia, dostupná prostredníctvom zobrazenia Compare Projects View, umožňuje používateľom porovnať dve verzie toho istého projektu a získať prehľadný, štruktúrovaný súhrn zmien. Porovnávanie vo Factory Agent sa zameriava konkrétne na zmeny medzi verziami v rámci projektu a poskytuje hlbší pohľad na úpravy, refaktorovanie alebo neúmyselné zmeny. To umožňuje inžinierom rýchlo validovať zmeny, pochopiť, ako tieto zmeny ovplyvňujú funkčnú prevádzku zariadenia, skontrolovať prácu pred nasadením a zachovať prehľadnosť vhodnú na audit o tom, ako sa projekt v čase vyvíja.

Matica kompatibility výrobcov a jazykov PLC vo Factory Agent​

Software Defined Automation poskytuje nástroj poháňaný AI, ktorý generuje podrobnú dokumentáciu pre každý projekt na úrovni súborov. Tento nástroj identifikuje závislosti v rámci súboru a bezproblémovo ich integruje do dokumentácie.

Momentálne sú podporovaní nasledujúci výrobcovia a formáty súborov:

VýrobcaStructured Text / SCLLadder LogicFBD
Beckhofftruetruefalse
BoschRexrothtruetruefalse
CODESYStruetruetrue
Rockwell Automationtruetruefalse
SEW MOVIRUN opentruetruefalse
Siemens TIA Portaltruetruefalse
WAGOtruetruefalse

Ako vygenerovať dokumentáciu kódu​

Začnite tým, že v hlavnom zozname projektov vyberiete projekt, pre ktorý chcete vygenerovať dokumentáciu. Kliknutím na požadovaný projekt získate prístup k jeho podrobnému zobrazeniu a dostupným možnostiam dokumentácie.

Výber podporovaných súborov

V zobrazení Project Viewer vyberte ľubovoľný súbor, ktorý podporuje generovanie dokumentácie.

Spustenie generovania dokumentácie

  1. V zobrazení Project Viewer vyberte požadovaný súbor
  2. Kliknutím na tlačidlo „Explain“ spustite proces generovania dokumentácie
  3. Zobrazí sa indikátor priebehu s aktuálnym stavom procesu generovania

Spracovanie na pozadí: Generovanie dokumentácie prebieha ako proces na pozadí, takže môžete opustiť stránku alebo zatvoriť prehliadač bez prerušenia operácie. Neskôr sa môžete vrátiť a skontrolovať priebeh alebo zobraziť hotovú dokumentáciu.

informácia

Poznámka: Na generovanie dokumentácie budú dostupné iba súbory, ktoré vyhovujú kritériám podporovaných formátov. Úplný zoznam kompatibilných typov a formátov súborov nájdete v časti Prehľad.

Factory Agent na porovnávanie kódu (funkcia pred vydaním)​

Začnite tým, že v hlavnom zozname projektov vyberiete projekt, pre ktorý chcete porovnať rozdiely medzi verziami. Kliknutím na požadovaný projekt získate prístup k jeho podrobnému zobrazeniu a dostupným možnostiam dokumentácie a vyberte 2 verzie na porovnanie. Následne vyberte „Compare Versions“, čím otvoríte nástroj na porovnávanie verzií.

V zobrazení projektu vyberte prvok, ktorý vykazuje rozdiely. Tieto prvky sú zvyčajne modré (upravené), zelené (pridané) alebo červené (odstránené) – biela znamená, že nedošlo k zmene. Keď sa zobrazí porovnávacie zobrazenie, vyberte „Explain“ v bloku, pre ktorý si chcete zobraziť vysvetlenie rozdielu. Vysvetlenie rozdielu sa zobrazí pod blokom.

Úrovne podrobnosti dokumentácie​

Systém predvolene generuje podrobnú dokumentáciu, ktorá poskytuje komplexnú analýzu s detailnými vysvetleniami a hĺbkovým pokrytím. Používatelia však môžu prepnúť na skrátenú verziu, ak preferujú stručnejší prehľad.

  • Podrobná: Poskytuje detailné vysvetlenia, komplexnú analýzu a hĺbkové pokrytie (predvolené)
  • Skrátená: Poskytuje základné informácie a kľúčové koncepty v zhustenej podobe