Technical Reference - FPGA API

Old Content - visit altium.com/documentation

Parent page: Altium Designer API Reference

This section of the Altium Designer API documentation provides a detailed reference of the FPGA API interfaces.

The Altium Designer scripting system implements a subset of the complete Altium Designer API and its Object Interfaces. The Altium DXP Developer, used for developing Altium Designer server Extensions, has access to the full Altium Designer API via a set of API SDK source units.

The FPGA API reference covers interfaces for FPGA objects in the Altium Designer application FPGA Object Model. The FPGA interfaces exist as long there are associated existing objects in memory, thus when writing a script or server code, you have the responsibility of checking whether the interface you wish to query exists or not before you proceed to invoke the interface's methods.

To obtain the interface which represents the FPGA work bench object, invoke the GetNexusWorkbench function in your script which returns you the INexusWorkbench interface. Which you can then extract data from FPGA objects and invoke FPGA object's methods.

Example

    NexusWorkBench := GetNexusWorkbench;
    If NexusWorkBench.GetSoftDeviceCount > 0 Then 
        SoftDeviceCount := NexusWorkBench.GetSoftDeviceCount
    Else Exit;
FPGA API components

The FPGA API is covered in three separate files; RT_FPGA, RT_NexusWorkspace and RT_NexusDevice units.

Main FPGA Interfaces

The INexusWorkbench interface is the main interface in FPGA API. To use FPGA interfaces, invoke the GetNexusWorkbench function to retrieve the INexusWorkbench interface.

Script Examples
There are FPGA script examples in the \Examples\Scripts\DelphiScript\FPGA folder that demonstrate the use of FPGA interfaces.

References for the FPGA API

Separate references for other Altium Designer APIs

 

FPGA Interfaces Overview

When you need to deal with the objects associated with the NanoBoard and the FPGA editor software, the starting point is to invoke the GetNexusWorkbench function or the GetDeviceManager function in your script. This function returns you the INexusWorkbench object interface or the IDeviceManager object interface.

Main interfaces for the Nexus WorkBench

INexusWorkbench
IProjectLink
IPCBProjectLink

Main interfaces for the Nexus Devices

INexusDevice
INexusBreakpoint   
IMemorySpace       
IProcessorRegister 
IInstrumentView    
IJTagChannel       
IBSDLObject        
IBSDLEntity        
IScanPin           
IPinMapping        
IBoundaryCell      
IInstructionOpCode 
IRegisterAssociation
IDeviceInformation 

FPGA low level routines

Constants
Types
Functions
Classes

You are reporting an issue with the following selected text and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.


Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Sounds exciting! Did you know we offer special discounted student licenses? For more information, click here.

In the meantime, feel free to request a free trial by filling out the form below.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.