page 1 / 23 Copyright 2011, RFXCOM

Transcription

1 RFXLAN Ethernet Interface User guid de page 1 / 23

2 1. Table of Contents 1. Table of Contents RFXLAN Ethernet interface Front panel RFXLAN 5V DC power USB connection Reset button LAN connection Receiver and transmitter installation How to find the IP and MAC address of the RFXLAN Configure the RFXLAN Configure the network interface Restore to default network settings Configure Port Configure Port Configure I/O ports Configure Dynamic DNS Configure SNMP Flash update of the RFXLAN Update firmware in the RFXLAN (soon available) Update web pages in the RFXLAN Install a Windows COM Port redirector Create the Connector Create the TcpClient Save the configured virtual COM ports Start VSPE automatically at Windows startup Ports to open in a Firewall I/O lines I/O Control Protocol Command types Warranty Warning: Copyright notice Revision history page 2 / 23

3 2. RFXLAN Ethernet interface. The function of the Ethernet interface is to facilitate I/O connections to the RF receivers and RF transmitters. The Ethernet Interface communicates with the system using a TCP/IP connection. The device controller in the RFXCOM Ethernet interface communicates to the RFXCOM receivers and transmitter via the internal COM ports. For the Windows platform a COM port redirector is necessary. All existing Home Automation software based on Windows that is using COM port communication to the RFXCOM receivers can also use the RFXCOM Ethernet interface without any change. The RFXCOM receivers have a W800 compatible receiving mode and all existing W800 Home Automation software based on Windows can also use the RFXCOM Ethernet interface without any modifications. All software supporting TCP/IP connections can also use the RFXCOM Ethernet Interface. RFXLAN Ethernet Interface: Internal COM port for 2 receivers (Master+Slave) Internal COM port for 1 transmitter IP port with 8 I/O lines TCP/IP communication, Configuration using a web browser, USB interface for firmware upgrades, LAN interface 10/100Mb. The RFXCOM Ethernet Interface uses the Internet Protocol (IP) for network communications. It uses the Transmission Control Protocol (TCP) to assure that no data is lost or duplicated, and that everything sent to the connection arrives correctly at the target. TCP is used for the serial ports and the I/O lines. IP is used for addressing, routing, and data block handling over the network. HTTP is used for the build-in web server to configure the Ethernet device controller. SNMP V2 is used for network monitoring. page 3 / 23

4 3. Front panel 3.1. RFXLAN 5V DC power Important: use the delivered 5 Volts 1.2AA DC switched power supply s with the positive voltage as center pin. A non-compatible power adaptor will destroy the Ethernet interface and the installed receivers/transmitter! 3.2. USB connectionn This connection is used for firmware flashh updates and RFXCOM diagnostics Reset button The reset button is behind the front panel and has multiple functions. Use a 2 mm pin to push the reset button gently. The firmware flash update procedure will start if the reset button is pressed during power up and held for at least 4 seconds, The RFXLAN default settings are restored if the reset button is pressed for at least 4 seconds when the RFXLAN is running LAN connectionn Connect the RFXLAN using a straight RJ45 cable as supplied. The left LED indicates data traffic and thee right LED indicates connected. 4. Receiver and transmitter installation Disconnect the power from the RFXLAN.. The Master receiver should be plugged inn into the JP4 connector of the Ethernet module. An optional Slave receiver must always be plugged into the JP55 connector. A transmitter must always be plugged into the JP6 connector. page 4 / 23

5 5. How to find the IP and MAC address of the RFXLAN Start the RFXCOM Ethernet Discoverer.e exe and click Discover Devices. All connected RFXCOM devices will be displayed with their IP, NetBIOS name and MAC address. 6. Configure the RFXLAN Start a browser and connect the RFXLANN using or the IP address of the RFXLAN supplied by the DHCP server. After the connect you will see this screen: page 5 / 23

6 6.1. Configure the network interface. The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom The default network settings in the RFXLAN are: NetBIOS name: RFXLAN DHCP enabled Important: If you have multiple RFXLAN interfaces you have to assign a different NetBIOS name before you connect the next RFXLAN to avoid duplicate NetBIOS names. Assign A alsoo a different NetBIOS name to the next RFXLAN so that a restore to default settings will w not result in duplicate NetBIOS names on your network. To use the RFXLAN in applications you can use the NetBIOS name n with DHCP enabled or deselect DHCP and assign a fixed f IP address. page 6 / 23

