Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 9.88 KB

CHANGELOG.md

File metadata and controls

115 lines (79 loc) · 9.88 KB
Raw

Change Log

0.4 (2024-05-12)

Backward-incompatible changes

  • New syntax for autogenerated components (#184, #186)
    • Components that are not referenced in any connection set will not be rendered. Instead, a warning will be output in the console. (#328, #332)
  • New command line interface (#244). Run wireviz --help for details
    • The path specified with the -o/--output-dir option no longer includes the filename (without extension) of the generated files. Use the -O/--output-name option to specify a different filename for the generated files.
  • The .gv file is no longer included as a default output format (only as an intermediate file during processing) unless specified with the new -f option described below.

New features

  • Allow mates between connectors (#134, #186)
  • Improve technical drawing output (#74, #32, #239)
  • Embed images in SVG output (#189)
  • Add ability to choose output formats using the -f/--format command line option (#60)
  • Add option to multiply additional component quantity by number of unpopulated positions on connector (#298)

Misc. fixes

  • Use isort and black for cleaner code and easier merging (#248)
  • Code improvements (#246, #250)
  • Bug fixes (#264, #318)
  • Minor adjustments (#256)

0.3.2 (2021-11-27)

Hotfix

  • Adjust GraphViz generation code for compatibility with v0.18 of the graphviz Python package (#258, #261)

0.3.1 (2021-10-25)

Hotfix

  • Assign generic harness title when using WireViz as a module and not specifying an output file name (#253, #254)

0.3 (2021-10-11)

New features

  • Allow referencing a cable's/bundle's wires by color or by label (#70, #169, #193, #194)
  • Allow additional BOM items within components (#50, #115)
  • Add support for length units in cables and wires (#7, #196 (with work from #161, #162, #171), #198, #205. #206)
  • Add option to define connector pin colors (#53, #141)
  • Remove HTML links from the input attributes (#164)
  • Add harness metadata section (#158, #214)
  • Add support for supplier and supplier part number information (#240, #241)
  • Add graph rendering options (background colors, fontname, color name display style, ...) (#158, #214)
  • Add support for background colors for cables and connectors, as well as for some individual cells (#210, #219)
  • Add optional tweaking of the .gv output (#215) (experimental)

Misc. fixes

  • Remove case-sensitivity issues with pin names and labels (#160, #229)
  • Improve type hinting (#156, #163)
  • Move BOM management and HTML functions to separate modules (#151, #192)
  • Simplify BOM code (#197)
  • Bug fixes (#218, #221)

Known issues

  • Including images in the harness may lead to issues in the following cases: (#189, #220)
    • When using the -o/--output_file CLI option, specifying an output path in a different directory from the input file
    • When using the --prepend-file CLI option, specifying a prepend file in a different directory from the mail input file

0.2 (2020-10-17)

Backward incompatible changes

  • Change names of connector attributes (#77, #105)
    • pinnumbers is now pins
    • pinout is now pinlabels
  • Remove ferrules as a separate connector type (#78, #102)
    • Simple connectors like ferrules are now defined using the style: simple attribute
  • Change the way loops are defined (#79, #75)
    • Wires looping between two pins of the same connector are now handled via the connector's loops attribute.

See the syntax description for details.

New features

  • Add bidirectional AWG/mm2 conversion (#40, #41)
  • Add support for part numbers (#11, #114, #121)
  • Add support for multicolored wires (#12, #17, #96, #131, #132)
  • Add support for images (#27, #153)
  • Add ability to export data directly to other programs (#55)
  • Add support for line breaks in various fields (#49, #64)
  • Allow using connector pin names to define connections (#72, #139, #140)
  • Make defining connection sets easier and more flexible (#67, #75)
  • Add new command line options (#167, #173)
  • Add new features to build_examples.py (#118)
  • Add new colors (#103, #113, #144, #145)
  • Improve documentation (#107, #111)

Misc. fixes

  • Improve BOM generation
  • Add various input sanity checks
  • Improve HTML output (#66, #136, #95, #177)
  • Fix node rendering bug (#69, #104)
  • Improve shield rendering (#125, #126)
  • Add GitHub Linguist overrides (#146, #154)

0.1 (2020-06-29)

  • Initial release