The Annuncicom Technical Documentation for Firmware Version 02.06 Table of Contents SOFTWARE APPLICATION INTERFACE ............................ 2 .................................2 ONTROL NTERFACE ESCRIPTION ................................2 ONCATENATE ONTROL OMMANDS ......................................2 ORMATS SUPPORTED CGI WEB ................................3 RINCIPLES OF INTERFACE SERIAL ..................................3 RINCIPLES OF INTERFACE ..................................3 RINCIPLES OF INTERFACE ..................................3 RINCIPLES OF...
The Annuncicom Technical Documentation for Firmware Version 02.06 1 Software Application Interface Control Interface Description • 0xnn means a hexadecimal number. ↵ means 0x0D 0x0A 0x00 on answers. On requests ↵ could be one or more of the following codes/bytes: 0x0D, 0x0A, 0x00. •...
• Respect the common character set for URL's. • Example for CGI WEB commands: http://x.x.x.x/rc.cgi?c=84 (command for RESETTALK on Annuncicom IC x.x.x.x) Principles of SERIAL interface • Default settings of the serial control interface: 9600 baud, 8 data bits, 1 stop bit, no parity •...
The Annuncicom Technical Documentation for Firmware Version 02.06 Principles of pushed streaming • The default TCP Receiver port is 2020. • The default UDP Receiver port is 3030. • The device listens on the TCP Receiver port. • Open a TCP connection to the TCP streaming port and send your MP3 file over this connection or send your file as raw UDP packets to the UDP streaming port.
The Annuncicom Technical Documentation for Firmware Version 02.06 1.10 Control, SERIAL, UDP, TCP and CGI WEB interface Element Description CGI command SERIAL, TCP or UDP command ANSWERS Standard answer file ack.ack will be sent if nothing else is specified see the files in 1.13 Own skins and web interface with the L command.
Page 7
The Annuncicom Technical Documentation for Firmware Version 02.06 SERIALBIN Select Serial B as input source (digital MP3 data). c=27 0x63 0x3D 0x32 0x37 0x00 (c=27↵) LINEIN Select Line In as input. c=28 0x63 0x3D 0x32 0x38 0x00 (c=28↵) MICIN Select Mic In as input. c=29 0x63 0x3D 0x32 0x39 0x00 (c=29↵) FORCEPAUSE...
Page 8
The Annuncicom Technical Documentation for Firmware Version 02.06 SETI0 Simulates the a set on I0 c=85 0x63 0x3D 0x38 0x35 0x00 (c=85↵) RESETI0 Simulates a reset on I0 c=86 0x63 0x3D 0x38 0x36 0x00 (c=86↵) SETI1 Simulates the a set on I1 c=87 0x63 0x3D 0x38 0x37 0x00 (c=87↵) RESETI1...
Page 9
The Annuncicom Technical Documentation for Firmware Version 02.06 CONFIG Configuration commands via the normal CGI WEB command 0x43 0x3d … 0x00 (C=…↵) interface. Append the setup elements to this command. (see 1.11) CFGENCODE Sets the encoding quality. e=… 0x65 0x3D … 0x00 (e=…↵) The high nibble of byte is used for the encoding quality 0..7.
Page 10
TCP ports will have no affect. As a general rule if there is already a separate command to perform the change, e.g Volume control then QUIETCONFIG will not work. If you are not sure please ask Barix for advice. Page 9...
Page 11
The Annuncicom Technical Documentation for Firmware Version 02.06 SENDUDPSTRING Send a command string in an UDP packet r=… 0x72 0x3D (r=…↵) Syntax: r=[<prot>://][[<ip>][:<port>]/]<cmd> <prot> = udp <cmd> = [<param>]{&<cmd>} If no <prot> is defined then udp is used. If no <ip> is in the command then the IP address of the last received stream is used.
Page 12
The Annuncicom Technical Documentation for Firmware Version 02.06 SETTEMPTARGET Set a temporary target to talk to. s=… 0x73 0x3D …0x00 (s=…↵) Syntax: s=[udp://][<ip>][:<port>] or s=[file|cfg|tab]://<nr> If no port is defined then the UDP RX Port is used. If 'file' is defined, the target is taken out of the text file targets.ini. The file contains one target per line with the following syntax: <nr>=[<prot>://][[[<ip>][:<port>]]•...
Page 13
The Annuncicom Technical Documentation for Firmware Version 02.06 SENDTCPSTRING Sends the attached string through the TCP interface. The answer T=… 0x53 0x3D (T=…↵) will be the string itself. VOLUME00 Set minimal volume level (volume off). 0x76 0x3D 0x30 0x00 (v=0↵) VOLUME01 Set volume level 1.
The Annuncicom Technical Documentation for Firmware Version 02.06 1.11 Configuration via the command interfaces (only for internal use) The difference between the command and the configuration interface is only the used prefix setup.cgi instead of rc.cgi for cgi web interface. Element Description CGI command...
Page 15
The Annuncicom Technical Documentation for Firmware Version 02.06 Parameter Byte Dyn. Name Length Default Short Description [dec] [Byte] Value Own IP 0 B0, B1, B2, B3 4 0.0.0.0 Static IP address of the device. 0.0.0.0 for DHCP. 0.0.1.0 disable AutoIP 0.0.2.0 disable DHCP 0.0.4.0 disable BOOTP 0.0.8.0 disable IPzator...
Page 16
The Annuncicom Technical Documentation for Firmware Version 02.06 IFMODE1 83 B83b0-1, 1 0x4C Definition of the bits in that byte for the serial port 0: B83b2-3, Function B83b4-5, RS232-C B83b6-7 7 Bit or B83 8 Bit no parity even parity odd parity 1 Stopbit 2 Stopbit...
Page 17
The Annuncicom Technical Documentation for Firmware Version 02.06 A/D Amplifier Gain 249 B249 A/D amplifier gain 0=-3, 15=19.5 dB, one step is 1,5 dB (only for the line input) Output Mode 250 B250 1 for mono, 2 for bridge (mono) Non MP3 Packet Size 251 W251 2 1400...
Page 18
353 S353 33 /xstrea Path for the internet radio connection (example URL for an internet radio connection to the Annuncicom IC http://a.a.a.a/xstream where a.a.a.a is the IP address of the serving device) Init Sequence 386 S386 String of commands (like serial command interface) which is executed after each startup of the device.
Page 19
The Annuncicom Technical Documentation for Firmware Version 02.06 Mic Amplifier Gain 487 B487 Microphone amplifier gain, n = 0..15 and (n * 1.5) + 21 [dB] Pre Trigger Start 488 W488 Amount of bytes that will be streamed before the trigger occured Post Trigger Play 490 W490 Amount of time [ms] that will be streamed after the trigger has switched off...
Page 20
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 1 Entry 8 Type 534 B534 Type for the connection (0=Internet Radio, 1 = Raw UDP, 2 = Raw TCP, 3=not used) Command IO pushed 535 S535 64 c=83 Command sequence executed if IO will be pushed Command IO 599 S599 64 c=84...
Page 21
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 2 Entry 3 IP 959 B959, B960, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B961, B962 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 2 Entry 3 Port 963 W963 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 22
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 3 Entry 3 IP 1015 B1015, B1016, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1017, B1018 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 3 Entry 3 Port 1019 W1019 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 23
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 4 Entry 3 IP 1071 B1071, B1072, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1073, B1074 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 4 Entry 3 Port 1075 W1075 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 24
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 5 Entry 3 IP 1127 B1127, B1128, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1129, B1130 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 5 Entry 3 Port 1131 W1131 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 25
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 6 Entry 3 IP 1183 B1183, B1184, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1185, B1186 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 6 Entry 3 Port 1187 W1187 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 26
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 7 Entry 3 IP 1239 B1239, B1240, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1241, B1242 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 7 Entry 3 Port 1243 W1243 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
Page 27
The Annuncicom Technical Documentation for Firmware Version 02.06 Table 8 Entry 3 IP 1295 B1295, B1296, 4 0.0.0.0 Destination IP for the connection (on type Raw UDP 0.0.0.0 is the subnet broadcast IP address), B1297, B1298 (on type Raw TCP 0.0.0.0 means listener on the corresponding port) Table 8 Entry 3 Port 1299 W1299 Destination Port for the connection (0 for use UDP Rx Port, if this is 0 use default 3030)
The Annuncicom Technical Documentation for Firmware Version 02.06 1.13 Own skins and web interface With the Annuncicom IC App Development Kit (DOS) you can design your own web pages (skin) and modify the answers to your needs. This kit is available on www.barix.com.
Page 30
The Annuncicom Technical Documentation for Firmware Version 02.06 uiaudio.html configuration pages for the corresponding settings uicontrol.html uiio.html uinetwork.html uisecurity.html uiserial.html uistreaming.html uittable1.html uittable2.html uittable3.html uittable4.html uittable5.html uittable6.html uittable7.html uittable8.html uicfg.html shows the current loaded versions of the device uiconfig.html main configuration, contains the main frames for the configuration uidefaults.html set factory defaults Page 29...
Page 31
The Annuncicom Technical Documentation for Firmware Version 02.06 uifaudio.html specific configuration page, contains the frames for the corresponding configuration pages uifcontrol.html uifdefaults.html uifio.html uifloader.html uifnetwork.html uifreboot.html uifsecurity.html uifserial.html uifstreaming.html uifttable1.html uifttable2.html uifttable3.html uifttable4.html uifttable5.html uifttable6.html uifttable7.html uifttable8.html uifupdate.html uifmenu.html frame page for the skin and version uifstatus.html frame page for the device status uihaudio.html...
Page 32
The Annuncicom Technical Documentation for Firmware Version 02.06 uihstatus.html help for the device status page uilogout.html logout page uimenu.html frame for menu uimenuline.html menu for the configuration buttons on the configuration pages uimenu0.html menu for the configuration button on the control page uiraudio.html showed after pressing apply or a reboot of the device is needed until the device has rebooted uircontrol.html...
Page 33
The Annuncicom Technical Documentation for Firmware Version 02.06 Java Script util.js javascript functions for the HTML configuration pages (range checks) The filenames shouldn't start with rc.cgi or setup.cgi. Don't exceed 64 kByte of data per file. Note that a bigger .cob file needs per 64 kByte one flash page of 64 kByte. To generate a .cob file start the batch annuncicomicapp.bat.
The Annuncicom Technical Documentation for Firmware Version 02.06 1.14 Memory Page Usage A page is 64 kByte of flash memory. Free pages can be used for additional resources. Annuncicom IC (1MB Flash) (Note: 0xC00000 = 0xD00000 = 0xE00000 = 0xF00000) Page / Target Content...
The Annuncicom Technical Documentation for Firmware Version 02.06 1.15 Dynamic Web Page Dynamic Web Pages are built in HTML or XML or each other text file format that doesn't contain the binary character 0x00. A dynamic page can be an HTML file. To indicate such a page it has to contain the initial mark &L(0,"*") in the first 500bytes before the first dynamic value is used.
The Annuncicom Technical Documentation for Firmware Version 02.06 1.17 Configuration via HTML Pages The HTML pages for the device configuration use the functionality for dynamic web pages (see 1.15 Dynamic Web Page). All of the configuration parameters are placed in HTML forms and are transferred by the method GET. Some of the values are checked by java script to prevent wrong values. Not all of the configuration parameters have to be present in a form.
Page 37
The Annuncicom Technical Documentation for Firmware Version 02.06 This example shows how to implement a form field for the configuration of the Netmask. The names for the bytes of the Netmask are N8B0, N8B1, N8B2 and N8B3. 8 is the address of the Netmask in the common setup (see table in 1.12 Setup). The value after the B is the byte number of the byte in the Netmask starting with 0 for the first byte at the left.
Page 38
The Annuncicom Technical Documentation for Firmware Version 02.06 Dynamic Marks For Group State: <id> Type Description Function Print string if equal 3. [par]: state variable volume lock (0 = no lock, 1 = locked) 12 loudness on (0 = off, 1 = on) 13 volume mute (0 = off, else on) 22 mode (0 = unknown, 1 = streaming, 2 = pull) 23 status (0 = idle, 1 = play, 2 = pause)
Page 39
The Annuncicom Technical Documentation for Firmware Version 02.06 hardware type (0 = unknown, 1 = Annuncicom IC) codec type (0 = no codec, 1 = MAS3509 (decoder), 2 = MAS3587 (encoder)) mode (0 = unknown, 1 = streaming, 2 = pull)
Page 40
The Annuncicom Technical Documentation for Firmware Version 02.06 3. [par]: Address (decimal) of the value in the setup 4. [par]: Type of the value (B for unsigned byte, W for word, D for double word, c for char/signed byte, b for bit numbered from 0 to 7 ex.
The Annuncicom Technical Documentation for Firmware Version 02.06 If the value is a string the first character is an S. If the value is a long (4 byte) the first character is a D. If the value is a signed byte the character is a c. if the value is a word the character is a W.
The Annuncicom Technical Documentation for Firmware Version 02.06 1.19 Green and Red LED Application is starting: First the red goes on and the green LED blinks once. Then during the startup the green and red LEDs are blinking. During DHCP the red LED is blinking always and the green LED is blinking alternate for five times and then pause for four times.
Page 43
The Annuncicom Technical Documentation for Firmware Version 02.06 Device after production without bootloader: Red LED Green LED Meaning No power or bootstrap checksum failed RAM Test in progress, stays on if test failed Serial port being polled Blink Serial port load in progress Serial port load failed Blink Serial flash load in progress (not used)
The Annuncicom Technical Documentation for Firmware Version 02.06 2 Hardware and Connectors Ethernet Yellow LED (right LED): Link ok if on Green/Orange LED (left LED): green if 10Mbit, orange if 100Mbit Serial Port +/- 15V TxD is short circuit protected. Max.
Need help?
Do you have a question about the Annuncicom IC and is the answer not in the manual?
Questions and answers