Краткое руководство по началу работы с Altium Designer SDK

Краткий обзор

Создайте своё первое расширение для Altium Designer с помощью этого пошагового руководства по SDK. Пройдите весь путь от настройки инструментов разработки и создания проекта C# до добавления и запуска команды, которая отображает имена цепей схемы или проекта. Вы также узнаете о шаблоне для командной строки с поддержкой горячей перезагрузки. Читайте дальше, чтобы сделать первые шаги в расширении возможностей Altium Designer.

- Ознакомьтесь с предварительными требованиями и этапами настройки среды для разработки расширений с помощью SDK.
- Узнайте, как реализовать, зарегистрировать и запустить команду «Показать цепи» в Altium Designer.
- Найдите шаблон для командной строки и справочные материалы для разработки следующего расширения.
Узнайте больше с ИИ:

Altium Designer SDK сейчас находится на этапе закрытого бета-тестирования и доступен только нескольким выбранным клиентам в рамках программы раннего доступа.

Altium Designer SDK позволяет создавать собственные расширения, которые интегрируются непосредственно в Altium Designer: добавлять команды, автоматизировать рабочие процессы и получать доступ к данным проекта через управляемый API .NET.

В этом руководстве описаны установка инструментов разработки, создание проекта расширения, добавление команды и её запуск в Altium Designer.

Prefer the command line? Шаблон Altium Designer Extension Template создаёт полноценное расширение на C# с одной командой без использования встроенного мастера или Visual Studio. hot-reloads your code while Altium Designer keeps running.

dotnet new install Altium.Designer.Extension.Templates
dotnet new ad-extension -n MyTools --altium-system-dir "C:\Program Files\Altium\AD26\System"

Для него требуются Altium Designer 24 или более поздней версии и .NET SDK 8 или более поздней версии (.NET SDK 10 для Altium Designer 26.12 и более поздних версий). Приведённый ниже в Step 3 код команды работает так же и в проекте, созданном на основе шаблона.

