Nexus C-816 User manual

Nexus Audio Systems
C-816 MULTI-ROOM CONTROLLER
RS232 Command Re erence
1.0 03/23/2011 1

RS232 PROTOCOL
The C-816 Controller has an RS-232 port that allows the system to be ontrolled with an external
ontroller or be ome a sub-system in a whole-house ontrol pa kage. This allows the system installer to
integrate the operations of the C-816 with other ontrol systems in the home.
The C-816 Serial Port allows full ontrol of all system fun tions. In addition to being able to ontrol the
C816/expansion Controllers ‘on board’ fun tions (on/off, input sele t, et ) RS-232 ontrol in ludes
ontrol of the Tuner and other sour e omponents, in luding any atta hed iPod/do k ombinations.
When the C-816 ‘sees’ a ommand for one of the on board fun tions, it responds a ordingly. When it
sees a ommand su h as CD play, the in oming RS-232 ommand is interpreted in a similar manner to a
keypad button press and the C-816 will output the appropriate orresponding IR ommand.
The Serial Port on the C-816 uses a female DB9 onne tor wired in a DTE onfiguration. Tx (transmit)
= pin 2, Rx (re eive) = pin 3, Ground = pin 5. Communi ation settings are 19200 baud, 8 bits, no parity,
no handshake.
Figure 1. RS-232 Port Pin Out
Ea h ommand must be terminated with a arriage return: < r>. If an invalid ommand is sent, the C-
816 will respond with ERR. If a valid ommand is sent, the C-816 will respond with OK unless it is a
query type ommand, in whi h ase the C-816 will respond with information. Every response from the
C-816 is terminated with < r>.
The C-816 sends out unsoli ited information whenever a keypad is operated. The syntax is the same as
that used for ontrolling the C-816. For instan e, if someone turns on Zone 1 via a keypad, the C-816
will transmit Z011 out of the serial port. The string will be terminated with < r>.
Note: the symbol < r> shown in the table below represents a arriage return ontrol hara ter who's
value is hex 0x0d. This is what must be transmitted to the C-816 at the end of every ommand, not the
hara ters <, , r, >.
RS232 ommand table starts on next page.
1.0 03/23/2011 2

Command Syntax Parameters Des ription
Zone Power Zxxy< r> xx=zone, valid range 01-
16
y=state, 1=on, 0=off
Similar to pushing the power button on a
zones keypad. This will power up/down
the spe ified zone
Zone Power
Query
Zxx?< r> xx=zone,
valid range 01-16
Ask the C-816 if a zone is on or off. The
C-816 will respond with Zxx1 for zone
on, and Zxx0 for zone off. xx is the zone
number queried.
All off ZA0< r> 0=off Turn all zones off. If an Expansion
Controller is onne ted, it's zones will
also be turned off.
All on ZA1< r> 1=0n Turn all zones on. They will be set to
their last used sour e and volume.
Sour e Sele t Sxxy< r> xx=zone, valid range 01-
16
y=input, range T, 1-6
Similar to sele ting a sour e on a keypad.
T=tuner, 1-6=inputs 1-6. Inputs 5 and 6
orrespond to expansion slots 1 and 2.
Sour e Query Sxx?< r> xx=zone, valid range 01-
16
Ask the C-816 what input a zone is on.
The C-816 will respond with Sxxy, where
xx is the zone number queried and y the
input it is set to.
Fun tion Fxxyy< r> xx=zone, valid range 01-
16
yy=fun tion:
on keypad: SU, SD, RW,
FW, ST, PS. Additional
on IR remote: GU, IN,
EX, MN, CU, CD, NU,
NR, ND, NL, EN, N1,
N2, N3, N4, N5, N6,
N7, N8, N9, N0, TR, DI.
Similar to pressing a fun tion on a
keypad or remote. SU=s roll up,
SD=s roll down, RW=rewind, FF=fast
forward, ST=star, PS=pause.
R-3 Remote only: GU=guide, IN=info,
EX=exit, MN=menu, CU= h up, CD= h
down, NU=nav up, NR=nav right,
ND=nav down, NL=nav left, EN=enter,
N1-N0=numeri buttons, TR=tra k,
DI=dis .
Volume
Absolute
Vxxyy< r> xx=zone, valid range 01-
16
yy= volume, range 00-
99
Set an absolute volume level in a C-816
zone. NOTE: yy number is in dB so 00 is
the loudest at 0dB and 99 is the softest at
-99dB.
Volume Query Vxx?< r> xx=zone, valid range 01-
16
Ask the C-816 what volume a zone is set
to. The C-816 will respond with Vxxyy
where xx is the zone number, (01-16) and
yy is the volume of that zone (00-99) =
0dB to -99dB
Volume Step Vxx++< r>
or
Vxx- -< r>
xx=zone, valid range 01-
16
In rease or de rease the volume of a zone
by one step (1dB).
1.0 03/23/2011 3

