Cyber Sciences CyTime SER-32e Instruction Bulletin Download Page 24

Page: 24 / 46

INSTRUCTION BULLETIN—Reference Guide

CyTime

Sequence of Events Recorder

IB-SER32e-02

Jan-2022

www.cyber-sciences.com

Event Log Contents

The CyTime SER-32e features an event log file system containing up to 8192 event

records. Each record consists of 8 registers describing the event:

●

date and time of the event (adjusted for local time, if applicable)

●

input name

●

event type

●

input status

●

time quality at time of the event

●

unique record sequence number

3—ACCESSING THE SER EVENT LOG

File Record Access

The primary method for retrieving SER events is “file record access” using Modbus

function code 20. The SER event log memory stores event records in “circular” fash-

ion, rolling over after 8192 events, in a first-in-first-out (FIFO) stack. The total number

of events is stored in holding register 402001, with record pointers in 402002 and

402003. First, these values are read (e.g., function code 03), then event records are

accessed one at a time using function code 20, starting with the first event record

position (from register 402002) through 8191, and starting over at 0, if necessary,

up to the last event record position (stored in register 402003). To ensure reliable

software access even after rollover (excess of 8192 events), the sequence number of

last event record (registers 402004-402005) may be read periodically as well.

Description

Bytes

Request (hex)

Notes

Modbus Function Code 20

1 byte

0x14

function code 20 (hex 14) for file record access

Byte count

1 byte

0x07

always 0x07

Reference type

1 byte

0x06

always 0x06

File number

2 bytes

0x0001

always 0x0001

Record number

2 bytes

0x0000 to

0x1FFF

record position number of event to be read

(based on value in register 402002: starting position)

Record length

2 bytes

0x0008

always 0x0008 (8 registers)

Event # 1
Event # 2

Event # 3

Event # 5000

Event

record

address

8191

Example 1:

Total # of events = 5000

First event

(position = 0)

Last event

(position = 4999)

Event # 5192
Event # 5193

Event # 5194

Event # 5191

Event

record

address

8191

Example 2:

Total # of events = 8192

First event

(position = 3001)

Last event

(position = 3000)

Event # 8192
Event # 1

Table 3-1 – File Record Access (FC 20) Example

Summary of Contents for CyTime SER-32e

Page 1: ...Reliable Power Starts With Reliable Data SM INSTRUCTION BULLETIN REFERENCE GUIDE IB SER32e 02 Jan 2022 CyTime TM Sequence of Events Recorder SER 32e ...

Page 3: ...G EPSS DATA LOGS 24 EPSS Data Log Overview 24 EPSS Data Log File Structure 25 5 COMMAND INTERFACE 26 Description 26 Command Interface Example 1 Clear Event Log 27 Command Interface Example 2 Initiate Auto Test 27 6 XML SETUP FILE 28 Setup File Overview 28 XML Setup File Example 28 7 RESTFUL API 30 Overview 30 HTTP GET Supported Commands 30 HTTP GET Command Descriptions 31 HTTP GET Example Use 32 H...

Page 4: ...ding Apply appropriate personal protective equipment PPE and follow safe electrical practices For example in the USA see NFPA 70E Turn off all power supplying the equipment in which the device is to be installed before installing and wiring the device Always use a properly rated voltage sensing device to confirm that power is off Beware of potential hazards wear personal protective equipment and c...

Page 5: ...9 takes advantage of special time stamping Ethernet hardware to distribute a precise time reference over Ethernet ensuring time accuracies of 100 µs or better The PTP grandmaster broadcasts precise date time and network delay correction data to PTP slaves using UDP ports 319 ptp event and 320 ptp general via multicast IP address 224 0 1 129 Ethernet Protocols Supported The standard Modbus data mod...

Page 6: ... to real time data configuration values and event records via Ethernet using Modbus TCP protocol The SER supports Modbus function codes 01 02 03 05 06 16 and 20 Up to 44 concurrent Modbus TCP con nections are supported All registers in the SER are read only holding registers unless otherwise noted The SER 32e features a non volatile event log for SER applications and a second data logging space fo...

Page 7: ...r format in which the date time is expressed in seconds since the epoch date of Jan 1 1984 Example SER event log registers 3 and 4 in each event record Note Where applicable the SER uses big endian encoding consistent with Modbus standards That is the most significant byte or word is stored in the first position or lowest register The one exception is the event log here encoding is reversed little...

Page 8: ...gister date time Jan 1 2000 to Dec 31 2120 Condensed date time format without ms see Table 1 1 400213 Last NTP sync day of week integer 1 to 7 1 Sunday 2 Monday etc 400214 Last NTP sync month integer 1 to 12 400215 Last NTP sync day of month integer 1 to 31 400216 Last NTP sync year integer 2000 to 2120 400217 Last NTP sync hour integer 0 to 23 400218 Last NTP sync minute integer 0 to 59 400219 La...

Page 9: ...44 0x90 Other 160 0xA0 Internal none 400233 reserved 400234 reserved 400235 reserved 400236 PTP communications model integer 1 or 2 1 Unicast 2 Multicast 400237 PTP network transport protocol integer 0 1 or 2 0 UDPv4 1 UDPv6 2 802 3 Layer 2 400238 PTP operating mode integer 1 or 2 2 two step 1 one step 400239 PTP path delay mechanism integer 0 1 or 2 0 disabled 1 End to End E2E 2 Peer to Peer P2P ...

Page 10: ...d OFF bit 00 Input 17 bit 01 Input 18 bit 02 Input 19 bit 15 Input 32 400246 Forced ON Channels 1 to 16 Inputs 1 16 bitmap 0x0000 0xFFFF 0 Normal 1 Forced ON bit 00 Input 1 bit 01 Input 2 bit 02 Input 3 bit 15 Input 16 400247 Forced ON Channels 17 to 32 Inputs 17 32 bitmap 0x0000 0x00FF 0 Normal 1 Forced ON bit 00 Input 17 bit 01 Input 18 bit 02 Input 19 bit 15 Input 32 400248 Inversion of Inputs ...

Page 11: ...put 24 400260 to 400267 PTP Clock ID character array EVENT LOG REGISTERS 400253 Number of events in event log integer 1 to 8192 400254 Position of first event record integer 0 to 8191 400255 Position of last event record integer 0 to 8191 400256 to 400257 Sequence number of last event record 32 bit integer 0 to 4 294 967 295 note reg 400256 high word big endian MSW first EVENT LOG REGISTERS Duplic...

Page 12: ...x group members 10 base 4 File Mode integer fixed 1 1 FIFO base 5 Record Entry Enable Disable integer 0x0000 to 0xFFFF 0x0000 disabled 0xFFFF enabled base 6 Entry Update Interval integer 0 to 65535 not used fixed 0 base 7 Entry Interval Offset Time integer 0 to 65535 not used fixed 0 base 8 Current No of Records in File integer 0 to 14000 base 9 Current First Record Sequence integer 0 to 14000 poi...

Page 13: ...5 403013 Counter Channel 13 Input 13 integer 0 to 65535 403014 Counter Channel 14 Input 14 integer 0 to 65535 403015 Counter Channel 15 Input 15 integer 0 to 65535 403016 Counter Channel 16 Input 16 integer 0 to 65535 403017 Counter Channel 17 Input 17 integer 0 to 65535 403018 Counter Channel 18 Input 18 integer 0 to 65535 403019 Counter Channel 19 Input 19 integer 0 to 65535 403020 Counter Chann...

Page 14: ...1 2000 to Dec 31 2120 403319 to 403321 Date Time of Last Reset Channel 07 Input 07 3 register date time Jan 1 2000 to Dec 31 2120 403322 to 403324 Date Time of Last Reset Channel 08 Input 08 3 register date time Jan 1 2000 to Dec 31 2120 403325 to 403327 Date Time of Last Reset Channel 09 Input 09 3 register date time Jan 1 2000 to Dec 31 2120 403328 to 403330 Date Time of Last Reset Channel 10 In...

Page 15: ...n 1 2000 to Dec 31 2120 403367 to 403369 Date Time of Last Reset Channel 23 Input 23 3 register date time Jan 1 2000 to Dec 31 2120 403370 to 403372 Date Time of Last Reset Channel 24 Input 24 3 register date time Jan 1 2000 to Dec 31 2120 403373 to 403375 Date Time of Last Reset Channel 25 Input 25 3 register date time Jan 1 2000 to Dec 31 2120 403376 to 403378 Date Time of Last Reset Channel 26 ...

Page 16: ...1 0 disabled 1 enabled 404012 to 404015 IP address octet 1 to 4 MSB to LSB integer 0 to 255 LAN 1 default 169 254 0 10 LAN 2 default 169 254 1 10 404016 to 404019 Subnet mask octet 1 to 4 MSB to LSB integer 0 to 255 default 255 255 0 0 404020 to 404023 Default gateway octet 1 to 4 MSB to LSB integer 0 to 255 default 0 0 0 0 404024 to 404101 reserved 404102 to 404107 Device ID 12 characters 6 regis...

