Processing Jumpers and Loops, Plus Processing Wires inside the Table as Edges #369

tobiasfalk · 2024-05-30T14:31:57Z

Here I started to implement Jumpers, and a new way of drawing Wires inside the Wire table.

Currently, only the Black circles are done and nothing else.
See ex15.png
Ps. And now even the right branch

Edit:
Ex15:

Ex16:

tobiasfalk · 2024-05-30T20:37:41Z

Now everything from #350 is implemented.

tobiasfalk · 2024-05-30T20:38:19Z

Syntax:

connectors:
  X1:
    type: Molex KK 254 # more information
    subtype: female
    pinlabels: [GND, VCC, RX, TX, GND, VCC, GND] # pincount is implicit in pinout
    internal_shorts: [[1, 5, 7], [2, 6]]
    internal_shorts_color: [PK, RD]
  X2:
    type: Molex KK 254
    subtype: female
    pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
    internal_shorts: [[1, 5, 7], [2, 6]]

Changed the syntax and added options for the shorts, see ex15 for more

tobiasfalk · 2024-06-05T23:02:49Z

New Syntax:

connectors:
  X1:
    type: Molex KK 254 # more information
    subtype: female
    pinlabels: [GND, VCC, RX, TX, GND, VCC, GND] # pincount is implicit in pinout
    shorts:
      SH1:
        pins: [1, 5, 7]
        color: PK
        manufacturer: WireViz
        mpn: 42XCD42A5
        description: shortPart
      SH2:
        pins: [2, 6]
        color: RD
        manufacturer: WireViz
        mpn: 42XCD42A5
        description: shortPart
        length: 42

tobiasfalk · 2024-06-05T23:04:35Z

tobiasfalk · 2024-06-08T23:50:05Z

ex16:

kvid · 2024-06-09T09:32:12Z

I'm sorry that I've not yet had time to play with this PR, but it seems to work as proof of concept for the #350 discussions.

I suggest that you activate "convert to draft" while this is work-in-progress (I do forget that with my PRs also sometimes).
Be aware that your latest syntax expansion probably will need coordinaton with changes in Large scale refactoring #251 that is first in line for merge into dev.
The way you want to combine internal shorts and loops, might also need a discussion in Way to implement Jumpers/Interconnects #350 because I fear it will be too complicated for the simplest use cases.

tobiasfalk · 2024-06-09T10:09:24Z

I mainly have problems with the bom and how I add the shorts to the bom

kvid · 2024-06-09T10:27:47Z

I mainly have problems with the bom and how I add the shorts to the bom

Have you considered making the additional components list be a union of shorts and explicitly specified entries, instead of having a separate list for shorts? Then adding to BOM could be handled equally as well.

tobiasfalk · 2024-06-14T23:35:20Z

@kvid @martinrieder could you look at the new syntax in ex15 & 16?

martinrieder

This needs a bit of rework. Comments added.

examples/ex15.yml

martinrieder · 2024-06-15T07:23:26Z

examples/ex15.yml

+        manufacturer: WireViz
+        mpn: 42XCD42A5
+        type: shortPartA
+        qty: 42


I find qty confusing for unit mm. How about length as an alias?

Yes, but Additional Components works with qty

Yes, just leave it, as changing this is not in scope.

examples/ex16.yml

examples/ex15.tmp

martinrieder · 2024-06-15T09:01:29Z

examples/ex15.yml

+    shorts:
+      - SH1: [1, 5, 7]
+      - SH2: [2, 6]


Using a list here is fine. Does not match the syntax description though.

Syntax description is yet to be updated.

src/wireviz/Harness.py

martinrieder · 2024-06-15T09:22:25Z

src/wireviz/wv_bom.py

