Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FEATURE] Export KiCanvas with schematic like Interative BOM #572

Closed
andersruneson opened this issue Jan 26, 2024 · 8 comments
Closed

[FEATURE] Export KiCanvas with schematic like Interative BOM #572

andersruneson opened this issue Jan 26, 2024 · 8 comments
Assignees
@set-soft
Labels
enhancement New feature or request

Comments

@andersruneson
Copy link

Is your feature request related to a problem? Please describe.
Well, when exporting gerbers, schematics etc with KiBot it would be nice to also get a stand-alone KiCanvas schematic (https://kicanvas.org/home/) just like the interactive BOM. I'm not sure KiCanvas can be packaged like that so I might need to suggest this to KiCanvas first.

Describe the solution you'd like
Add an output, kicanvas, where the schematic will be distributed with KiCanvas runtime, maybe the files need to be put in a folder, and then a .html-file that opens the KiCanvas in the local browser.

Describe alternatives you've considered
Ah, we can use the schematic pdf, but KiCanvas gives more features of course.

Additional context
image
@andersruneson andersruneson added the enhancement New feature or request label Jan 26, 2024
@set-soft
Copy link
Member

Interesting! the script is self contained, it has some issues, but looks really promising

set-soft added a commit that referenced this issue Jan 26, 2024
@set-soft
[KiCanvas][Added] Some very raw support
de1fc05 
Closes #572
@set-soft
Copy link
Member

Hi @andersruneson !

Ok, I added some basic support. Some stuff isn't really working (quick-start example and Makefile use are broken). For testing I'm using:

# Example KiBot config file
kibot:
  version: 1

outputs:
  - name: 'KiCanvas'
    comment: "Example of KiCanvas export"
    type: kicanvas
    dir: KiCanvas
    options:
      source: ['schematic', 'pcb', 'project']
      overlay: false
      # local_script: false
      # source: ['schematic', 'pcb', 'project', 'pp']
      # source: pp

@andersruneson
Copy link
Author

Wow fast, I'll have a try! Thanks.

@bluespider42
Copy link

Thanks for this - seems to be working well. Only thing missing for me is that only the top level schematic is loaded.

@andersruneson
Copy link
Author

andersruneson commented Jan 30, 2024 •
edited
Loading

Hm, I get the following output:

- 'Example of KiCanvas export' (KiCanvas) [kicanvas]
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/EA00189-kicanvas.html (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/kicanvas.js (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/y.lib (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/n.lib (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/sym-lib-table (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/EA00189.kicad_sch (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/out/KiCanvas/EA00189.kicad_pcb (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/EA00189.kicad_pro (kibot - out_kicanvas.py:98)
ERROR:/builds/Parts/EA/EA00189/source/EA00189.kicad_prl (kibot - out_kicanvas.py:98)

From this config:

# Example KiBot config file
kibot:
  version: 1

outputs:
  - name: 'KiCanvas'
    comment: "Example of KiCanvas export"
    type: kicanvas
    dir: KiCanvas
    options:
      source: ['schematic', 'pcb', 'project']
      overlay: false
      # local_script: false
      # source: ['schematic', 'pcb', 'project', 'pp']
      # source: pp

The generated html-file renders completely empty in chome, but has the following content which looks decent:

<!DOCTYPE HTML>
<html lang="en">
  <body>
    <script type="module" src="kicanvas.js"></script>
    <kicanvas-embed controls="full" controlslist="nooverlay">
      <kicanvas-source src="EA00189.kicad_sch"></kicanvas-source>
      <kicanvas-source src="EA00189.kicad_pcb"></kicanvas-source>
      <kicanvas-source src="EA00189.kicad_pro"></kicanvas-source>
    </kicanvas-embed>
  </body>
</html>

set-soft added a commit that referenced this issue Jan 30, 2024
@set-soft
[KiCanvas] Multiple sheets fix
6315728 
Sort of ... looks like you must explicitly list the sub-sheets, but it has
various drawbacks, look here: theacodes/kicanvas#77

Should fix the issue mentioned by @bluespider42 in #572
@set-soft
Copy link
Member

Hm, I get the following output:

This is just for debug, I was fixing the targets and wanted to list them in a very visible way. Now they are fixed.

From this config:

# Example KiBot config file
kibot:
  version: 1

outputs:
  - name: 'KiCanvas'
    comment: "Example of KiCanvas export"
    type: kicanvas
    dir: KiCanvas
    options:
      source: ['schematic', 'pcb', 'project']
      overlay: false
      # local_script: false
      # source: ['schematic', 'pcb', 'project', 'pp']
      # source: pp

Try excluding the project, it doesn't work as expected.

The generated html-file renders completely empty in chome, but has the following content which looks decent:

<!DOCTYPE HTML>
<html lang="en">
  <body>
    <script type="module" src="kicanvas.js"></script>
    <kicanvas-embed controls="full" controlslist="nooverlay">
      <kicanvas-source src="EA00189.kicad_sch"></kicanvas-source>
      <kicanvas-source src="EA00189.kicad_pcb"></kicanvas-source>
      <kicanvas-source src="EA00189.kicad_pro"></kicanvas-source>
    </kicanvas-embed>
  </body>
</html>

Which browser are you using? For chrome you need something like:

google-chrome --allow-file-access-from-files HTML_FILE

Don't know about other browsers. This is because the Java Script is loading files from the local filesystem using a mechanism that is for the network. This cross reference is forbidden.

The last patch solves some problems with sub-sheets, but KiCanvas needs a lot of adjusts on this side. I added an issue to discuss it: theacodes/kicanvas#77

@set-soft
Copy link
Member

Don't know about other browsers. This is because the Java Script is loading files from the local filesystem using a mechanism that is for the network. This cross reference is forbidden.

I added a Java Script check to inform this problem. And also suggested upstream to add such a check (theacodes/kicanvas#78)

I'm closing this issue, bugs in the KiCanvas output should go to new issues.

@andersruneson
Copy link
Author

It works, well done! Hope kicanvas fixes the issues you reported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@set-soft set-soft

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@andersruneson @bluespider42 @set-soft