Guida rapida introduttiva all'SDK di Altium Designer

L'SDK di Altium Designer consente di creare estensioni personalizzate che si integrano direttamente in Altium Designer, aggiungendo comandi, automatizzando i flussi di lavoro e accedendo ai dati di progettazione tramite un'API .NET gestita.

Questa guida ti accompagna nell'installazione degli strumenti di sviluppo, nella creazione di un progetto di estensione, nell'aggiunta di un comando e nella sua esecuzione all'interno di Altium Designer.

Prerequisiti

• Registrazione su Altium Developer Center – necessaria per sbloccare l'accesso all'SDK di Altium Designer e alle sue estensioni

• Altium Designer installato e con licenza attiva

• Un IDE compatibile con .NET (Visual Studio o VS Code con supporto C#)

Passaggio 1: installare l'estensione Altium Developer

L'estensione Altium Developer aggiunge direttamente in Altium Designer modelli di progetto e strumenti SDK.

1. In Altium Designer, vai a Extensions and Updates → Available.

2. Nella sezione Software Extensions , cerca Altium Developer.

3. Installa l'estensione, quindi riavvia Altium Designer quando richiesto.

Passaggio 2: creare un nuovo progetto di estensione

1. In Altium Designer, vai a File → New → Other → Extension.

   • Extension ID: ShowNetsExtension

   • Extension Kind: Altium Designer Server

   • Development Language: C#

   • IDE Version: latest

   • SDK Version: latest

2. Una volta creata l'estensione, Altium Designer ne mostra i dettagli. Prendi nota del Source Location — apri il file .csproj da quel percorso nel tuo IDE.

Passaggio 3: aggiungere il primo comando

Apri Source Code\Commands.cs e aggiungi i seguenti metodi alla classe 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();
    }

Apri Source Code\Main.cs e registra il comando nella classe PluginServerModule:

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

Compila il progetto per installare l'estensione.

Passaggio 4: eseguire il comando in Altium Designer

1. Avvia Altium Designer.

2. Fai clic con il pulsante destro su una barra degli strumenti e seleziona Customize…

3. In Commands, fai clic su New… e configura quanto segue:

   • Process: ShowNetsExtension:ShowNets

   • Caption: ShowNets

4. Trascina il nuovo comando su una barra degli strumenti.

5. Fai clic sul comando: dovrebbe apparire una finestra di dialogo con l'elenco delle net.

Passaggi successivi

• Consulta la documentazione dell'Altium Designer SDK per le interfacce che coprono schemi, layout PCB, componenti e altro ancora.

• Esplora estensioni di esempio e demo nell'organizzazione GitHub AltiumDeveloper.