+                }
+            else:
+                common_args = {
+                    "qty": part.qty * component.get_qty_multiplier(part.qty_multiplier),


numShorts could be the return value of the function.

Do not completely understand what you mean

@martinrieder ?

You had the qty_multiplier choice extended for shorted, so I thought that the function get_qty_multiplier might return numShorts as an integer in that case. The meaning has changed now with references.

martinrieder · 2024-06-15T09:22:48Z

src/wireviz/wv_bom.py

+            else:
+                numShorts = len(part.shorts)
+
+            if numShorts > 0:


This could be avoided, see below.

Do not completely understand what you mean

@martinrieder ?

Sorry, the order of comments got mixed up and my statement was possibly misleading.

tutorial/tutorial01

tobiasfalk · 2024-06-15T14:05:10Z

Overall question is if the syntax is acceptable?
If so Checks and other things can be done.

martinrieder · 2024-06-15T15:35:51Z

@tobiasfalk wrote:

Overall question is if the syntax is acceptable?

I would prefer a solution that does not require using loops or shorts in two different locations. Alternatively, I suggest to use a reference key instead for both, since designators have to be unique anyways. It will also avoid the situation like in ex15 where loops and shorts got unintentionally mixed up.

Overall, I would say that this implementation is quite close to what was discussed in #224 (comment). The only difference is that reference was implied, but implementing that is a little more tricky. Still, I think that we should clarify the outcome of #224 before merging this PR.

Please also have a look at #288, which also implements some loop handling and might cause some merge issues. What I need for my daily work is having alphanumeric pin names and pinlabels matching to work also on loops. I am currently using a workaround for this.

ex15

connectors:
  X1:
    #[...] 
    pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
    shorts:
      - SH1: [1, 5, 7]  
      - SH2: [2, 6]
    additional_components:
      - reference: SH1 # discussed in #224
        color: PK
        #[...] 
        
      - reference: SH2
        color: RD
        #[...] 

  X2:
    #[...] 
    pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
    shorts:
      - SH1: [1, 5, 7] # same designator as above... 
      - SH2: [2, 6]   # does this imply the same attributes?

EDIT: Cross-referring to #224 (comment) for additional details.

… bom

martinrieder · 2024-06-18T15:10:56Z

@tobiasfalk I finally got around to test your PR on my dev machine. It fails to run gvpr due to a path issue or missing environment variable:

Error: gvwrite_no_z problem 57
gvpr: Could not find file "pin2pin.gvpr" in GVPRPATH

You may need to use an absolute path for calling this script. I tried to set the environment variable to point to the right path and also moved pin2pin.gvpr` into the same folder, but it fails to run.

tobiasfalk · 2024-06-18T15:12:41Z

@tobiasfalk I finally got around to test your PR on my dev machine. It fails to run gvpr due to a path issue or missing environment variable:
Error: gvwrite_no_z problem 57
gvpr: Could not find file "pin2pin.gvpr" in GVPRPATH
You may need to use an absolute path for calling this script. I tried to set the environment variable to point to the right path and also moved pin2pin.gvpr` into the same folder, but it fails to run.

Will look in to it

martinrieder · 2024-06-18T15:49:06Z

@tobiasfalk I fixed it by adding the line

os.environ['GVPRPATH'] = str(Path(__file__).parent)

tobiasfalk · 2024-06-18T16:16:31Z

@martinrieder to where exactly?

martinrieder · 2024-06-18T16:40:46Z

Just before the call to gvpr in the if branch with find_executable in harness.py.

tobiasfalk · 2024-06-18T21:02:00Z

@martinrieder could you test it again?

tobiasfalk · 2024-06-18T21:20:20Z

Some commits back, do not know exactly which one, I implemented #352 and it works without a problem for me

martinrieder · 2024-06-19T03:07:10Z

Then I propose you edit the description of the PR to include this and the other issues from #369 (comment) as well.

tobiasfalk · 2024-06-19T11:16:31Z

If everything is now Ok, then I would now wait for #251
Is there a Time frame for when it will be merged? Since the last update on it was in April(2 months ago)

tobiasfalk · 2024-06-19T11:17:43Z

Oh yes I need to clean up the code a bit, I know that

martinrieder · 2024-07-13T11:33:37Z

@tobiasfalk: While working on another machine I ran into a dependency issue for find_executable:

C:\Users\Martin\Git\WireViz\src\wireviz>python build_examples.py
Traceback (most recent call last):
  File "C:\Users\Martin\Git\WireViz\src\wireviz\build_examples.py", line 14, in <module>
    from wireviz import APP_NAME, __version__, wireviz
  File "C:\Users\Martin\Git\WireViz\src\wireviz\wireviz.py", line 14, in <module>
    from wireviz.Harness import Harness
  File "C:\Users\Martin\Git\WireViz\src\wireviz\Harness.py", line 12, in <module>
    from distutils.spawn import find_executable
ModuleNotFoundError: No module named 'distutils'

It was a fresh install of Python 3.12.4, see the detailed log below:

Details

C:\Users\Martin\Git\WireViz>pip install -e .
Obtaining file:///C:/Users/Martin/Git/WireViz
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Preparing editable metadata (pyproject.toml) ... done
Requirement already satisfied: click in c:\users\martin\appdata\local\programs\python\python312\lib\site-packages (from wireviz==0.5.dev0) (8.1.7)
Requirement already satisfied: pyyaml in c:\users\martin\appdata\local\programs\python\python312\lib\site-packages (from wireviz==0.5.dev0) (6.0.1)
Requirement already satisfied: pillow in c:\users\martin\appdata\local\programs\python\python312\lib\site-packages (from wireviz==0.5.dev0) (10.4.0)
Requirement already satisfied: graphviz in c:\users\martin\appdata\local\programs\python\python312\lib\site-packages (from wireviz==0.5.dev0) (0.20.3)
Requirement already satisfied: colorama in c:\users\martin\appdata\local\programs\python\python312\lib\site-packages (from click->wireviz==0.5.dev0) (0.4.6)
Building wheels for collected packages: wireviz
  Building editable for wireviz (pyproject.toml) ... done
  Created wheel for wireviz: filename=wireviz-0.5.dev0-0.editable-py3-none-any.whl size=16699 sha256=aa3cf29677b77974ad34bc45a6258d9f5487b32f06b5b91fef9c7af69ca17f22
  Stored in directory: C:\Users\Martin\AppData\Local\Temp\pip-ephem-wheel-cache-01soqxb3\wheels\9c\81\24\1a1dd1dee9702950ff7aec4857f0e0d6d2ce93b0c328529227
Successfully built wireviz
Installing collected packages: wireviz
  Attempting uninstall: wireviz
    Found existing installation: wireviz 0.4.1.dev0
    Uninstalling wireviz-0.4.1.dev0:
      Successfully uninstalled wireviz-0.4.1.dev0
Successfully installed wireviz-0.5.dev0

C:\Users\Martin\Git\WireViz>pip list
Package  Version  Editable project location
-------- -------- ---------------------------
click    8.1.7
colorama 0.4.6
graphviz 0.20.3
pillow   10.4.0
pip      24.1.2
PyYAML   6.0.1
wireviz  0.5.dev0 C:\Users\Martin\Git\WireViz

C:\Users\Martin\Git\WireViz>wireviz --version
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\Martin\AppData\Local\Programs\Python\Python312\Scripts\wireviz.exe\__main__.py", line 4, in <module>
  File "C:\Users\Martin\Git\WireViz\src\wireviz\wv_cli.py", line 12, in <module>
    import wireviz.wireviz as wv
  File "C:\Users\Martin\Git\WireViz\src\wireviz\wireviz.py", line 14, in <module>
    from wireviz.Harness import Harness
  File "C:\Users\Martin\Git\WireViz\src\wireviz\Harness.py", line 12, in <module>
    from distutils.spawn import find_executable
ModuleNotFoundError: No module named 'distutils'

During some research, I found out that distutils was deprecated in Python 3.10 already:

https://docs.python.org/3.12/whatsnew/3.12.html#distutils

Remove the distutils package. It was deprecated in Python 3.10 by PEP 632 “Deprecate distutils module”. For projects still using distutils and cannot be updated to something else, the setuptools project can be installed: it still provides distutils. (Contributed by Victor Stinner in gh-92584.)

Doing pip install setuptools fixes the issue, though it is just a workaround. Do you want to add this to requirements.txt or rather find a replacement for the function?

tobiasfalk · 2024-07-13T11:47:01Z

@martinrieder
When I have time I will find a replacement. Did the notice give a list of replacements?

martinrieder · 2024-07-13T13:22:09Z

Did the notice give a list of replacements?

https://peps.python.org/pep-0632/

For these modules or functions, use the standard library module shown:

distutils.fancy_getopt — use the argparse module

distutils.spawn.find_executable — use the shutil.which function

distutils.spawn.spawn — use the subprocess.run function

distutils.sysconfig — use the sysconfig module

distutils.util.get_platform — use the platform module

martinrieder · 2024-07-13T18:48:23Z

I realized that setuptools is already listed in requirements.txt, but not in setup.py. Not sure why they are not aligned, because I found out that this behavior has been discussed in #172 earlier.

tobiasfalk · 2024-07-13T19:57:59Z

I still want to look if there is a current way to do it since it is already depricated.

tobiasfalk · 2024-07-20T21:40:17Z

@martinrieder in #412 I have now replaced distutils.spawn.find_executable with shutil.which. Could you test it again?

tobiasfalk added 2 commits May 30, 2024 16:26

Added Dark Circles

465aefa

Added dashed lines

a015da5

tobiasfalk changed the title ~~[WIP] Jumpers, A start to implement #350~~ Jumpers, implementaition of #350 May 30, 2024

tobiasfalk added 2 commits June 1, 2024 11:09

Made line from dashed to solid bold

8c97c5d

Added Documentaion

ee5b292

amotl changed the title ~~Jumpers, implementaition of #350~~ Processing Jumpers Jun 4, 2024

Added more options for shorts

f49921b

Changed the syntax and added options for the shorts, see ex15 for more

tobiasfalk mentioned this pull request Jun 5, 2024

Way to implement Jumpers/Interconnects #350

Open

tobiasfalk added 2 commits June 8, 2024 14:17

more to added more options

02fcc68

Added type for shorts(loop or internal), see ex16

be801c3

tobiasfalk marked this pull request as draft June 9, 2024 10:00

tobiasfalk added 2 commits June 9, 2024 21:44

Added Bom entrys and removed grapgh bom

11e4611

add synrax description

cd1f489

kvid mentioned this pull request Jun 12, 2024

Improving additional component display, BOM item numbers #224

Open

Updated Syntax to make the shorts as Aditional Component

0801d7b

martinrieder reviewed Jun 15, 2024

View reviewed changes

fix multicoolr Straitening

1b90104

tobiasfalk mentioned this pull request Jun 16, 2024

Proposal for new way to draw Wires in the Wire box #352

Open

Changed AddComp shorts to references and added the designators to the…

b5aa1c2

… bom

Added some Graphviz Magic for drawing Dots at the end of straight lines

e0ae9be

tobiasfalk added 2 commits June 18, 2024 23:09

Clean up and some checks

2680a12

re run the examplse

0f5c612

tobiasfalk changed the title ~~Processing Jumpers and Loops~~ Processing Jumpers and Loops, Plus Processing Wires inside the Table as Edges Jun 18, 2024

tobiasfalk added 2 commits June 19, 2024 12:49

added a copy for the pin2pin file and a message on how to use

fa034c5

Added tutorial09 for shorts and loops

9e54d02

tobiasfalk added 3 commits June 19, 2024 16:56

Cleand up and added comends, description in the readme

e0dd2c1

changed color code of ex15, for testing of the edge inside of the table

6ba3f25

rerun examples

f0b242d

tobiasfalk mentioned this pull request Jul 7, 2024

Large scale refactoring #251

Open

5 tasks

martinrieder mentioned this pull request Jul 13, 2024

Various improvements BartBrood/Interactive-Graphviz-Diagrams#4

Merged

tobiasfalk mentioned this pull request Jul 20, 2024

[WIP]Processing Jumpers and Loops, Plus Processing Wires inside the Table as Edges based on #251 #412

Draft

This was referenced Sep 24, 2024

[discussion] Adding Inkscape as an optional post Processing step #423

Open

[feature] Adding banded multicolor wires #109

Open

Processing Jumpers and Loops, Plus Processing Wires inside the Table as Edges #369

Are you sure you want to change the base?

Processing Jumpers and Loops, Plus Processing Wires inside the Table as Edges #369

Conversation

tobiasfalk commented May 30, 2024 • edited Loading

tobiasfalk commented May 30, 2024

tobiasfalk commented May 30, 2024

tobiasfalk commented Jun 5, 2024

tobiasfalk commented Jun 5, 2024

tobiasfalk commented Jun 8, 2024

kvid commented Jun 9, 2024 • edited Loading

tobiasfalk commented Jun 9, 2024

kvid commented Jun 9, 2024

tobiasfalk commented Jun 14, 2024

martinrieder left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiasfalk Jun 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiasfalk commented Jun 15, 2024

martinrieder commented Jun 15, 2024 • edited Loading

martinrieder commented Jun 18, 2024

tobiasfalk commented Jun 18, 2024

martinrieder commented Jun 18, 2024 • edited Loading

tobiasfalk commented Jun 18, 2024

martinrieder commented Jun 18, 2024

tobiasfalk commented Jun 18, 2024

tobiasfalk commented Jun 18, 2024 • edited Loading

martinrieder commented Jun 19, 2024 • edited Loading

tobiasfalk commented Jun 19, 2024

tobiasfalk commented Jun 19, 2024

martinrieder commented Jul 13, 2024

tobiasfalk commented Jul 13, 2024

martinrieder commented Jul 13, 2024 • edited Loading

martinrieder commented Jul 13, 2024

tobiasfalk commented Jul 13, 2024

tobiasfalk commented Jul 20, 2024

tobiasfalk commented May 30, 2024 •

edited

Loading

kvid commented Jun 9, 2024 •

edited

Loading

martinrieder left a comment •

edited

Loading

tobiasfalk Jun 16, 2024 •

edited

Loading

martinrieder commented Jun 15, 2024 •

edited

Loading

martinrieder commented Jun 18, 2024 •

edited

Loading

tobiasfalk commented Jun 18, 2024 •

edited

Loading

martinrieder commented Jun 19, 2024 •

edited

Loading

martinrieder commented Jul 13, 2024 •

edited

Loading