Omni-Bus Interface Translatr Rev 2 Reference Manual
Table f Cntents 1. Overview... 3 1.1. LEVITON Omni Link Interface... 3 1.2. Bus Gateway... 4 2. TCPIP Netwrk Setup... 5 3. USB Gateway Setup... 6 4. TCPIP Gateway Setup... 7 4.1. Enabling the TCPIP Gateway... 7 4.2. Cnnecting t the TCPIP Gateway frm OMNIBUS... 8 4.3. Using the TCPIP Gateway... 8 5. LEVITON Omni Link Interface Setup... 9 5.1. Enabling the LEVITON Omni Link RS232 Interface... 9 5.2. Enabling the LEVITON Omni Link TCPIP Interface... 9 5.3. RS232 Interface Setup... 10 5.4. TCPIP Interface Setup... 11 6. Device Setup... 12 6.1. OMNIBUS Device Setup Bus Devices Methd 1... 12 6.2. OMNIBUS Device Setup Bus Devices Methd 2... 13 6.3. OMNIBUS Device Setup RF Devices... 14 7. LEVITON Omni Cntrller Setup... 15 7.1. RS232 Interface... 15 7.2. TCPIP Interface... 16 7.3. Unit Setup... 16 8. Diagnstics... 17 8.1. Fatal Errr Audi reprt... 17 8.2. Nn Fatal Errr Audi reprt... 18 8.3. General Audi reprting... 18 9. Firmware Upgrade... 19 10. Hardware Cnnectins... 20 11. Omni Link Serial Interface Cable Pinut... 21 Page 2 f 21
Nte: Fr the purpse f this dcument it is assumed that the user is familiar with the general prgramming and setup prcedures f the LEVITON and Omni-Bus systems. Please refer t the relevant dcumentatin fr mre infrmatin. This setup prcedure requires OMNIBUS SOFTWARE V1.0.2 r newer and Interface Translatr Hardware Rev 2 (117A00-1 Rev 2) with firmware release V2.20 r later. Please visit www.levitn.cm t dwnlad the latest OMNIBUS sftware. 1. Overview 1.1. LEVITON Omni-Link Interface The Omni-Bus Interface (Translatr) hardware cmmunicates with the LEVITON cntrller via a RS232 serial cnnectin r a TCPIP netwrk cnnectin. Optin 1: RS232 Optin 2: TCPIP RS232 LOCAL AREA NETWORK (ETHERNET) INTERFACE TRANSLATOR 117A00-1 INTERFACE TRANSLATOR 117A00-1 OMNIBUS NETWORK HAI CONTROLLER OMNIBUS NETWORK HAI CONTROLLER The interface perates by creating a relatinship between the Omni-Bus prducts and the LEVITON Cntrller. This relatinship between the tw prducts is achieved by crss referencing the serial number f the Omni-Bus prduct t an address number that crrelates t the same address r unit number n the LEVITON Cntrller. Addresses n the Omni-Bus system are assigned t each Omni-Bus Device using the OMNIBUS sftware. Page 3 f 21
1.2. Bus Gateway The Omni-Bus Interface Translatr can be utilized as a Gateway between the LEVITON OMNIBUS sftware and a Omni-Bus Bus Netwrk utilizing a lcal area Ethernet netwrk r USB cnnectin. The USB and TCPIP Bus Gateway functins can be used simultaneusly with the LEVITON Omni-Link Interface. 1.2.1. USB Bus Gateway INTERFACE TRANSLATOR 117A00-1 USB CABLE OMNIBUS NETWORK OMNIBUS Installatin Sftware 1.2.2. TCPIP Bus Gateway LOCAL AREA NETWORK (ETHERNET) INTERFACE TRANSLATOR 117A00-1 OMNIBUS NETWORK OMNIBUS Installatin Sftware Page 4 f 21
2. TCPIP Netwrk Setup In OMNIBUS, g t the Interface Translatr setup frm (duble click n the Translatr after a List Devices) Set the Translatr Ethernet netwrk settings fr the lcal netwrk by clicking n the Netwrk Setup Tab (cnsult yur netwrk administratr t btain the necessary TCPIP netwrk settings fr the Interface Translatr) Ethernet Prt Enabled: Enable r disable the ethernet prt n the translatr. Optain an IP Address Autmatically: Select t get an IP address fr the Translatr frm the DHCP server n the netwrk. Use the fllwing IP Address: Select t set a fixed IP address fr the Translatr. IP Address: Fixed IP address that will be used by the Translatr t cnnect t the lcal netwrk. This is als the Bus gateway address that will used by OMNIBUS t cnnect t the Translatr in TCPIP Cmmunicatin mde. Subnet Mask: Netwrk subnet mask. Default Gateway: Netwrk gateway. TCP Prt Number: The Bus Gateway prt number used by OMNIBUS. Passwrd: Used by OMNIBUS when cnnecting t the Translatr in TCPIP Cmmunicatin mde. In DHCP mde, the IP address assigned t the Translatr by the DHCP server will be displayed at the bttm f the Netwrk Setup screen. T restre the netwrk settings t the factry default values: Unplug the Translatr frm the Bus netwrk r external pwer supply. While pressing and hlding the buttn at the bttm f the unit, restre pwer t the Translatr. Keep the buttn pressed in until the Translatr sunds 3 beeps (after apprximately 10 secnds). Release the buttn. The Translatr will autmatically restart with the fllwing default settings: Ethernet Prt: Enabled Optain an IP Address Autmatically: Enabled Fixed IP: Disabled TCP Prt Number: 43690 Passwrd: Enabled Cde: 1234 Page 5 f 21
3. USB Gateway Setup The USB Gateway is always active (enabled) n the Interface Translatr. N further setup prcedure is required n the Interface Translatr. The USB cnnectin can be used by OMNIBUS Installatin Sftware fr further setup and mde cnfiguratin f the Interface Translatr and as a prgramming interface t the Omni-Bus netwrk. In OMNIBUS g t Setup, Cmmuncatin Prt Setup. Under INTERFACE, select USB: 117A00-1 Interface Translatr Rev 2 Click the OK buttn Cnnect a standard printer USB cable (nt included) between the Interface and a spare USB prt n the cmputer. Wait fr driver installatin t cmplete. The interface uses the standard HID drivers included in the Windws perating system and n additinal driver files are required. A green tick mark in OMNIBUS indicates that the USB prt is cnnected t the Interface. Page 6 f 21
4. TCPIP Gateway Setup 4.1. Enabling the TCPIP Gateway In OMNIBUS, g t the Interface Translatr setup frm (duble click n the Translatr after a List Devices) Click n the CBIT Prfile Tab. Click n DEFAULT PROFILE fr a new setup r UPLOAD FROM CBIT t change an existing setup. Under MODE(S), set the TCPIP Bus Gateway checkbx t enable the Bus gateway mde. Click n DOWNLOAD TO CBIT t dwnlad the prfile t the CBIT cntrller. Click n REBOOT CBIT fr changes t take effect. Page 7 f 21
4.2. Cnnecting t the TCPIP Gateway frm OMNIBUS In OMNIBUS g t Setup, Cmmunicatin Prt Setup. Under INTERFACE, select TCP/IP: 117A00-1 Interface Translatr Rev 2 Up t 10 different cnfiguratins can be saved. Select ne f the psitins n the drpdwn list. Change the Descriptin fr the cnnectin if required. Enter the Interface IP address (See 2. TCPIP Netwrk Setup) r a Dmain name, Translatr TCPIP Bus Gateway Prt number and Passwrd. Click n SAVE t save the cnfiguratin. Click OK. On the Main frm, a Green tick mark indicates that a TCPIP cnnectin t the Interface is active. A cnnectin t the Interface will nly be established when an actin is perfrmed such as a LIST DEVICES. After an inactivity timeut perid f apprximately 90 secnds the Interface will autmatically discnnect frm CLBUS unless the Keep Cnnectin alive when cnnected ptin was selected. 4.3. Using the TCPIP Gateway The TCPIP Gateway can be used as a Prgramming Interface t the Omni-Bus netwrk frm the OMNIBUS Installatin sftware. On the OMNIBUS main frm, set the Bus Gateway checkbx t enable the gateway. All Bus devices cnnected t the Bus netwrk will be listed n a LIST DEVICES cmmand. Uncheck the Bus Gateway checkbx t disable the gateway. Only the Translatr will be listed n a LIST DEVICES cmmand. Page 8 f 21
5. LEVITON Omni-Link Interface Setup 5.1. Enabling the LEVITON Omni-Link RS232 Interface In OMNIBUS, g t the Interface Translatr setup frm (duble click n the Translatr after a List Devices) Click n the CBIT Prfile Tab. Click n DEFAULT SETUP fr a new setup r UPLOAD FROM CBIT r OPEN FILE t change an existing setup. A prduct file frm a Rev 1 Interface Translatr (nn-ethernet versin) can als be pened by clicking n the IMPORT V1 FILE buttn. Under MODE(S) set the LEVITON Omni-Link RS232 checkbx t enable the LEVITON Serial RS232 Interface. 5.2. Enabling the LEVITON Omni-Link TCPIP Interface In OMNIBUS, g t the Interface Translatr setup frm (duble click n the Translatr after a List Devices) Click n the CBIT Prfile Tab. Click n DEFAULT SETUP fr a new setup r UPLOAD FROM CBIT r OPEN FILE t change an existing setup. Under MODE(S) set the LEVITON Omni-Link TCPIP checkbx t enable the LEVITON TCPIP Interface. Page 9 f 21
5.3. RS232 Interface Setup Click n the LEVITON Omni-Link tab. Baud Rate: Sets the baud rate (speed) f the RS232 prt n the Translatr mdule. The baud rate range frm 9600 t 115200. Set t 9600 fr ptimal perfrmance. The selected baud rate must crrespnd t the baud rate selected n the LEVITON Omni Cntrller (see 7. LEVITON Omni Cntrller Setup). Passwrd: User cde fr the LEVITON Omni Cntrller (see 7. LEVITON Omni Cntrller Setup) First/Last Unit: Only devices within this range will be addressed by the Translatr mdule. The Startupstatus is the methd that the Translatr is ging t use t initialize its unit statuses, i.e. must the Translatr retrieve the unit status frm the Omni-Bus netwrk r the Cntrller during the start-up prcedure fllwing a nrmal start-up r fllwing a pwer interruptin. Optins are: LEVITON r BUS. Click DOWNLOAD TO CBIT t dwnlad the prfile t the Translatr and rebt the Translatr by clicking n the REBOOT CBIT buttn Page 10 f 21
5.4. TCPIP Interface Setup Click n the LEVITON Omni-Link tab. Cntrller IP Address: The Netwrk IP address fr the LEVITON Omni Cntrller (see 7. LEVITON Omni Cntrller Setup). (default: 192.168.0.101) TCP Prt Number: The Netwrk Prt Number fr the LEVITON Omni Cntrller (see 7. LEVITON Omni Cntrller Setup) (default: 4369) Netwrk Encryptin Key: The Netwrk Encryptin Key fr the LEVITON Omni Cntrller (see 7. LEVITON Omni Cntrller Setup) (default: FF-FF-FF- ) First/Last Unit: Only devices within this range will be addressed by the Translatr mdule. The Startupstatus is the methd that the Translatr is ging t use t initialize its unit statuses, i.e. must the Translatr retrieve the unit status frm the Omni-Bus netwrk r the Cntrller during the start-up prcedure fllwing a nrmal start-up r fllwing a pwer interruptin. Optins are: LEVITON r BUS. Click DOWNLOAD TO CBIT t dwnlad the prfile t the Translatr and rebt the Translatr by clicking n the REBOOT CBIT buttn Page 11 f 21
6. Device Setup 6.1. OMNIBUS Device Setup Bus Devices Methd 1 Fr each Omni-Bus Device t be cntrlled frm LEVITON, enable and assign a unique device address (unit number) frm 1 t 512 t the device. Page 12 f 21
6.2. OMNIBUS Device Setup Bus Devices Methd 2 The Bus Device address crss reference list can als be manually defined. This list is dwnladed t and stred in the Translatr. G t the Interface Translatr Setup page by duble clicking n the Translatr after a LIST DEVICES. Click n the CBIT Prfile Tab. Click n the UPLOAD FROM CBIT functin t retrieve the current prfile frm the Translatr r pen an existing prfile by clicking n the OPEN FILE buttn. Click n the BUS Devices Tab Click n the ADD buttn t add devices t the list. Chse ADD FROM DEVICE LIST t select a device frm the currently listed devices r chse ENTER DEVICE SERIAL NUMBER t select a device nt currently listed. Enter an address r unit number frm 1 t 512 fr the device. It is pssible t assign duplicate addresses r an address already assigned t a RF device s that multiple Omni-Bus devices can be cntrlled frm a single LEVITON unit. Use the EDIT buttn t change the prperties fr a specific device. Page 13 f 21
6.3. OMNIBUS Device Setup RF Devices A crss reference between an Omni-Bus remte cntrl (key-fb r wall munt remte) and the cntrller unit number can be assigned manually via the CBIT Prfile setup. G t the Translatr Setup page by duble clicking n the CBIT Interface (Translatr) after a LIST DEVICES and clicking n the CBIT Prfile tab. Click n the UPLOAD FROM CBIT functin t retrieve the current prfile frm the Translatr r pen an existing prfile by clicking n the OPEN FILE buttn. A prduct file frm a Rev 1 Interface Translatr (nn-ethernet versin) can als be pened by clicking n the IMPORT V1 FILE buttn. Click n the RF Device Tab Add the crrespnding RF Remte channel fr each RF Device t be mnitred frm the LEVITON cntrller and set the address fr each device t a number frm 1 t 512. Use the EDIT buttn after selecting a device n the list t change the prperties f the RF device. ALIAS: Optinal descriptin f the device ADDRESS: Unit address fr device. Page 14 f 21
7. LEVITON Omni Cntrller Setup 7.1. RS232 Interface In Dealer PC Access: Under Expansin, Serial, set the Baud rate fr the apprpriate prt t the value selected in the Interface Translatr Setup (see 5.3 RS232 Interface Setup) and set the Functin value t Omni-Link. Set the baud rate t 9600 fr ptimal perfrmance. Under Cdes, set the last Cde in the list t the Passwrd specified in the Interface Translatr Setup (see 5.3 RS232 Interface Setup) and set the cde authrity as Master. Page 15 f 21
7.2. TCPIP Interface In Dealer PC Access: Under Optins, select Netwrk. Fr an existing installatin take care when changing any netwrk settings as ther systems may rely n these settings fr prper peratin and interactin with the LEVITON system. Click n Shw Keys t shw the current Netwrk Encryptin Key. Under Prefered Prtcl select TCP (Omni-Link II). Use the values entered here t setup the Translatr TCPIP Interface (see 5.4 TCPIP Interface Setup). 7.3. Unit Setup In Dealer PC Access: Assign Units t crrespnd t the OmniBus Device addresses as set up n the OmniBus system r in the CBIT Prfile (see 6. Device Setup) Page 16 f 21
8. Diagnstics 8.1. Fatal Errr Audi reprt Fatal errr cnditins are reprted by generating Audible beeps n the Translatr mdule. Fatal errrs are reprted by a number f lng high beeps. Each beep within the set is separated by a 2 secnd pause. Each set f beeps are separated by a 5 secnd pause befre the fatal errr message is repeated. RS232 Fatal Errr beeps: 1 lng high beep: The Translatr mdule is nt cnnected t the Cntrller (Check that the prduct is cnnected and then rebt r pwer-cycle the Translatr). 2 lng high beeps: The Translatr mdule is nt cnnected t the Omni-Bus netwrk (Check that the prduct is cnnected and then rebt r pwer-cycle the Translatr). 4 lng high beeps fllwed by a chime: The passwrd specified in the CBIT Prfile is nt valid fr the lg-n prcedure t the LEVITON cntrller. Crrect the passwrd in the CBIT Prfile r n the LEVITON cntrller bard. TCPIP Fatal Errr beeps: 1 lng high beep: The Translatr mdule is nt cnnected t the Cntrller (Check that the prduct is cnnected, netwrk settings have been entered crrectly and then rebt r pwer-cycle the Translatr). 2 lng high beeps: The Translatr mdule is nt cnnected t the Omni-Bus netwrk (Check that the prduct is cnnected and then rebt r pwer-cycle the Translatr). 4 lng high beeps fllwed by a chime: The Translatr mdule cannt establish a secure cnnectin t the LEVITON Cntrller. Check that the netwrk key specified in the CBIT Prfile crrespnds t the LEVITON cntrller netwrk key. Crrect the key in the CBIT prfile r n the LEVITON cntrller bard. Page 17 f 21
8.2. Nn-Fatal Errr Audi reprt Nn-Fatal errr cnditins are reprted by generating Audible beeps n the Translatr mdule. Once the fatal errr checking has cmpleted successfully the Translatr will start checking fr nn-fatal errrs. Nn-fatal errrs are verified sequentially and reprted sequentially. Crrect the relevant errrs and then rebt r pwer-cycle the Translatr. Nn-Fatal errrs are reprted by an audible cde f beeps cmprising f an index beep fllwed by cunter beep that indicates the number f the same errr ccurring. Nn-fatal errrs: The cdes are shwn as [Index beep(s)] [Cunter beep(s)] where index beep(s) indicate the errr cde, this beep is fllwed by a shrt pause and then fllwed by cunter beep(s) indicating hw many f the same errr ccurred during start up. Fr example 2 3 represents index beep f 2 fllwed by a pause and then by 3 shrt beeps. Each errr cde is repeated 3 times. If there are multiple errr types the errr message will be separated by a 5 secnd delay between each type f errr. Index beep 1-X is related t errrs encuntered within the CBIT Prfile: 1-X: This errr is caused by clashing unit numbers in the CBIT Prfile, ne r mre f the entries in the prfile has the same unit number. The number f clashes is represented by the number f X-beeps. Index beep 2-X is related t errrs encuntered within the Omni-Bus Addressing: 2-X: This errr is caused by clashing address numbers n the Omni-Bus netwrk; ne r mre bus devices have the same address number. The number f clashes is represented by the number f X-beeps. Index beep 3-X is related t errrs encuntered between the CBIT Prfile and the Omni-Bus Addressing: 3-X: This errr is caused by ne r mre Omni-Bus devices having a crrespnding unit number in the CBIT Prfile. The number f clashes is represented by the number f X-beeps. 8.3. General Audi reprting Further audible reprting has been incrprated within the CBIT mdule t facilitate checking fr errrs and generating a warning while the user is updating the systems r making any changes. 2 shrt beeps: The user added / changed a bus address number (unit number) using an external tl (fr example the OMNIBUS installer prgram). These audible beeps will nly sund nce while changes are made t the Omni-Bus netwrk. Page 18 f 21
9. Firmware Upgrade Obtain the latest firmware file frm Hme Autmatin, Inc In OMNIBUS sftware, perfrm a LIST DEVICES. Duble click n the TRANSLATOR in the list t enter the device setup. On the Setup Tab, select UPGRADE APPLICATION FIRMWARE. Brwse and select the apprpriate firmware file. The file will be in the fllwing frmat: OBIT_RRR.BIN where RRR is the revisin number (ex OBIT_123.BIN fr firmware revisin V1.23). Wait fr the dwnlad t cmplete. The unit will autmatically restart after a successful firmware dwnlad. In case f an unsuccessful dwnlad, the interface will revert back t the previus versin. In case f crrupt applicatin firmware (device des nt list in OMNIBUS), the Interface can be frced int the FIRMWARE LOADER mde by pressing the BUTTON n the frnt f the Interface while pwering up the unit. Release the buttn when the tp LED starts flashing green cntinuusly. Perfrm a LIST DEVICES in OMNIBUS and select the Interface frm the device list (shws as CBIT FWLOADER in the list). Repeat the abve dwnlad prcedure. Page 19 f 21
10. Hardware Cnnectins BUS BUS USB RES JP1 P1 P2 1 5 6 9 RS232 LAN ANT BUS: RJ45 CAT5 cnnectin t Omni-Bus Netwrk. USB: USB interface cnnectin t cmputer running OMNIBUS Installatin sftware P1, P2: 16 24VAC/DC supply input (Required current rating = 250mA + current required fr any additinal Omni-Bus devices pwered frm the Translatr) RS232: RS232 Prt Pin 1: DCD input Pin 3: TXD utput Pin 5: GND Pin 7: RTS utput Pin 2: RXD input Pin 4: DTR utput Pin 6: DSR input Pin 8: CTS input Pin 9: RI input LAN: RJ45 CAT5 cnnectin t Ethernet Lcal area netwrk. ANT: 433.92MHz antenna cnnectr fr internal RF Receiver (Fr use with supplied antenna). JP1: Pwer supply ptins jumper: Unit is supplied with pwer frm the Omni-Bus netwrk (n need fr a supply input n P1 r P2) Unit supplies pwer t the Omni-Bus Netwrk (300mA max) (must have a supply input n P1 r P2) RES: Reset buttn. Press and release t rebt unit. Press and hld 3 secnds while applying pwer t run firmware lader. Press and hld 10 secnds while applying pwer t reset netwrk settings t factry default values. Page 20 f 21
11. Omni-Link Serial Interface Cable Pinut Page 21 f 21
FOR CANADA ONLY Fr warranty infrmatin and/r prduct returns, residents f Canada shuld cntact Levitn in writing at Levitn Manufacturing f Canada Ltd t the attentin f the Quality Assurance Department, 165 Hymus Blvd, Pinte-Claire (Quebec), Canada H9R 1E9 r by telephne at 1 800 405-5320. LEVITON LIMITED WARRANTY Levitn warrants t the riginal cnsumer purchaser and nt fr the benefit f anyne else that prducts manufactured by Levitn under the Levitn brand name ( Prduct ) will be free frm defects in material and wrkmanship fr the time perids indicated belw, whichever is shrter: OmniPr II and Lumina Pr: three (3) years frm installatin r 42 mnths frm manufacture date. OmniLT, Omni IIe, and Lumina: tw (2) years frm installatin r 30 mnths frm manufacture date. Thermstats, Accessries: tw (2) years frm installatin r 30 mnths frm manufacture date. Batteries: Rechargeable batteries in prducts are warranted fr ninety (90) days frm date f purchase. Nte: Primary (nn-rechargeable) batteries shipped in prducts are nt warranted. Prducts with Windws Operating Systems: During the warranty perid, Levitn will restre crrupted perating systems t factry default at n charge, prvided that the prduct has been used as riginally intended. Installatin f nn-levitn sftware r mdificatin f the perating system vids this warranty. Levitn s bligatin under this Limited Warranty is limited t the repair r replacement, at Levitn s ptin, f Prduct that fails due t defect in material r wrkmanship. Levitn reserves the right t replace prduct under this Limited Warranty with new r remanufactured prduct. Levitn will nt be respnsible fr labr csts f remval r reinstallatin f Prduct. The repaired r replaced prduct is then warranted under the terms f this Limited Warranty fr the remainder f the Limited Warranty time perid r ninety (90) days, whichever is lnger. This Limited Warranty des nt cver PC-based sftware prducts. Levitn is nt respnsible fr cnditins r applicatins beynd Levitn s cntrl. Levitn is nt respnsible fr issues related t imprper installatin, including failure t fllw written Installatin and peratin instructins, nrmal wear and tear, catastrphe, fault r negligence f the user r ther prblems external t the Prduct. T view cmplete warranty and instructins fr returning prduct, please visit us at www.levitn.cm. Cpyright and Trademark Infrmatin This dcument and all its cntents herein are subject t and prtected by internatinal cpyright and ther intellectual prperty rights and are the prperty f Levitn Manufacturing C., Inc, its subsidiaries, affiliates and/r licensrs. 2013 Levitn Manufacturing C., Inc. All rights reserved. Use herein f third party trademarks, service marks, trade names, brand names and/r prduct names are fr infrmatinal purpses nly, are/may be the trademarks f their respective wners; such use is nt meant t imply affiliatin, spnsrship, r endrsement. N part f this dcument may be reprduced, transmitted r transcribed withut the express written permissin f Levitn Manufacturing C., Inc. Fr Technical Assistance Call: 1-800-824-3005 (U.S.A. Only) www.levitn.cm PK-93352-10-B0-8AAR2133