Welcome to pytmc’s documentation!

Pytmc helps developers automatically generate ADS based Epics records files from Beckhoff’s TwinCAT3 projects.

Pytmc is developed with these guidelines in mind.

The source code is hosted on github.

Issues and requests can be posted on the github issue tracker. Use the bug tag for issues with intended features and the enhancement tag can be used for feature requests. The question tag will be treated like an ‘enhancements’ tag for the documentation but regular questions can be posted there as well.

Contents:

• User Guide
  • Getting Started
    • General Usage
    • Marking the TwinCAT project
    • Python Usage
    • Full IOC Creation
  • Installation
    • Obtaining the code
    • Installing in an environment
    • Testing the installation
    • Installing for development
  • Annotating a TwinCAT3 project
    • Data and Record Types
    • Pragma syntax
    • Declaring top level variables
    • Declaring encapsulated variables
    • Declaring bidirectional PVs
    • Arrays
    • Pragma fields
      • pv
      • io
      • Update rate
      • Scale and Offset
      • Archiver settings
      • Record fields
      • SCAN
      • Autosave
      • Sub-Items
  • Command-line Usage
    • Using pytmc
    • pytmc db
      • Positional Arguments
      • Named Arguments
    • pytmc stcmd
      • Positional Arguments
      • Named Arguments
    • pytmc xmltranslate
      • Positional Arguments
      • Named Arguments
    • pytmc debug
      • Positional Arguments
      • Named Arguments
    • pytmc pragmalint
      • Positional Arguments
      • Named Arguments
    • pytmc stcmd
      • Positional Arguments
      • Named Arguments
    • pytmc summary
      • Positional Arguments
      • Named Arguments
    • pytmc template
      • Positional Arguments
      • Named Arguments
    • pytmc types
      • Positional Arguments
  • Templates
    • stcmd_default.cmd
    • asyn_standard_file.jinja2
    • asyn_standard_record.jinja2
• API Documentation
  • pytmc.pragmas
    • SingularChain
      • SingularChain.item_to_config
      • SingularChain.chain
      • SingularChain.tcname
      • SingularChain.pvname
      • SingularChain.last
      • SingularChain.data_type
      • SingularChain.config
    • chains_from_symbol()
    • dictify_config()
    • expand_configurations_from_chain()
    • find_pytmc_symbols()
    • get_array_suffix()
    • get_pragma()
    • has_pragma()
    • make_fake_symbol_from_data_type()
    • normalize_config()
    • normalize_io()
    • parse_archive_settings()
    • parse_array_settings()
    • parse_update_rate()
    • record_packages_from_symbol()
    • separate_configs_by_pv()
    • split_field()
    • split_pytmc_pragma()
    • squash_configs()
  • pytmc.record
    • BinaryRecordPackage
    • EPICSRecord
      • EPICSRecord.render()
      • EPICSRecord.update_autosave_from_pragma()
      • EPICSRecord.update_pini_for_autosave()
    • EnumRecordPackage
    • FloatRecordPackage
      • FloatRecordPackage.generate_input_record()
      • FloatRecordPackage.generate_output_record()
      • FloatRecordPackage.get_scale_offset()
    • IntegerRecordPackage
    • RecordPackage
      • RecordPackage.from_chain()
      • RecordPackage.records
      • RecordPackage.render()
      • RecordPackage.valid
    • StringRecordPackage
      • StringRecordPackage.generate_input_record()
      • StringRecordPackage.generate_link_record()
      • StringRecordPackage.generate_output_record()
      • StringRecordPackage.nelm
      • StringRecordPackage.records
    • TwincatTypeRecordPackage
      • TwincatTypeRecordPackage.asyn_input_port_spec
      • TwincatTypeRecordPackage.asyn_output_port_spec
      • TwincatTypeRecordPackage.asyn_update_options
      • TwincatTypeRecordPackage.generate_input_record()
      • TwincatTypeRecordPackage.generate_output_record()
      • TwincatTypeRecordPackage.io_direction
      • TwincatTypeRecordPackage.records
    • WaveformRecordPackage
      • WaveformRecordPackage.dtyp
      • WaveformRecordPackage.ftvl
      • WaveformRecordPackage.generate_input_record()
      • WaveformRecordPackage.generate_output_record()
      • WaveformRecordPackage.nelm
    • generate_archive_settings()
    • make_autosave_defaults()
    • sort_fields()
  • pytmc.parser
    • Action
    • ArrayInfo
      • ArrayInfo.level
      • ArrayInfo.post_init()
    • Axis
    • AxisPara
    • BaseType
    • BitOffs
    • BitSize
    • BoundDataType
    • Box
    • BuiltinDataType
    • Compile
    • DUT
      • DUT.declaration
      • DUT.get_source_code()
    • DataArea
    • DataType
      • DataType.guid
    • DataTypes
      • DataTypes.post_init()
    • Declaration
    • DefaultResolution
    • Device
    • EncPara
    • Encoder
    • Entry
      • Entry.comment
      • Entry.entry_type
    • EnumInfo
    • EnumerationTextList
      • EnumerationTextList.declaration
      • EnumerationTextList.get_source_code()
    • EtherCAT
    • ExtendsType
      • ExtendsType.guid
      • ExtendsType.namespace
      • ExtendsType.type_name
    • GVL
      • GVL.declaration
      • GVL.get_source_code()
    • Get
    • Implementation
      • Implementation.ST
    • Instance
      • Instance.task_pous
    • Io
    • LibraryReference
    • Link
      • Link.post_init()
    • Method
    • Module
      • Module.ads_port
    • NC
      • NC.post_init()
    • Name
    • Namespace
    • OwnerA
    • OwnerB
    • POU
      • POU.actions
      • POU.call_blocks
      • POU.declaration
      • POU.get_source_code()
      • POU.implementation
      • POU.methods
      • POU.program_name
      • POU.properties
      • POU.variables
    • Pdo
    • PlaceholderReference
    • PlaceholderResolution
    • Plc
      • Plc.ams_id
      • Plc.find()
      • Plc.get_source_code()
      • Plc.port
      • Plc.post_init()
      • Plc.target_ip
    • PlcProject
    • Property
      • Property.key
      • Property.value
    • RemoteConnections
      • RemoteConnections.post_init()
    • Resolution
    • ST
    • Safety
    • SafetyPlc
    • Set
    • SubItem
      • SubItem.bit_offset
      • SubItem.bit_size
      • SubItem.qualified_type_name
      • SubItem.type
    • Symbol
      • Symbol.base_type
      • Symbol.module
      • Symbol.qualified_type_name
      • Symbol.type_name
    • Symbol_DUT_MotionStage
    • Symbol_ST_MotionStage
      • Symbol_ST_MotionStage.motor_name
      • Symbol_ST_MotionStage.nc_axis
      • Symbol_ST_MotionStage.nc_to_plc_link
      • Symbol_ST_MotionStage.program_name
    • System
    • T_MaxString
    • Task
      • Task.array_index
      • Task.priority
    • Tasks
      • Tasks.post_init()
      • Tasks.priority_to_task
    • TcModuleClass
      • TcModuleClass.create_data_area()
    • TcSmItem
    • TcSmProject
      • TcSmProject.plcs
      • TcSmProject.plcs_by_link_name
      • TcSmProject.plcs_by_name
      • TcSmProject.post_init()
    • TopLevelPlc
      • TopLevelPlc.post_init()
    • TopLevelProject
      • TopLevelProject.ams_id
      • TopLevelProject.target_ip
      • TopLevelProject.tasks
      • TopLevelProject.top_level_plc
    • Type
      • Type.guid
      • Type.qualified_type
      • Type.qualified_type_name
      • Type.type_name
    • case_insensitive_path()
    • element_to_class_name()
    • get_data_type_by_reference()
    • parse()
    • projects_from_solution()
    • separate_by_classname()
    • strip_namespace()
  • pytmc.linter
    • DbdFile
      • DbdFile.filename
      • DbdFile.parsed
    • LinterResults
      • LinterResults.errors
      • LinterResults.warnings
      • LinterResults.success
    • lint_db()