Page 17: ...nual or external 4 DCF77 24V DCLS via EZC 5 DCF77 over RS 485 7 PTP IEEE 1588 slave 404202 Time sync master OUT integer 0 or 1 0 disabled 1 enabled 404203 Time zone offset integer 1200 to 1300 Divide by 100 to get hours 404204 reserved 404205 Time zone offset Apply to PLX IRIG B DCF77 or 1per10 time sync output integer 0 or 1 0 disabled 1 enabled 404206 Time zone offset Apply to ASCII RS 485 integ...

Page 18: ...4230 PTP announce interval master signed integer 1 fixed 2 sec log base2 of value in seconds 404231 PTP announce receipt time out master integer 3 fixed multiple of announce interval 404232 PTP sync interval master signed integer 0 fixed 1 sec log base2 of value in seconds 404233 PTP delay request interval master signed integer 5 fixed 32 sec log base2 of value in seconds 404234 PTP packet time to...

Page 19: ...4334 to 404365 Inputs 1 to 32 Debounce in ms integer 0 to 65535 0 disabled default 20ms 404366 to 404397 Inputs 1 to 32 Chatter count integer 0 to 255 0 disabled default 20ms 404402 to 404913 Inputs 1 to 32 Input names 32 characters 16 registers each character array default Input xx where xx 01 32 405002 to 405257 Inputs 1 to 32 off text 16 characters 8 registers each character array default OFF 4...

Page 20: ...to 32768 406651 Input 11 Log Group integer 0 to 32768 406652 Input 12 Log Group integer 0 to 32768 406653 Input 13 Log Group integer 0 to 32768 406654 Input 14 Log Group integer 0 to 32768 406655 Input 15 Log Group integer 0 to 32768 406656 Input 16 Log Group integer 0 to 32768 406657 Input 17 Log Group integer 0 to 32768 406658 Input 18 Log Group integer 0 to 32768 406659 Input 19 Log Group integ...

Page 21: ...t 01 Group 2 bit 02 Group 3 bit 15 Group 16 406742 to 406997 Groups 1 to 16 Group names 32 characters 16 registers each character array UTILITY REGISTERS 407800 to 407999 Mailbox registers read write for customer use total of 200 16 bit registers COMMAND INTERFACE 408001 Command register used to initiate all commands integer 0 to 65535 See Section 4 for details 408002 to 408150 Additional register...

Page 22: ...9 Divide value by 100 409010 reserved 409011 IP address type static or dynamic actual integer 0 or 1 0 static 1 dynamic 409012 to 409015 IP address octet 1 to 4 MSB to LSB integer 0 to 255 409016 to 409019 Subnet mask octet 1 to 4 MSB to LSB integer 0 to 255 409020 to 409023 Default gateway octet 1 to 4 MSB to LSB integer 0 to 255 409024 to 409025 Serial number 32 bit integer 0 to 4 294 967 295 no...

Page 23: ... setup file bit 08 RTC battery bit 09 power control module bit 10 reserved bit 15 reserved 409052 reserved 409053 to 409054 Carrier board temperature in milli Celcius 32 bit integer 0 to 4 294 967 295 note reg 409053 high word MSW first Divide by 1000 to get the value in Celcius 409061 Scale factor for registers 409062 409065 integer 1 or 1024 409062 to 409063 Total memory in bytes MSW LSW multipl...

Page 24: ...e at a time using function code 20 starting with the first event record position from register 402002 through 8191 and starting over at 0 if necessary up to the last event record position stored in register 402003 To ensure reliable software access even after rollover excess of 8192 events the sequence number of last event record registers 402004 402005 may be read periodically as well Description...

Page 25: ...F 1 ON bit 11 DST 0 STD 1 DST bit 12 bit 13 bit 14 reserved bit 15 2 Event description part 2 bitmap 0x0000 0xFFFF bit 00 bit 01 bit 02 bit 03 bit 04 ms 0 to 999 bit 05 bit 06 bit 07 bit 08 bit 09 bit 10 bit 11 reserved bit 12 bit 13 always 0 bit 14 bit 15 time quality 0 to 3 0 good 1 ms 1 fair 50 ms 2 poor 50 ms 3 bad unknown 3 and 4 No of seconds since Jan 1 1984 LSW MSW 32 bit int 0 to 4 294 96...