Command Syntax Parameters Des ription
Frequen y
Query
FREQ?< r> none Query what frequen y the Tuner is on.
The reply will be ‘FM’ or ‘AM’ followed
by the frequen y. Example: ‘FM105.9’ or
‘AM1010’
FM tuner
frequen y
FMFxxxx< r> xxxx=frequen y, valid
range 0875-1079,
leading zeros required.
Set the FM frequen y of the C-816
internal tuner. If the tuner is on the AM
band, it will swit h to FM.
AM tuner
frequen y
AMFxxxx< r> xxxx=frequen y, valid
range 0530-1710,
leading zeros required.
Set the AM frequen y of the C-816
internal tuner. If the tuner is on the FM
band, it will swit h to AM.
Swit h to FM FMB< r> none Swit h to the FM band without hanging
the frequen y.
Swit h to AM AMB< r> none Swit h to the AM band without hanging
the frequen y.
Frequen y Seek SEEKx< r> x = + or x = - Seek up or down the urrent band (FM or
AM), and stop on the next station.
Slave tuner
ontrol
SL_ Prepend to tuner
ommands above
Allows ontrol of tuner in slave hassis, if
one is atta hed.
Query tuner
preset
PRE?< r> none Che k if urrent tuner frequen y is
assigned to a preset. The reply will be
PRE00 if it is not a preset, or PRExx
where xx = preset number.
Set FM preset PRExxFMyyyy
< r>
xx = preset number,
range 01-20, yyyy =
frequen y, range 0875-
1079
Assign an FM tuner frequen y to a preset.
Set AM preset PRExxAMyyyy
< r>
xx = preset number,
range 01-20, yyyy =
frequen y, range 0530-
1710
Assign an AM tuner frequen y to a
preset.
Mute on MUTE_ONxx
< r>
xx=zone, valid range 01-
16
A tivates mute on the desired zone xx. If
xx is omitted, then zones will mute
a ording to those enabled in the mute
menu.
Mute off MUTE_OFFxx
< r>
xx=zone, valid range 01-
16
De-a tivates mute on the desired zone xx.
If xx is omitted, then zones will un-mute
a ording to those enabled in the mute
menu.
1.0 03/23/2011 4

Command Syntax Parameters Des ription
Treble Txxyy< r> xx=zone, valid range 01-
16
yy= value, range 00-20
Adjusts the treble for a given zone. The
adjustment range is -10dB to +10db with
0dB being flat, so a yy value of 0 =
-10dB, 10 = 0dB, 20 = +10dB.
Bass Bxxyy< r> xx=zone, valid range 01-
16
yy= value, range 00-20
Adjusts the bass for a given zone. The
adjustment range is -10dB to +10db with
0dB being flat, so a yy value of 0 =
-10dB, 10 = 0dB, 20 = +10dB.
Query sour e
name
SNxx?< r> xx=sour e, range 01-07 Returns a hara ter string des ribing the
name of the queried sour e.
Set sour e name SNxx < r> xx=sour e, range 01-07,
= a hara ter string,
max 10 hara ters
Sets the name of sour e xx to .
Example to hange the name of sour e 2
to CABLE, issue:
SN02CABLE< r>
Query zone
name
ZNxx?< r> xx=zone, range 01-16, Returns a hara ter string des ribing the
name of the queried zone.
Set zone name ZNxx < r> xx=zone, range 01-16,
= a hara ter string,
max 16 hara ters
Sets the name of zone xx to .
Example to hange the name of zone 1 to
KITCHEN, issue:
ZN01KITCHEN< r>
Query number
of zones
ZONES? none Returns the number of zones in the
system. It will be either 08, or 16 if a
slave is atta hed.
1.0 03/23/2011 5

