FieldServer FS-8700-84 User Manual

A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
FS-8700-84_Lutron_eLumen Manual Table of Contents
TABLE OF CONTENTS
1. Lutron eLumen Description.......................................................................................... 1
2. Driver Scope of Supply................................................................................................... 2
1.01 Supplied by FieldServer Technologies for this driver............................................ 2
1.02 Provided by the Supplier of 3rd Party Equipment ................................................... 2
2.1.1. Required 3rd Party Hardware.............................................................................. 2
3. Hardware Connections................................................................................................... 3
4. Configuring the FieldServer as a Lutron eLumen Client ...................................... 5
1.03 Data Arrays/Descriptors ............................................................................................. 5
1.04 Client Side Connection Descriptions........................................................................ 6
1.05 Client Side Node Descriptors .................................................................................... 6
1.06 Client Side Map Descriptors...................................................................................... 7
4.1.1. FieldServer Related Map Descriptor Parameters............................................8
4.1.2. Driver Related Map Descriptor Parameters...................................................... 8
4.1.3. Timing Parameters ............................................................................................. 10
4.1.4. System Monitor Command – Time Now......................................................... 11
4.1.5. System Monitor Command – Astro Times...................................................... 11
4.1.6. System Monitor Command – Date...................................................................12
4.1.7. System Monitor Command – Code Revision Level....................................... 12
4.1.8. System Monitor Command – Bootcode Revision Level ............................... 12
4.1.9. System Monitor Command – Serial Number.................................................. 13
4.1.10. System Monitor Command – Area Status ...................................................... 13
4.1.11. System Monitor Command – Timeclock Status............................................. 14
4.1.12. System Monitor Command – Zone Intensity.................................................. 14
4.1.13. System Monitor Command – Request Panel Emergency Status............... 15
4.1.14. System Monitor Command – System Variable Value................................... 15
4.1.15. System Monitor Command – Wallstation Status........................................... 16
4.1.16. System Monitor Command – Switch Status................................................... 16
4.1.17. System Control Commands containing no Parameters: – Halt Zone......... 17
4.1.18. System Control Commands containing no Parameters: – Stop Scene
Ramp Up............................................................................................................................... 17
4.1.19. System Control Commands containing no Parameters: – Select System Scene(s) 18
4.1.20. System Control Commands containing no Parameters: – Disable
Timeclock until Enabled...................................................................................................... 18
4.1.21. System Control Commands containing no Parameters: – Disable timeclock
until end of day or enable issued...................................................................................... 18
4.1.22. System Control Commands containing no Parameters: – Re-enable
timeclock with complete catchup ...................................................................................... 19
4.1.23. System Control Commands containing no Parameters: – Re-enable
timeclock and do previous event....................................................................................... 19
4.1.24. System Control Commands containing no Parameters: Standard re-enable
timeclock............................................................................................................................... 19
4.1.25. System Control Commands containing no Parameters: Run script(s)....... 20
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Manual Table of Contents
4.1.26. System Control Commands containing no Parameters: Toggle system
variable value....................................................................................................................... 20
4.1.27. System Control Commands containing no Parameters: Output temp scene
21
4.1.28. System Control Commands containing no Parameters: Select scene in area 22
4.1.29. System Control Commands containing no Parameters: Timeclock new schedule 23
4.1.30. System Control Commands containing no Parameters: Set timeclock...... 23
4.1.31. System Control Commands containing no Parameters: Enable
wallstation(s)......................................................................................................................... 24
4.1.32. System Control Commands containing no Parameters: Disable
wallstation(s)......................................................................................................................... 24
4.1.33. System Control Commands containing no Parameters: Simulate
wallstation(s) switch press ................................................................................................. 25
4.1.34. System Control Commands containing no Parameters: Simulate
wallstation(s) switch release.............................................................................................. 26
4.1.35. System Control Commands containing no Parameters: Stop scene ramp down 26
4.1.36. System Control Commands Containing Parameters: Toggle zone............ 27
4.1.37. System Control Commands Containing Parameters: Fade zone(s) to level
27
4.1.38. System Control Commands Containing Parameters: Ramp zone(s) up... 28
4.1.39. System Control Commands Containing Parameters: Ramp zone(s) down
28
4.1.40. System Control Commands Containing Parameters: Pommel or pulse
zone(s Toggle zone) ........................................................................................................... 29
4.1.41. System Control Commands Containing Parameters: Flash zones aka
“Multi level ( Flash or Warn or Chase )“........................................................................... 30
4.1.42. System Control Commands Containing Parameters: Ramp scene zones up 30
4.1.43. System Control Commands Containing Parameters: Ramp scene zones down 31
4.1.44. System Control Commands Containing Parameters: Select system
scene(s) using override times............................................................................................ 31
4.1.45. System Control Commands Containing Parameters: Set system variable value 32
4.1.46. Listening to switch presses and releases: Enabling switch presses and
releases reporting................................................................................................................ 32
4.1.47. Listening to switch presses and releases: Disabling switch presses and
releases reporting................................................................................................................ 32
4.1.48. Listening to switch presses and releases: Listening to switch presses and releases 33
4.1.49. Active read on startup: Retrieving names....................................................... 34
Appendix A. Data Tables..................................................................................................... 35
Appendix B. Revision History............................................................................................ 36
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 1 of 36
1. Lutron eLumen Description
The Serial Lutron eLumen driver allows the FieldServer to transfer data to and from devices over RS-232 or RS-485 using eLumen protocol. The FieldServer can only be used operationally as a Lutron Client driver. Any existing Lutron Server drivers are for FieldServer testing purposes only and cannot be used to emulate a Lutron eLumen system.
The driver supports the following 3 panels: GRAFIK5000, GRAFIK6000 and GRAFIK7000. The hardware for all 3 panels is identical. The only differences are limits in the database. GRAFIK5000 has only 1 CSD link and can have a max of 128 zones. GRAFIK6000 has 3 CSD links with 512 zones. GRAFIK7000 has 6 links with 512 zones and can communicate with other processors.
The FieldServer eLumen driver implements the following functionality:
Status monitoring of eLumen system data and parameters. System Control of eLumen.
Status monitoring is achieved by sending status requests to the eLumen system. Retrieved status data are collected and stored in FieldServer Data Arrays that allow access by other protocols.
System Control Commands can be configured in the FieldServer to address any groups of Areas, Zones or Scenes. A mechanism is provided by which the parameters are set before the command is triggered using the upstream protocol.
Commands are provided to read the names of Areas, Zones and Scenes from the eLumen to facilitate access by SCADA systems.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 2 of 36
2. Driver Scope of Supply
1.01 Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART #
Description
FS-8915-10 UTP cable (7 foot) for RS-232 use FS-8917-02 RJ45 to DB9F connector adapter FS-8700-84 Driver Manual.
1.02 Provided by the Supplier of 3rd Party Equipment
2.1.1. Required 3rd Party Hardware
Part # Description
Lutron Panel
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 3 of 36
3. Hardware Connections
The FieldServer is connected to the Lutron eLumen as shown in connection drawing. Configure the eLumen according to manufacturer’s instructions
FS-8917-02
FS-8917-02
LUTRON SERIAL RS-232 INTERFACE PART # 470-784
CAT 5 CABLE
FS-8915-10
Serial
RxTx RxTx
EthernetEIA232 USB EIA485
FS-B2010
Power OK
FUNCTION FROM TO COLOUR
RX RJ45-01 DB9M-02 WHITE CTS RJ45-02 DB9M-08 BROWN DSR RJ45-03 DB9M-06 YELLOW
GND RJ45-04 DB9M-05 GREEN GND RJ45-05 RED DTR RJ45-06 DB9M-04 BLACK
RTS RJ45-07 DB9M-07 ORANGE
TX RJ45-08 DB9M-03 BLUE
-
+
8917-02 WIRE LIST
(408)-262-2299
LUTRON ELUMEN RS-232
CONNECTION DIAGRAM
BASE NAME: FILE NAME: FS-T28700-84 .VSD
DATE: 11/12/04 BY: MC
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 4 of 36
120V 15A Dedicated Control Feed
Wallstation link
To control stations
Aux Link (RS-485)
User Interface link
Inter-processor link
Serial
RxTx RxTx
EthernetEIA232 USB EIA485
FS-B2010
eLumen
Processor
Power OK
Dimmer panel link
-
+
To dimmer panels
(408)-262-2299
LUTRON ELUMEN RS-485
CONNECTION DIAGRAM
BASE NAME: FILE NAME: FS-T28700-84 .VSD
DATE: 11/12/04 BY: MC
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 5 of 36
4. Configuring the FieldServer as a Lutron eLumen Client
For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
This section documents and describes the parameters necessary for configuring the FieldServer to communicate with a Lutron eLumen Server
1.03 Data Arrays/Descriptors
The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable the FieldServer for Lutron eLumen communications, the driver independent FieldServer buffers need to be declared in the “Data Arrays” section, the destination device addresses need to be declared in the “Client Side Nodes” section, and the data required from the Servers needs to be mapped in the “Client Side Map Descriptors” section. Details on how to do this can be found below.
Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.
Section Title
Data_Arrays
Column Title Function Legal Values
Data_Array_Name Provide name for Data Array
Provide data format. Each Data
Data_Array_Format
Array can only take on one format.
Up to 15 alphanumeric characters Float, Bit, UInt16, SInt16, Packed_Bit, Byte, Packed_Byte,
Swapped_Byte Number of Data Objects. Must be larger than the data storage
Data_Array_Length
area required by the Map
1-10,000 Descriptors for the data being placed in this array.
Example
// Data Arrays Data_Arrays
Data_Array_Name, Data_Format, Data_Array_Length Area_status, UInt16, 64 Zone_list, UInt16, 64 Zone_pars, UInt16, 10
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 6 of 36
1.04 Client Side Connection Descriptions
Section Title
Connections
Column Title Function Legal Values
Specify which port the
Port
device is connected to the
P1-P8, R1-R21
FieldServer Protocol Specify protocol used eLumen Baud* Specify baud rate 9600 – Vendor limitation Parity* Specify parity Data_Bits* Specify data bits Stop_Bits* Specify stop bits
Handshaking*
Specify hardware
handshaking
None 8 1
None
Poll _Delay* Time between internal polls 0-32000 seconds, 1 second Example
// Client Side Connections Connections
Port, Protocol, Baud, Parity, Data Bits, Stop Bits, Poll_Delay P1, eLumen, 9600, None, None, 1, 0.100s
1.05 Client Side Node Descriptors
Section Title
Nodes
Column Title Function Legal Values
Node_Name Provide name for node
Up to 32 alphanumeric characters
The eLumen processor
Node_ID
address - only decimal values allowed e.g. 11 hex has to be
0-255
entered as 17.
Protocol Specify protocol used eLumen Port
Node_type
Specify which port the device is connected to the FieldServer Specifies the eLumen command and data format
P1-P8, R1-R21 Hex, decimal
1
Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for
details of the ports available on specific hardware.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 7 of 36
Example
// Client Side Nodes Nodes
Node_Name, Node_ID, Protocol, Connection, Node_type LUT_GRF6_0, 17, eLumen, P1, hex
1.06 Client Side Map Descriptors
The driver uses Map Descriptors with Lutron commands to build poll messages that will be sent to the eLumen system. Example Map Descriptors are shown in the next section. Note the following in the use of Map Descriptors for the Lutron driver:
Lutron command Every Map Descriptor must have a Lutron command specified so the driver will know which command to send to the eLumen.
Function
Map Descriptor functions must be correctly specified to implement the functionality embodied by the specific Lutron command, e.g. a command to retrieve area status requires a read Map Descriptor whereas a command to toggle zones requires a write Map Descriptor.
DA_Area_Names, DA_Scene_Names, DA_Zone_Names, xxx_Offset
These are user Map Descriptor fields needed to retrieve area, scene and zone names from the eLumen. Please refer to the Map Descriptor examples.
Link, Area, Link_station, Switch, Zone, Sys_var, Panel
These are user Map Descriptor fields that must be used as needed with a specific Lutron command. Please refer to the Map Descriptor examples.
DA_Lut_List, DA_Lut_List_Offset
Lutron commands that allow multiple areas, zones, etc to be specified in one command e.g. Toggle zones use the areas or zones in the Data Array specified by DA_Lut_List at an offset specified by DA_Lut_List_Offset to build the poll message. The list must be filled in before the command is triggered by writing into the Data Array specified by Data_Array_Name.
DA_Lut_Parms, DA_Lut_Parms_Offset
Lutron commands that use parameters such as delay and fade cycles use the parameters at the offset as specified by these Map Descriptor fields. Parameters must be filled in together with the list data if applicable before triggering the command by writing into the Data Array specified by Data_Array_Name. Please refer to the Map Descriptor examples.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 8 of 36
4.1.1. FieldServer Related Map Descriptor Parameters Column Title Function Legal Values
Map_Descriptor_Name
Data_Array_Name
Data_Array_Location
Function
Name of this Map Descriptor Name of Data Array where data is to be stored in the FieldServer
Starting location in Data Array
Function of Client Map Descriptor
Up to 32 alphanumeric characters
One of the Data Array names from “Data Array” section above
0 to maximum specified in “Data Array” section above ARS, RDBC, WRBC, WRBX, AWT
4.1.2. Driver Related Map Descriptor Parameters
Column Title Function Legal Values
One of the node names specified in “Client Node Descriptor” above
A list of commands is provided in Appendix A.
Node_Name
GRAFIK_command
Name of Node to fetch data from
Specifies the command to be sent to the eLumen.
0–11 for GRAFIK_command: ena_wallstation, dis_wallstation, sim_ws_sw_press,
Link Wallstation link number
sim_ws_sw_rls, 0-31 for
GRAFIK_command: wallstation_status, switch_status,
Area Link_station Switch Zone Sys_var
GRAFIK system area number Wallstation on link’s number Wallstation switch number GRAFIK system zone number GRAFIK system variable number
0–511 0–31 0–31 0–511 0–65535
Panel GRAFIK panel number 0–511
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-84_Lutron_eLumen Driver Manual Page 9 of 36
Column Title Function Legal Values
Any Data Array name. If not listed under Data Arrays the driver will auto-create the Data Array.
DA_Lut_List
Name of Data Array that contains a list of zones or areas, etc, needed to build the poll message.
The offset into the
DA_Lut_List_Offset
DA_Lut_List Data Array where the driver will retrieve the list data when building the poll
0 to the maximum offset into the DA_Lut_List Data Array.
message.
Any Data Array name. If not listed under Data Arrays the driver will auto-create the Data Array.
DA_Lut_Parms
Name of Data Array containing parameters needed to build the poll message.
The offset into the DA_Lut_Parms Data
DA_Lut_Parms_Offset
Array where the driver will retrieve the parameters when
0 to the maximum offset into the DA_Lut_Parms
Data Array. building the poll message.
Any Data Array name. If
DA_Area_Names
Name of Data Array where retrieved area names will be stored.
not listed under Data
Arrays the driver will
auto-create the Data
Array.
DA_Area_Names_Offset
The offset into the DA_Area_Names Data Array where retrieved area names will be stored.
0 to the maximum offset
into the
DA_Area_Names Data
Array.
Any Data Array name. If
DA_Scene_Names
Name of Data Array where retrieved scene names will be stored.
not listed under Data
Arrays the driver will
auto-create the Data
Array.
DA_Scene_Names_Offs et
The offset into the DA_Scene_Names Data Array where retrieved scene names will be stored.
0 to the maximum offset
into the
DA_Scene_Names Data
Array.
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com
Tel: (408) 262-2299 Fax: (408) 262-9042 Toll_Free: 888-509-1970 email: support@fieldServer.com
Loading...
+ 27 hidden pages