Page 26: ...ecorded by the SER Table 3 3 Event Codes Event Code Type 0 reserved 1 Input Status Change Off to On On to Off 2 Input Enabled for Event Recording by User 3 Input Disabled for Event Recording by User 4 Input Chatter Count Off Event Recording Resumed 5 Input Chatter Count On Event Recording Suspended 6 Power On 7 SER Inter Device RS 485 Time Sync Lock 8 SER Inter Device RS 485 Time Sync Fail 9 Inter...

Page 27: ...ains less than 22 events 4 Once buffer contents read write a 1 to coil at address 000002 FC 05 5 Begin reading coil 000001 again until value is set to 1 6 Repeat process until all events are retrieved Register Description Type Range Notes ID 1 COMPATIBILITY REGISTERS 000001 Data buffer ready bit coil 0 or 1 value of 1 indicates ready 000002 Data buffer acknowledge bit coil 0 or 1 write 1 to clear ...

Page 28: ...eporting the condition of associated equipment in the emergency power supply system 4 ACCESSING EPSS DATA LOGS The data log structure for EPSS report data consists of up to 16 data log groups each of which can be allocated a variable number of registers up to a total of 56 000 for all log files Data log file table of contents TOC are stored in fixed locations begin ning with register number 402020...

Page 29: ...el number s whose status values are stored Starting Register No 409501 Legend Header Header record which defines the contents of data records Record Length RL 4 registers for date time 1 to 10 registers 1 per group member Allocated File Size AFS Total number of registers per log group allocated by user File Size FS Actual number of registers used equals no of records 1 x RL Header Record 1 Record ...

Page 30: ...08001 4210 408002 1 Clears event log 408001 9700 none none Creates and activates default SSL certificate 408001 9750 408002 1 Recalibrates the HMI display 408001 21930 408002 24 Initiates auto test simulation 1 generates a Test Mode ON event code 24 in event log 2 generates a Test Status Change event off to on and then back on to off for each channel at 1 ms intervals 3 generates a Test Mode OFF e...

Page 31: ...n in one step using FC16 multiple register write or two steps using FC06 single register write If command is done in two steps it must be done in the order shown above Command Interface Example 1 Clear Event Log Example 2 To initiate auto test using the command interface 1 Write value of 24 to parameter register 408002 2 Write command code 21930 0x55AA to command register 408001 3 The SER enters t...

Page 32: ...e schemaVersion 8 xsi noNa mespaceSchemaLocation http www cyber sciences com products xsd ser xsd comms media_type 0 media_type DHCP_enabled false DHCP_enabled IP_address octet 1 169 IP_address IP_address octet 2 254 IP_address IP_address octet 3 0 IP_address IP_address octet 4 10 IP_address subnet_mask octet 1 255 subnet_mask subnet_mask octet 2 255 subnet_mask subnet_mask octet 3 0 subnet_mask s...

Page 33: ...ver2 octet 4 29 NTP_server2 PTP_domain_number 0 PTP_domain_number PTP_priority1 128 PTP_priority1 PTP_priority2 128 PTP_priority2 time inputs input id 1 enabled true enabled input_name Input 01 input_name filter 0 filter debounce 0 debounce chatter 0 chatter off_text Off off_text on_text On on_text trigger false trigger inverted false inverted log_group 0 log_group input outputs output id 1 enable...

Page 34: ... GET HTTP POST requests Information on implementing typical HTTP GET requests is included here For additional detail and information on all HTTP GET and HTTP POST requests refer to SER 32e_REST_Web_Service API_ HTML5 pdf 1 setup comms 2 setup time 3 setup time refresh 4 setup inputs 5 setup groups 6 setup groups name 7 setup admin 8 setup https 9 setup configuration 10 setup firmware_upgrade 11 ch...

Page 35: ...evice_diagnostics 0 events last This reports the event record pointers 1 Response parameters a NumberOfEvents This is the total number of events captured from 1 to 8192 b FirstRecord This is the location from 0 to 8191 of the first record location c LastRecord This is the location from 0 to 8191 of the last record location d LastSequenceNumber This is the sequence number of the last record 2 Examp...

Page 36: ...75 0001 0000 0000 0000 r 0261 8013 3EA1 6075 0002 0000 0000 0000 r 021A 810D 3ECB 6075 0003 0000 0000 0000 See page 21 Table 3 2 Event Log Registers for format events posix short record 0 count 3 4 register format with Posix epoch UTC timestamp 1 Example response events r 000A 02D5 3AF9 6075 r 0013 02F9 3EA1 6075 r 0406 C002 3ECB 6075 See page 21 Table 3 2 Event Log Registers for format events pos...

