Factory Agent – AI által generált kóddokumentáció
A Factory Agent kódleírásának áttekintése
A Factory Agent AI által generált kóddokumentációt biztosít közvetlenül az SDA Platformon belül, megkönnyítve a mérnöki csapatok számára az automatizálási projektek megértését, karbantartását és hibaelhárítását. A Project View nézetből elérhető Factory Agent automatikusan elemzi a projekt struktúráját, logikáját, változóit és kódelemeit, hogy áttekinthető, ember által olvasható dokumentációt készítsen.
Ez a képesség segíti a csapatokat a betanulás felgyorsításában, a tudásbeli hiányosságok csökkentésében és a hosszú távú karbantarthatóság javításában – különösen olyan környezetekben, ahol a nem dokumentált szakmai tudás vagy az örökölt kódbázisok megnehezítik a kézzel írt dokumentáció karbantartását. A Factory Agent kimenetei igény szerint jönnek létre, így a dokumentáció mindig a projekt SDA-ban tárolt legfrissebb verzióját tükrözi.
A dokumentáción túl a Factory Agent AI-támogatott kódösszehasonlítást is támogat ugyanazon támogatott gyártók körében. A Compare Projects View nézetből elérhető funkció lehetővé teszi, hogy a felhasználók összehasonlítsák ugyanazon projekt két verzióját, és világos, strukturált összefoglalót kapjanak a változásokról. A Factory Agent összehasonlítása kifejezetten a projekten belüli, verziók közötti változásokra összpontosít, mélyebb betekintést nyújtva a módosításokba, refaktorálásokba vagy a nem szándékolt szerkesztésekbe. Ez lehetővé teszi a mérnökök számára, hogy gyorsan validálják a változtatásokat, megértsék, hogyan hatnak ezek a változások az eszköz működésére, a telepítések előtt átnézzék az elvégzett munkát, és auditra kész átláthatóságot tartsanak fenn a projekt időbeli fejlődéséről.
Factory Agent gyártói és PLC-nyelvi kompatibilitási mátrix
A Software Defined Automation olyan AI-alapú eszközt biztosít, amely fájlszinten részletes dokumentációt generál minden projekthez. Az eszköz azonosítja a fájlon belüli függőségeket, és zökkenőmentesen beépíti azokat a dokumentációba.
Jelenleg a következő gyártók és fájlformátumok támogatottak:
| Vendor | Structured Text / SCL | Ladder Logic | FBD |
|---|---|---|---|
| Beckhoff | true | true | false |
| BoschRexroth | true | true | false |
| CODESYS | true | true | true |
| Rockwell Automation | true | true | false |
| SEW MOVIRUN open | true | true | false |
| Siemens TIA Portal | true | true | false |
| WAGO | true | true | false |
Hogyan generálható kóddokumentáció
Először válassza ki a fő projektlistából azt a projektet, amelyhez dokumentációt szeretne generálni. Kattintson a kívánt projektre a részletes nézet és az elérhető dokumentációs lehetőségek megnyitásához.
Támogatott fájlok kiválasztása
A Project Viewer nézetben válasszon ki bármely olyan fájlt, amely támogatja a dokumentációgenerálást.
A dokumentációgenerálás elindítása
- Válassza ki a kívánt fájlt a Project Viewer nézetben
- Kattintson az „Explain” gombra a dokumentációgenerálási folyamat elindításához
- Megjelenik egy folyamatjelző sáv, amely a generálási folyamat aktuális állapotát mutatja
Háttérben történő feldolgozás: A dokumentációgenerálás háttérfolyamatként fut, így elnavigálhat az oldalról vagy bezárhatja a böngészőt anélkül, hogy megszakítaná a műveletet. Később visszatérhet a folyamat állapotának ellenőrzéséhez vagy az elkészült dokumentáció megtekintéséhez.
Note: Csak azok a fájlok érhetők el dokumentációgeneráláshoz, amelyek megfelelnek a támogatott formátumok követelményeinek. A kompatibilis fájltípusok és formátumok teljes listáját az Áttekintés szakaszban találja.
Factory Agent kódösszehasonlításhoz (előzetes funkció)
Először válassza ki a fő projektlistából azt a projektet, amelynek verziói közötti különbségeket össze szeretné hasonlítani. Kattintson a kívánt projektre a részletes nézet és az elérhető dokumentációs lehetőségek megnyitásához, majd válasszon ki 2 összehasonlítandó verziót. Innen válassza a „Compare Versions” lehetőséget a verzió-összehasonlító eszköz megnyitásához.
A projektnézetben válasszon ki egy olyan elemet, amely eltéréseket mutat. Ezek az elemek jellemzően kék (módosított), zöld (hozzáadott) vagy piros (eltávolított) színnel jelennek meg – a fehér azt jelenti, hogy nincs változás. Amikor az összehasonlító nézet megjelenik, válassza az „Explain” lehetőséget abban a blokkban, amelyhez az eltérés magyarázatát szeretné látni. Az eltérés magyarázata a blokk alatt jelenik meg.
Dokumentáció részletességi szintjei
Alapértelmezés szerint a rendszer bőbeszédű dokumentációt generál, amely átfogó elemzést nyújt részletes magyarázatokkal és mélyreható tárgyalással. A felhasználók azonban átválthatnak az összefoglalt változatra, ha tömörebb áttekintést részesítenek előnyben.
- Bőbeszédű: Részletes magyarázatokat, átfogó elemzést és mélyreható tárgyalást kínál (alapértelmezett)
- Összefoglalt: A lényeges információkat és a kulcsfogalmakat tömörített formában nyújtja