Skip to content

Latest commit

 

History

History
43 lines (37 loc) · 1.59 KB

README.md

File metadata and controls

43 lines (37 loc) · 1.59 KB
Raw

opcua_doc_generator

A scripte to generate a docx documentation from a OPC UA nodeset file

Warning this script not stable the template placeholder can be changed very often

Features

  • Generate a docx Documentation from a OPC UA nodeset file
  • Customize with your own Template

Missing Features and Problems

  • Doc internal references
  • VariableType generation
  • DataType generation
  • Method generation
  • Profile generation
  • other models will not import

Dependencies

Example

A simple coffee machine OPC UA model we use in our trainings, and a simple template based on the OPC UA Companion Specification template run node main.js -n example/coffeemachine.nodeset2.xml -t example/opcua_template.docx -d example/description.xlsx

How to Customize

Copy the example doc file or start with an empty docx file. You can add the text between: {#objectType} and {/objectType} will be repeated for each ObjectType. The following placeholder can insert and will be removed with the value of the ObjectType:

  • {browsename}
  • {isAbstract}
  • {superType}
  • {superTypeSrc} (not completed) Also you can access childs of the ObjectType insert {childrows}...{/childrows}. Child has the following placeholders:
  • {browsename}
  • {nodeClass}
  • {referenceType}
  • {#datatype}{datatype}{/datatype}
  • {typedefintion}
  • {modelingsrule}