Page 37: ...st and events First use the events last to discover the number of events in the Event log From this result the events command can be called with the parameters for starting record and number of records desired Here are examples for each To get the number of events in the Event log use the command events last This command returns a JSON object NumberOfEvents 8192 FirstRecord 0 LastRecord 8191 LastS...

Page 38: ... event record for event 8092 The event record is eight 16 bit hex values registers 1 8 separated by the dash symbol To parse the event record split the result into an array separated by the dash symbol 1 0814 hex value is the event description part 1 reg 1 2 0141 hex value is the event description part 2 reg 2 3 38E4 reg 3 and 4085 reg 4 hex value is the number of seconds since Jan 1 1984 in local...

Page 39: ...e Though the Simple PTP Profile is proposed by Cyber Sciences it is not proprietary Simple PTP is based on the IEEE 1588 Default Profile defined in IEEE 1588 2008 Annex J and 2019 Annex I Devices using Simple PTP are interoperable with others set to use this profile When SER 32e Event Recorders are used as both the PTP master and PTP slaves they support the PTP options indicated below When a third...

Page 40: ...r condition 3 Disabled PTP not used 4 Listening waiting for sync 5 Pre master not applicable 6 Master not applicable 7 Passive not applicable 8 Uncalibrated transient state 9 Slave normal state for PTP slave Clock Class 13 Normal UTC 14 Holdover UTC 58 Out of spec UTC 255 Slave only 06 Normal PTP Timescale 07 Holdover PTP Timescale 13 Normal UTC 14 Holdover UTC 52 Out of spec PTP Timescale 58 Out ...

Page 41: ...Global Positioning System TAI International Atomic Time UTC Coordinated Universal Time TAI is always ahead of GPS time by 19 seconds At the time of this publication there have been 36 leap seconds This gives the following relationships TAI GPS 19 s UTC GPS 17 s and counting UTC TAI 36 s and counting GPS Clock IRIG B PTP SER 32e PTP MASTER PTP SLAVE IRIG B Meter EPMS SW Local time adjusted by EPMS ...

Page 42: ...rates the solution employing this method Instead of transferring the time reference based on UTC between devices the SER outputs the time reference in DCF77 already adjusted for the local time zone GPS Clock IRIG B PTP SER 32e PTP MASTER PTP SLAVE DCF77 Meter EPMS SW SER 32e Local time displayed by EPMS software time zone offset applied at each device 10 00 17 GPS 10 00 00 UTC 10 00 00 UTC 10 00 0...

Page 43: ...00 Pacific Std Time Figure 8 5 Local time adjusted at each device in system GPS clock as PTP master Cyber Sciences recommends that event timestamps be based exclusively on UTC or standard time since discontinuities introduce potential for confusion and make comparisons of historical values more difficult For example if events occur around the time of the start of DST Spring forward their timestamp...

Page 44: ...net switch s are configured to support PTP messaging Ensure there is not another PTP master in the system with same domain number Ensure all managed switches are configured to allow PTP packets Loss of Time Sync PTP PTP master clock has lost its time sync or has been set to a different domain number Confirm the PTP master clock is time sync ed Ensure the PTP master and slave devices have the same ...

Page 45: ...ge Port 502 is blocked on your network Confirm the Modbus Server Enabled option is selected and click apply Enable port 502 on managed IT devices Inputs Do Not Work 24 Vdc whetting voltage may not be present Ensure 24 Vdc whetting voltage is present on contacts being monitored Confirm Input voltages are within SER specification 24 Vdc 15 10 Input voltages outside this range may not function as exp...

Page 46: ...er Sciences Inc CSI 229 Castlewood Drive Suite E Murfreesboro TN 37129 USA Tel 1 615 890 6709 Fax 1 615 439 1651 MADE IN USA RoHS Lead Free Pb The service marks Reliable Power Starts With Reliable Data CyTime and the Cyber Sciences stylized logo are trademarks of Cyber Sciences All other trademarks are the property of their respective owners Doc no IB SER32e 02 Jan 2022 ...

Search results

Summary of Contents for CyTime SER-32e

Reviews:

Related manuals for CyTime SER-32e

Brands by name

Popular brands

Cyber Sciences CyTime SER-32e, Instruction Bulletin

Search results

Summary of Contents for CyTime SER-32e

Reviews:

Related manuals for CyTime SER-32e

Brands by name

Popular brands