7 Press the Save Config button after youu have made the required changes. The next screen will be displayed: 6.2. Restoree to default network settings. Follow the next procedure to restore r the RFXLAN to default network settings: Power the RFXLAN interface, (reset button NOT pressed) Press and hold the reset button for 5 seconds. The reset button is behind the hole in the middle of the front panel. Warning: The RFXLAN will start a firmware flash update if the reset button is pressed for 10 seconds. The RFXLAN network settingss are now set to: Host Name: RFXLAN and DHCP enabled. Note: The firmware flash procedure will also start if the reset button iss pressed for 5 seconds when the RFXLAN is connected to the power. See the chapter Install new firmware e in the RFXLAN. page 7 / 23

8 7. Configure Port 1 The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom COM port 1 is normally used for f the receivers in the JP4 / JP5 connectors. c. The default settings used are: IP port 10001, 4800bd, 8 bits data, no parity, 1 stop bit Press the Save button after you have made the required changes. The RFXLAN will reboot to activate the selected settings. page 8 / 23

9 8. Configure Port 2 The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom COM port 2 is normally used for f the transmitter in the JP6 connector. The default settings used are: port 10002, 4800bd, 8 bits data, no parity, 2 stop bits Press the Save button after you have made the required changes. The RFXLAN will reboot to activate the selected settings. page 9 / 23

10 9. Configure I/O ports The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom The 8 I/ /O ports can be configured individually for Input or Output. Only Input ports can be configured for use with or without the use of an internal pull-up. Press the Save button after you have made the required changes. The RFXLAN will reboot to activate the selected settings. page 10 / 23

11 10. Configure Dynamic DNS The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom Important: This function has not been tested yet. page 11 / 23

12 11. Configure SNMP The configuration pages are protected byy a User name and Password. User name: admin Password: rfxcom SNMP has not been tested and is not yett fully implemented. page 12 / 23

13 12. Flash update of the RFXLAN Update firmware in the RFXLAN (soon available) a Firmware is flashed in the RFXLAN usingg this procedure on a Windows system: Use the file on the RFXCOM CD or download the RFXLAN_x_yy.hex firmware file. Remove the power from the RFXLAN Connect the RFXLAN USB to a Windows system Push and hold the reset button onn the RFXLAN Power the RFXLAN and hold the reset button for at least 5 secondss until the PC detects the RFXLAN USB. If this is the first time you have connected the RFXLAN USB to the PC the Wizard New Hardware will open. o Do not allow to let Windows search o Do not install automaticallyy o Insert and select the RFXCOM CD o Accept the driver Start the RFXflash program. Select in RFXflash the USB RFXLAN COM port Click the Connect to Device button page 13 / 23

14 Click the Erase Devicee button Click the Connect to Device button to disconnect the RFXLAN Click again the Connect to Devicee button to connect thee RFXLAN Click the Open HEX file button and load the RFXCOM_x_xx.hex file page 14 / 23

15 Click the Write device button and the RFXLAN is reprogrammed. Click on the Normal Execution Mode button to set the RFXLAN R to running mode. Update the web pages now. This is only necessary if a new n versionn is available. page 15 / 23

16 12.2. Update web pages in the RFXLAN The web pages are uploaded using this procedure: Use the file on the RFXCOM CD or download the RFXLAN_x_yy.web file. Important: The web file must havee the same main release (x) as thee RFXLAN x_yy.hex firmware loaded in the RFXLAN interface. Start a web browser and enter: (iff the NetBIOS name is RFXLAN) or IP number>/rfxupload (e.g. Select the RFXLAN web file and click Upload page 16 / 23

17 13. Install a Windows COM Port redirecto or. Some Home Automation programs have direct TCP/ /IP communications built in like the RFXCOM plug-in for Homeseer and xplrfx. These programs do not need a COM port redirector. Programs that only can communicate using a COM port will need a COM port redirector. This is for example applicable for HouseBot. A free COM port edirector forr 32 bits Windows can be downloaded at: Eterlogic delivers also a COM port redirector for 64 bits Windows systems. A few steps are necessary to create and use a VSPE virtual COM port: 1. Create a device with type: Connector and assign a COMM port to this device. 2. Create a device with type: TcpClient and connect the IPP address orr NetBIOS name with the Connector COM port. 3. Save the configured COM ports 4. Create a shortcut to start VSPE automatically at Windows startup Create the Connector Select Device and click Createe page 17 / 23

18 Select Connector and click Next Click Finish. page 18 / 23

19 13.2. Create the TcpClient Select Device and click Createe Select TcpClient and click Next page 19 / 23

20 Enter the IP address or NetBIOS name at Remote TCP host, At Remote TCP port enter: for the receiver port or for the transmitter port Select the source serial port that was created in the previous step, COM8 in this case, Click Settings and set the Serial port settings to: Speed: 4800, DTR/RTS: NO, Parity: no, Bits: 8 Stop bits: 1 for the receivers and 2 for the transmitter. Click Finish Save the configured virtual COM ports. If you have configured the COM port (COM8 in this example) correctly it will show the status OK and is now ready to use. Click File Save as and save the file on your selected location. page 20 / 23

21 13.4. Start VSPE automatically at Windows startup. Create windows shortcut. (right click on the desktop screen andd create neww shortcut) If you have installed VSPE at default location ("C:\Program Files\Eterlogic..com\Virtual Serial Ports Emulator") and the config file was saved as c:\config.vspe than set the shortcut parameters as: Target: "C:\Program Files\Eterlogic.com\ \Virtual Serial Ports Emulator\VSPEmulator.exe" - minimize -hide_splash c:/config.vspe Start in: "C:\Program Files\Eterlogic.com\Virtual Serial Ports Emulator" Move or copy-paste the created shortcut to the "Start Menu\Programs\Startup" folder. 14. Ports to open in a Firewall. If the RFXLAN Interface is behind a firewall then open the next ports: IP port 80 used for http configuration of the RFXLAN IP port used for COM port 1, (IP port can be configured!) ) IP port used for COM port 2, (IP port can be configured!) ) UDP port used for the TCP/IP discoverer function IP port used for I/O lines page 21 / 23

22 15. I/O lines Solutions for these lines IO0 to IO7 are not yet implemented. These lines can however be used if you know how to hardware interface these lines. The output levels are 3.3 Volts and they are 5 Volt tolerant for input. Maximum output sunk is 25mA per I/O line with a total of 150mA for all 8 lines. Important: Do not use the other IO lines as they are not 5 Volt tolerant and have other function for internal use! Use these I/O pins to control devices such as relays, servers, lights, monitor switches, sensors. Output pins are set low after reset. The protocol supports now 8 I/O lines. The input or output selection can be retrieved and controlled. Every change of state (active/inactive) requires a command over TCP, and thus is not very fast with a maximum of about 1 Kbps I/O Control Protocol The I/O control protocol is described from the PC side. Send means from PC to RFXLAN. Response comes from RFXLAN to PC. The protocol allows control of up to 8 I/O lines. The parameters are four bytes long and represent I/O 0-31, with IO0 in bit 0 of the first byte (Little Endian). Every command consists of nine bytes: one command type of one byte and two parameters of four bytes each. Command Parameter 1 Parameter 2 Byte IO On some commands, one or all parameters are ignored. Responses to valid commands are always five bytes long, consisting of the returned command byte and as parameters in the current or updated values. In case of an invalid command, only one byte with value 0FFh is returned. Command Parameter 1 Byte IO When sending a command wait for the response before sending the next command Command types 0x10 Get functions 0x11 Get directions (input or output) 0x12 Get active levels (only high active supported) 0x13 Get current states (active or not active) 0x19 Set directions 0x1A Set active levels (not supported) 0x1B Set current states 0x1C Pushed current states (transmitted by the RFXLAN to the PC on any input change) page 22 / 23

23 16. Warranty European warranty rules are applicable. Warranty is lost if: Connections have been made to the I/O lines, Any modification has been made to the device, Other devices than RFXCOM receivers and transmitters are connected to JP4, 5 and 6, If another power supply as the delivered 5V DC power adapter is used, Any abnormal use or abnormal conditions are applied. 17. Warning: RF signals are possible disturbed and it has not been justified for this equipment at uses in circumstances where life-threatening or dangerous situations are possible. 18. Copyright notice It is forbidden to use any RFXCOM device, software or protocol as part of an exclusive or patented product without the express prior written permission of RFXCOM. All materials contained in this document are protected by copyright laws, and may not be reproduced, republished, distributed, transmitted, displayed, broadcast or otherwise exploited in any manner without the express prior written permission of RFXCOM. 19. Revision history. Version 0.0 December 8, 2010 Initial version. Version 0.1 December 9, 2010 Firmware flash procedures added Version 0.2 December 19, 2010 Web page update added Version 0.3 March 8, 2011 Flash program description added Version 0.4 March 9, 2011 Flash program pictures changed Version 0.5 March 11, 2011 Flashing procedure updated page 23 / 23