MCC iPortAI LabVIEW VI Library Reference

iPortAI LabVIEW VI Library Reference (V2.1)

Copyright (c) 2015 MCC (Micro Computer Control Corporation)

The iPortAI LabVIEW VI Library provides VIs (Virtual Instruments) that support the development of National Instruments LabVIEW^TM applications for I²C Bus communications. This library reference and executable files were created by the MCC Technical Support team, are owned solely by MCC, and are made available on a non-exclusive, royalty-free, as-is basis for use with MCC I²C Bus host adapters.

LabVIEW is the industry standard graphical development environment for test and control. MCC's iPortAI LabVIEW Library accelerates the development and deployment of systems incorporating I²C Bus and other derived protocols, for configuration, testing, control, security, and monitoring activities.

Sample Master Transmit Sequence
Sample I²C Bus Master Transmit Sequence

Supported MCC ASCII-Interface I²C Bus Adapters:

Supported LabVIEW Development Tools:

LabVIEW 2010 and above.

Project Requirements:

MCC ASCII-interface I²C Bus adapter (See Supported Adapters).
LabVIEW 2010 or later.

How to Install and Use This Library:

Review and accept the MCC iPortAI LabVIEW Library License Agreement.
Download the compressed Library File: iPortAILV2010Lib_v2_1.ZIP.
Extract Compressed Folders/Files with Windows Explorer, PKunZip, or other extraction software.
Copy extracted folder \instr.lib\MCC iPortAI V2\ and contents to your ...\National Instruments\LabVIEW n\instr.lib\ folder.

iPortAI VIs will appear on the LabVIEW Instrument I/O|Instrument Drivers Function palette.

Copy extracted folder \project\MCC iPortAI V2\ and contents to your ...\National Instruments\LabVIEW n\project\ folder (Optional).

iPortAI Sample Application VIs will appear on the LabVIEW Tools menu.

Run LabVIEW and select an iPortAI Sample Project from the LabVIEW Tools menu, or create a new blank VI.
All iPortAI VIs are supported with Context Help (See LabVIEW Help|Show Context Help menu).
Save, run, test, and modify application wiring diagram and front panel as required.
Send comments and feedback to support@mcc-us.com

LabVIEW VI Library Release History

The iPortAI LabVIEW VI Library is organized into three groups:

High Level VIs provide high level access to the iPortAI device and the I²C Bus.
Low Level VIs provide direct access to the iPortAI ASCII-text commands and responses.
Sample Application VIs demonstrate how to use library VIs to create a LabVIEW I²C Bus application.

The following tables list the VIs provided with the iPortAI LabVIEW Library.

High Level VIs

Close Connection
Master Rx
Master Tx
Master TxRx
Open Connection
Slave Tx
Wait For Event

Low Level VIs

Baud Rate Command (Bcmd)
Byte Array To Hex-Equivalent String
Clock Rate Command (Kcmd)
Close Command (Ccmd)
Event Reader
General Call Enable Command (Gcmd)
Hex Out Only Enable Command (Hcmd)
Hex-Equivalent String To Byte Array
Master Read Command (Rcmd)
Master Transmit Command (Tcmd)
Open Command (Ocmd)
Reset Command (Reset)
Set Destination Slave Address Command (Dcmd)
Set My Slave Address Command (Icmd)
Slave Transmit Command (Scmd)

Sample Applications

Project 1 - I²C Bus Quick Start
Project 2 - I²C Bus Master Transmit
Project 3 - I²C Bus Master Read
Project 4 - I²C Bus Master Tx-Rx
Project 5 - I²C Bus Slave Tx-Rx
Project 6 - I²C Bus Message Center

Archive

High Level VIs

iPortAI Sample LabVIEW applications

Name	Description
Close Connection	The Close Connection VI deactivates the iPortAI device as a master or slave device on the I²C Bus. Operation: 1. Issue iPortAI Close Command. 2. Wait for Open Command to finish. 3. Close serial port. Terminals - Input: VISA resource in - Serial Port used by iPortAI device (COMn). Timeout (2000 ms) - Maximum time to complete operation (See Note 1). error in - Entry error condition. Standard Functionality. Terminals - Output: Event Description - Operation result string (See Note 3). Event Code - 4-character iPortAI device response code (See Note 2). error out - Exit error condition. Standard Functionality. Notes: 1. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 2. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Close Connection is "/CCC", Close Connection Complete. See the Wait For Event VI for a complete list of Event Codes. 3. Event Description The Event Description string is a text description of the result of the operation.
Master Rx	The Master Rx VI master reads the specified number of data bytes from a specified I²C Bus slave address. Operation: 1. Sets the I²C Bus Destination Slave Address. 2. Issues iPortAI Master Rx Command. 3. Wait for Master Rx operation to finish (See Blocked Terminal). Terminals - Input: VISA resource in - Serial Port used by iPortAI device (COMn). Bytes To Read - Number of data bytes to read (See Note 1). Timeout (2000 ms) - Maximum time to complete operation (See Note 2). doStop (T) - End message with Stop condition. error in (no error) - Entry error condition. Standard Functionality. Destination Slave Address - I²C Bus Slave Address (See Note 3). Blocked (T) - Wait for operation to complete or timeout (See Note 4). Terminals - Output: Event Description - Operation result string (See Note 5). VISA resource out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 6). Rx Data - 1D byte (U8) array containing data received from slave device. error out - Exit error condition. Standard Functionality. Notes: 1. Bytes To Read Bytes To Read specifies the number of bytes to read from the slave device. This value can be in the range of 0 to 32767. A byte count of zero indicates a Variable Length message read, where the first byte received from the slave device indicates the number of additional trailing bytes to read. For Variable Length messages, the iPortAI device automatically reads the first byte and all additional bytes from the slave. 2. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 3. Destination Slave Address The Destination Slave Address specifies the slave address of the device to receive the I²C Bus message data. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Master Read slave addresses include even-numbered values between 0x02 and 0xFE (02, 04, 06,... FE). 4. Blocked If Blocked is true, Master Rx waits for the operation to complete or Timeout, and returns Event Code/String/Description strings. Unblocked calls return immediately, and require a subsequent call to the Wait For Event VI to get the result of the operation and retrieve any data read from a slave device. Unblocked calls with separate thread iPortAI event handling are recommended for Slave Transmit Requests, or Slave Receive, events that could occur at any time. 5. Event Description The Event Description string is a text description of the result of the operation. 6. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Master Rx is "/MRC", Master Receive Complete. See the Wait For Event VI for a complete list of Event Codes.
Master Tx	The Master Tx VI master transmits the specified data bytes to the specified I²C Bus slave address. Operation: 1. Sets the I²C Bus Destination Slave Address. 2. Issues iPortAI Master Transmit Command. 3. Wait for Master Transmit Command to finish (See Blocked Terminal). Terminals - Input: Tx Data - 1D byte (U8) array containing data to send to slave device. VISA resource in - Serial Port used by iPortAI device (COMn). Timeout (2000 ms) - Maximum time to complete operation (See Note 1). doStop (T) - End message with Stop condition. error in (no error) - Entry error condition. Standard Functionality. Destination Slave Address - I²C Bus Slave Address (See Note 2). Blocked (T) - Wait for operation to complete or timeout (See Note 3). Terminals - Output: Event Description - Operation result string (See Note 4). VISA resource out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 5). error out - Exit error condition. Standard Functionality. Notes: 1. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 2. Destination Slave Address The Destination Slave Address specifies the slave address of the device to receive the I²C Bus message data. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Master Tx slave addresses include even-numbered values between 0x00 and 0xFE (00, 02, 04, 06,... FE). 3. Blocked If Blocked is true, Master Tx waits for the operation to complete or Timeout, and returns Event Code/String/Description strings. Unblocked calls return immediately, and require a subsequent call to the Wait For Event VI to get the result of the operation and retrieve any data read from a slave device. Unblocked calls with separate thread iPortAI event handling are recommended for Slave Transmit Requests, or Slave Receive, events that could occur at any time. 5. Event Description The Event Description string is a text description of the result of the operation. 4. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Master Tx is "/MTC", Master Transmit Complete. See the Wait For Event VI for a complete list of Event Codes.
Master TxRx	The Master TxRx VI master transmits specified data bytes to a specified I²C Bus slave address with no Stop condition. This is followed by a Repeated Start condition and a master read of a specified number of data bytes from the same slave address. Operation: 1. Sets the I²C Bus Destination Slave Address. 2. Issues iPortAI Master Tx Command with No Stop. 3. Wait for Master Tx operation to finish (See Blocked Terminal). 4. Issues iPortAI Master Rx Command. 5. Wait for Master Rx operation to finish (See Blocked Terminal). Terminals - Input: Tx Data - 1D byte (U8) array containing data to send to slave device. VISA resource in - Serial Port used by iPortAI device (COMn). Bytes To Read - Number of data bytes to read (See Note 1). Timeout (2000 ms) - Maximum time to complete operation (See Note 2). doStop (T) - End Master Rx message with Stop condition. error in (no error) - Entry error condition. Standard Functionality. Destination Slave Address - I²C Bus Slave Address (See Note 3). Blocked (T) - Wait for operation to complete or timeout (See Note 4). Terminals - Output: Event Description - Operation result string (See Note 5). VISA resource out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 6). Rx Data - 1D byte (U8) array containing data received from slave device. error out - Exit error condition. Standard Functionality. Notes: 1. Bytes To Read Bytes To Read specifies the number of bytes to read from the slave device. This value can be in the range of 0 to 32767. A byte count of zero indicates a Variable Length message read, where the first byte received from the slave device indicates the number of additional trailing bytes to read. For Variable Length messages, the iPortAI device automatically reads the first byte and all additional bytes from the slave. 2. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 3. Destination Slave Address The Destination Slave Address specifies the slave address of the device to receive the I²C Bus message data. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Master TxRx slave addresses include even-numbered values between 0x02 and 0xFE (02, 04, 06,... FE). 4. Blocked If Blocked is true, Master Rx waits for the operation to complete or Timeout, and returns Event Code/String/Description strings. Unblocked calls return immediately, and require a subsequent call to the Wait For Event VI to get the result of the operation and retrieve any data read from a slave device. Unblocked calls with separate thread iPortAI event handling are recommended for Slave Transmit Requests, or Slave Receive, events that could occur at any time. 5. Event Description The Event Description string is a text description of the result of the operation. 6. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Master TxRx is "/MRC", Master Receive Complete. See the Wait For Event VI for a complete list of Event Codes.
Open Connection	The Open Connection VI activates the iPortAI device as an active master or slave device on the I²C Bus. Operation: 1. Open serial port. 2. Wait for device power-up to finish (See Power-Up Delay Terminal). 3. Reset device. 4. Set device own I²C Bus Slave Address. 5. Set/Clear device General Call Enable. 6. Flush serial port I/O buffers. 7. Set I²C Bus Clock Rate. 8. Set serial port Baud Rate. 9. Issue iPortAI Open Command. 10 Wait for Open Command to finish. Terminals - Input: Baud Rate (19200) - Set serial port communication rate (See Note 1). Power-Up Delay (0.25 s) - Wait for device to power-up (See Note 2). VISA Resource In - Serial Port used by iPortAI device (COMn). iPortAI's Own Slave Address (0x6E) - I²C Bus Slave Address (See Note 3). Timeout (2000 ms) - Maximum time to complete operation (See Note 4). General Call Enable (F) - Enable General Call Slave Address (See Note 5). Error In - Entry error condition. Standard Functionality. Clock Rate (100 KHz) - I²C Bus Clock Rate (See Note 6). Terminals - Output: Event Description - Operation result string (See Note 7). VISA Resource Out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 8). Error Out - Exit error condition. Standard Functionality. Notes: 1. Baud Rate Baud Rate sets serial port communication rate between the host computer and the iPortAI device. The standard Baud Rates are 19200, 57600, and 115200. Not all iPortAI devices support all baud rates. Some iPortAI devices without an RS-232 connection may operate at high baud rates independent of the baud rate setting. See the iPortAI device User's Guide for details. 2. Power-Up Delay The power for some iPortAI devices may be controlled by the host computer Power Management System. A Power Management System may remove power from the iPortAI device when a connection to the device is not open. The Power-Up Delay specifies the amount of time to wait after opening the connection before attempting to communicate with the device. This delay may be needed to allow the device to complete its power-up/reset sequence. 3. iPortAI's Own Slave Address The iPortAI's Own Slave Address specifies the slave address recognized by the iPortAI device. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Slave addresses include even-numbered values between 0x02 and 0xFE (02, 04, 06,... FE). 4. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 5. General Call Enable The General Call Enable enables or disables the iPortAI device's response to the I²C Bus General Call (0x00) address. 6. Clock Rate Clock Rate specifies the I²C Bus Clock Rate the iPortAI device uses when operating as a bus master. It is an enum representing 23 KHz, 86 KHz, 100 KHz, and 400 KHz. Not all Clock Rates are supported by all iPortAI devices. See the iPortAI device User's Guide for details. 7. Event Description The Event Description string is a text description of the result of the operation. 8. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Open Connection is "/OCC", Open Connection Complete. See the Wait For Event VI for a complete list of Event Codes.
Slave Tx	The Slave Tx VI slave transmits the specified data bytes to an I²C Bus master device in response to a Slave Transmit Request. Operation: 1. Issues iPortAI Slave Transmit Command. 2. Wait for Slave Transmit operation to finish (See Blocked Terminal). Terminals - Input: Tx Data - 1D byte (U8) array containing data to send to slave device. VISA resource in - Serial Port used by iPortAI device (COMn). Timeout (2000 ms) - Maximum time to complete operation (See Note 1). error in (no error) - Entry error condition. Standard Functionality. Blocked (T) - Wait for operation to complete or timeout (See Note 2). Terminals - Output: Event Description - Operation result string (See Note 3). VISA resource out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 4). error out - Exit error condition. Standard Functionality. Notes: 1. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 2. Blocked If Blocked is true, Slave Tx waits for the operation to complete or Timeout, and returns Event Code/Description strings. Unblocked calls return immediately, and require a subsequent call to the Wait For Event VI to get the result of the operation and retrieve any data read from a slave device. Unblocked calls with separate thread iPortAI event handling are recommended for Slave Transmit Requests, or Slave Receive, events that could occur at any time. 3. Event Description The Event Description string is a text description of the result of the operation. 4. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The normal Event Code for Slave Tx is "/STC", Slave Transmit Complete. See the Wait For Event VI for a complete list of Event Codes.
Wait For Event	The Wait For Event VI monitors iPortAI device responses, and returns an Event Code, Event Description, and any received data upon detecting a complete response, timeout, or error. Operation: 1. Repeated calls iPortAI Event Reader VI. 2. Maintains timeout timer. 3. Returns on complete iPortAI response, timeout, or error. Terminals - Input: Timeout (2000 ms) - Maximum time to complete operation (See Note 1). VISA resource name - Serial Port used by iPortAI device (COMn). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: Event Description - Operation result description string (See Note 2). VISA resource out - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code (See Note 3). Rx Data - 1D byte (U8) array containing any received data. error out - Exit error condition. Standard Functionality. Notes: 1. Timeout The maximum time (ms) allowed to complete the operation before a time-out. 2. Event Description The Event Description string is a text description of the result of the operation. 3. Event Code The Event Code is a four-character string that identifies the result of the operation, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The complete list of iPortAI Event Code strings include: "/OCC" Open Connection Complete The iPortAI device has completed the Open Connection operation, and can perform I²C Bus master and slave operations. "/CCC" Close Connection Complete The iPortAI device has completed Close Connection operation, and has disconnected from the I²C Bus. "/MTC" Master Transmit Complete The iPortAI device has completed the Master Transmit operation. Slave device acknowledged its address. Data transmitted. "/MRC" Master Receive Complete The iPortAI device has completed the Master Receive operation. Slave device acknowledged its address. Data is available at Rx Data terminal. "/STR" Slave Transmit Request The iPortAI device has received a slave transmit request from a master on the bus. The iPortAI device will hold the bus (clock stretch) until it receives Slave Transmit data from the the host computer. See the Slave Transmit VI. "/SRC" Slave Receive Complete Data has been received at the iPortAI device Slave Address. Data is available at Rx Data terminal. "/GRC" General Call Receive Complete Data has been received at the I²C Bus General Call address (0x00). Data is available at Rx Data terminal. "/STC" Slave Transmit Complete The Slave Transmit operation has been completed. "/SNA" Slave Not Acknowledging A slave device has not acknowledged the slave address in the last Master Transmit or Master Receive message. "/I81" iPortAI Device Busy The iPortAI device is busy. It may be performing a Master or Slave operation. You may need to repeat the previous operation. "/I83" I²C Bus Arbitration Loss The iPortAI device has lost bus arbitration to another master during a Master Transmit or Master Receive operation. You may need to repeat the previous operation. "/I84" I²C Bus Error Detected. The iPortAI device has detected an illegal signal condition on the bus. You may need to repeat the precious operation, or Close, Open, or Reset the iPortAI device to free the bus. "/I85" I²C Bus Time-Out Detected The iPortAI device has detected 1 second of bus inactivity within a message in which it is participating as a master or a slave. This is a warning. This may not be a problem, but it could be caused by a slave device stuck holding the SCL line low. This is a report only, the iPortAI device does not take any corrective action. You may need to repeat the precious operation, or Close, Open, or Reset the iPortAI device to free the bus. "/I88" iPortAI Device Connection Closed An attempt has been made to issue a master or slave command to the iPortAI device when the communication link is closed. "/I89" Invalid Command Argument The iPortAI device has detected an invalid command argument. "/I8A" Slave Tx Request Not Active The iPortAI device has received a Slave Transmit command when a Slave Transmit Request is not pending. "/I8F" Invalid iPortAI Command The iPortAI device has received an unsupported, invalid, unrecognized, or incomplete command. "I90" iPortAI Receive Buffer Overflow The iPortAI device has lost receive data arriving on its serial port. This normally indicates the host computer serial port flow control is not working. The host computer may not be using flow control (required), the internal host computer UART Transmit FIFO buffer may need adjustment, the host computer and the iPortAI device may be using different flow control methods (hardware or software), or the hardware flow control wire may be missing in the RS-232 interconnecting cable. "/IA1" VISA Serial Port Error The iPortAI Event Reader VI has received a serial port communications error notification from the LabVIEW serial port driver VI. "/IA2" VISA Serial Port Read Error The iPortAI Event Reader VI has received a serial port communications error notification from the LabVIEW serial port driver VI. "/IA3" VI Error In Detected "/IA4" Wait For Event Time-out

