pyrtma.compile.compile

compile(defs_files, out_dir, out_name, python=False, javascript=False, matlab=False, c_lang=False, info=False, combined=False, debug=False, validate_alignment=True, auto_pad=True, import_coredefs=True)[source]

compile message defs

Parameters:

  • defs_files (List[str]) – Root YAML message defintion file to parse. List of C header file(s) will use v1 python compiler (deprecated)

  • out_name (str) – Output directory for compiled files. For v1 compiler (deprecated), full output filename.

  • python (bool) – Output python .py file. Defaults to False.

  • javascript (bool) – Output javascript .js file. Defaults to False.

  • matlab (bool) – Output matlab .m file. Defaults to False.

  • c_lang (bool) – Output C .h file. Defaults to False.

  • info (bool) – Output info .txt file. Defaults to False.

  • combined (bool) – Output combined YAML file. Defaults to False.

  • debug (bool) – Debug mode. Defaults to False.

  • validate_alignment (bool) – Validate message 64-bit alignment. Defaults to True.

  • auto_pad (bool) – Automatically pad messages failing 64-bit alignment validation. Defaults to True. Has no effect if validate_alignment is False.

  • import_coredefs (bool) – Automatically import pyrtma.core_defs. Defaults to True.

  • out_dir (str)

Raises: