WS 800 Serial Protocol
User Manual: WS-800 - Serial Protocol
Open the PDF directly: View PDF 
.
Page Count: 7
| Download | |
| Open PDF In Browser | View PDF |
Serial Protocol Definition WS800 Wireless Microphone System Serial Protocol Definition ClearOne WS800 Serial Protocol Definition This document defines the serial commands available for control and monitoring of ClearOne WS8x receivers. The serial commands may be snet using either USB or RS232 connections. Port Setup The USB port on the ClearOne receiver uses a RS232 to USB driver on the PC, so it appears as a COM port on the computer. The settings for the communications are: • Baud Rate: 115200 • Data Bits: 8 • Stop Bits: 1 • Parity: None • IE 115200, 8, N, 1 Available Commands 1. Read system status (Audio level, Diversity status, TX Battery level, TX Battery run time hours, TX PAD, TX Low cut, TX Power switch mode, TX Button Mode, Conference/Stage mode) 2. RF Channel change 3. Main output volume change 4. Headphone output volume change 5. Mute audio 6. Read System information 7. Headphone output volume change 8. Set transmitter parameters (PAD, Low Cut, RF Power Level, Channel, Power switch mode, Button Lock, Button Mode, Conference/Stage mode) 9. Set transmitter name 10. Antenna phantom power on/off 11. Set headphone mode (balanced/unbalanced) 12. Load preset 13. Save preset 14. Read preset names 15. Set GPIO configuration Serial Protocol Definition All communications start with a command sent from the PC to the ClearOne receiver. The general format for a packet is: • 0xFD : Start byte • 0xd : Device address (0-7) • 0xs : Slot address (0-7) • 0xC : Command code • 0xd : Number of data bytes that follow • 0xd0 : Data byte 0 • : Data byte n-2 • : Data byte n-1 • 0xdn : Data byte n • 0xFE : End byte The “0x” prefix indicates a hex value follows. (Don’t actually send the 0x characters). In other words, for the 0xFD, the actual value that is sent is 253, which is FD in hex. For example, the string the PC sends to request the status is: 0xFD 0x0 0x0 0x1 0x0 0xFE Start Device Slot Cmd Num End byte addr addr code data byte bytes Since there are no data bytes, the end byte appears directly after the data byte count. 2 1. Read System Status Command The PC sends the Read Status request to the ClearOne Receiver and the receiver returns the string defined below. • The command retrieves 4 channels (slots) of status info at a time. • To get status of channels 0-3, use 0 for the slot value. • To get status of channels 4-7, use 4 for the slot value. • Each channel’s info uses 14 bytes, so all 4 channels use a total of 56 data bytes. Bytes 6 through 19 are the block of data for the first channel, bytes 20 through 33 are for the second channel, etc. Bytes 10, 11, and 18 are bit-mapped. The bits are defined as follows: BYTE 10: • Bit 7: diversity status (0=Ant A, 1=Ant B) • Bits 6-5: TX status (0=Off, 1=On, 2=Mute) • Bits 4-3: Battery Type (0=NIMH ,1=Alkaline) • Bit 1: Antenna A RF clipping indicator • Bit 0: Antenna B RF clipping indicator BYTE 18: • Bit 5-4: Button Mode (0=Toggle on/off, 1=Push to talk, 2=Push to mute) • Bit 3-2: Model (0=Beltpack, 1=Handheld, 2=Podium, 3=Tabletop) • Bit 1: Logic Mute (1=Enabled) • Bit 0: TX Button Lock 3 BYTE 11: • Bit 7: AES Encryption on/off • Bit 6: Conference mode or stage mode (1=Conf mode) • Bits 5-4: Power switch mode (0=On/Off,1=On/ Mute, 2=On/On) • Bits 3-2: TX RF Power (0=1 mW,1=10 mW, 2=25 mW,3=50 mW) • Bit 1: Low Cut • Bit 0: Pad The PC sends: • 0xFD startbyte • 0 device • 0 slot • • • The ClearOne receiver returns: byte Receiver Returns: 1 0xFD startbyte 2 0 device 3 0 slot 4 1 command 5 58 data bytes 6 x RSSI1a 7 x RSSI1b 8 x Audio Level 1 9 x RF Channel 1 10 x diversity/TX status/battery type/ 11 x AES/conf/swmod/txpwr/lc/pad 12 x tx run hours1 13 x BAT1 14 x main output level 1 15 x HP output level 1 16 x BER MSB 17 x BER LSB 18 x TXLock /logic mut/Model/btnmd 19 x reserved 20 x RSSI1a 21 x RSSI1b 22 x AUDIO2 23 x CHAN2 24 x diversity/TX status/battery type/ 25 x AES/conf/swmod/txpwr/lc/pad 26 x tx run hours2 27 x BAT2 28 x main output level 2 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 1 0 0xFE command data # endbyte x x x x x x x x x x x x x x x x x x x x x x x x x x x x x HP output level 2 BER MSB BER LSB TXLock /logic mut/Model/btnmd reserved RSSI1a RSSI1b AUDIO3 CHAN3 diversity/TX status/battery type/ AES/conf/swmod/txpwr/lc/pad tx run hours3 BAT3 main output level 3 HP output level 3 BER MSB BER LSB TXLock /logic mut/Model/btnmd reserved RSSI1a RSSI1b AUDIO4 CHAN4 diversity/TX status/battery type/ AES/conf/swmod/txpwr/lc/pad tx run hours4 BAT4 main output level 4 HP output level 4 byte 58 59 60 Receiver Returns: x BER MSB x BER LSB x TXLock /logic mut/Model/btnmd 61 62 63 x x 0xFE reserved mainmutebits/hpmute bits endbyte 2. RF Channel Change Command The PC sends the RF Channel Change command for the selected slot. The chanval is indexed starting at 0, so to set a slot to RF channel 1, send a chanval of 0. The PC sends • 0xFD • 0 • 0 • 2 startbyte device slot command • • • 1 data # chanval data 0xFE endbyte 3. Main Output Volume Change Command The PC sends the desired value for the analog output volume level. The range is 0 (off) to 100 (Full Scale). The steps are 0.5 dB. The PC sends • 0xFD • 0 • 0 • 3 startbyte device slot command • • • 1 data # volume data 0xFE endbyte 4. Headphone Volume Change Command The PC sends the desired value for the analog output volume level. The range is 0 (off) to 100 (Full Scale). The steps are 0.5 dB. The PC sends • 0xFD • 0 • 0 • 11 startbyte device slot command • • • 1 data # volume data 0xFE endbyte 5. Mute Audio Command The PC sends the desired mute state (0=NOT muted, 1=muted) for the selected slot. The PC sends • 0xFD startbyte • dev num device • 0 slot • 4 command • • • 1 0 or 1 0xFE data # on/off endbyte 6. Read System Information Command This command retrieves information about the receiver such as the serial number, data code, model, # channels, # of receivers, Firmware version, PCB version, and total run time hours. 4 The PC sends • 0xFD startbyte • dev num device • 0 channel • • • The Receiver responds: byte drf Replies: 1 0xFD startbyte 2 0 device 3 0 channel 4 5 command 5 24 data bytes 6 x #DRF in network 7 x DRF serial number MSB 8 x DRF serial number midB 9 10 11 12 13 14 15 16 5 0 0xFE command data # endbyte x x x x x x x x DRF serial number LSB model DRF FW Ver DRF #1 mfg year/month reserved DRF #1 mfg day DRF Tot Hours MSB DRF Tot Hours midB The Receiver responds: byte drf Replies: 17 x DRF Tot Hours LSB 18 x MasterSlave slot 0 19 x MasterSlave slot 1 20 x MasterSlave slot 2 21 x MasterSlave slot 3 22 x MasterSlave slot 4 23 x MasterSlave slot 5 24 25 26 27 28 29 30 x x x x x x 0xFE MasterSlave slot 6 MasterSlave slot 7 DRF1PCB REV DRF2PCB REV DRF3PCB REV DRF4PCB REV end byte 7. Set Transmitter Parameters Command This sets all of the syncable transmitter parameters. Once this is sent, syncing the transmitter to the receiver card via IR will transfer the values to the transmitter. The values are contained in 2 bit mapped bytes, Telem1 and Telem 2, defined below: Telem1: • Bit 7: AES on/off • Bit 6: Conf mode/stage mode (0=conf mode) • Bits 5-4: Power switch mode: (0 = on/off, 1 = on/mute, 2 = on/on) • Bits 3-2: TX Power level (0=1 mW, 1=10 mW, 2=25 mW, 3=50 mW) • Bit 1: Low cut • Bit 0: Pad byte# 1 2 3 4 PC Sends: 0xFD startbyte 0 device 0 channel 21 command Telem2: • Bit 5: Logic Mute enable (1=logic mute enabled, muting will trigger a GPIO but not mute audio output) • Bits 4-3: Button Mode for podium/tabletop TX(0=Toggle on/off, 1=Push to talk, 2=push to mute) • Bit 2: TX Button lock • Bits 1-0: Battery Type (0=NiMh, 1 = alkaline) 5 6 7 8 2 data # Telem1 Telem2 0xFE endbyte 8. Set Transmitter Name Command This command sends up to 10 characters (letters and numbers only) for the name value displayed on the selected transmitter OLED display and on the receiver card OLED display. The transmitter must be IR synced to update the name value after this command is sent. byte# 1 2 3 4 5 6 7 8 9 PC Sends: 0xFD startbyte dev num device 0 slot # 9 command 12 data # name byte 0 name byte 1 name byte 2 name byte 3 10 11 12 13 14 15 16 17 18 name byte 4 name byte 5 name byte 6 name byte 7 name byte 8 name byte 9 reserved reserved 0xFE endbyte 9. Antenna Phantom Power On/Off Command This turns on or off the antenna jack 3.3V phantom power for powering active antennas, like the ones ClearOne provides. byte# 1 2 3 4 5 PC Sends: 0xFD startbyte dev num device 0 slot 29 command 5 6 7 1 on/off 0xFE data # 0=off,1=on endbyte 10. Set Headphone Mode Command The headphone output jack on the front panel can operate in 2 modes. In the normal headphone mode, the tip and ring of the TRS jack are in-phase signals for monitoring with headphones. In balanced mode, the tip and ring are 180 degrees out of phase. This mode is for connecting the jack to the input of a mixer or other balanced input. If the headphone jack is in normal headphone mode, there will be no sound if it is connected to a balance input since the + and – signals will be the same. If the jack is in balanced mode and it is monitored with headphones, the left and right ears will be out of phase and it will sound a bitt weird. byte# 1 2 3 4 PC Sends: 0xFD startbyte dev num device 0 slot # 30 command 5 6 7 1 0 or 1 0xFE data # 0=HP mode, 1=balanced mode endbyte 11. Load Preset Command This preset loads the selected preset form eeprom into the current settings. byte# 1 2 3 4 PC Sends: 0xFD startbyte dev num device 0 slot 21 command 5 6 7 1 data # Preset # 0xFE endbyte 12. Save Preset Command This saves the current settings to a selected user preset. It also allows a 10 character preset name to be saved with the preset. This name is diplayed in the ClearOne GUI in the list of available presets. Presets 1-3 are factory presets and can not be overwritten. Presets 4-8 are user presets and can be written. The name characters should be sent in ASCII format. byte# 1 2 3 4 5 6 7 8 9 PC Sends: 0xFD startbyte 0 device 0 channel 22 command 11 data # preset number name byte 0 name byte 1 name byte 2 10 11 12 13 14 15 16 17 name byte 3 name byte 4 name byte 5 name byte 6 name byte 7 name byte 8 name byte 9 0xFE endbyte 13. Read Preset Names This command retrieves the preset names for the 8 presets. It loads either the first 4 names or the second 4 names, depending on the value of the slot parameter. The names are 10 characters long, and the values are returned in ASCII format.The name characters should be sent in ASCII format. byte# 1 2 3 6 PC Sends: 0xFD startbyte 0 device 0 slot (0 for 0-4, 4 for 5-8) The Receiver responds: byte drf Replies: 1 FD startbyte 2 0 device 3 0 channel 4 31 command 5 40 data bytes 6 preset 1 name char 1 7 preset 1 name char 2 8 preset 1 name char 3 9 preset 1 name char 4 4 5 6 10 11 12 13 14 15 16 17 18 31 0 0xFE command data # endbyte preset 1 name char 5 preset 1 name char 6 preset 1 name char 7 preset 1 name char 8 preset 1 name char 9 preset 1 name char 10 preset 2 name char 1 preset 2 name char 2 preset 2 name char 3 The Receiver responds: byte drf Replies: 19 preset 2 name char 4 20 preset 2 name char 5 21 preset 2 name char 6 22 preset 2 name char 7 23 preset 2 name char 8 24 preset 2 name char 9 25 preset 2 name char 10 26 preset 3 name char 1 27 preset 3 name char 2 28 preset 3 name char 3 29 preset 3 name char 4 30 preset 3 name char 5 31 preset 3 name char 6 32 preset 3 name char 7 33 34 35 36 37 38 39 40 41 42 43 44 45 46 FE preset 3 name char 8 preset 3 name char 9 preset 3 name char 10 preset 4 name char 1 preset 4 name char 2 preset 4 name char 3 preset 4 name char 4 preset 4 name char 5 preset 4 name char 6 preset 4 name char 7 preset 4 name char 8 preset 4 name char 9 preset 4 name char 10 end byte 14. Set GPIO Configuration Command This command configures the GPIO for the DB25 connector on the back of the receiver. Each GPIO pin can be either an input, an output, or disabled. When configured as an output, it is floating/high impedance when not asserted and driven low when asserted. When configured as an input, driving it low asserts it. In addition, pins 2 and 3 are shared with the RS232 function. When configured as RS232, these pins are only used for TX and RX and unavailable for GPIO. Byte 31 determines if pins 2 and 3 are GPIO pins or RS232 pins. Setting it to 0 enables RS232, setting it to 1 enables GPIO on these pins. In the command structure, each pin has a byte associated with it to configure it. • • • • BITS 6-5: pin function (0 = mute, 1 = low battery; 2,3 reserved) BITS 4-2: slot (0-7). This determines which receiver slot is associated with the pin. BIT 1: input or output. (0 = input, 1 = output) BIT 0: enable or disable. (0 = disabled, 1 = enabled) byte# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 PC Sends: 0xFD startbyte 0 device 0 channel 25 command 26 data # pin1 pin2 pin3 pin4 pin5 pin6 pin7 pin8 pin9 pin10 pin11 pin12 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 pin13 pin14 pin15 pin16 pin17 pin18 pin19 pin20 pin21 pin22 pin23 pin24 pin25 RS232OFF 0xFE endbyte 7 North America Tel: 801-975-7200 Toll Free: 800-945-7730 Sales: 800-707-6994 Fax: 801-977-0087 sales@clearone.com Europe & Oceania Tel: +44 (0) 1189 036 053 global@clearone.com Asia Pacific Tel: +852 3590 4526 global@clearone.com Latin America Tel: 801-974-3621 global@clearone.com Middle East Tel: +852 3590 4526 global@clearone.com Other product names may be registered trademarks of their respective owners who do not necessarily endorse ClearOne or ClearOne’s products. All rights reserved. Information in this document subject to change without notice. © 2012 ClearOne. DOC-0082-001 Revision 1.0 December 2012.
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.4 Linearized : Yes Tagged PDF : Yes XMP Toolkit : Adobe XMP Core 5.2-c003 61.141987, 2011/02/22-12:03:51 Instance ID : uuid:f1aafb16-84d7-4c97-b3e2-868e228b3ad9 Document ID : xmp.did:40CA9AA77E48E2118478EF08C441AE7B Original Document ID : adobe:docid:indd:765d8d98-3fbe-11e2-9774-a3ead0c151b2 Rendition Class : proof:pdf Derived From Instance ID : xmp.iid:3DCA9AA77E48E2118478EF08C441AE7B Derived From Document ID : xmp.did:14904A1F7D45E211A86AACD3603B8200 Derived From Original Document ID: adobe:docid:indd:765d8d98-3fbe-11e2-9774-a3ead0c151b2 Derived From Rendition Class : default History Action : saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved, saved History Instance ID : xmp.iid:947FF940C240E2119F67F12BFDB588B8, xmp.iid:957FF940C240E2119F67F12BFDB588B8, xmp.iid:1262988EE343E211AEE5C0F1654B175B, xmp.iid:A78C1F7CF643E211AEE5C0F1654B175B, xmp.iid:F6A2BB1FC444E21199969AA2537837B2, xmp.iid:2E39FE6BC644E21199969AA2537837B2, xmp.iid:2C450E8D3F45E211A86AACD3603B8200, xmp.iid:2D450E8D3F45E211A86AACD3603B8200, xmp.iid:E57925745A45E211A86AACD3603B8200, xmp.iid:56A2265C5B45E211A86AACD3603B8200, xmp.iid:59A2265C5B45E211A86AACD3603B8200, xmp.iid:14904A1F7D45E211A86AACD3603B8200, xmp.iid:7C2B762B8845E211A86AACD3603B8200, xmp.iid:573BEDB13546E2118495AD1DE3CF40D2, xmp.iid:7792EB3A3646E2118495AD1DE3CF40D2, xmp.iid:995F13553746E2118495AD1DE3CF40D2, xmp.iid:6F074E894146E2118495AD1DE3CF40D2, xmp.iid:6C0926B14A46E2118495AD1DE3CF40D2, xmp.iid:3DCA9AA77E48E2118478EF08C441AE7B, xmp.iid:40CA9AA77E48E2118478EF08C441AE7B, xmp.iid:43CA9AA77E48E2118478EF08C441AE7B, xmp.iid:0FBD21BE3849E211AEB5DF4D2785AA10, xmp.iid:6EF3A9553949E211AEB5DF4D2785AA10 History When : 2012:12:07 16:03:03-07:00, 2012:12:07 16:03:03-07:00, 2012:12:11 17:54:29-07:00, 2012:12:11 17:54:29-07:00, 2012:12:12 18:26:31-07:00, 2012:12:12 18:42:58-07:00, 2012:12:13 09:10:02-07:00, 2012:12:13 09:16-07:00, 2012:12:13 12:22:37-07:00, 2012:12:13 12:29:06-07:00, 2012:12:13 16:30:44-07:00, 2012:12:13 16:30:47-07:00, 2012:12:13 17:49:52-07:00, 2012:12:14 14:32-07:00, 2012:12:14 14:35:50-07:00, 2012:12:14 14:43:43-07:00, 2012:12:14 15:56:46-07:00, 2012:12:14 17:02:18-07:00, 2012:12:17 15:08:12-07:00, 2012:12:17 15:08:12-07:00, 2012:12:17 15:11:13-07:00, 2012:12:18 10:31:23-07:00, 2012:12:18 13:54:38-07:00 History Software Agent : Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5, Adobe InDesign 7.5 History Changed : /;/metadata, /metadata, /metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata, /metadata, /;/metadata, /;/metadata, /;/metadata, /;/metadata Create Date : 2012:12:18 13:54:55-07:00 Modify Date : 2012:12:18 13:55-07:00 Metadata Date : 2012:12:18 13:55-07:00 Creator Tool : Adobe InDesign CS5.5 (7.5.3) Page Image Page Number : 1, 2 Page Image Format : JPEG, JPEG Page Image Width : 256, 256 Page Image Height : 256, 256 Page Image : (Binary data 7977 bytes, use -b option to extract), (Binary data 8051 bytes, use -b option to extract) Doc Change Count : 11328 Format : application/pdf Producer : Adobe PDF Library 9.9 Trapped : False Page Count : 7 Creator : Adobe InDesign CS5.5 (7.5.3)EXIF Metadata provided by EXIF.tools