Documentation

Practical guides for getting an audit out the door.

Audit rules

R001portability

Naming convention

R002safety

I/O address duplicate

R003safety

Safety circuit missing

R005structural

Unmapped tag reference

R007doc-quality

Tag without description

R010safetyRockwell

Latch without unlatch

R013safetyRockwell

E-stop redundancy missing

R014structural

Unreferenced tag

R022structural

Inconsistent alias declaration

R036structural

Cyclic routine call

R044safetyRockwell

OTL + OTU same rung

R068maintainabilityRockwell

Magic-number comparison (decimal)

R082maintainabilitySiemens

Magic-number literal (hex)

R083maintainabilitySiemens

Magic-number literal (binary)

R084portabilitySiemens

Compound assignment (TIA V14+)

R092safetySiemens · Mitsubishi

Zero-duration TIME literal

R093doc-qualityRockwell

Routine without description

PLC vendor support

Rockwell Studio 5000

stable

.L5X v20 – v36

Siemens TIA Portal (text)

stable

.scl / .awl / .udt

Siemens TIA Portal (binary)

preview

.ap14 – .ap18 (SQLite, partial decode)

Mitsubishi GX Works3 (text)

stable

IEC ST (.st)

Mitsubishi GX Works3 (binary)

stable

.gx3 / .gxw / .gxws (PROGRAM body + VAR_GLOBAL tags + CpuType, ladder routines binary)

LS XG5000 (.xgwx workspace)

stable

.xgwx (controller metadata + Symbols tag table, LDRoutine body binary)

LS XG5000 (legacy binary)

preview

.prj / .xgp (text-island probing, partial decode)

Quickstart

1. Sign up — workspace is auto-provisioned via Clerk webhook.

2. Add your Gemini API key under Settings → Keys.

3. Upload your PLC project export (.L5X, .scl / .awl / .udt, .ap14 – .ap18, .st, .gx3, .prj). The audit runs asynchronously; the report appears when ready.

4. Review findings with AI-augmented explanations and remediation suggestions.

API reference

Detailed docs in preparation. Until then, read the source — every rule has a short rationale comment at the top.