Skip to content

Commit

Permalink
fixed documentation and scripting examples (#72)
Browse files Browse the repository at this point in the history
- added section on scripting to point to install AIM BSP and VIP
- fixed .bin and xml to use proper PayloadID, frame type and size and correct parameter settign
  • Loading branch information
fmussi authored Dec 14, 2023
1 parent 04a12a4 commit 6849939
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 2 additions & 0 deletions Docs/User Guide/User Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ The AIM ARINC 664 custom device includes a LabVIEW scripting API to configure th
To use the scripting API, the optional scripting package must be installed:
`ni-aim-arinc-664-veristand-20xx-labview-support`

In addition to this package you must install the [AIM ARINC 664 BSP Driver and LabVIEW API](https://www.ni.com/en/support/downloads/software-products/download.aim-arinc-664-driver.html#494504) 2023Q4 or later and once the AIM BSP is installed, run the `aim_gmbh_lib_arinc_664-<a.b.c.d>.vip` VI Package which containes the LabVIEW VIs. Version 1.0.0.18 or later of the .vip is required.

The scripting API includes two example files inside a LabVIEW example project found at the following directory: `C:\Program Files (x86)\National Instruments\LabVIEW 20xx\examples\NI VeriStand Custom Devices\AIM ARINC 664`. It contains two example VIs:

- `Import Parameters Configuration to New AIM ARINC 664 Custom Device.vi` - Demonstrates using the AIM ARINC 664 scripting API to configure the custom device by importing a parameters configuration file.
Expand Down
Binary file modified Source/Scripting Examples/Support/2FrameProperlyDefined.bin
Binary file not shown.
12 changes: 6 additions & 6 deletions Source/Scripting Examples/Support/UDP_RX_TX_Loopback_TxRxMon.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
<Board xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" PortSpeed="FDX_1000MBIT">
<Port PortId="0" PortMap="0">
<TxUdpSession VlId="60" Bag="128" NetSelect="FDX_TX_FRAME_BOTH" DomainID="1" SideID="1" LocationID="1" InterfaceID="1" MaxFrameLength="1000" FrameBufferSize="0">
<TxCommPort ID="Payload1" PortType="FDX_UDP_SAMPLING" PartitionID="1" SubVlId="1" UdpSrcPort="1" UdpDstPort="1" UdpSamplingRate="128" UdpNumBufMessages="1" UdpMaxMessageSize="1000">
<TxCommPort PayloadID="Payload1" PortType="FDX_UDP_SAMPLING" PartitionID="1" SubVlId="1" UdpSrcPort="1" UdpDstPort="1" UdpSamplingRate="128" UdpNumBufMessages="1" UdpMaxMessageSize="1000">
<Parameter>
<direction>outgoing</direction>
<encoding>BCD</encoding>
<encoding>Float_64</encoding>
<signed>true</signed>
<startBit>0</startBit>
<numberOfBits>256</numberOfBits>
<numberOfBits>64</numberOfBits>
<scale>1</scale>
<offset>0</offset>
<name>Param 0</name>
Expand All @@ -23,10 +23,10 @@
<RxCommPort PortType="FDX_UDP_SAMPLING" DomainID="1" SideID="1" LocationID="1" PartitionID="1" UdpSrcPort="1" UdpDstPort="1" UdpNumBufMessages="1" UdpMaxMessageSize="1000">
<Parameter>
<direction>incoming</direction>
<encoding>BCD</encoding>
<signed>true</signed>
<encoding>Float_64</encoding>
<signed>true</signed>
<startBit>0</startBit>
<numberOfBits>256</numberOfBits>
<numberOfBits>64</numberOfBits>
<scale>1</scale>
<offset>0</offset>
<name>Param 0</name>
Expand Down

0 comments on commit 6849939

Please sign in to comment.