Related Manuals for MCC iPort/LAN 2
Summary of Contents for MCC iPort/LAN 2
- Page 1 User’s Guide Ethernet to I C Host Adapter ASCII Fast Mode with Circuit Sense www.mcc-us.com...
- Page 2 Local (LAN Connected), or Remote (Internet Connected) I C devices across an I Bus. This user’s guide describes the installation and operation of the iPort/LAN 2 host adapter, Virtual Communication Port (VCP) driver, iPort Utility Pack Software for Windows, and includes the Programmer’s Reference for creating custom applications.
- Page 3 WARNING - Life Support Applications: MCC products are not designed for use in life support appliances, devices, or systems where the malfunction of the product can reasonably be expected to result in a personal injury.
-
Page 4: Table Of Contents
Utility Pack Software ......... 5 iPort/LAN 2 Programmer’s Resources ....... . 5 System Requirements . - Page 5 +5VDC Power Connection ........17 Part 2 - iPort Utility Pack for Windows .
- Page 6 Beep On Arbitration Loss ........32 Beep On Slave Negative Acknowledgment .
- Page 7 Uninstalling VCP Device Driver ........43 Part 3 - iPort/LAN 2 Programmer’s Reference ......44 Quick Start .
- Page 8 2 Connection Closed ........62 Invalid Command Argument ........62 Slave Transmit Request Not Active .
-
Page 9: Part 1 - Iport/Lan 2 Ethernet To I
Part 1 - iPort/LAN 2 Ethernet to I C Bus Host Adapter Part 1 Ethernet C Bus Host Adapter with Circuit Sense ™ User’s Guide Model: MIIC-210... -
Page 10: Overview
PC and one or more direct, local (LAN) or remote (Internet) I devices across an I C Bus. Circuit Sense, our new I C Bus voltage sensing technology, allows the iPort/LAN 2 to work with the latest I C Bus devices at voltages as low as 0.5 volts. - Page 11 2 Product Features: • Access Direct, Local (LAN) or Remote (Internet) I C devices from your PC. • High Performance Processor Increases Throughput (2x to 200x). • External Power Jack or I C Bus Powered (5VDC). • Built-in ESD, Over-voltage, and Reverse-voltage Protection.
- Page 12 2 Package The iPort/LAN 2 package include the following items: • iPort/LAN 2, Ethernet to I C Bus Host Adapter. • I C Bus Mini Clip-lead Cable (5-wire, 1ft.) • Ethernet Interface Cable (Standard, 3 ft.). • Global 5VDC Power Supply.
-
Page 13: Iport/Lan 2 Ethernet To I
1.1 iPort/LAN 2 Ethernet to I C Bus Host Adapter The iPort/LAN 2 host adapter is an Ethernet-based device that plugs into a Direct, Local (LAN), or Remote (Internet) network and generates I C Bus signals. 1.2 iPort/LAN 2 Virtual Communications Port (VCP) The iPort/LAN 2 uses a Virtual Communications Port (VCP) driver to create a virtual serial port within a Windows-based PC. -
Page 14: Interconnects
Ethernet hub, switch, or access point. From that point, a local network, or the Internet, completes the link to the iPort/LAN 2 adapter. A Direct-connect setup uses a crossover Ethernet cable to connect the iPort/LAN 2 directly to the Ethernet port on a host computer. -
Page 15: 5Vdc Power Jack
• RX - Receive Data from the iPort/LAN 2 to the Host Computer. • RTS - Request to Send from the Host Computer to iPort/LAN 2. • CTS - Clear to Send from the iPort/LAN 2 to the Host Computer. 2.2 +5VDC Power Jack The iPort/LAN 2 adapter requires 300ma of REGULATED +5 volt power. -
Page 16: Interrupt (/Int) Signal Connector
/INT signal to a logical low voltage level. The iPort/LAN 2 provides an open-drain /INT signal which can be connected to a corresponding pin on a master or slave device. The /INT signal allows the iPort/LAN 2 to participate in interrupt signaling between master or slave devices. -
Page 17: Hardware Configuration
Power Source Mode - The +V pin can supply power (5v @ 100 mA) Vcc to an external I C Bus system. In Power Source Mode, the voltage of the iPort/LAN 2 SCL, SDA, and /INT internal pull-ups, if enabled, and Voltage Sense circuit (0.3Vcc Low... -
Page 18: Connecting To A Low-Voltage Target System
Packet Error Check byte processing. The non-supported SMBus features may, or may not, permit the use of the I adapter in your SMBus application. Consult the MCC FAQ web page and SMBus Specification for details. -
Page 19: Esd (Electrostatic Discharge) Precautions
4 ESD (Electrostatic Discharge) Precautions Electrostatic discharge is defined as the transfer of charge between bodies at different electrical potentials. Electrostatic discharge can change the electrical characteristics of a semiconductor device, degrading or destroying it. Electrostatic discharge also may upset the normal operation of an electronic system, causing equipment malfunction or failure. -
Page 20: Virtual Comport
2. A Virtual ComPort (VCP) driver is installed on the host computer, and an Ethernet Crossover Cable is used to connect the iPort/LAN 2 to a wired Ethernet Port on the host computer. During VCP driver installation on the host... -
Page 21: Local Connect
Standard Ethernet Cable is used to connect the iPort/LAN 2 to the local network. During VCP driver installation on the host computer, the iPort/LAN 2 is assigned a local Static or Dynamic IP address and a ComPort number. -
Page 22: Vcp Driver Installation
VCP Driver Installation Plug the iPort/LAN 2 into your network and apply power, install the iPort Utility Pack (available on CD or online) on the host computer, and select the iPort/LAN 2 driver installer feature. The iPort/LAN 2 uses the Digi RealPort Virtual ComPort Driver. The Setup Wizard runs at the completion of the iPort Utility Pack installation. - Page 23 The Setup Wizard scans your network for connected iPort/LAN 2 devices. For Direct or Local connected devices, select the found device and click Next. For Remote connected devices, select “Device Not Listed”, and click Next.
- Page 24 Number. Default settings can be accepted as is, or modified as required by your local network administrator. For Remote connected devices, the iPort/LAN 2 should be assigned the public IP address of its local Modem/Router. This information should be available from the remote site network administrator.
-
Page 25: Hardware Set-Up
VCP driver at system power-up and assign the selected communications port number (COMn). You can find the ComPort number assigned to the iPort/LAN 2 by running the iPort Utility Pack Message Center or Message Manager software, and selecting the iPort/LAN device. -
Page 26: Part 2 - Iport Utility Pack For Windows
Part 2 - iPort Utility Pack for Windows Part 2 iPort Utility Pack Windows... -
Page 27: Iport Utility Pack For Windows
1 iPort Utility Pack for Windows The iPort Utility Pack for Windows is your express lane to I C Bus communications. The Utility Pack includes two (2) Windows-based applications (Message Center and Message Manager) that will help you get started sending and receiving I C Bus messages quickly and easily. -
Page 28: Iport Message Manager
1.2 iPort Message Manager The iPort Message Manager operates with all versions of our I C Bus Host Adapters. Using the Message Manager, you can perform all four (4) modes of I Bus message activity, including: • Master Transmit • Master Receive •... -
Page 29: System Requirements
I C Bus devices. 3.1 Installing from the Web Visit MCC’s web site (www.mcc-us.com), and click on the Upgrades/Updates link. 1. Under Application Software, click the iPort Utility Pack for Windows link. 2. Click to download the .ZIP file. -
Page 30: Iport Message Center
4 iPort Message Center The iPort Message Center supports I C Master Transmit and Master Receive activities for all MCC I C Bus host adapters. With this program you can create, save, and execute scripts of I C Master messages. -
Page 31: Message Center Operations
4.1 Message Center Operations Communicating with another device on the I C Bus is easy. Just install the software as described in Section 3, then follow these simple steps: 4.1.1 Starting the Message Center Click, Start Programs iPort Utility Pack iPort Message Center 4.1.2 Selecting the Adapter Select the I... -
Page 32: Select The Communications Port
4.1.3 Select the Communications Port Use the “ComPort:” control to select the communication port connected to the I adapter. If a USB or Ethernet based device is selected, the serial number for the adapter is displayed. In addition to legacy (RS-232), USB, and Ethernet based Virtual Communication Ports, Message Center supports USB and network connected local or remote RS-232 ports via the Windows Com driver. -
Page 33: Set I C Address
Use the I C Message Editor to: 1. Set I C Address. The I C Address is the I C slave address of the slave device being addressed on the bus. All slave addresses are displayed as even numbers (00...FE), representing the 7 most significant bits of the 8-bit slave address transmitted on the bus (aaaa aaa0). -
Page 34: Set Time Delay
across the bus begins with a Start Condition, in this case a Repeated Start. An I C Bus master, that successfully sends a message on the bus, owns the bus until that master sends a message with a terminating Stop Condition. The Repeated Start operation allows the bus master to retain control of the bus while sending one or more messages on the bus. -
Page 35: Inserting And Deleting Messages
4.1.7 Inserting and Deleting Messages You can insert a new message between existing messages by clicking once on a message below where you want to insert, then press the “Insert” key on your keyboard. The Message Editor also remembers the last message displayed, so double clicking on a blank spreadsheet row will allow you to copy a message. -
Page 36: Slave Not Acknowledging
4.1.11 Slave Not Acknowledging If you get a “Slave Not Acknowledging” message in the Status window, this could indicate you have the wrong address in the I C Destination Address, or the device is not answering to its address. Some slave devices temporarily stop acknowledging their address. -
Page 37: Command Line Arguments
4.2 Command Line Arguments The Message Center can be controlled via command line arguments. This feature allows the Message Center to be accessed from a batch file or another program. Message Center Command Line Arguments Command Description iPort, iPort/AI, iPort/AFM, Variable, iPort/USB, Specify I C adapter type.* iPort/LAN, i2cStick, iPortDLL/USB... -
Page 38: Set Adapter Type
(#MIIC-203) iPort/USB iPort/USB (#MIIC-204) iPort/LAN iPort/LAN (#MIIC-205), iPort/LAN 2 (#MIIC-210) i2cStick i2cStick (#MIIC-207) The Adapter Type argument should be the first argument in the argument list as it controls the availability of other arguments. If the Adapter Type is not specified, the startup adapter selection screen will be presented. -
Page 39: Enable /Int Signal Monitor
Set the I C Bus Clock Rate to the specified value. The defaults rate for the Variable Clock adapter is 451Hz. The Variable Clock adapter does not support all rates within the specified range. The Message Center will adjust the specified rate to the nearest available supported rate. -
Page 40: Beep On Arbitration Loss
computer. 4.2.10 Beep On Arbitration Loss BeepOnArbLoss (Default=OFF) Generate a host computer beep if the adapter returns a "Bus Arbitration Loss" response to the host computer. Bus Arbitration Loss occurs when another I C Bus master wins arbitration while the adapter is attempting to become a bus master. 4.2.11 Beep On Slave Negative Acknowledgment BeepOnNak (Default=OFF) Generate a host computer beep if the adapter returns a "Slave Not Acknowledging"... -
Page 41: Saved I C Message List File
4.2.14 Saved I C Message List File AutoSave=filename AutoSave="file name" Automatically save message list to the specified file upon executing AutoExit. Use to save message data read from a slave transmitter device. 4.2.15 Auto Open AutoOpen Auto Open Link to I C Adapter Open link to the adapter. -
Page 42: Iport Message Manager
5 iPort Message Manager The iPort Message Manager supports I C Master and Slave, Transmit and Receive activities for all MCC I C Bus host adapters, allowing a PC to become an I Master or Slave device, transmitting or receiving I... -
Page 43: Message Manager Operations
5.1 Message Manager Operations Communicating with another device on the I C Bus is easy. Just install the software as described in Section 3, then follow these simple steps: 5.1.1 Starting the Message Manager Click, Start Programs iPort Utility Pack iPort Message Manager 5.1.2 Select the Adapter Select the I... -
Page 44: Establish Adapter Communications Link
5.1.3 Establish Adapter Communications Link On the main screen, click the Open button to view the Set Up Screen. Three levels of setup options are available, Basic, Advanced, and Diagnostic. Only Basic setup is required. Basic Set Up Screen 5.1.3.1 Basic Setup Use the “ComPort”... -
Page 45: Advanced Setup
Advanced Set Up Screen 5.1.3.2 Advanced Setup On the Advanced Setup screen you can set the following parameters: Adapter’s Own I C Slave Address Select the I C adapter’s own slave address. The adapter will acknowledge messages sent to this slave address. The default address is 0x6E. General Call Enable General Call Enable allows the I C adapter to respond as a slave receiver to the I... -
Page 46: Diagnostic Setup
Diagnostic Set Up Screen 5.1.3.3 Diagnostic Setup (on supported adapters) On the Diagnostic Set-up screen you can set the following parameters: Log File Level A log file is available for troubleshooting communication problems between the host computer and the I C adapter. -
Page 47: Sending I C Messages
5.1.4 Sending I C Messages 5.1.4.1 Master Operations 5.1.4.1.1 Specifying the Destination Address The Destination Address is the I C slave address of the slave device being addressed on the bus. All slave addresses are displayed as even numbers (00...FE), representing the 7 most significant bits of the 8-bit slave address transmitted on the bus (aaaa aaa0). -
Page 48: Auto Repeat
5.1.4.1.3 Auto Repeat The situation often arises, where you would like to automatically repeat a master message operation. The Message Manager supports auto-repeat with the Auto Repeat checkbox. You can automatically repeat a master operation by checking the Auto Repeat control before clicking the Master Tx, Master Rx, or Master TxRx buttons. -
Page 49: Sending Master Transmit Messages
Click OK to accept the data. Sending Master Transmit Messages Click the Master Tx button to write the specified Master Tx Data Bytes to the selected destination slave device. If Auto Repeat is checked, the message will automatically repeat upon completion. The Communications Events window on the main screen should report “Master Tx Complete.”... -
Page 50: Negative Acknowledge Last Byte
Negative Acknowledge Last Byte On supported adapters, the doNak checkbox gives you the option to acknowledge, or negatively acknowledge, the last byte read from a slave device. Some Slave Transmitter Devices require a negative acknowledgment on the final byte read from the slave device. -
Page 51: Uninstalling Iport Utility Pack For Windows
based and LAN-based adapters, the Virtual Communications Port (VCP) Device Driver. The following instructions can be used to remove either or both software components from your computer. 6.1 Uninstalling iPort Utility Pack for Windows To uninstall the iPort Utility Pack for Windows software, use the Windows Control Panel “Programs and Features”... -
Page 52: Part 3 - Iport/Lan 2 Programmer's Reference
Part 3 - iPort/LAN 2 Programmer’s Reference Part 3 Programmer’s Reference ASCII Command Interface Definitions... -
Page 53: Quick Start
MS.NET Class Library or LabVIEW VI Library for custom application development. Creating a custom iPort/LAN 2 program is easier if you know what to expect. Follow these steps to manually control the iPort/LAN 2 from your computer’s keyboard and screen using a terminal emulation application. -
Page 54: Ascii Command Interface
2 ASCII Command Interface Note: [CR] = Carriage Return Code or Enter Key. Syntax: [Select], (Optional), xx = [00..FE], n = [0..32767] Command Description Ctrl/R,Ctrl/R,Ctrl/R iPort/LAN Reset This command resets the iPort/LAN to its default state. //[CR] Status Display Display iPort/LAN status information. -
Page 55: Synchronous Interface Events
Display Tx bYte Count Display number of data bytes last sent to slave device (Requires iPort/AFM Firmware v2.0+, iPort/AI 2, iPort/AFM 2, iPort/USB, i2cStick, iPort/USB 2, iPort/LAN 2). *= Also display last received Ack bit received from slave device (Requires iPort/AI 2, iPort/AFM 2, i2cStick, iPort/USB 2, iPort/LAN 2). -
Page 56: Status Display
'Baud Change Complete Response 3: /BC2[CR] 'Baud Change Complete Response 3: /I89[CR] 'Invalid Command Argument Default Setting: /B0[CR] Close I C Connection Disconnect iPort/LAN 2 from the I C Bus. Command: /C[CR] 'Close I C Connection Response: /CCC[CR] 'Close Connection Complete... -
Page 57: Set Destination I C Slave Address
Transmit or Receive operations. Command: /Dxx[CR] 'Set Destination I C Slave Address Response 1: * 'iPort/LAN 2 Ready Response 2: /I89[CR] 'Invalid Command Argument Default Setting: 00 Echo/Prompt Control This command enables or disables data entry echo and prompts used as feedback to manual operations from a computer terminal. -
Page 58: I 2 C General Call Control
Response: * 'iPort/LAN 2 Ready Default Setting: XON/XOFF C General Call Control Enables or disables iPort/LAN 2 response to I C Bus General Call (Address x00) messages. Command: /G[0|1][CR] 'I C General Call [0 = Disabled, 1 = Enabled] Response: *... -
Page 59: Set Iport/Lan's Own I
Sets iPort/LAN 2's own I C Slave Address (Hex 2...FE). Subsequent I C messages to this address will cause iPort/LAN 2 to become an active Slave device on the bus. Command: /Ixx[CR] 'Set iPort/LAN 2’s Own I C Slave Address... -
Page 60: Interrupt Signal Control/Status
Extended Cmds (See Prompt or User's Guide) /(*)Y Display Tx bYte Count *with Last Rx Ack Bit Interrupt Signal Control/Status The INT signal allows the iPort/LAN 2 to participate in INT master and/or slave communications. Control Command: /N0[CR] Disable Monitor... -
Page 61: Master Read Message
If the slave device acknowledges its I C Slave Address, the specified number of bytes are read. The iPort/LAN 2 acknowledges all bytes read except the last. If not disabled, the message is then terminated with an I C Stop condition. - Page 62 Note 1: Upon receiving a Slave Transmit request from a Master Receiver device on the I C Bus, the iPort/LAN 2 outputs a Slave Transmit Request to its Host device, and initiates an I C Clock Stretch (SCL Low) until a Slave Transmit command is received from the Host computer.
-
Page 63: Master Transmit Message
Note: The tilde (~) character and the Carriage Return (CR) characters are used as special marker characters within all iPort/LAN 2 transmitted text messages. These characters may not be used within the text of a message, but must be replaced by the following "Hex-equivalent"... -
Page 64: Set I 2 C Bus Time-Out In Msec
Set I C Bus Time-oUt in msec Set bus time-out in milliseconds. The iPort/LAN 2 reports a bus time-out if no inter-byte bus activity for the specified time occurs within an I C Bus message. Command: /Unnnnn[CR] C Bus time-oUt (nnnn = 0 (disable)...32000 msec) - Page 65 Command: /X[S|~xx|R|r|P|0|1|?|D|d|C|c|L|A| |"]..., then Press Enter or ESCape Enter /X followed by zero or more sub-commands, the [CR] Response: /XCC(see commands below)[CR] High Level Sub-Commands: S = Send Start ~xx = Send Byte (xx = 00...FF)(response = A or N) R = Read Byte with Ack (response = ~xx) r = Read Byte with Nak (response = ~xx) P = Send Stop...
- Page 66 Mid Level Command:/X S 01001110 ? 00000001 ? 00000010 ? 00000011 ? P [CR] Mid Level Response: /XCC0000[CR] Low Level Command:/X dc dCcDCcdCcdCcDCcDCcDCcdCc DCAc dCcdCcdCcdCcdCcdCcdCcDCc DCAcdCcdCcdCcdCcdCcdCcDCcdCc DCAc dCcdCcdCcdCcdCcdCcdCcDCc DCAc dCD[CR] Low Level Response: /XCC0000[CR] Master read three bytes from slave address 0x4F. First two bytes are acknowledged by master.
-
Page 67: Display Tx Byte Count
Response: /XCCAA[CR] Display Tx bYte Count Returns the number of bytes received by the slave device in the last master transmit message, with an option to receive the state of the last received Acknowledgment bit. Note: The byte count and last received acknowledgment bit state can be used for SMBus Packet Error Check (PEC) error detection. -
Page 68: Asynchronous Interface Events
Note: Upon receiving a Slave Transmit request from a Master Receiver device on the I C Bus, iPort/LAN 2 outputs a Slave Transmit Request to its Host device, and initiates an I C Clock Stretch (SCL Low) until a Slave Transmit Text command is received from the Host computer. -
Page 69: Iport/Lan Ready
Prompt: /I81[CR] ‘iPort/LAN 2 Busy Cause: The host computer attempted a Master operation while iPort/LAN 2 was busy. The host computer should wait for any previously issued command to complete, process any pending slave events, and retry the last command. -
Page 70: I 2 C Bus Time-Out Detected
Prompt: /I85[CR] ‘I C Bus Time-out Detected Cause: iPort/LAN 2 issues this response when it detects a byte transfer delay greater than the specified I C Bus Time-oUt period. No corrective action is taken by the iPort/LAN 2 regarding I C Bus activity. -
Page 71: Iport/Lan Receive Buffer Overflow
Prompt: /I90[CR] ‘iPort/LAN 2 Serial Receive Buffer Overflow Cause: This event normally indicates that data sent to the iPort/LAN 2 via the serial port has been lost. Check the host computer’s Serial Port Flow Control (XON/XOFF, or Hardware) to make sure it matches current iPort/LAN Flow Control. -
Page 72: Example Code
Example Code The following examples are written in MS Visual Basic V3 for Windows using the serial communications control (MSCOMM.VBX). It can be used as a guide in implementing iPort/LAN 2 interface programs in other programming languages and operating environments. Note: Sample code is also available online at: www.mcc-us.com... -
Page 73: Communication Event Processing
If Msg$ = Chr$(13) Then Msg$ = "" ' Remove CR If Msg$ = Chr$(10) Then Msg$ = "" ' Remove LF If Msg$ = "*" Then ' if iPort/LAN 2 Ready Msg$ = "****" ‘ Substitute Token CharIn$ = Chr$(13) ‘ Terminate Line... - Page 74 'Update Display ' Test for iPort/LAN Response Messages ElseIf (StrComp(iPortResp$, "****") = 0) Then TextBox.Text = "* iPort/LAN 2 Ready" 'Update Display ElseIf (StrComp(iPortResp$, "/SNA") = 0) Then TextBox.Text = "/SNA Slave Not Acknowledging" ElseIf (StrComp(iPortResp$, "/I81") = 0) Then TextBox.Text = "/I81 iPort/LAN 2 Busy"...
- Page 75 TextBox.Text = "/I83 Arbitration Loss" 'Update Display ElseIf (StrComp(iPortResp$, "/I84") = 0) Then TextBox.Text = "/I84 I2C Bus Error Detected" ElseIf (StrComp(iPortResp$, "/I85") = 0) Then TextBox.Text = "/I85 I2C Bus Time-out Detected" ElseIf (StrComp(iPortResp$, "/I88") = 0) Then TextBox.Text = "/I88 iPort/LAN Connection Closed" ElseIf (StrComp(iPortResp$, "/I89") = 0) Then TextBox.Text = "/I89 Invalid Command Argument"...
-
Page 76: Iport/Lan Revision Report
Revision Report This section defines revisions and changes made to the iPort/LAN 2 interface: Revision: 1.00 1 Initial Release Additional Information For additional information on the I C Bus, please refer to the following: “What is I C?” www.mcc-us.com/I2CBusTechnicalOverview.pdf “Frequently Asked Questions (FAQ)”... -
Page 77: Appendix A - I C Connector Information
Appendix A - I C Connector Information C Bus Interface Connector and Plug Information The iPort/LAN 2 uses the following 1x5 2.54 mm (.100") pitch, 0.64 mm (.025") square pin, header and plug assemblies for the I C Bus interface. -
Page 78: Declaration Of Conformity
CE Declaration of Conformity We, Micro Computer Control Corporation, of 83 Princeton Avenue #1D / PO Box 275, Hopewell, New Jersey 08525 USA, declare under our sole responsibility that the iPort/LAN 2 (#MIIC-210), to which this declaration relates, is in conformity with EN55032:2015,...
Need help?
Do you have a question about the iPort/LAN 2 and is the answer not in the manual?
Questions and answers