Philips FMod-TCP BOX manual

See page 10 for quick start Ethernet Converter Device FMod-TCP BOX User Manual Version 1.2[...]

2 / 58 Version: 1.2 Last revision: August 14th, 2006 Printed in Switzerland © Copyright 2003-2006 FiveCo Sàrl. All rights reserved. The contents of this manual may be modified by FiveCo withou t any warning. Trademarks Windows® is a registered trademark of Microsoft Corporation. Ethernet® is a registered trademark of Xerox Corporation. Java® i[...]

3 / 58 Table of Contents 1 Package and operati ng conditions ............................................................................................... ..................5 Starter Kit contents ................................................................................................................................................5 Absolu[...]

4 / 58 Revision history Revision Date Author Note Firmware version Applet version Win32 app version 1.0 05.05.06 AG - First version Since 1.0 Since 1.0 Since 3.0 1.1 09.06.06 AG - Update specifications - Text corrections Since 1.0 Since 1.0 Since 3.0 1.2 14.08.06 AG - I2C speed correction. - Warning register bits correction. Since 1.0 Since 1.0 Sin[...]

5 / 58 1 P ack age and oper ating conditions Starter Kit contents The FMod-TCP BOX “Starter kit” should contain:  FMod-TCP BOX device  RS232 DSub cable  DIN 41651 40 lines cable  CD-Rom with dedicated software and Java applet sample  This manual Absolute maximum rating Damage may occur if the device is operated using values beyon[...]

6 / 58 2 Over vie w Applications The FMod-TCP BOX is a TCP/IP server that allows system integrators to connect different devices such as home appliances, industrial sensors and industrial control systems directly to th e Ethernet network, (10BaseT) and to remotely monitor and control th ose using standard protocols. It can either be accessed throug[...]

7 / 58 "Question & Answer" oriented. The PC should send a Question, wait for the Answer and so on. To configure the device's parameters and to access I/O and A/D features, the protocol uses an Internal Registers Access routine (see chapter 4 and 7). The code samples available on the FiveCo's web site can help programmers get[...]

8 / 58 See page 9 to know how the SOS button works. Two LEDs illuminate the SOS button and the displaye d color as the following meanings: Green Everything is normal. Red There is an error. See Warning register to know the source of the error. Red-Green The device found another one with the same IP address er device and rebo t the FMod-TCP BOX. bli[...]

9 / 58 The I2C pins are provided through a Philips PCA9512 driver chip. 10k Ω pull ht side Standard RS232 DSub 9 connector (male like on a computer) 1 NC 6 NC 2 Receive data 7 Request To Send 3 Transmit data 8 Clear To Send 4 NC 9 NC 5G N D -ups are connected to A. SCL and SD Rig The RS232 connector is the same as the ones found on any computer. [...]

10 / 58 3 Quick star t This section is intended to help users to quickly plug the module into their system and establish a connection between the computer and the device. You can find the device’s factory co mmunication settings on the following label. This device is not intended to be used in a medical, lif e-support or space product. Any fai lu[...]

11 / 58 You can now connect the device with th e Win32 software or open its web page by typing its new IP address into a web browser. Notes:  The IP address won't be changed if a TCP connection exists with the device.  The protocol used to change the IP address is described later in this manual. FMod-TCP User Manual v.2.8[...]

12 / 58 4 Contr olling the FMod-T CP BO X by T CP or UDP General Information All the device's parameters (configur ation registers) and features can be accessed through a TCP or UDP port. In addition, an HTTP-TCP port is a vailable for web pages downloading and another TCP port for RS232 bus access. Those ports are:  TCP Port #80 for HTTP c[...]

13 / 58 So, with speeds greater than 9600bds, th e buffer may be filled faster than data can be sent by TCP and part of th ose will be lost if no RS232 hardware flow control is used between the FMod-TCP BOX and the RS232 device (CTS and RTS lines). If you cannot use hardware flow contr ol on RS232 bus and you have to get more than 2048 bytes at one[...]

14 / 58 Registers access feature TCP/IP works in big endian: most significant byte first, followed by least significant byte. The access to the data is done through an easy (6 byte header) protocol over TCP. Structure of each packet: 1. Function ID (2 bytes), 2. Transaction ID (2 bytes) 3. Length of the parameters (2 bytes) 4. Parameters (X byte) 5[...]

15 / 58 Write register(s) command: Byte# Number of bits Example 0x00 Write (0x0022) 16 bits 0x0022 0x02 TransactionID 16 bits 0x1B34 0x04 Number of bytes in command 16 bits 0x0003 0x06 Register Addresses 8 bits 0x02 0x07 Register value 8 — 64 bits 0x1234 The two previous entries are replicated for ev ery register that has been asked for reading ?[...]

16 / 58 To be able to do all of these 3 sequences, use this command: Byte# Number of bits Example 0x00 I2CRWwithAck (0x0007) 16 bits 0x0007 0x02 TransactionID 16 bits 0x1B34 0x04 LengthOfParameters (X + 3) 16 bits 0x0005 0x06 7 bits Address (bit 7 = 0) 8 bits 0x28 0x07 X (number of bytes to write) 8 bits 0x02 0x08 xBytes X bytes 0xAF1D …. Y (numb[...]

17 / 58 Note that the max length of those sequences is 180 bytes. Pay close attention to building sequences that do not exceed this and not to ask too much byte in answer ! The FMod-TCP BOX translates automatically those sequences to I2C sequences. It is mandatory that the seque nce has to be transmitted within one TCP packet. Otherwise, the FMod-T[...]

18 / 58 3. The I2C controller does not match all I2C specifications at speed higher than 100kHz. This feature w ill therefore not work with all I2C slaves. The value of the I2CSPD parameter mu st be computed with the following formula: 1 2 10 2 7 − = wanted CSpeed I CSPD I The I2C speed cannot be saved in EEPROM. FMod-TCP User Manual v.2.8[...]

