iPort IW-2 Instruction Manual

Iport rs-232 programming
Hide thumbs Also See for IW-2:

Advertisement

Quick Links

Instruction Manual

Introduction
This specification provides the communication protocol that
allows two-way communication between an RS-232 enabled
controller and an Apple
®
iPod™ docked into an RS-232 enabled
enabled iPort™ model. This document specifies telegrams that
will allow for the command and control of the docked iPod in
extended interface mode and for receiving meta data from the
iPod for display on the controller's display.
Applicable iPort Models
This specification only applies to iPort models that are two-way
communication enabled. Two-way communication is enabled in
the IW-4 and IW-5 systems, and can be added to iPort IW-2 and
IW-3 systems by adding the iPort RS-232 Upgrade Kit (sold
separately) to the IW-3, and the iPort RS-232 and the iPort
Balanced Audio Upgrade kits (both sold separately) to the IW-2.
Summary of RS-232 Operation
This communication protocol is enabled when the iPod is in
extended interface mode, which can be determined by checking
the iPod screen. The iPort logo will be on the iPod screen when
in extended interface mode.
NOTE: The iPod interface is disabled when in two-way
(RS-232) mode. The user will no longer be able to
control the iPod from the iPod when in two-way mode.
There are commands to enter two way and exit two way. One
may wish to make these commands available to the customer
through the user interface. Refer to section 35 and section 36.
NOTE: If the iPod is docked while in the Play mode it
will automatically enter the Pause mode. This is due to
the iPod protocol. You may wish to set the RS-232
control system to automatically send a Play command to
return the iPod to the last playing song when it is
inserted in the dock.
Connection Description
The iPort communication protocol uses an RJ-11 connector on
the Balanced Audio Wallplate or external break-out box.
(A compatible RJ-11/DB-9 cable is supplied with RS-232 enabled
iPort systems and the iPort RS-232 Upgrade Kit.)
The pin assignments for the RS-232 cable are:
RJ-11 Pin
DB-9
Name
1
2
PC Rx
2*
5
GND
3*
5
GND
4
3
PC Tx
5
2
PC Rx
6
N/A
* Only one GND pin may be connected, if desired.
Com Port Settings:
Baud Rate = 19200
Parity = N
Stop Bits = 1
Data Bits = 8
Packet Structure
The iPort communication packet structure is constructed using a
combination of ASCII characters and hex data. A packet consists
of seven elements described below.
Byte Number Value
0x00
0x2A
0x01
0x49
0x02
0xNN
0x03
0xNN
0x04
0xNN
0x05
0xNN
0x06
0xNN
0x07 – 0xNN
0xNN
0xNN
0xNN
Packet Command Type:
Code
0x38
0x3C
0x01*
* Device type code for this command is 0x4D
1
iPort RS-232 Programming
Meaning
Start character
Device type (iPort)
Packet Length High Byte
Packet Length Low Byte
Packet Command Type
Packet Command High Byte
Packet Command Low Byte
Packet Data Bytes
Checksum = 2's compliment of the
sum of all bytes excluding the start
character and checksum
Command Type
Two-Way
General
LED control

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the IW-2 and is the answer not in the manual?

Questions and answers

