Few questions about IPC API eeschema api development

[박범석]

Hi, all

I recently joined the KiCad developer forum to work on IPC API development. Before writing any code, I'd like to check a few things about the current progress.

1. As mentioned in this post [https://gitlab.com/kicad/code/kicad/-/issues/2077#note_2265266555], I understand the goal is to replace the functionality currently provided by SWIG bindings with IPC API. I know work is progressing on the pcbnew API, but is there anyone currently working on the eeschema API, or are there any ongoing efforts in this area?
2. If not, I'm thinking I'll need to refer to the api_handler in kicad_source_code/eeschema and create proto files along with schematic.py, schematic_types.py, etc. in kipy. However, with recent changes to eeschema [https://gitlab.com/kicad/code/kicad/-/commit/718bf408070198012b1a95ddfe2c84d2f9fe6b78], it seems difficult to proceed without knowing the plan for future eeschema functionality. What's the roadmap for eeschema changes? If there's any documentation I should refer to, please let me know.

Thanks in advance for your help!

[Ethan Chien]

You can refer to the pro-api-sdk of jlceda:

https://www.npmjs.com/package/@jlceda/pro-api-types

https://gitee.com/jlceda/pro-api-sdk

--
You received this message because you are subscribed to the Google Groups "KiCad Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to devlist+u...@kicad.org.
To view this discussion visit https://groups.google.com/a/kicad.org/d/msgid/devlist/6b3068ac-7d4a-4da0-b00e-83154b1dde9fn%40kicad.org.

[Ethan Chien]

I'm also working on the IPC API for placing design blocks and symbols, any ideas are welcome

[Anthony Park]

Thanks for your reply. I'll check the source code first and post any ideas I have.

2025년 5월 12일 월요일 오후 4시 11분 36초 UTC+9에 liangt...@gmail.com님이 작성:

[Jon Evans]

The schematic editor is less stable in terms of internals and there are some important changes happening with regards to sheet storage. I had not started on the schematic API because we should not release any API until we can consider it stable to support, and it is harder to chase a moving target.

It would be fine if you wanted to work on it but the caveat is that I don't think it should be merged if any of the parts that you expose are potentially going to change in incompatible ways. So, I suggest starting small (for example, creating/updating any object types other than symbols). Please tag me for review of any proposed protobuf changes.

There is no documentation other than what is already at dev-docs.kicad.org so please reach out if you are unsure about something.

Thanks,
Jon

To view this discussion visit https://groups.google.com/a/kicad.org/d/msgid/devlist/8d745d44-a88c-48df-9f8c-624e5f94e1b0n%40kicad.org.

[Anthony Park]

Thank you for your reply. 

I'll start by understanding the basics of the Eeschema API and then begin working on small implementations.

2025년 5월 12일 월요일 오후 9시 56분 58초 UTC+9에 j...@craftyjon.com님이 작성:

[Ethan Chien]

How about implementing a set shortcut APIs that can place a sheet or an entire symbol through an URL without exposing the details of the symbol or sheet which is intended to save users the steps of downloading, copying and pasting.

[Jon Evans]

To clarify, it sounds like Ethan is taking on some of the API definitions that will be necessary for implementing placement of symbols through API plugins, so Anthony it is probably a good idea for you to work in another area to avoid duplicating effort.  There are a number of not-yet-implemented objects on the PCB side (groups, for example) that would maybe be a better starting point if you're interested in contributing to the API.

-Jon

To view this discussion visit https://groups.google.com/a/kicad.org/d/msgid/devlist/CAJgxgPb_5p_s0bVkGHbWPBArjJFk2zZCZD01YP4ptm22wkbSCg%40mail.gmail.com.

[박범석]

Ok i got it. I understand. I'll implement the PCB side instead of the schematic.

2025년 5월 13일 (화) 오전 3:04, Jon Evans <j...@craftyjon.com>님이 작성:

To view this discussion visit https://groups.google.com/a/kicad.org/d/msgid/devlist/CA%2BqGbCDGzk6sqmdrspOuDQDoN7DhZXVOkKujQ40B1cWZTMpxvg%40mail.gmail.com.