manualshive.com logo in svg

iPort IW-2, Instruction Manual, Page: 3 / 18

Share
Download
iPort IW-2 Instruction Manual Download Page 3

Application Usage Example

The following table is an example of telegram traffic between the
iPort and the controller:

Sent from Controller

Sent from iPort

RequestiPodName

ReturniPodName (“My iPod”)

ResetDBSelection

Acknowledge

SelectDBRecord 
(Category = Artist, 
Index = 1)

Acknowledge

GetNumber
CategorizedDBRecords 
(Category = Songs)

ReturnNumber
CategorizedDBRecords 
(Matching Record Count = 2)

Retrieve
CategorizedDBRecords
(Category = Songs, 
Index = 1, 
Read Count = 2)

ReturnCategorizedDBRecord 
“Zooropa”

ReturnCategorizedDBRecord 
“Babyface”

[User selects “Zooropa”]

SelectDBRecords 
(Category = Songs, 
Index = 0)

Acknowledge

PlayCurrentSelection 
(Index = 0)

Acknowledge

Command Code Description

The following section describes the individual iPort commands
and includes the packet structure for each command.

PACKET COMMAND TYPE: 0x38

1. SelectSortDBRecord

0x3C

0x04

SelectSortDBRecord

Direction: Controller —> iPort

Description: Selects one or more records in the iPod database

based on a category type, index, and sort order. 

Category  Type  Code:

Code

Category Type

0x01

Playlist

0x02

Artist

0x03

Album

0x04

Genre

0x05

Song

0x06

Composer

Sort  Order  Code:

Code

Sort Order

0x00

Genre

0x01

Artist

0x02

Composer

0x03

Album

0x04

Song

0x05

Playlist

0xFF

Default

Packet  structure:

Byte Number Value

Meaning

0x00

0x2A

Start character

0x01

0x49

Device type (iPort)

0x02

0x00

Packet Length High Byte

0x03

0x09

Packet Length Low Byte

0x04

0x38

Packet Command Type

0x05

0x3C

Packet Command High Byte

0x06

0x04

Packet Command Low Byte

0x07

0xNN

Category Type Code

0x08

0xNN

Record Index (byte 4)

0x09

0xNN

Record Index (byte 3)

0x0A

0xNN

Record Index (byte 2)

0x0B

0xNN

Record Index (byte 1)

0x0C

0xNN

Sort Order Code

0x0D

0xNN

Checksum

2. GetNumPlayingSongs

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.

3

Instruction Manual

iPort RS-232 Programming

iPort

Command

High Byte

iPort

Command

Low Byte

Command 

iPort

Command

High Byte

iPort

Command

Low Byte

Command 

Summary of Contents for IW-2

Page 1: ...ce 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 connect...

Page 2: ...3C 0x23 ReturnCurrentPlayingSongIndex 0x3C 0x24 GetNumberCategorizedDBRecords 0x3C 0x25 ReturnNumberCategorizedDBRecords 0x3C 0x26 RetrieveCategorizedDBRecords 0x3C 0x27 ReturnCategorizedDBRecord 0x3C 0x28 RequestiPodName 0x3C 0x29 ReturniPodName 0x3C 0x2A ResetDBSelection 0x3C 0x2B SelectDBRecord 0x3C 0x3D Acknowledge The table below lists the valid command codes for use in packet command high an...

Page 3: ...a category type index and sort order Category Type Code Code Category Type 0x01 Playlist 0x02 Artist 0x03 Album 0x04 Genre 0x05 Song 0x06 Composer Sort Order Code Code Sort Order 0x00 Genre 0x01 Artist 0x02 Composer 0x03 Album 0x04 Song 0x05 Playlist 0xFF Default Packet structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 ...

Page 4: ...ying songs and current playing song index respectively NOTE This command is only usable when the iPod is in a playing or paused state The command will fail if the iPod is stopped Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x07 Packet Length Low Byte 0x04 0x38 Packet Command Type 0x05 0x3C Packet Command Hi...

Page 5: ...current iPod shuffle mode state is returned Shuffle Mode Code Code Category Type 0x00 Shuffle Off 0x01 Shuffle Songs 0x02 Shuffle Albums Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x04 Packet Length Low Byte 0x04 0x38 Packet Command Type 0x05 0x3C Packet Command High Byte 0x06 0x11 Packet Command Low Byte ...

Page 6: ...ction Song Record Index byte 2 0x0B 0xNN Selection Song Record Index byte 1 0x0C 0xNN Checksum 12 PlayControl 0x3C 0x15 PlayControl Direction Controller iPort Description Sets the new play state of the iPod Play Control Command Code Code Category Type 0x01 Toggle Play Pause 0x02 Stop 0x03 Next Track 0x04 Previous Track 0x05 StartFF 0x06 StartRew 0x07 EndFFRew Packet Structure Byte Number Value Mea...

