Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
resources:tools-software:a2bv2:quickstartguide:appendix-j [25 Nov 2022 08:21] Gireesha Nirvanaiahresources:tools-software:a2bv2:quickstartguide:appendix-j [08 Dec 2022 12:45] (current) – [Add Connection] Gireesha Nirvanaiah
Line 1: Line 1:
 +[[:resources:tools-software:a2bv2:quickstartguide|Click here to return to the QSG homepage]]
 +
 ====== APPENDIX J Thrift ====== ====== APPENDIX J Thrift ======
 Thrift enables automation of creation of schematics and updating schematics. Refer thrift documentation at https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting?s[]=thrift for generic APIs which can be used with A2B as well as SigmaStudio+. The following section introduces APIs specific to A2B and this in addition to the one’s available at the website mentioned above. Thrift enables automation of creation of schematics and updating schematics. Refer thrift documentation at https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting?s[]=thrift for generic APIs which can be used with A2B as well as SigmaStudio+. The following section introduces APIs specific to A2B and this in addition to the one’s available at the website mentioned above.
Line 4: Line 6:
 **Note :-** Documentation for A2B thrift will be uploaded to wiki.analog.com in the future releases. Any further updates to A2B thrift documentation will be provided at this domain. **Note :-** Documentation for A2B thrift will be uploaded to wiki.analog.com in the future releases. Any further updates to A2B thrift documentation will be provided at this domain.
  
-A UID is a unique identifier string used extensively in thrift to identify the desired entity. It has the format <name>_<zero-based-positive-integer>. For instance "EvalAD2433WB1BZ_0". To know the UID of any entity, use the GetAllPlugins API (refer the link above) to get a full list of plugins loaded by SS+. Then filter this list for A2B plugins by referring to J.3A2B Shape full names. Now from this list, the string after the last ‘.’ without the _v<version> will be the <name> in the UID string. The integer part of UID must always be incremented for every shape added using a particular <name>.+A UID is a unique identifier string used extensively in thrift to identify the desired entity. It has the format <name>_<zero-based-positive-integer>. For instance "EvalAD2433WB1BZ_0". To know the UID of any entity, use the GetAllPlugins API (refer the link above) to get a full list of plugins loaded by SS+. Then filter this list for A2B plugins by referring to J.3 [[:resources:tools-software:a2bv2:quickstartguide:appendix-j#a2b_shape_full_names|A2B Shape full names]]. Now from this list, the string after the last ‘.’ without the _v<version> will be the <name> in the UID string. The integer part of UID must always be incremented for every shape added using a particular <name>.
  
 For instance, one of the items you would get from GetAllPlugins API is "AnalogDevices.Plugins.Platforms.EvalAD2433WA1BZ_v2.0.0.0". From this the UID <name> will be EvalAD2433WA1BZ. For the first EvalAD2433WA1BZ shape added to the system, it’s UID will be EvalAD2433WA1BZ_0. For the second shape it will be EvalAD2433WA1BZ_1 and so on. For instance, one of the items you would get from GetAllPlugins API is "AnalogDevices.Plugins.Platforms.EvalAD2433WA1BZ_v2.0.0.0". From this the UID <name> will be EvalAD2433WA1BZ. For the first EvalAD2433WA1BZ shape added to the system, it’s UID will be EvalAD2433WA1BZ_0. For the second shape it will be EvalAD2433WA1BZ_1 and so on.
Line 22: Line 24:
 ==== Add Connection ==== ==== Add Connection ====
 Refer https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/addconnection. In addition, the following information is applicable. Refer https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/addconnection. In addition, the following information is applicable.
-  - channelFullName – refer Table 7: Plugin full names+  - channelFullName – refer [[:resources:tools-software:a2bv2:quickstartguide:appendix-j#a2b_shape_full_names|Table 7: Plugin full names]]
  
 ==== Remove connection ==== ==== Remove connection ====
Line 101: Line 103:
  
 Use the API GetAllPlugins to get a list of all the plugins loaded into the application and use the formats given below to filter out A2B plugins. (available at https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getallplugins) Use the API GetAllPlugins to get a list of all the plugins loaded into the application and use the formats given below to filter out A2B plugins. (available at https://wiki.analog.com/resources/tools-software/sigmastudiov2/usingsigmastudio/scripting/getallplugins)
 +
 +**Table 7:** Plugin full names
 +
 +^ ** Shape ** ^ ** Shape/Channel full name ** ^
 +| All platforms that have the name format \\ “Eval<transceiver part number and PCB number>”. \\ Example :- \\ EvalAD2433WA1BZ | “AnalogDevices.Plugins.Platforms.Eval<transceiver part number and PCB number>_v<plugin version in a.b.c.d format>”. \\ \\ Example:- \\ "AnalogDevices.Plugins.Platforms.EvalAD2433WA1BZ_v2.0.0.0" |
 +| All A2B transceivers | “AnalogDevices.Plugins.Transceivers.<transceiver name>_v<version in a.b.c.d format>” \\ Example:- \\ AnalogDevices.Plugins.Transceivers.AD243xMain_v2.0.0.0 |
 +| All A2B generic devices | “AnalogDevices.Plugins. Peripherls.<peripheral type name>_v<version in a.b.c.d format>” \\ Example:- \\ "AnalogDevices.Plugins.Peripherls.A2B.GenericDevices_v1.0.0.0" |
 +| A2B links/Channels | "AnalogDevices.Plugins.Channels.A2BChannel_v2.0.0.0"
 +| I2C, SPI, USB Links/Channels | "AnalogDevices.Plugins.CommunicationChannels.USBChannel_v1.0.0.0" |
 +
resources/tools-software/a2bv2/quickstartguide/appendix-j.txt · Last modified: 08 Dec 2022 12:45 by Gireesha Nirvanaiah