Nexus C-816 iPod control protocol
This se tion des ribes the ommands used to ontrol an iPod atta hed to a Nexus C-816 via the RS232
port on the rear of the unit. The RS232 port uses a baud rate of 19200, 8 data bits, 1 stop bit, and no
parity. In the examples shown, the string < r> represents a arriage return; a single byte non-printable
hara ter with the hexade imal value 0x0d. For information regarding onne ting an iPod do k to the
C-816, please refer to the Nexus C-816 installation guide.
Command list.
I_SLOT1
This ommand allows a devi e atta hed to the RS232 port to take ontrol of an iPod atta hed to slot 1 of
the C-816. If the iPod is not in use, a reply of “OK” will be returned. If the iPod is in use (by a keypad),
a reply of “ERR iPod in use” will be returned. After this ommand is issued, and if su essful, a 32
se ond timer will be started. If any iPod related ommands are sent to the ontroller, this timer will be
reset. If no iPod related ommands are re eived for 32 se onds, a reply of “Slot1 timeout” will be
returned, and the RS232 port loses ontrol of the iPod.
Example:
--> I_SLOT1< r>
<-- OK< r>
I_SLOT2
Same as I_SLOT1, but instead takes ontrol of an iPod on slot 2.
I_ ELIPOD
When the devi e on the RS232 is finished ontrolling the iPod, it should issue this ommand to make
the iPod available to the system.
Example:
--> I_RELIPOD< r>
<-- OK< r>
I_ ESDBSEL
Resets the iPod's database sele tion to an empty state, and sets the ategory ount to zero. This is
analogous to pressing the iPod menu button repeatedly to get to the topmost iPod menu. Any previously
sele ted database items are de-sele ted. The ommand has no effe t on the playba k engine – any songs
urrently in the play queue will ontinue to play.
Example:
--> I_RESDBSEL< r>
<-- OK< r>
I_GETNUMCATDB EC
Retrieves the number of re ords in a parti ular database ategory. For example, the number of artists, or
albums in the iPod database ould be queried. The ategory types available are as follows:
Playlist = 01
1.0 01/02/10 6

Artist = 02
Album = 03
Genre = 04
Tra k = 05
Composer = 06
AudioBook = 07
Pod ast = 08
This ommand must be used to initialize the ategory ount before sele ting a database re ord using the
I_SELDBRECORD ommand. A ategories re ord ount an hange based on prior ategories sele ted
and the database hierar hy. For example, if the database has just been reset using I_RESDBSEL, then
this ommand would return the total number of re ords for a given ategory. However, if this ommand
is sent after one or more ategories have been sele ted, the returned re ord ount will be a subset of the
re ords that are member of all the ategories sele ted prior to this ommand.
Example:
--> I_GETNUMCATDBREC 02< r> 'request the number of artists
<-- 184< r> 'there are 184 artists
I_ ETCATDB EC
Retrieves one or more database re ords from the iPod based on the results from the
I_GETNUMCATDBREC ommand. This ommand spe ifies the ategory type (see above), the starting
re ord index, and the re ord ount. For example, using a ategory type of two (artist), a starting index of
zero, and a re ord ount of five, the iPod will return the names of the first five artists in the database.
Example:
--> I_RETCATDBREC 02,0,5< r> 'request artist names starting at re ord 0, get 5 artists
<-- a-ha< r> '5 artist names are returned
<-- Aaron Neville< r>
<-- AC/DC< r>
<-- Adam Ant< r>
<-- Aerosmith< r>
I_SELDB EC
Sele ts one or more re ords in the iPod database, based on a ategory relative index. For example
sele ting ategory two (artist), and re ord index one results in a list of database re ords from the se ond
artist in the artist list. Sele tions are additive and limited by the ategory hierar hy. Sele tion of a single
re ord automati ally passes it to the playba k engine and starts its playba k. This ommand may only be
used after a ategory ount has been initialized by use of the ommand I_GETNUMCATDBREC.
Example:
--> I_SELDBREC 02,2< r> '(see above) Artist number 2 (AC/DC) is sele ted
<-- OK<CR>
I_PLYCU SEL
This ommand opies items from the iPod's database engine to the playba ks engine, and optionally
shuffles the tra ks if shuffle is a tive, then starts playba k at the spe ified tra k index.
1.0 01/02/10 7

