KiCad 9.0 Python API (IPC API)

Software
102

Ah, I seeā€¦
I enabled the trace output for the API subsystem. The strange thing is that after I did that the plugin icon was loaded. :confused: But I found a few issues and it still works after removing the environment variables again.
Thank you!

103

So, I am just trying to create the schematic and layout using Skidl but it is not working for creating schematic so now I get to know about this API. So any one please tell me that this API can be used for the above thing I mentioned.

104

@devbisme is the developer and contributor here.

105

There is no API for schematics yet, new API (and old one) is pcb only for now.

106

image
image1129Ɨ760 56.4 KB

The program freezes here

108

Thanks for the clarification qu1ck

109

Just wanted to make sure that my thank you post (Thank you. Thank you. Thank you) also reaches you directly :slight_smile:

110

Since I donā€™t get much / any traction on my other posts and I really struggle with the documentation of the API, Iā€™ll try to revive this post, maybe I can get more feedback here.

Posts I made that were left mostly unanswered:

  1. IPC Plugin debug prints
  2. IPC-Plugins: Visiblity-Flag for text

Currently Iā€™m struggling with the creation of a pad (that I use as a fake-via in a footprint). I got so far that I now have a plated hole, but I donā€™t understand how I create the annular ring / the pad itself. Currently Iā€™ve got this:

fake_via = Pad()
fake_via.number = ""
fake_via.position = Vector2.from_xy_mm(10, 10)
fake_via.padstack.unconnected_layer_removal = True
fake_via.padstack.drill.diameter = Vector2.from_xy_mm(0.3, 0.3)

This seems to be the attribute Iā€™m looking for. However, I have to set this per layer, which seems strange to me, because the UI in KiCad lets me set this as a ā€œglobalā€ setting:

image
image957Ɨ566 28.4 KB

111

okay, slight progress, but I think I ran into a bug. I can set the pad diameter this way:

for layer in fake_via.padstack.copper_layers:
	layer.size = Vector2.from_xy_mm(1, 1)

However, the created pad looks like this:

image
image1099Ɨ739 29.2 KB

Note that the ā€œPad Propertiesā€ dialog shows how I expect it to look, but it does look different on the board. Toggling a setting like ā€œF.Maskā€ and then pressing OK fixes it on the board without changing anything. This seems like a bug that prevents the update of the pad.

@craftyjon Sorry for the ping, but it seems like no one is answering any of my posts about the API and I think you should be aware of this feedback. Especially since I think I ran into a second bug. Both of them could be related though, both of them look like as if some update has to be triggered in KiCad.

Edit: Iā€™ve update to v9.0.2 and the behavior is unchanged.

Editt 2: I should also mention that I ran into issues every now and again if I have more than one KiCad instance open.

image
image1231Ɨ320 19.6 KB

Trying to open a UI created with the IPC API from within KiCad creates this error:

image
image1644Ɨ294 17 KB

This does not cause any problems when using the old SWIG bindings. Maybe it is an issue with my code, but the same code works with the old bindings.

112

Bugs should be reported on GitLab, please. Forum posts are not a place to report problems with the API, your issues will be lost.

113

My last report on GitLab regarding design rules was mostly ignored in the last three weeks, so I wanted to make sure it is an issue with the API and not my understanding of the API. Especially since Iā€™m not sure if I should report that Iā€™m unable to create pads - this could be entirely on my code, hence I asked for help.

But if you prefer, I can create a few issues.

114

I am currently unavailable to investigate bugs or give help, sorry. Maybe someone else will step in, otherwise please be patient. Issues are the best way to make sure that when I am available later on, things arenā€™t totally lost.

1 Like
115

FYI, when padstack mode is simple, only the first (F_Cu) layer is used. Likewise when padstack is front/inner/back, only F_Cu, In1_Cu, and B_Cu are used.

1 Like
116

ahh, that is good to know. That probably already resolves one of the issues I just created. I know you guys have lots of things to do, so I donā€™t blame you, but the documentation on the API is really bad. It is more helpful to look through the code than to actually take a look at the documentation.

117

I created a few issues :smiley:

118

You are welcome to submit changes that improve it. Using the API is expected to require looking through the code, though, at least in the near term. There has intentionally not been any effort put into documenting it to the level where people would be expected to get things done without ever looking at the code

The documentation also is never going to cover everything about how KiCad works, e.g. what is a padstack etc. The user is assumed to be knowledgeable about that.

1 Like
119

Makes sense! I was just confused about the basically empty doc page.

I probably donā€™t have time next to work and trying to get this to work. But Iā€™ll keep it in mind. For now I know too little to write any meaningful documentation

120

I am currently a developer working on kicad mcp. Iā€™m trying to use the official IPC API rather than the swig API which will be deprecated, but Iā€™ve found that the API for eeschema has not yet been developed.

Could you tell me when schematic related functions might be added? Or if I want to write or contribute related code, who should I talk to? Is there someone in charge of this area?

121

I donā€™t think there are concrete plans to when schematic api will be added. All Iā€™ve heard is ā€œpcb first, other parts of kicad laterā€ and pcb part is somewhat raw right now so it may be in v10, but most likely v11+.

Reach out to kicad devs on their mailing list if you want to help, they will provide guidance.

3 Likes
122

Thank you for checking. Iā€™ll join the mailing list.

1 Like