Page 7: ...ue to send PlayStatusChangeNotificaiton telegrams until this telegram is sent again with the disable notification option Play Status Change Notification Mode Code Code Category Type 0x00 Disable All 0x01 Enable All Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x04 Packet Length Low Byte 0x04 0x38 Packet Comm...

Page 8: ...te 0x08 0x02 New Status Playback Forward Seek Stop 0x09 0x22 Checksum Playback Backward Seek Stop 0x03 Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x04 Packet Length Low Byte 0x04 0x38 Packet Command Type 0x05 0x3C Packet Command High Byte 0x06 0x1B Packet Command Low Byte 0x08 0x03 New Status Playback Backward Seek Stop 0x...

Page 9: ...aying song index is invalid Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x07 Packet Length Low Byte 0x04 0x38 Packet Command Type 0x05 0x3C Packet Command High Byte 0x06 0x1E Packet Command Low Byte 0x08 0xNN Database Song Record Index byte 4 0x09 0xNN Database Song Record Index byte 3 0x0A 0xNN Database So...

Page 10: ...um 23 GetCurrentPlayingSongIndex 0x3C 0x22 GetCurrentPlayingSongIndex Direction Controller iPort Description Requests the database index of the currently playing song NOTE The song index returned is only valid if the iPod is currently playing or paused a song Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x03...

Page 11: ...2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x07 Packet Length Low Byte 0x04 0x38 Packet Command Type 0x05 0x3C Packet Command High Byte 0x06 0x25 Packet Command Low Byte 0x07 0xNN Database Record Count byte 4 0x08 0xNN Database Record Count byte 3 0x09 0xNN Database Record Count byte 2 0x0A 0xNN Database Record Count byte 1 0x0B 0xNN Checksum 27 RetrieveC...

Page 12: ...06 0x28 Packet Command Low Byte 0x07 0x18 Checksum 30 ReturniPodName 0x3C 0x29 ReturniPodName Direction iPort Controller Description In response to the RequestiPodName command returns the name of the user s iPod NOTE If the iPod name is undefined will return iPod Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0xNN Packet Length High Byte 0x03 ...

Page 13: ...abase Record Index byte 1 0x0C 0xNN Checksum 33 Acknowledge 0x3C 0x3D Acknowledge Direction iPort Controller Description This telegram acknowledges the receipt of a command received and returns the command status Command Result Status Code Code Category Type 0x00 Success OK 0x01 Error Unknown Database Category 0x02 Error Command Failed 0x03 Error Out of Resources 0x04 Error Bad Parameter 0x05 Erro...

Page 14: ...acket Command High Byte 0x06 0x39 Packet Command Low Byte 0x07 0x03 Checksum 36 ExitRemoteUIMode 0x3C 0x3A ExitRemoteUIMode Direction Controller iPort Description Command to force the iPod to exit two way communication mode Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x49 Device type iPort 0x02 0x00 Packet Length High Byte 0x03 0x03 Packet Length Low Byte 0x04 0x3C Pa...

Page 15: ... an iPod is docked into the iPort LED Mode Code Code LED Mode 0x00 OFF 0x01 ON Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x4D Device type iPort Micro 0x02 0x00 Packet Length High Byte 0x03 0x04 Packet Length Low Byte 0x04 0x01 Packet Command Type 0x05 0x00 Packet Command High Byte 0x06 0x01 Packet Command Low Byte 0x07 0xNN LED Mode Code 0x08 0xNN Checksum 40 LED_ON...

Page 16: ...0x08 0xNN Checksum 42 LED_Brightness_Undocked 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 Dim 0x02 Medium 0x03 Bright Packet Structure Byte Number Value Meaning 0x00 0x2A Start character 0x01 0x4D Device type iPort Micro 0x02 0x0...

Page 17: ...PodName My iPod Value Meaning 0x2A Start character 0x49 Device type 0x00 Packet Length H 0x0A Packet Length L 0x38 Command Type 0x3C Packet Command H 0x29 Packet Command L 0x4D ASCII M 0x79 ASCII y 0x20 ASCII space 0x69 ASCII i 0x50 ASCII P 0x6F ASCII o 0x64 ASCII d 0x00 ASCII null 0x9E Checksum 17 Instruction Manual iPort RS 232 Programming Detailed Example The following example is a ReturniPodNa...

Page 18: ... are trademarks of Dana Innovations iPod is a registered trademark of Apple Computer Inc Decora is a registered trademark of Leviton Manufacturing Co Inc Instruction Manual iPort RS 232 Programming 07 05 san clemente ca 888 45 iPort www iportmusic com ...

Reviews:

No comments