Example:
--> I_PLYCURSEL 0< r>
<-- OK<CR>
I_GETPLYSTAT
Requests the urrent iPod playba k status. A reply of “Playing”, “Paused”, or “Stopped” will be
returned.
Example:
--> I_GETPLYSTAT< r>
<-- Playing<CR>
I_GETCU PLYT IND
Requests the index of the urrently playing tra k in the playba k engine. The index is returned.
Example:
--> I_GETCURPLYTRIND< r>
<-- 12<CR>
I_GETINDPLYT TIT
Requests the urrently playing tra k title. The tra k title will be returned.
Example:
--> I_GETINDPLYTRTIT 12< r>
<-- Tra k1: Walking On Broken Glass<CR>
I_GETINDPLYT A T
Requests the urrently play tra k artist. The artist name will be returned.
Example:
--> I_GETINDPLYTRART 12< r>
<-- Artist1: Annie Lennox<CR>
I_GETINDPLYT ALB
Requests the urrently playing tra k album name. The album name will be returned.
Example:
--> I_GETINDPLYTRALB 12< r>
<-- Album1: Medusa<CR>
I_PLYCONT
Controls the playba k state of the iPod. If the iPod is already in the requested state, then this ommand
has no effe t. The states that the iPod an be put into are listed below:
Toggle play/pause = 01
Stop = 02
Next tra k = 03
Previous tra k = 04
1.0 01/02/10 8

Start FF = 05
Start REW = 06
End FF/REW = 07
Next = 08
Previous = 09
Play = 10
Pause = 11
Note: if the urrent tra k is an audiobook or pod ast, then Next and Previous ommands skip to the next
or previous hapter. Otherwise, they a t like Next tra k and Previous tra k.
Example:
--> I_PLYCONT 01< r> 'Toggle Play/Pause
<-- OK<CR>
I_GETSHUF
Requests the urrent shuffle status of the iPod. The reply will be Shuffle off, Shuffle tra ks, Shuffle
albums.
Example:
--> I_GETSHUF< r>
<-- Shuffle off<CR>
I_SETSHUF
Sets the shuffle state of the iPod. Use 00 to turn shuffle off, 01 to shuffle tra ks, or 02 to shuffle albums.
Example:
--> I_SETSHUF 01< r> 'Shuffle albums
<-- OK<CR>
I_GET EP
Requests the urrent repeat status of the iPod. The reply will be Repeat off, Repeat 1, or Repeat all.
Example:
--> I_GETREP< r>
<-- Repeat off<CR>
I_SET EP
Sets the repeat state of the iPod. Use 00 to turn repeat off, 01 to repeat one tra k, or 02 to repeat all
tra ks.
Example:
--> I_SETREP 01< r> 'Repeat 1 tra k
<-- OK<CR>
I_GETNUMPLYT
Requests the number of tra ks in the list of tra ks queued to play on the iPod.
1.0 01/02/10 9

Example:
--> I_GETNUMPLYTR< r>
<-- 14<CR>
I_SETCU PLYT
Sets the index of the tra k to play in the now playing playlist on the iPod. The number of playing tra ks,
and the urrent playing tra k index may be queried using I_GETNUMPLYTR and
I_GETCURPLYTRIND. This ommand only works if the iPod is in the play or pause modes, not in the stop
mode.
Example:
--> I_SETCURPLYTR 7< r>
<-- OK<CR>
I_ EQIPODNAM
Requests the name of the atta hed iPod. The name will be returned. If the user has not set a name for the
iPod, then “iPod” will be returned.
Example:
--> I_REQIPODNAM< r>
<-- John's iPod<CR>
I_METADATAON
This ommand enables reporting of the artist, album, and tra k names out of the RS232 port. This info
will be reported every time the tra k hanges without having to request it. Ea h item is reported with a
field identifier, and a arriage return at the end. For example, if the song hanges on the iPod whi h is
on slot 1, the following will be sent out the serial port:
Artist1: Be k
Album1: Sea Change
Tra k1: The Golden Age
For the iPod on slot 2, the prefixes will be Artist2: Album2: and Tra k2
Example:
--> I_METADATAON< r>
<-- OK<CR>
I_METADATAOFF
Can els reporting of song metadata out of the serial port. This information ould still be requested
manually using the ommands I_GETCURPLYTRIND, I_GETINDPLYTRTIT,
I_GETINDPLYTRART, and I_GETINDPLYTRALB.
Example:
--> I_METADATAOFF< r>
<-- OK<CR>
1.0 01/02/10 10