Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual USB Serial Adapter Software (version 2.x) for Mac OS X User Manual Table of Contents 1.1 - Introduction 2.1 - Mac OS X vs 'Classic' Drivers - Important 3.1 - Installation Instructions 4.1 - Configuring Your Serial Device 5.1 - Keyspan Serial Assistant 6.1 - Problem Solving 7.1 - Appendices - 7.1.a - Frequently Asked Questions (FAQs) 7.1.c - Configuration Examples for Mac OS X - 7.1.cx.01 - Palm Desktop 7.1.cx.02 - Modem/Cell Phone PPP Setup 7.1.cx.03 - VirtualPC 7.1.cx.04 - Final Cut Pro 7.1.u - Uninstalling Keyspan software 7.1.z - Support Information 2 3 6 8 10 12 14 15 16 17 22 27 35 38 40 Rev 2006aug07 Page 1 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual 1.1 - Introduction The Keyspan USB Serial Adapter Software for Mac OS X allows you to add serial ports to your Mac OS X computer. Using Mac OS X native software, you can use your Keyspan USB to Serial Adapter to communicate with various serial devices via the POSIX API (for more information, Serial Ports - Mac OS X vs 'Classic' Mac OS section in this manual) . Important Note: The Keyspan USB Serial Adapter Software for Mac OS X will add 'Mac OS X serial ports' to your computer. These 'Mac OS X serial ports' can only be used by Mac OS X native software (ie a program that does not require the Classic environment to run). If you are not certain if your serial device's software can access Mac OS X serial ports, please read the Serial Ports - Mac OS X vs 'Classic' Mac OS section in this manual. Examples of serial devices that use Mac OS X serial ports are modems using PPP (for internet access - configured via the Networking System Preference icon), Palm Handhelds (using Palm's HotSync Manager), and UPS devices (using PowerGuardian software - www.benatong.com). Requirements The Keyspan USB Serial Adapter Software for Mac OS X requires the following: · Macintosh: · At least one available USB port · Mac OS X (10.2.8 or greater) · For use with one of the following Keyspan USB to Serial Adapters: USB Twin Serial Adapter (pn# USA-28X, USA-28XG) USB PDA Adapter (pn# USA-19, USA-19X, USA-19Qi, USA-19Q) High Speed USB Serial Adapter (pn# USA-19W, USA-19QW) USB 4-Port Serial Adapter (pn# USA-49W, USA49WLC, 4E230) USB Serial Port Adapter (pn# USA-18X) USB Serial Adapter (pn# USA-28) Mini Port Replicator (pn# UPR-112/UPSH-112 - only supports serial) USB Serial Adapter (pn# USA-19H, USA-19HS, USA-19HG) Note: This documentation applies to Keyspan's USB Serial Adapter Software for Mac OS X and covers the features and use of this software on that platform. For specific information about Keyspan's USB to Serial Adapter hardware, please visit Keyspan's web page or read the Keyspan Mac OS 9 User Manual for that product. Rev 2006aug07 Page 2 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual 2.1 - Mac OS X vs 'Classic' Drivers - Important Mac OS X compatible Keyspan USB to serial adapters typically also have Mac OS 8.6-9.x drivers. Depending on the serial device you intend to connect to your Mac (ie Palm Pilot, GPS, modem, etc), you may need to uninstall Keyspan's Mac OS X software. This section is intended to help you determine which Keyspan drivers you should install. Terms Used In This Section Before reading this section, please familiarize yourself with the following terms: Mac OS X Mac OS X refers to any version of Mac OS X. This is Apple's current operating system. Classic (Mac OS 9.2.2 running within Mac OS X) Classic refers to Mac OS 9.2.2 running within Mac OS X. Classic is only available on non-Intel Macs (ie G3, G4, G5 computers). Please note that Classic is an emulator and is not the same as booting your Mac directly into Mac OS (see below). Mac OS Mac OS refers to Apple's Mac OS versions prior to Mac OS X (ie Mac OS 8.6 9.2.2). In this section, we will refer to Mac OS when referring to Macs that have been booted directly into Mac OS 8.6 - 9.x. This is not the same as running Classic. Which Keyspan Software Should I Use? In order for a serial device (ie Palm Pilot, GPS, modem, etc) to work on your Mac, all serial devices require the following: · a serial device (ie Palm Pilot, GPS, modem, etc) · software that communicates with that serial device (ie Palm software for Palm PDAs, terminal software for Cisco routers, GPS software for GPS units). This is typically the software that you launch before using the device · a serial port (HARDWARE) to connect the serial device to physically (provided by your Keyspan adapter) · a serial port (SOFTWARE) for your serial device's software to point to If your serial device has Mac OS X compatible software, meaning that the software DOES NOT RUN REQUIRE CLASSIC, install Keyspan's Mac OS X software. Rev 2006aug07 Page 3 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual If your software requires Classic and has not been updated to work with Mac OS X, install the Keyspan OS 8.6 - 9.x drivers. DO NOT INSTALL THE MAC OS X drivers. If you install the Keyspan Mac OS X drivers, Mac OS X will control your Keyspan adapter and it will not 'share' it with Classic. Uninstall the Keyspan Mac OS X drivers to resolve this issue. IMPORTANT NOTE: There is no way to make a Keyspan adapter work in two OSes at the same time (ie both Mac OS 9.2.2 via Classic and Mac OS X). Please make sure you only install one driver. If your serial device's software requires the 'Classic' environment to run under Mac OS X, please skip ahead to 'classic' Mac OS Serial Ports & Serial Devices ... If your serial device's software is Mac OS X native software, please skip ahead to Keyspan Mac OS X Serial Ports & Serial Devices ... If you are not sure if your serial device has Mac OS X native software, please read the rest of this section ... 'Classic' Mac OS Serial Ports & Serial Devices Serial devices under theMac OSes (Mac OS 8.x-9.x) access serial ports via the following software: the Chooser (ie printers) applications (ie Palm Pilots) Control Panels (ie Wacom tablets) Regardless of which software you used, your serial device was communicating with software libraries that handled the very low level communications between your serial device hardware and your serial port. These low level software libraries (specifically: Communications Resource Manager (CRM), CommToolBox (CTB), and OpenTransport) are unique to the pre-Mac OS X OSes (9.2.2 and below) and are not found on Mac OS X. Unfortunately, 'older' serial programs cannot communicate with Mac OS X serial ports. Therefore, if your serial device's software only works on a 'older' Mac OSes, installing the USB Serial Adapter software for Mac OS X will not make your serial device work under Mac OS X. If your serial device's software only runs in 'classic' Mac OSes, you have several options: · Try to get your serial device to work using your existing 'classic' hardware and software (the hardware and software that ran on Mac OS 8.1 through 9.x) via Mac OS X CLASSIC environment. If this does not work, please try option 2. Rev 2006aug07 Page 4 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual · Boot into Mac OS 9.x and use your serial device from there. Keyspan, Mac OS X Serial Ports & Serial Devices Serial devices that run natively on Mac OS X access serial ports via the following software: System Preferences Mac OS X applications terminal applications Regardless of which method is used, your serial device communicates with a software library called POSIX (aka POSIX API). When a Keyspan adapter is connected, the Keyspan USB Serial Adapter software for Mac OS X registers a port with the IORegistry (this is another software library). At this point, a program can get the list of available serial ports (including Keyspan serial ports) from IORegistry. Once the program has the list available serial ports, the program uses the POSIX API to communicate with the serial port. Note: If you are a developer and need more information about using Mac OS X serial ports, please visit our Developer web page at: Using the Keyspan Serial Assistant application, you see which Keyspan serial ports have been added to Mac OS X. This is useful in determining which port to select in your serial device's software. Please read the Keyspan Serial Assistant section later in this manual for details about the Keyspan Serial Assistant. Please note, the POSIX API is unique to Mac OS X and cannot be used by applications running under the Classic environment. Rev 2006aug07 Page 5 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual 3.1 - Installation Instructions Installing the USB Serial Adapter Software for Mac OS X Note: Only proceed if you are sure that your serial device and its software are Mac OS X compatible. If you are not sure about this, please read the Serial Ports - Mac OS X vs 'Classic' Mac OS section in this manual for further information. Step 1 - Insert the Keyspan Serial Adapter CD-ROM Place the CD into the CD-ROM drive. When the CD icon appears on your desktop, double click on this icon to display its contents. Locate the Keyspan Mac OS X folder and then locate the Keyspan USB Serial Software for Mac OS X Installer. Step 2 - Run the Keyspan USB Serial Software for Mac OS X Installer Run the Keyspan USB Serial Software for Mac OS X Installer by double clicking the Keyspan USB Serial Software for Mac OS X installer icon. This will start the installer. Once the installer is running, follow the instructions on screen. Note: The installer requires that you enter an administrator password before the Keyspan software can be installed. Generally, this password will be the same as your standard password. To enter the password, click on the lock icon in the lower left-hand section in the installer window. The Keyspan USB Serial Adapter software is now installed. Step 3 - Software Installation Complete! Now that you have installed the Keyspan USB Serial Adapter software, you are ready to install the Keyspan USB Serial Adapter hardware. Please proceed to the installing the Keyspan USB Serial Adapter Hardware instructions. Rev 2006aug07 Page 6 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual Installing the Keyspan USB Serial Adapter Hardware The following hardware installation instructions provide a basic overview on installing the Keyspan USB Serial Adapter in a USB port. For detailed instructions on how to connect USB devices your specific computer, please refer to the USB Device Install section in your computer's user's manual. Step 4 - Connect the USB cable to the Adapter (if necessary) If your Keyspan adapter does not have an attached USB cable, attach the included USB cable into the Keyspan adapter's USB port. Step 5 - Connect the Adapter to your USB port Attach the Adapter to your computer by connecting the Adapter's USB cable into any built-in USB port on your computer or USB Hub. It is not necessary to turn off your computer when attaching the Adapter. Step 6 - Hardware Installation Complete! Your Keyspan USB Serial Adapter is ready for use now that you have installed hardware and software. Please proceed to the Keyspan Serial Assistant section in this manual for instructions on what to do next. Rev 2006aug07 Page 7 Keyspan USB Serial Adapter Software v2.x for Mac OS X User Manual 4.1 - Configuring Your Serial Device Prior to using your serial device (modem,UPS, etc.) with the Keyspan USB Serial Adapter, you must: 1. connect your serial device (hardware) to the Keyspan port 2. configure your serial device's software to use the Keyspan port The following instructions provide a general overview of this process. Note: We will be adding detailed instructions in how to configure specific serial devices in the future. Please check Keyspan's website for the latest version of this document. Connecting Your Serial Device (Hardware) If your Keyspan adapter is not connected, please do so NOW. Step 1 - Connect Your Serial Device To The Keyspan Adapter Attach your serial device's serial cable to the serial port on your Keyspan USB Serial Adapter. Step 2 - Determine Which Keyspan Port Your Serial Device Is Connected To If you have a Keyspan product that has more than one serial port, please note which Keyspan serial port your serial device is connected to (the serial port on the Keyspan product, not your USB ports on your computer or USB hub). This information will become useful as we start Configuring Your Serial Device's Software. Configuring Your Serial Device's Software The following configuration instructions provide a basic overview of how to configure your software to use your Keyspan serial port(s). For specific instructions on how to operate your serial device, please refer to that device's user's manual for detailed instructions. Rev 2006aug07 Page 8 Keyspan USB Serial Adapter Software v2. ...