MCC i2cStick User Manual

Usb to i2 c bus host adapter
Table of Contents

Advertisement

Quick Links

User's Guide
2
USB to I
C Bus
Host Adapter
with iPort Utility Pack Software
www.mcc-us.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the i2cStick and is the answer not in the manual?

Questions and answers

Summary of Contents for MCC i2cStick

  • Page 1 User’s Guide USB to I C Bus Host Adapter with iPort Utility Pack Software www.mcc-us.com...
  • Page 2 C? Want to know more? We suggest you review “What is I C?” at www.mcc-us.com/I2CBusTechnicalOverview.pdf. This MCC product uses NXP (Philips) components and is licensed to use the I²C Bus. “Purchase of Philips I²C components conveys a license under the Philips’ I²C patent to use the components of the I²C system, provided the system conforms to...
  • 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

    Programmer’s Reference ........3...
  • Page 5 2 System Requirements ..........15 3 iPort Utility Pack Installation .
  • Page 6 Uninstalling VCP Device Driver ........37 Part 3 - i2cStick Programmer’s Reference ......39...
  • Page 7 Connection Closed ........
  • Page 8 Initialization ........
  • Page 10: Part 1 - I2Cstick Usb To I C Bus Host Adapter

    Part 1 - i2cStick USB to I C Bus Host Adapter Part 1 USB to I C Bus Host Adapter User’s Guide Model: MIIC-207...
  • Page 11: Overview

    The i2cStick package includes the following items: 1.1 i2cStick USB to I C Bus Host Adapter The i2cStick adapter is a bus-powered USB device that plugs into a host computer’s USB port or self-powered USB hub and generates I C Bus signals.
  • Page 12: Iport Utility Pack Software

    Manager applications to help you easily send and receive I C Bus messages. 1.4 i2cStick Programmer’s Reference This section of the i2cStick User’s Guide provides a programmer’s guide to creating custom I C Bus applications. Find additional sample programs and complete projects on our web site’s Sample Program page.
  • Page 13: Virtual Communications Port (Vcp)

    USB hub. The i2cStick operates as a low-power (<100 mA) bus-powered USB device. 2.1.1 Virtual Communications Port (VCP) The i2cStick provides a Virtual Communications Port (VCP) interface via a host computer driver. Install the iPort Utility Pack (available on CD or online) and plug the i2cStick into a USB port.
  • Page 14 C Bus Pinout C Bus Connector An i2cMini Interface Cable 1x5 2.54 mm (.100") is provided to connect the I adapter to an external I C Bus. An optional i2cMini Clip-Lead cable is available to connect the I C adapter to a target system.
  • Page 15: Hardware Configuration

    C Bus system must have at least one pull-up on the signal lines. Use this switch to configure the pull-up resistors for your system. 3.2 Connecting a 5V i2cStick to a 3.3 Volt Target System If you are connecting a 5 volt I C adapter to a 3.3 volt target system, you should...
  • Page 16: Esd (Electrostatic Discharge) Precautions

    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 17: Grounding Solutions

    1. Driver Install The i2cStick uses a Virtual Communications Port (VCP) driver that is pre- installed with the iPort Utility Pack CD (See the installation instructions in “Part 2 - iPort Utility Pack for Windows” of this User’s Guide). Pre- installation places the VCP driver into the Windows Driver Store, ready for installation when the i2cStick is first plugged into the host computer.
  • Page 18: Driver Update

    Windows Device Manager (Start | Settings | Control Panel | System | Device Manager | Ports (COM & LPT)) to see the current version of the i2cStick driver installed on your computer, and determine if new driver is available. If a new VCP driver is available, follow website instructions to download and install a driver update on your computer.
  • Page 19: I 2 C Bus Connection

    +V wire to your target system. Refer to the “Hardware Configuration” section for details on pull-up resistors and connecting the optional +V wire. If you have any questions on I C adapter setup and configuration, please visit our FAQ page (http://www.mcc-us.com/faq.htm), or contact our technical support team (support@mcc-us.com).
  • Page 20: Part 2 - Iport Utility Pack For Windows

    Part 2 - iPort Utility Pack for Windows Part 2 iPort Utility Pack Windows...
  • Page 22: 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 23: 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 24: System Requirements

    Run and type “D:SETUP.EXE.” Click OK. 3. Follow instructions on screen. 3.2 Installing from the Web Visit MCC’s web site (www.mcc-us.com), and click on the Upgrades/Updates link. 1 Follow the instructions listed on the Upgrade/Update web page for your specific adapter.
  • Page 25: 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 26: 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 27: 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-based device is selected, the serial number for the adapter is displayed (Win 2000, XP+ only). In addition to legacy RS-232 ports and USB- based Virtual Communication Ports, Message Center supports USB and network connected local or remote RS-232 ports via the Windows Com driver.
  • Page 28: 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 29: 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 30: 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 31: 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 32: Command Line Arguments

    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, Specify I C adapter type.* iPort/USB, i2cStick COM1...COM99 Specify RS-232 communication port. BAUD19200, BAUD57600, BAUD115200 Set RS-232 Baud Rate.* CLOCK12.5K, CLOCK23K, CLOCK86K, Set I C Bus Clock Rate.*...
  • Page 33: Set Adapter Type

    4.2.3 Set RS-232 Baud Rate BAUD19200 (Default*) BAUD57600 (iPort/AFM, iPort/USB, i2cStick* ONLY) BAUD115200 (iPort/AFM, iPort/USB, i2cStick* ONLY) Set the RS-232 Baud Rate. *i2cStick internally re-maps to 115.2K baud. 4.2.4 Set I C Bus Clock Rate CLOCK12.5K (iPort ONLY) CLOCK23K (iPort/AFM, iPort/USB, i2cStick ONLY)
  • Page 34: Enable /Int Signal Monitor

    nearest available supported rate. 4.2.5 Enable /INT Signal Monitor Monitor/INT (on INT signal supported adapters only. Default=OFF) Enable /INT signal monitoring. 4.2.6 Stop On Busy StopOnBusy (Default=OFF) Stop sending I C messages if the adapter returns a "Busy" response to the host computer.
  • Page 35: Beep On Arbitration Loss

    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 36: 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 37: 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 38: 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 39: 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 40: 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 41: 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 42: 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 43: 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 44: 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 45: 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 46: Uninstalling Software Components

    6 Uninstalling Software Components Software components include the iPort Utility Pack for Windows, and for USB- 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 48: Part 3 - I2Cstick Programmer's Reference

    Part 3 - i2cStick Programmer’s Reference Part 3 Programmer’s Reference ASCII Command Interface Definitions...
  • Page 49: Quick Start

    Programmer’s Quick Start Creating a custom i2cStick program is easier if you know what to expect. Follow these steps to manually control the i2cStick from your computer’s keyboard and screen. 1 Install the i2cStick as directed in the “Hardware Set-Up” section of this User’s Guide.
  • Page 50: Ascii Command Interface

    Display i2cstick status information. /B[0|1|2][CR] Serial Communication Baud Rate Control Set the serial communication baud rate (0 = 19.2K, 1 = 57.6K, 2 = 115.2K Baud). Note: For backward compatibility only. i2cStick internally re-maps all three baud rates to 115.2K. /C[CR] Close I...
  • Page 51: Synchronous Interface Events

    Display number of data bytes last sent to slave device. * = Also display last received Acknowledgment bit from slave device. Synchronous Interface Events Synchronous Events are those i2cStick interface activities initiated by the Host computer. i2cStick Reset Reset i2cStick to its default state.
  • Page 52: Status Display

    Response 3: /BC2[CR] 'Baud Change Complete Response 3: /I89[CR] 'Invalid Command Argument Default Setting: /B0[CR] NOTE: The Serial Communications Baud Rate command is supported for backward compatibility only. i2cStick internally re-maps all three baud rates to 115.2K baud. Close I C Connection...
  • Page 53: Set Destination I 2 C Slave Address

    Host computer. i2cStick implements either XON/XOFF (by default) or RTS/CTS flow control protocols. Flow control is used by the i2cStick to limit character flow to and from the Host computer to avoid overflowing internal communication buffers and lost data.
  • Page 54: I 2 C General Call Control

    Command: /F[0|1][CR] Flow Control [0 = XON/XOFF, 1 = RTS/CTS] Response: * 'i2cStick Ready Default Setting: XON/XOFF C General Call Control Enables or disables i2cStick 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 55: Set I2Cstick's Own I

    C Slave Address Sets i2cStick's own I C Slave Address (Hex 2...FE). Subsequent I C messages to this address will cause i2cStick to become an active Slave device on the bus. Command: /Ixx[CR] 'Set i2cStick's Own I C Slave Address...
  • Page 56: Interrupt Signal Control/Status

    Extended Cmds (See Prompt or User's Guide) /(*)Y Display Tx bYte Count *= with last received Ack bit Interrupt Signal Control/Status The i2cStick does not support the INT signal. The following commands and responses are provided for backward compatibility only. Control Command:...
  • Page 57: Master Read Message

    Default Setting: Closed Master Read Message This command causes i2cStick to read the specified number of data bytes from the currently selected Destination I C Slave Address with or without generating an I Stop condition after the last byte is received.
  • Page 58: Slave Transmit Message

    This command should be issued to i2cStick in response to a Slave Transmit Request (/STR). This command causes i2cStick to write the specified data bytes to the requesting I C Master Receiver device. Enter Message Bytes (1 or more Printable ASCII or Hex-equivalent ~00..~FF), then Press Enter, or ESCape to Cancel.
  • Page 59: Master Transmit Message

    Note: The tilde (~) character and the Carriage Return (CR) characters are used as special marker characters within all i2cStick 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 60: Set I 2 C Bus Time-Out In Msec

    Set I C Bus Time-oUt in msec Set bus time-out in milliseconds. The i2cStick 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 61 commands use firmware to "bit-bang" the SCL and SDA lines. This firmware cannot operate as fast as the hardware, and it can be interrupted at any time by adapter internal interrupts. The eXtended commands run directly off the command characters as they are received on the serial link. Speed of execution of eXtended commands is controlled by the serial link communication rate, the execution speed of the firmware, delays caused by execution interruptions that may occur while a command is executing, and I...
  • Page 62 Miscellaneous Sub-Commands: space = no action "comment" = no action Examples: Master transmit three bytes to slave address 0x4e using high level, mid level, and low level sub-commands. High Level Command:/X S ~4e ~01 ~02 ~03 P [CR] High Level Response: /XCCAAAA[CR] Mid Level Command:/X S 01001110 ? 00000001 ? 00000010 ? 00000011 ? P [CR] Mid Level Response: /XCC0000[CR] Low Level Command:/X dc dCcDCcdCcdCcDCcDCcDCcdCc DCAc...
  • Page 63: Display Tx Byte Count

    Issue a Read WCR command to a Xicor X9241 at slave address 0x50. Command: /X S ~50 ~90 ~R P [CR] Response: /XCCAA~xx[CR] ‘(xx = 00...FF) Issue an Increment Wiper command to a Xicor X9241 at slave address 0x50. Command: /X S ~50 ~20 1 P [CR] Response: /XCCAA[CR] Issue a Decrement Wiper command to a Xicor X9241 at slave address 0x50.
  • Page 64: Asynchronous Interface Events

    Note: Upon receiving a Slave Transmit request from a Master Receiver device on the I C Bus, i2cStick 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 65: I2Cstick Ready

    Busy Prompt: /I81[CR] ‘i2cStick Busy Cause: The host computer attempted a Master operation while i2cStick 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 66: I 2 C Bus Time-Out Detected

    C Bus Time-out Detected Prompt: /I85[CR] ‘I C Bus Time-out Detected Cause: i2cStick 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 i2cStick regarding I C Bus activity.
  • Page 67: I2Cstick Receive Buffer Overflow

    Prompt: /I90[CR] ‘i2cStick Serial Receive Buffer Overflow Cause: This event normally indicates that data sent to the i2cStick 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 i2cStick Flow Control. Also, check if the host computer’s FIFO buffers in its 16550 UART are enabled.
  • Page 68: 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 i2cStick interface programs in other programming languages and operating environments. Note: Sample code is also available online at: www.mcc-us.com...
  • Page 69: Communication Event Processing

    If CharIn$ = Chr$(13) Then ' if Carriage Return detected iPortResp$ = Left$(LineBuf$, 4) 'Isolate Response Code ' Test for i2cStick Synchronous Interface Events If (StrComp(iPortResp$, "/OCC") = 0) Then ' Open Connection Complete Processing TextBox.Text = "/OCC Open Connection Complete"...
  • Page 70 ElseIf (StrComp(iPortResp$, "/BC0") = 0) Then ' i2cStick Baud Change 0 {19.2K} TextBox.Text = "i2cStick Baud Change 0 {19.2K} " ElseIf (StrComp(iPortResp$, "/BC1") = 0) Then ' i2cStick Baud Change 1 {57.6K} TextBox.Text = "i2cStick Baud Change 1 {57.6K} "...
  • Page 71 TextBox.Text = "/I8A Slave Tx Request Not Active" ElseIf (StrComp(iPortResp$, "/I8F") = 0) Then TextBox.Text = "/I8F Invalid i2cStick Command" ElseIf (StrComp(iPortResp$, "/I90 = 0) Then TextBox.Text = "/I90 i2cStick Rx Buffer Overflow” Else TextBox.Text = LineBuf$ 'Other Update Display End If LineBuf$ = ""...
  • Page 72: I2Cstick Revision Report

    Revision Report This section defines revisions and changes made to the i2cStick 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 73: Appendix A - I C Connector Information

    Appendix A - I C Connector Information C Bus Interface Connector and Plug Information The i2cStick 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. C Header Molex C-Grid®...
  • Page 74 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 i2cStick (#MIIC-207), to which this declaration relates, is in conformity with General Emissions Standard EN55022 (CISPR22): 2006 Class A, and General Immunity Standard EN 55024: 1998 + A1:2001 + A2: 2003.

Table of Contents