19 / 58 Easy IP address config (UDP # 7010) A really useful feature of the UDP po rt #7010 is the "Easy IP config" one. The user who wants to design his own so ftware can use this feature to do a "quick start/install" method. Indeed, since this protocol uses a broadcast UDP packet, even if the device is not in th e same subnet, [...]

20 / 58 Checksum calculation This checksum is the same as the IP checksum. Definition: sum of 1’s complement of all 16 bits words of whole message (FiveCo packet) except checksum bytes. Note: all values are unsigned! Sequence: 1. Clear accumulator Loop x. Only if last word is not made of two bytes, the data byte is the upper byte (big endian) 2. [...]

21 / 58 Here is an example of a checks um calculation function in C: int RetCheckSum(Byte* ByteTab, int Size) { // This function returns the calculated checksum unsigned int Sum=0; bool AddHighByte=true; unsigned int ChecksumCalculated; for(int i=0;i<Size;i++) { if(AddHighByte) { Sum+=((ByteTab[i])<<8)^0xFF00; AddHighByte=false; } else { S[...]

22 / 58 5 Java A pplet A specific Java Applet is provided with the module to control any of its ports without having to write any specific code. Overview To connect to the http server on the device, simply open your web browser and type the IP address of the modul e. Example with default address: “http://169.254.5.5” The applet is downloaded fr[...]

23 / 58 Main Config The Main panel shows the general in formation related to the device. • The first part allows the user to change the main settings of the device. Don't forget to use the "Save user parameters" button to make chan ges permanent! • The second part allows the user to save/restore user and factory parameters and to[...]

24 / 58 Test A/D and I/Os This page can be used to access Inputs state and voltage and change Outputs state. The Inputs state and voltage are regula rly updated automatically (20 kHz). You can change the low to high thresh old of the inputs between 0 and 24V. This page display also the device s upply voltage and warnings (Too low/high supply voltag[...]

25 / 58 Test RS232 This page can be used to access RS232 bus. If you click on the "Connect to RS232 TCP Port" you can send ASCII data to RS232 bus and receive data from it (only AS CII is visible in this application). You can check "Add LF", "Add CR" a nd/or "Add Null" boxes to add a Line Feed, a Carriage Ret[...]

26 / 58 Test I2C This page can be used to access I2C bus. The panel is divide d in two parts:  The part on the right allows sca nning the I2C bus to find available slave devices.  The part on the left allows sendi ng a read or a write command to a device on the I2C bus. You should first check if you want a re ad or a write. Then you have to w[...]

27 / 58 checked the "Read" box, the FMod- TCP BOX will use the read after write I2C feature). After writing the I2C address (7bits hexa) and the number of bytes to read (if applicable), click on the "Send" but ton. The answer is displayed in hex in the "Data received" field. FMod-TCP User Manual v.2.8[...]

28 / 58 6 Win3 2 A pplicatio n A specific application is provided with the module to control any of its ports without having to write a specific code. Overview IP address of the module Open or close TCP port TCP port number Depends on port Connection status To open a TCP port on the module, the user has to set the correct IP address of the module, [...]

29 / 58 This application uses the IP address of your computer and its su bnet mask to find the scan broadcast address. When you click on scan, a broadcast message will be sent to all devices in your subnet and answers will be listed. WARNING : it only works with de vices in your subnet! How does it work? When you click "Scan", the softwar[...]

30 / 58 RS232 interface chain to send Send ASCII, Hex, or Decimal chain Bytes received from RS232 The RS232 interface is easy to use. Just write the ASCII, HEX or decimal string in the dedicated text box and c lick corresponding "Send" button. The received bytes are displayed into the "Data received" boxes (same data but differe[...]

31 / 58 “Load web files” interface File(s) list operations List of files to load Number of bytes in list Create file for factory upload Load files into module This option allows users to load their pe rsonal web files (html, java, jpeg, gif, txt …) into the flash memory. A maximum of 44kB is available for that application. An example of pages[...]

32 / 58 Main port interface Change RS232 baud rate Outputs state and flow control Change disconnection timeout Inputs state and voltage Change IP address of the module Change subnet mask of the module Scan I2C bus Number of bytes to read from I2C Module MAC address Change module name Hex data to write to Bytes received from I2C I2C operation I2C Ad[...]

33 / 58 The I2C interface is an easy way to test the I2C connection between the module and the user's electronic. The user has to choose between an I2C Read or Write operation. In Write mode , the bytes (in hexadecimal like 41 42 45 separated by spaces!) must be written in the de dicated line and the I2C address in the dedicated Address space [...]

34 / 58 7 Registers management Memory Organization The user must know that a new register value sent through the communication port is loaded to the running parameters in RAM and used for the current process. All these parame ters are lost upon power-down. It is required to save them to “User Pa rameters” or “Factor y Parameters” with the c[...]

35 / 58 Full Register Description List of registers Address Bytes N a m e General Information 0x00 (00) 4 TYPE 0x01 (01) 4 VERSION 0x02 (02) 0 (fct) RESETCPU 0x03 (03) 0 (fct) SAVEUS ERPA RAMETER S 0x04 (04) 0 (fct) RESTOREUSER PARAMETE RS 0x05 (05) 0 (fct) RESTOREFACTORYPARAMETERS 0x06 (06) 0 (fct) SAVEFACTORYP ARAMETERS 0x07 (07) 4 VOLTAGE 0x08 ([...]

36 / 58 TYPE Register Address Register Name Functio n Read/Write Control 0x00 TYPE Product ID Read only Register Size Register structure 4 Bytes Unsigned Int 16bits (HH-HL) TYPE U nsigned Int 16bits (LH-LL) MODEL Description: Product identifier composed with a Type and Model number. It defines which kind of peripheral it is . Normally different mod[...]

37 / 58 VERSION Register Address Register Name Functio n Read/Write Control 0x01 VERSION Software ID Read only Register Size Register structure 4 Bytes Unsigned Int 16bits (HH-HL) Version Unsigned Int 16bits (LH-LL) Revision Description: Firmware identifier composed with a Version and Revision number. Same Version with different Revision is backwar[...]

38 / 58 RESET CPU Function Address Function Name Func tion Read/Write Control 0x02 RESETCPU Restart processor Write only Register Size Register structure Unit 0 Byte none none Description: Reboots the device. The communication will be lost. FMod-TCP User Manual v.2.8[...]

39 / 58 SAVE USER PARAMETERS Function Address Function Name Func tion Read/Write Control 0x03 SA VEUSE RPARAME TERS Saves all in EEPROM Write only Register Size Register structure Unit 0 Byte none none Description: Saves the following parame ters to user EEPROM space:  0x12 IPADDRESS  0x13 SUBNETMASK  0x14 TCPTIMEOUT  0x15 MODULENAME ?[...]

40 / 58 RESTORE USER PARAMETERS Function Address Function Name Function Read/Write Control 0x04 RESTOREUSE RPARAMETE RS Restores saved values Write only Register Size Register structure Unit 0 Byte none none Description: Restores the following parameters from user EEPROM space:  0x12 IPADDRESS  0x13 SUBNETMASK  0x14 TCPTIMEOUT  0x15 MOD[...]

41 / 58 RESTORE FACTORY PARAMETERS Function Address Function Na me Function Read/Write Control 0x05 RESTOREFACTORYPARAMETERS Factory default Write only Register Size Register structure Unit 0 Byte none none Description: Restores the following parameters from factory EEPROM space:  0x12 IPADDRESS  0x13 SUBNETMASK  0x14 TCPTIMEOUT  0x15 M[...]

42 / 58 SAVE FACTORY PARAMETERS Function Address Function Name Func tion Read/Write Control 0x06 SAVEF ACTORYPARAMET ERS Save factory default Write only Register Size Register structure Unit 0 Byte none none Description: Saves the following parameters to factory EEPROM space:  0x12 IPADDRESS  0x13 SUBNETMASK  0x14 TCPTIMEOUT  0x15 MODUL[...]

43 / 58 VOLTAGE Register Address Register Name Functio n Read/Write Control 0x07 VOLTAGE Power input voltage Read only Register Size Register structure Unit 4 Bytes Signed (2’s cplt) Int 16 (HH-HL) +16 bits fixed point (LH-LL) Volt Description: Input Voltage Limits: Max 0x7FFFFFFxx = 32’767.996 Min 0x000000xx = 0.0 Step 0x000001xx = 0.004 Examp[...]

44 / 58 WARNING Register Address Register Name Functio n Read/Write Control 0x08 WARNING Bit to bit state R/W Register Size Register structure Unit 4 Byte Unsigned Int 32 bits , each bit independent none Description: Each information/warning/error is containe d in 2 bits: the first one (from LSB to MSB) shows the actual state, the next one shows if[...]

45 / 58 COM OPTIONS Register Address Register Name Function Read/Write Control 0x10 COMOPTIONS Communication options Read/Write Register Size Register structure Unit 4 Bytes 32 individual bits none Description: This register is reserved for future use. FMod-TCP User Manual v.2.8[...]

46 / 58 ETHERNET MAC Register Address Register Name Functio n Read/Write Control 0x11 ETHERNETMAC Hardware network ID Read only Register Size Register structure Unit 6 Bytes 6 x Unsigned Bytes none Description: A standard hardware unique identifier (worldwide) for each device on an Ethernet network. Note: If the user writes into this register, the [...]

47 / 58 IP ADDRESS Register Address Register Name Function Read/Write Control 0x12 IPADDRESS IP netwo rk ID Read/Write Register Size Register structure Unit 4 Bytes 4 x Unsigned Bytes none Description: Network identifier used for TCP/IP and UDP/IP. The values 255 (0xFF) and 0 (0x00) are reserved for broadcast and network addresses and should not be[...]

48 / 58 SUBNET MASK Register Address Register Name Functio n Read/Write Control 0x13 SUBNETMASK IP subnet mask Read/Write Register Size Register structure Unit 4 Bytes 4 x Unsigned Bytes none Description: Network IP subnet mask used for TCP/IP and UDP/IP. Notes: The module will change for a new s ubnet mask only when all of its communications ports[...]

49 / 58 TCP TIMEOUT Register Address Register Name Functio n Read/Write Control 0x14 TCPTIMEOUT Time out for TCP connection Read/Write Register Size Register structure Unit 1 Byte Unsigned Int 8 bits sec Description: The TCP timeout is a value (in seco nds) after which the user will be disconnected if the device has not been accessed in the meantim[...]

50 / 58 MODULE NAME Register Address Register Name Function Read/Write C ontrol 0x15 MODULENAME Module’s ASCII name Read/Write Register Size Register structure Unit 16 Bytes 16 (only) x Unsigned Bytes (CHAR) none Description: Name and/or description of the module. Example: For the name “Hello Module”; extend to 16 byte the name: “Hello Modu[...]

51 / 58 RS232 CONFIG Register Address Register Name Functio n Read/Write Control 0x16 RS232CONFIG RS232 baud rate and flow control configuration Read/Write Register Size Register structure Unit 1 Byte Unsigned Int 8 bits none Description: RS232 baud rate and flow control configuration. Bits 0-2 Baud rate configuration : 0 : 4800 bds 1 : 9600 bps (d[...]

52 / 58 I2C SPeeD Register Address Register Name Function Read/Write Control 0x18 I2CSPD I2C speed setting Read/Write Register Size Register structure Unit 1 Byte Unsigned Int 8 bits none Description: I2C speed setting between ~39kHz and 400kHz. The value of this parameter must be compu ted with the following formula based on the wanted speed: 1 2 [...]

53 / 58 TCP CONNECTION S OPENED Register Address Register Name Function Read/Write Control 0x1A TCPCONNECTIONSOPENED Number of TCP connections that are opened Read only Register Size Register structure Unit 1 Byte Unsigned Int 8 bits none Description: Number of users connected to the device using TCP. Value can be 0 to 4. FMod-TCP User Manual v.2.8[...]

54 / 58 ANALOG INPUTS THRESHOLD Register Address Register Name Functio n Read/Write Control 0x20 ANALOGINPUTST HRESHOLD AD converter threshold on inputs Read/Write Register Size Register structure Unit 4 Bytes Signed (2’s cplt) Int 16 (HH-HL) +16 bits fixed point (LH-LL) Volt Description: Defines the threshold used by the AD converter on inputs p[...]

55 / 58 INPUTS Register Address Register Name Function Read/Write Contro l 0x21 INPUTS 16 inputs states Read only Register Size Register structure Unit 2 Bytes Unsigned Int 16 bits, each bit independent none Description: Show digital state of each inputs pin. The state is defined by comparing actual input voltage with the ANALOG INPUTS THRESHOLD. B[...]

56 / 58 OUTPUTS Register Address Register Name Function Read/Write Control 0x23 OUTPUTS Sets outputs states Read/Write Register Size Register structure Unit 2 Bytes Unsigned Int 16 bits, each bit independent none Description: Controls the state of each of the output pins. Bit 0 OUTPUT#1 (Relay A) Bit 1 OUTPUT#2 (Relay B) Bit 2 OUTPUT#3 Bit 3 OUTPUT[...]

57 / 58 INPUT VOLTAGE x VALUE Registers Addresses Register Name Func tion Read/Write Control 0x30 to 0x3F INPUTVOLTAGExVALUE Last INPUTVx A/D conversion result Read only Register Size Register structure Unit 4 Bytes Signed (2’s cplt) Int 16 (HH-HL) +16 bits fixed point (LH-LL) Volt Description: Voltage value of the 16 inputs pins between -12V and[...]

58 / 58 FMod-TCP User Manual v.2.8 Contact address : FiveCo - Innovative Engineering PSE-C CH-1015 Lausanne Switzerland Tel: +41 21 693 86 71 Fax: +41 21 693 8 6 70 www.fiveco.ch info@fiveco.ch[...]