• Release History
  • v2.16.0 (2023-07-31)
    • Changes
    • Maintenance
  • v2.15.1 (2023-06-30)
    • Bugfixes
    • Maintenance
  • v2.15.0 (2023-04-04)
    • Maintenance
  • v2.14.1 (2022-09-28)
    • Maintenance
  • v2.14.0 (2022-08-29)
    • Fixes
    • Enhancements
  • v2.13.0 (2022-06-30)
    • Enhancements
  • v2.12.0 (2022-05-27)
    • Fixes
    • Maintenance
  • v2.11.1 (2022-03-24)
    • Maintenance
  • v2.11.0 (2021-11-15)
    • Enhancements
    • Fixes
    • Maintenance
  • v2.10.0 (2021-08-09)
    • Enhancements
  • v2.9.1 (2021-04-27)
    • Enhancements
    • Maintenance
  • v2.9.0 (2021-04-02)
    • Enhancements
  • v2.8.1 (2021-02-10)
    • Fixes
    • Maintenance
  • v2.8.0 (2020-12-22)
    • Enhancements
    • Fixes
  • v2.7.7 (2020-11-17)
    • Fixes
    • Maintenance
  • v2.7.6 (2020-10-23)
    • Fixes
    • Maintenance
  • v2.7.5 (2020-08-31)
    • Fixes
    • Development
  • v2.7.1 (2020-08-18)
    • Fixes
    • Development
  • v2.7.0 (2020-07-16)
  • v2.6.9 (2020-07-06)
  • v2.6.8 (2020-07-06)
  • v2.6.7 (2020-07-02)
  • v2.6.6 (2020-06-24)
  • v2.6.5 (2020-06-09)
  • v2.6.0 (2020-02-26)
  • v2.5.0 (2019-12-20)
    • Features
    • Fixes
  • v2.4.0 (2019-12-06)
    • Features
    • Enhancements
    • Fixes
    • Pull requests incorporated
  • v2.3.1 (2019-11-08)
    • Fixes
    • Refactors
  • v2.3.0 (2019-10-28)
    • PRs
    • Features
    • Fixes
  • v2.2.0 (2019-09-20)
    • Enhancements
    • Fixes
  • v2.1.0 (2019-09-05)
  • v1.1.2 (2019-03-15)
    • Features
  • v1.1.1 (2019-02-14)
  • v1.1.0 (2018-10-16)
  • v1.0.0 (2018-09-24)
  • v0.1 (2018-03-02)