Предварительные требования

  • Регистрация в Altium Developer Center — необходима для получения доступа к Altium Designer SDK и его расширениям

  • Altium Designer — установленный и с активной лицензией

  • Совместимая с .NET среда разработки (Visual Studio или VS Code с поддержкой C#)

Шаг 1. Установите расширение Altium Developer

Расширение Altium Developer добавляет шаблоны проектов и инструменты SDK непосредственно в Altium Designer.

  1. В Altium Designer перейдите в Extensions and Updates → Available.

  2. В разделе Software Extensions найдите Altium Developer.

  3. Установите расширение, затем перезапустите Altium Designer, когда появится соответствующий запрос.

Шаг 2. Создайте новый проект расширения

  1. В Altium Designer перейдите в File → New → Other → Extension.

    • Extension ID: ShowNetsExtension

    • Extension Kind: Altium Designer Server

    • Development Language: C#

    • IDE Version: latest

    • SDK Version: latest

  2. После создания расширения Altium Designer отобразит сведения о нём. Обратите внимание на Source Location — откройте файл .csproj по этому пути в своей среде разработки.

Шаг 3. Добавьте первую команду

Откройте Source Code\Commands.cs и добавьте следующие методы в класс Commands:

    /// <summary>
    /// Determines the enabled/visible state for the "Show Nets" command in Altium Designer.
    /// </summary>
    /// <param name="argContext">The current server document view context.</param>
    /// <param name="argParameters">Command parameters (unused).</param>
    /// <param name="argEnabled">Set to true if the command should be enabled.</param>
    /// <param name="argChecked">Set to true if the command should appear checked (unused).</param>
    /// <param name="argVisible">Set to true if the command should be visible (unused).</param>
    /// <param name="argCaption">Command caption (unused).</param>
    /// <param name="argImageFile">Command image file (unused).</param>
    public static void GetState_ShowNets(IServerDocumentView argContext, ref string argParameters, ref bool argEnabled,
        ref bool argChecked, ref bool argVisible, ref string argCaption, ref string argImageFile)
    {
        // Retrieve the currently focused project from Altium Designer's workspace.
        var project = DXP.GlobalVars.DXPWorkSpace.DM_FocusedProject() as IProject;

        // If the project needs to be compiled (e.g., netlist out of date), compile it.
        if (project?.DM_NeedsCompile() == true)
            project.DM_Compile();

        // Enable the command only if a valid project is focused and it's not the "Free Documents" project.
        argEnabled = project != null && !IsFreeDocumentsProject(project);
    }

    /// <summary>
    /// Command handler to display all net names in the current schematic document or project.
    /// </summary>
    /// <param name="view">The current server document view.</param>
    /// <param name="parameters">Command parameters (unused).</param>
    public static void Command_ShowNets(IServerDocumentView view, ref string parameters)
    {
        // Get the currently focused project from Altium Designer.
        var project = DXP.GlobalVars.DXPWorkSpace.DM_FocusedProject() as IProject;
        if (project == null || IsFreeDocumentsProject(project))
            return;

        string documentName;
        // Get the currently focused document (e.g., schematic sheet).
        var document = DXP.GlobalVars.DXPWorkSpace.DM_FocusedDocument() as IDocument;
        if (document == null)
        {
            // If no document is focused, ensure the project is compiled and use the flattened project document.
            if (project.DM_NeedsCompile()) project.DM_Compile();
            document = project.DM_DocumentFlattened();
            documentName = "Project";
        }
        else
        {
            // Only proceed if the focused document is a schematic (DocKindSch).
            if (document.DM_DocumentKind() != EDPConstant.DocKindSch) return;
            documentName = document.DM_FileName();
        }

        // Enumerate all nets in the document, retrieve their full names, and sort them alphabetically.
        var netNames = Enumerable.Range(0, document.DM_NetCount())
            .Select(document.DM_Nets)
            .Select(net => net.DM_FullNetName())
            .OrderBy(name => name);

        // Display the list of net names in an information dialog within Altium Designer.
        DXP.Utils.ShowInfo(string.Join(Environment.NewLine, netNames), $"Nets [{documentName}]");
    }

    /// <summary>
    /// Checks if the given project is the special "Free Documents" project in Altium Designer.
    /// </summary>
    /// <param name="project">The project to check.</param>
    /// <returns>True if the project is the Free Documents project; otherwise, false.</returns>
    private static bool IsFreeDocumentsProject(IProject project)
    {
        return project == DXP.GlobalVars.DXPWorkSpace.DM_FreeDocumentsProject();
    }

Используемые здесь типы (IProject, IDocument и DXP.GlobalVars ) описаны в справочнике Altium Designer SDK.

Откройте Source Code\Main.cs и зарегистрируйте команду в классе PluginServerModule:

protected override void InitializeCommands()
{
    ((CommandLauncher)CommandLauncher).RegisterCommand("ShowNets", Commands.Command_ShowNets, Commands.GetState_ShowNets);
}

Выполните сборку проекта, чтобы установить расширение.

Шаг 4. Запустите команду в Altium Designer

  1. Запустите Altium Designer.

  2. Щёлкните правой кнопкой мыши любую панель инструментов и выберите Customize…

  3. В разделе Commands нажмите New… и настройте следующие параметры:

    • Process: ShowNetsExtension:ShowNets

    • Caption: ShowNets

  4. Перетащите новую команду на панель инструментов.

  5. Нажмите команду — должно появиться диалоговое окно со списком цепей.

Дальнейшие действия

  • Изучите справочник Altium Designer SDK — полное описание API .NET для пространств имён SCH, PCB, EDP, DXP, ComponentLib и Embedded.

  • Прочитайте соглашения API, чтобы узнать, как организованы точки входа, методы GetState/SetState и перечисления.

  • Создайте следующее расширение на основе шаблона Altium Designer Extension Template с поддержкой горячей перезагрузки при работающем Altium Designer.

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents