importing_device_servers_with_a_spreadsheet

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
importing_device_servers_with_a_spreadsheet [2023/02/01 15:32]
wikiadmin [Modbus PLC Registers] 		importing_device_servers_with_a_spreadsheet [2023/02/02 22:34] (current)
wikiadmin [Importing into TransSECS Devices Node]
Line 1: Line 1:
 =====Importing into TransSECS Devices Node===== =====Importing into TransSECS Devices Node=====
  
-A list of servers for a specific Device may be added by right clicking on the Device name and using **Import Excel**.+A list of servers for a specific Device may be added by right clicking on the Device name and using **Import Excel**. Some things to keep in mind when setting up and using your spreadsheet to add device servers: 
 + 
 +1. There must be a tab ("sheet") called "devices" in your spreadsheet. The **Import Excel** operation will only read from this sheet with this name. 
 + 
 +2. Tag names (the ServerName property) cannot start with a number and do not put spaces or other non-alphanumeric characters in this field. Do not re-use any names already used as server names for any other item in the devices node. 
 + 
 +3. Cells can be empty. You do not need to enter the default values. Empty cells will use the default when adding new servers or will not change values you have set manually if you re-import the spreadsheet (values will not be overwritten unless you have a non empty value in the cell). 
 + 
 +4. Use the minimal number of columns in your spreadsheet. In other words, do not add columns for parameters you are not going to use or if you only use the defaults for the parameter value. For example, all servers have a timebase and the default is 1.0 second. Do not add a column for timebase unless you plan to change the defaults on one or more of your servers. 
 + 
 +5. You can define severs in more than one spreadsheet and import them separately. For example, if you want to separate your tags into servers for alarms, servers for data values, and servers for events, you can make three spreadsheets. This is not mandatory but might help with organization. 
 + 
 +6. Re-importing the spreadsheet will override any values in the server. A blank entry in the cell will result in the default value for that property.
  
 ====Demo Servers==== ====Demo Servers====
Line 26: Line 38:
 [[https://www.ergotech.com/files/examples/spreadsheets/DemoServersTest.xlsx|Example DemoServers Spreadsheet]] [[https://www.ergotech.com/files/examples/spreadsheets/DemoServersTest.xlsx|Example DemoServers Spreadsheet]]
  
-====Modbus PLC Registers====+=====Modbus PLC Registers=====
  
 Spreadsheet header example (order of column headers does not matter). The "note" heading is not used, so you can put text in that cell for your own reference. Spreadsheet header example (order of column headers does not matter). The "note" heading is not used, so you can put text in that cell for your own reference.
Line 37: Line 49:
 **Reg:** The register for the server, one based. See [[modbusplcaddressing|Modbus Addressing]] **Reg:** The register for the server, one based. See [[modbusplcaddressing|Modbus Addressing]]
  
-**Server Type:** the class of the server. One of: Modbus 0x Reg, Modbus Word, Modbus Double Word, Modbus Float, Modbus String, Modbus 1x Reg, Modbus Array, or Modbus String Array+**ServerType:** the class of the server. One of: Modbus 0x Reg, Modbus Word, Modbus Double Word, Modbus Float, Modbus String, Modbus 1x Reg, Modbus Array, or Modbus String Array. These are entered as a whole string in the spreadsheet cell, i.e., "Modbus Word". 
 + 
 +Enter the type into the cell exactly as shown below: 
 + 
 +<code> 
 +Modbus Word 
 +Modbus Double Word 
 +Modbus Float 
 +Modbus String 
 +Modbus Array 
 +Modbus String Array 
 +Modbus 0x Reg 
 +Modbus 1x Reg 
 +Modbus Preset Word 
 +</code>
  
 Each server type may need optional parameters (not used for other server types, for example SwapStyle for ModbusFloat is only used for ModbusFloat and no other server type). If you want to use an optional parameter (and not use its default value), then add an additional column to the spreadsheet and enter the parameter value for this specific server. All other rows (for other server types) should be left empty. Each server type may need optional parameters (not used for other server types, for example SwapStyle for ModbusFloat is only used for ModbusFloat and no other server type). If you want to use an optional parameter (and not use its default value), then add an additional column to the spreadsheet and enter the parameter value for this specific server. All other rows (for other server types) should be left empty.
Line 45: Line 71:
 **Timebase:** the timebase should be the same for all servers (all servers in a block will use the smallest timebase of the servers in that block), and is the time in seconds between the PLC block reads, for example 1.0 for 1 second time interval. Use a zero timebase, "0.0", for servers you only write to. This defaults to 1.0 if not set. **Timebase:** the timebase should be the same for all servers (all servers in a block will use the smallest timebase of the servers in that block), and is the time in seconds between the PLC block reads, for example 1.0 for 1 second time interval. Use a zero timebase, "0.0", for servers you only write to. This defaults to 1.0 if not set.
  
-**Station Address:** the slave node address (station address). This defaults to 0 if not set to a different value such as 1.+**StationAddress:** the slave node address (station address). This defaults to 0 if not set to a different value such as 1.
  
-**RegType:** the register type defaults to 4X (holding register, read/write) but can be changed to 3X (input register, read only). This defaults to "4" but can be set to "3" for 3X register types. This is only used for all Modbus Server Types except Modbus 0X Reg and Modbus 1X Reg. If not set (blank in the spreadsheet cell) the default 4X will be used.+**RegisterType:** the register type defaults to 4X (holding register, read/write) but can be changed to 3X (input register, read only). This defaults to "4" but can be set to "3" for 3X register types. This is only used for all Modbus Server Types except Modbus 0X Reg and Modbus 1X Reg. If not set (blank in the spreadsheet cell) the default 4X will be used.
  
-===Special Parameters (Expert)=== +**//Special Parameters (not commonly changed from defaults)//**
-OptimizeReads +
-TriggerOnThread+
  
-====Word/Double Word Parameters====+**OptimizeReads:** This defaults to "true" so that registers are read in blocks. If OptimizeReads is set to false for this server then this register will be read individually at the set timebase interval. 
 + 
 +**TriggerOnThread:** This defaults to true and only effectively applies to timebase=0 servers that are being triggered for a read if set to false. Otherwise the server value will be updated on the block read "thread". 
 + 
 +==== Word and Double Word Parameters ====
  
 **Signed:** Signed is used for Modbus Word and Modbus Double Word register types. This defaults to false (unsigned) but can be set to true. **Signed:** Signed is used for Modbus Word and Modbus Double Word register types. This defaults to false (unsigned) but can be set to true.
Line 66: Line 94:
 </code> </code>
  
-====Parameters specific to Modbus Double Word====+====Parameters specific to Modbus Float====
  
-**ByteSwap:** whether or not to byte swap to read/write this value. Defaults to false.+**SwapStyle:** see description for Modbus Double Word above.
  
-===Parameters specific to Modbus Float===+====Parameters specific to Modbus String ====
  
-**SwapStyle:** The type of swap. This defaults to Word Swap (0). Options are: Word Swap (0),No Swap(1),Byte Swap (2), and Both Swap (3). The SwapStyle is set using a number for the style, as below:+These are also used in the Modbus String Array
  
 +**Length:** The length of the string (must be multiple of 2)
  
 +**ByteSwapString:** This defaults to false but can be set to true
  
 +====Parameters specific to Modbus Array and Modbus String Array ====
  
-===Parameters specific to Modbus String===+**RegisterCount:** The length of the array (how many array elements)
  
-===Parameters specific to Modbus Array===+**RegisterType:** (not used for Modbus String Array). This parameter has no default so must be set. All available types are in the list below:
  
-===Parameters specific to Modbus String Array===+<code> 
 +1 = Unsigned Word 
 +2 = Signed Word 
 +3 = Unsigned Double Word 
 +4 = Signed Double Word 
 +5 = Float 
 +6 = Coil (0x) 
 +7 = Discrete (1x) 
 +</code>
  
 +** //Advice on defining arrays in the spreadsheet// **
  
-====EtherNet/IP (Allen Bradley,Omron CJ EtherNet/IP for NJ CPU)====+Since arrays add extra columns to the spreadsheet not used by regular modbus register types such as Word, Floats, and Double Words, it is recommended that you make a separate  spreadsheet with a devices sheet (tab) to set up just arrays or if not too many arrays are used in your project you can add these manually to the project. The purpose of this recommendation is to keep the regular register rows cleaner without the extra sparely populated parameters only used for arrays. 
 +=====EtherNet/IP (Allen Bradley,Omron CJ EtherNet/IP for NJ CPU)=====
  
 see also: [[ethernetip_plc_addressing_for_all_products|EtherNet/IP Addressing]] see also: [[ethernetip_plc_addressing_for_all_products|EtherNet/IP Addressing]]
Line 127: Line 168:
 [[https://www.ergotech.com/files/examples/spreadsheets/EtherNetIPExample.xlsx|Example EtherNet/IP Devices Spreadsheet]] [[https://www.ergotech.com/files/examples/spreadsheets/EtherNetIPExample.xlsx|Example EtherNet/IP Devices Spreadsheet]]
  
-====Melsec (Mitsubishi Q)====+=====Melsec (Mitsubishi Q)=====
  
 Spreadsheet header example (order of column headers does not matter) Spreadsheet header example (order of column headers does not matter)
  • importing_device_servers_with_a_spreadsheet.1675287166.txt.gz
  • Last modified: 2023/02/01 15:32
  • by wikiadmin