Low Level VIs

Name	Description
Baud Rate Command (Bcmd)	The iPortAI Baud Rate Command (Bcmd) VI sends a /B command string to the iPortAI device. Upon receiving the /B command, the iPortAI device responds with an Event Code/String at the old baud rate, then immediately changes to the new baud rate. The normal response is "/BCn", Baud Change, where n = 0, 1, or 2 representing the new baud rate. The host computer should change its serial port to the new baud rate when this Baud Change response is received. See the iPortAI device User's Guide for details. Operation: 1. Send a /B command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). Baud Rate - Set serial port communication rate (See Note 1). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. Baud Rate Baud Rate is an enum representing 19200, 57600, and 115200 baud. The Baud Rate command is not supported by all iPortAI devices. The Baud Rate command causes the iPortAI device to send a response that can be used to change the serial port baud rate on the host computer. Sending a Baud Rate command to a non-supporting iPortAI device will cause the device to respond with "/I8F", Invalid Command. See the iPortAI device User's Guide for details.
Byte Array To Hex-Equivalent Stirng	The Byte Array to Hex-equivalent String VI is a LabVIEW iPortAI Library helper VI. It can be used to convert a single-dimension byte array into an iPortAI compatible Hex-equivalent string. Operation: 1. Convert byte-array into hex-equivalent string. Terminals - Input: Byte Arrary In - Single-dimension byte array. Terminals - Output: Hex-equivalent String - iPortAI device compatible data string (See Note 1). Notes: 1. Hex-equivalent String Hex-equivalent strings are used for input data by iPortAI Master Transmit, Master TxRx, and Slave Transmit VIs. Hex-equibalent strings represent one or more bytes (U8) of any value (00...FF hexadecimal or 0...255 decimal) and still maintain the ASCII character interface with the iPortAI device. An iPortAI Hex-equivalent string contains sets of three ASCII characters for each data byte. This three ASCII character set uses the form "~xx", where the "~" character is a Hex-equivalent marker, and the "xx" represents a string of two ASCII-Hexadecimal characters that represent an 8-bit unsigned number in the range of 0x00 to 0xFF hexadecimal.
Clock Rate Command (Kcmd)	The iPortAI Clock Rate Command (Kcmd) VI sends a /K command string to the iPortAI device. Upon receiving the /K command, the iPortAI device immediately changes to the new I²C Bus Clock Rate. The normal response is "". See the iPortAI device User's Guide for details. Operation:* 1. Send a /K command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). Clock Rate (100 KHz) - Set I²C Bus Clock Rate (See Note 1). error in (no error) - Entry error condition (no error). Standard Functionality. Terminals - Output: VISA resource name out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. Clock Rate Clock Rate is an enum representing 23 KHz, 86 KHz, 100 KHz, and 400 KHz. The Clock Rate command, or specific clock rates, may not be supported by all iPortAI devices. The Clock Rate command causes the iPortAI device to immediately change it I²C Bus Clock Rate. Sending a Clock Rate command to a non-supporting iPortAI device will cause the device to respond with "/I8F", Invalid Command. See the iPortAI device User's Guide for details.
Close Command (Ccmd)	The iPortAI Close Command (Ccmd) VI sends a /C command string to the iPortAI device. Upon receiving the /C command, the iPortAI device terminates I²C Bus master and slave activities The normal response is "/CCC", Close Connection Complete. See the iPortAI device User's Guide for details. Operation: 1. Send a /C command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality.
Event Reader	The iPortAI Event Reader VI monitors the iPortAI device serial port for device responses. With each Event Reader call, any available serial port receive characters are read and assembled into a string until the input stream is exhausted, or a terminating character (CR, or ) is received and a minimum (4 character) response is present. See the iPortAI device User's Guide for details. Operation:* 1. Read next available character from the iPorAI serial port. 2. Add new character to global string buffer. 3. Test string buffer for iPortAI device response termination (CR, or ). 4. Return Event Code/String. Terminals - Input:* VISA resource name - Serial Port used by iPortAI device (COMn). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource name - Serial Port used by iPortAI device (COMn). Event Code - 4-character iPortAI device response code. Event String - iPortAI device response string. error out - Exit error condition. Standard Functionality. Notes: 1. Event String The Event String may contain: a. The complete response string received from the iPortAI device. b. An "/NDA" if no input stream data is available. c. A null string ("") if no complete iPortAI device response is present. d. An Event Reader error string . 2. Event Code The Event Code contains the first 4 characters on the Event String, and can be used as input to a LabVIEW case structure to identify the specific iPortAI event. The complete list of iPortAI Event Code strings include: "/NDA" No Data Available The serial port input stream data is empty. "/SRC" Slave Receive Complete Slave data has been received at the iPortAI device Slave Address. The data is in the Event String. "/GRC" General Call Receive Complete Slave data has been received at the I²C Bus General Call address (0x00). The data is in the Event String. "/STC" Slave Transmit Complete The previous Slave Transmit operation has been completed. See the Slave Transmit Command (Scmd) VI. "/SNA" Slave Not Acknowledging A slave device has not acknowledged the slave address in the last Master Transmit or Master Receive message. "/I81" iPortAI Device Busy The iPortAI device is busy. It may be performing a Master or Slave operation. You may need to repeat the previous command. "/I83" Bus Arbitration Loss The iPortAI device has lost bus arbitration to another master during the previous Master Transmit or Master Receive command. You may need to repeat the previous command. "/I84" I²C Bus Error Detected. The iPortAI device has detected an illegal signal condition on the bus. You may need to repeat the precious command, or Close, Open, or Reset the iPortAI device to free the bus. "/I85" I²C Bus Time-Out Detected The iPortAI device has detected 1 second of bus inactivity within a message in which it is participating as a master or a slave. This is a warning. This may not be a problem, but it could be caused by a slave device stuck holding the SCL line low. This is a report only, the iPortAI device does not take any corrective action. You may need to repeat the precious command, or Close, Open, or Reset the iPortAI device to free the bus. "/I88" iPortAI Device Connection Closed An attempt has been made to issue a master or slave command to the iPortAI device when the communication link is closed. "/I89" Invalid Command Argument The iPortAI device has detected an invalid command argument. "/I8A" Slave Tx Request Not Active The iPortAI device has received a Slave Transmit command when a Slave Transmit Request is not pending. "/I8F" Invalid iPortAI Command The iPortAI device has received an unsupported, invalid, unrecognized, or incomplete command. "I90" iPortAI Receive Buffer Overflow The iPortAI device has lost receive data arriving on its serial port. This normally indicates the host computer serial port flow control is not working. The host computer may not be using flow control (required), the internal host computer UART Transmit FIFO buffer may need adjustment, the host computer and the iPortAI device may be using different flow control methods (hardware or software), or the hardware flow control wire may be missing in the RS-232 interconnecting cable. "/IA1" Serial Port Error The iPortAI Event Reader VI has received a serial port communications error notification from the LabVIEW serial port driver VI. "/IA2" Serial Port Read Error The iPortAI Event Reader VI has received a serial port communications error notification from the LabVIEW serial port driver VI. "/STR" Slave Transmit Request The iPortAI device has received a slave transmit message from a master on the bus. The iPortAI device will hold the bus (clock stretch) until it receives a Slave Transmit command from the host computer. See the Slave Transmit Command (Scmd) VI. "/MTC" Master Transmit Complete The iPortAI device has completed the previous Master Transmit command. See the Master Transmit Command (Tcmd) VI. "/CCC" Close Connection Complete The iPortAI device has completed the previous Close Connection command. See the Close Command (Ccmd) VI. "" No Event Available The iPortAI Event Reader VI is collecting data from the serial port, but a complete event response from the iPortAI device is not available. "/MRC" Master Receive Complete The iPortAI device has completed a Master Receive command (Rcmd). The data is in the Event String. "/OCC" Open Connection Complete The iPortAI device has completed the previous Open Connection command. See the Open Command (Ocmd) VI. "RDY" iPortAI Device Ready The iPortAI device has output an "*" to the host computer indicating it is ready for additional commands. This iPortAI response can occur in addition to other responses to the same command.
General Call Enable Command (Gcmd)	The iPortAI General Call Enable Command (Gcmd) VI sends a /G command string to the iPortAI device. The /G command enables or disables the iPortAI device's response to the I²C Bus General Call (0x00) address. The normal response is "". See the iPortAI device User's Guide for details. Operation:* 1. Send a /G command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). General Call Enable (F) - Enables/Disables I²C Bus General Call Slave Address (See Note 1). error in (no error) - Entry error condition (no error). Standard Functionality. Terminals - Output: VISA resource name out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. General Call The General Call slave address (0x00) is a special I²C Bus slave address use for broadcasting. Any master device on the I²C Bus may Master Transmit a message to the General Call slave address. This allows a master device to communicate with multiple slave devices at one time. Master Read to the General Call slave address is not permitted, as data from multiple slave devices could conflict and be indeterminate. See the iPortAI device User's Guide for details.
Hex Out Only Enable Command (Hcmd)	The iPortAI Hex Out Only Command (Hcmd) VI sends a /H command string to the iPortAI device. The /H command controls the output of received message data. The normal response is "". See the iPortAI device User's Guide for details. Operation:* 1. Send a /H command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). Hex Out Only Enable (T) - Controls the output of received message data (See Note 1). error in (no error) - Entry error condition (no error). Standard Functionality. Terminals - Output: VISA resource name out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. Hex Out Only Enable Hex Out Only Enable controls how the iPortAI device sends master or slave receive message data to the host computer. When Hex Out Only is disabled, received I²C Bus message data bytes representing ASCII printable characters are sent as their ASCII printable character. Non-ASCII printable data bytes are always sent in Hex (~00...~FF) form. When Hex Out Only is enabled, all received message data is sent in Hex (~00...~FF) form.
Hex-Equivalent String To Byte Array	The iPortAI Hex-equivalent String to Byte Array VI is a LabVIEW iPortAI Library helper VI. It can be used to convert an iPortAI Hex-equivalent string into a one-dimensional byte array ready for additional processing. To assist in processing the hex-equivalent strings, Hex-equivalent String to Byte Array VI provides a default offset of 4 to step past the leading four character iPortAI Event Code present in an Event String. Operation: 1. Convert byte-array into hex-equivalent string. Terminals - Input: Hex-equivalent String - iPortAI device compatible data string (See Note 1). Terminals - Output: Byte Array In - Single-dimension byte array. Notes: 1. Hex-equivalent String Hex-equivalent strings are output by the iPortAI Wait For Event VI, and Event Reader VI in response to iPortAI Master Rx, Master TxRx, and Slave Rx operations. Hex-equivalent strings represent one or more bytes (U8) of any value (00...FF hexadecimal or 0...255 decimal) and still maintain the ASCII character interface with the iPortAI device. An iPortAI Hex-equivalent string contains sets of three ASCII characters for each data byte. This three ASCII character set uses the form "~xx", where the "~" character is a Hex-equivalent marker, and the "xx" represents a string of two ASCII-Hexadecimal characters that represent an 8-bit unsigned number in the range of 0x00 to 0xFF hexadecimal.
Master Read Command (Rcmd)	The iPortAI Master Read Command (Rcmd) VI sends a /R command to the iPortAI device. The /R command causes the iPortAI device to attempt to access the I²C Bus as a bus master device, and read the specified number of data bytes from the currently selected Destination Slave Address, with or without generating a message terminating I²C Bus Stop. The normal response to the /R command is "/MRC" Master Read Complete, followed by the data read from the slave. All message bytes, including any Variable Length byte, are included in the response. Received data is a representation of the data bytes within the Master Receive message. The format of this data is controlled by the current value of the iPortAI Hex Out Only setting. See the Hex Out Only Command (Hcmd) VI. Operation: 1. Send a /R command string to the iPortAI device. Terminals - Input: doStop (T) - Controls generation of a message terminating I²C Bus Stop. VISA resource name - Serial Port used by iPortAI device (COMn). Bytes To Read - Specifies the number of bytes to read (See Note 1). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1.Bytes To Read Bytes To Read specifies the number of bytes to read from the slave device. This value can be in the range of 0 to 32767. A byte count of zero indicates a Variable Length message read, where the first byte received from the slave device indicates the number of additional trailing bytes to read. For Variable Length messages, the iPortAI device automatically reads the first byte and all additional bytes from the slave.
Master Transmit Command (Tcmd)	The iPortAI Master Transmit Command (Tcmd) VI sends a /T command to the iPortAI device. The /T command causes the iPortAI device to attempt to access the I²C Bus as a bus master device, and transmit the specified data bytes from the currently selected Destination Slave Address, with or without generating a message terminating I²C Bus Stop. The normal response to the /T command is "/MTC", Master Transmit Complete. Operation: 1. Send a /T command string to the iPortAI device. Terminals - Input: doStop (T) - Controls generation of a message terminating I²C Bus Stop. VISA resource name - Serial Port used by iPortAI device (COMn). I²C Message String - Specifies the data bytes to transmit (See Note 1). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. I²C Message String The Master Transmit Message VI accepts zero or more printable ASCII or Hex-equivalent (~00...~FF) data bytes. The special characters tilde (~) and Carriage Return (CR) have special meaning to the iPortAI device, and must be sent in their Hex-equivalent form (~ = ~7E, CR = ~0D).
Open Command (Ocmd)	The iPortAI Open Command (Ocmd) VI sends a /O command string to the iPortAI device. Upon receiving the /O command, the iPortAI device activates I²C Bus master and slave activities. The normal response is "/OCC", Open Connection Complete. See the iPortAI device User's Guide for details. Operation: 1. Send a /O command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality.
Reset Command (Reset)	The iPortAI Reset Command (Reset) VI sends a reset sequence (Ctrl/R, Ctrl/R, Ctrl/R) to the iPortAI device. This reset sequence is sent at three baud rates (115200, 57600, and 19200). This sequence will reset the iPortAI device at all currently supported baud rates, with a final baud rate of 19200. Upon receiving the Reset command, the iPortAI device terminates I²C Bus master and slave activities, and assumes a reset state. The normal response is "", Ready. See the iPortAI device User's Guide for details. Operation:* 1. Send a reset sequence (Ctrl/R, Ctrl/R, Ctrl/R) to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality.
Set Destination Slave Address Command (Dcmd)	The iPortAI Set Destination Slave Address (Dcmd) VI sends a /D command string to the iPortAI device. The /D command sets the I²C Bus destination slave address for subsequent Master Transmit or Master Receive messages sent by the iPort/AI. The /D command accepts even numbered slave addresses in the range of 0x00 to 0xFE. The normal response is "", Ready. See the iPortAI device User's Guide for details. Operation:* 1. Send a /D command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). Destination Slave Address - Set destination I²C Bus slave address (See Note 1). error in (no error) - Entry error condition (no error). Standard Functionality. Terminals - Output: VISA resource name out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. 1. Destination Slave Address The Destination Slave Address specifies the slave address of the device to receive the I²C Bus message. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Master Transmit slave addresses include even-numbered values between 0x00 and 0xFE (00, 02, 04,... FE). Master Read slave addresses include even-numbered values between 0x02 and 0xFE (02, 04, 06,... FE).
Set My Slave Address Command (Icmd)	The iPortAI My Slave Address (Icmd) VI sends a /I command string to the iPortAI device. The /I command sets the I²C Bus slave address for the iPortAI device. Once the Open Command activates the iPortAI device, it will respond to Master Transmit or Master Receive messages sent by another I²C Bus master device to the iPortAI device slave address. The /I command accepts even numbered slave addresses in the range of 0x02 to 0xFE. The normal response is "", Ready. See the iPortAI device User's Guide for details. Operation:* 1. Send a /I command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). iPortAI's Slave Address - Set iPortAI device own slave address (See Note 1). error in (no error) - Entry error condition (no error). Standard Functionality. Terminals - Output: VISA resource name out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1. iPortAI's Slave Address The iPortAI's Slave Address specifies the slave address of the iPortAI device. The slave address represents the 7 most-significant bits (bbbb-bbb0) sent across the bus following the Start condition. Slave addresses include even-numbered values between 0x02 and 0xFE (02, 04, 06,... FE).
Slave Transmit Command (Scmd)	The iPort/AI Slave Transmit Message (Scmd) VI sends a /S command to the iPortAI device. The /S command should be issued to the iPort/AI in response to a Slave Transmit Request "/STR". This command causes the iPortAI device to write the specified data bytes to the requesting I²C Bus Master Receiver device. The normal response to the /S command is "/STC", Slave Transmit Complete. NOTE: Upon receiving a Slave Transmit request from a Master Receiver device on the I²C Bus, the iPort/AI outputs a Slave Transmit Request "/STR" to its host computer, and initiates an I²C Bus Clock Stretch (SCL line Low) until a /S command is received from the host. While clock stretching, no other messages can be transmitted on the I²C Bus. Operation: 1. Send a /S command string to the iPortAI device. Terminals - Input: VISA resource name - Serial Port used by iPortAI device (COMn). I²C Message String - Specifies the data bytes to transmit (See Note 1). error in (no error) - Entry error condition. Standard Functionality. Terminals - Output: VISA resource out - Serial Port used by iPortAI device (COMn). error out - Exit error condition. Standard Functionality. Notes: 1.I²C Message String The Slave Transmit Message VI accepts zero or more printable ASCII or Hex-equivalent (~00...~FF) data bytes. The special characters tilde (~) and Carriage Return (CR) have special meaning to the iPortAI device, and must be sent in their Hex-equivalent form (~ = ~7E, CR = ~0D).