Summary of Contents for iPort IW-2

  • Page 1: Instruction Manual

    This specification only applies to iPort models that are two-way communication enabled. Two-way communication is enabled in the IW-4 and IW-5 systems, and can be added to iPort IW-2 and IW-3 systems by adding the iPort RS-232 Upgrade Kit (sold separately) to the IW-3, and the iPort RS-232 and the iPort Balanced Audio Upgrade kits (both sold separately) to the IW-2.
  • Page 2: Command Code Summary

    ResetDBSelection 0x3C 0x2B SelectDBRecord 0x3C 0x3D Acknowledge iPort RS-232 Programming The table below lists the valid command codes for use in packet command high and low bytes for the General command type: PACKET COMMAND TYPE: 0x3C iPort iPort Command Command...
  • Page 3: Command Code Description

    Low Byte 0x3C 0x09 GetNumPlayingSongs Direction: Controller — > iPort Description: Requests the number of tracks in the actual list of songs queued. In response the iPort will send a ReturnNumPlayingSongs packet with the count of the songs queued to play.
  • Page 4 Command Command High Byte Low Byte 0x3C 0x0A ReturnNumPlayigSongs Direction: iPort — > Controller Description: In response to GetNumPlayingSongs the return pack- et will include the count of the songs queued to play. Packet Structure: Byte Number Value Meaning 0x00...
  • Page 5 Command Command High Byte Low Byte 0x3C 0x0D SetRepeat Direction: Controller — > iPort Description: Sets the repeat state of the iPod. The repeat mode codes are listed in the ReturnRepeat command code description. Packet Structure: Byte Number Value Meaning...
  • Page 6: Play Control

    Command Command Command High Byte Low Byte 0x3C 0x13 GetRepeat Direction: Controller — > iPort Description: Requests the current iPod track repeat state. Packet Structure: Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type (iPort)
  • Page 7 Command Command Command High Byte Low Byte 0x3C 0x19 ReturnIndexedPlayingSongAlbumName Direction: iPort — > Controller Description: In response to the GetIndexedPlayingSongAlbum Name command, returns the album name of the indexed playing song. Packet Structure: Byte Number Value Meaning 0x00 0x2A...
  • Page 8 Low Byte 0x3C 0x1C GetIndexedPlayingSongTitle Direction: Controller — > iPort Description: Requests the song title of the indexed playing song from the iPod. NOTE: iPod will respond with an ACK including the specific error status if the received command length or...
  • Page 9 Command Command Command High Byte Low Byte 0x3C 0x1D ReturnIndexedPlayingSongTitle Direction: iPort — > Controller Description: In response to the GetIndexedPlayingSongTitle command, returns the song title of the indexed playing song. Packet Structure: Byte Number Value Meaning 0x00 0x2A...
  • Page 10 High Byte Low Byte 0x3C 0x21 ReturnPlayStatus Direction: iPort — > Controller Description: In response to the GetPlayStatus command, returns the current iPod playback status. NOTE: The song length/song position fields are only valid if the iPod is playing or paused.
  • Page 11 High Byte Low Byte 0x3C 0x24 GetNumberedCategorizedDBRecords Direction: Controller — > iPort Description: Requests the number of records of a particular data- base category. Category type codes are described in the SelectSortDBRecord command code descrip- tion section. NOTE: The record count returned by this command depends on the database state before this command is sent.
  • Page 12 Command Command Command High Byte Low Byte 0x3C 0x27 ReturnCategorizedDBRecords Direction: iPort — > Controller Description: In response to the RetrieveCategorizedDBRecords command, returns information for a single database. Packet Structure: Byte Number Value Meaning 0x00 0x2A Start character 0x01...
  • Page 13 High Byte Low Byte 0x3C 0x2B SelectDBRecord Direction: Controller — > iPort Description: Selects one or more records in the iPod database based on a category relative index. Selections are additive and limited only by the category hierarchy. Category Type Code:...
  • Page 14 Command Command Command High Byte Low Byte 0x3C 0x38 ReturnRemoteUIMode Direction: iPort — > Controller Description: In response command, returns the state of the iPod UI mode. UI Mode Code: Code Category Type 0x00 Two-Way Mode 0x01 Standard Mode...
  • Page 15 High Byte Low Byte 0x00 0x02 LED_ON/OFF_Undocked Direction: Controller — > iPort Description: Command to turn ON/OFF the LEDs when an iPod is not docked into the iPort. LED Mode Code: Code LED Mode 0x00 0x01 Packet Structure: Byte Number Value...
  • Page 16 High Byte Low Byte 0x00 0x04 LED_Brightness_Undocked Direction: Controller — > iPort Description: Command to adjust the brightness of the LEDs when an iPod is not docked into the iPort. LED Brightness Mode Code: Code LED Brightness Mode 0x01 0x02 Medium...
  • Page 17: Detailed Example

    Instruction Manual Detailed Example The following example is a ReturniPodName command response from the iPort in response to a RequestiPodName command. Sent from Controller RequestiPodName Value Meaning 0x2A Start character 0x49 Device type (iPort) 0x00 Packet Length High Byte 0x03...
  • Page 18 | 888 . 45 . iPort | www.iportmusic.com ©2005 iPort. All rights reserved. iPort and RotoLock are trademarks of Dana Innovations. iPod is a registered trademark of Apple Computer, Inc. Decora is a registered trademark of Leviton Manufacturing Co., Inc.

This manual is also suitable for:

Iw-3Iw-4Iw-5Rs-232

Table of Contents