IB SER 02 Reference Guide
IB SER 02 Reference Guide
May-2018
TABLE OF CONTENTS
1—ETHERNET COMMUNICATIONS-------------- 1
Ethernet Protocols Supported------------------------------------------- 1
Modbus Addressing Conventions-------------------------------------- 1
Modbus Memory Map-------------------------------------------------------- 2
Byte Order----------------------------------------------------------------------- 3
Date/Time Conventions----------------------------------------------------- 3
9—TROUBLESHOOTING----------------------------36
SAFETY PRECAUTIONS
! DANGER
HAZARD OF ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
●● Only qualified workers should install this equipment. Such work should be performed only
after reading this entire set of instructions.
●● NEVER work alone.
●● Beware of potential hazards, wear personal protective equipment, and carefully inspect the
work area for tools and objects that may have been left inside the equipment.
●● The successful operation of this equipment depends upon proper handling, installation, and
operation. Neglecting fundamental installation requirements may lead to personal injury as
well as damage to electrical equipment or other property.
Failure to follow these instructions can result in death or serious injury.
NOTE:
Electrical equipment should be serviced by qualified personnel. No responsibility is assumed by Cyber Sciences, Inc. for any consequences arising out of
the use of this material. This document is not intended as an instruction manual for untrained persons.
1—ETHERNET COMMUNICATIONS
Ethernet Protocols Supported The CyTimeTM SER-3200 / SER-2408 Sequence of Events Recorder supports the fol-
lowing Ethernet protocols:
●● Hypertext Transfer Protocol (HTTP): HTTP is a networking protocol used
by web browsers to access and present data. The CyTime SER uses HTTP to
Note: This instruction bulletin describes product fea- provide web server functionality over TCP port 80 (default).
tures and behaviors for the latest firmware version
●● XML Sockets: The Actionscript 3.0 XMLSocket class implements client sockets
available at the time of publication. Cyber Sciences
that allow the Adobe Flash Player to communicate with the SER web server to
recommends updating to the latest firmware when-
obtain real-time data from the device using TCP port 8080. A master security
ever feasible, available for free download:
policy file is served from the SER over TCP port 843, per Adobe standards.
www.cyber-sciences.com/downloads
●● File Transfer Protocol (FTP): FTP is a networking protocol that provides the
ability to transfer files over Ethernet from one computer to another, using TCP
port 21 (default). The SER supports both active and passive FTP modes. The
maximum number of concurrent FTP sessions is five.
●● Modbus TCP: Modbus TCP is a combination of the Modbus protocol, which
provides master-slave communication between devices, and TCP/IP, which
Note: This XML Sockets section only applies to provides communications over an Ethernet connection. Modbus TCP can be
firmware v2.16 and earlier. used by application software, PLCs, or other master devices to access data
or send commands to the SER, using TCP port 502. The following Modbus
Function Codes are supported: 01, 02, 03, 05, 06, 16 and 20. Note: Connec-
tions (“Modbus TCP Sockets”) that remain idle for 75 seconds and then fail to
acknowledge after three (3) retries are closed automatically (TCP keep-alives).
●● Simple Network Time Protocol (SNTP): SNTP is a time protocol used to syn-
Note: The maximum number of supported TCP chronize clocks of networked devices to a time reference provided by an NTP
connections is 44. The first five (5) are reserved for time server, using UDP port 123.
system use, leaving a total available for customer
●● Precision Time Protocol (PTP): PTP, defined in IEEE Std. 1588-2008, takes
use = 39. Any combination of these is possible,
advantage of special time-stamping Ethernet hardware to distribute a precise
subject to the limits shown at right for Modbus TCP
time reference over Ethernet, ensuring time accuracies of 100 µs or better. The
connections (32 max) and FTP (5 max).
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. (Applies only to SER models with optional
PTP license key.)
Modbus Addressing Conventions The standard Modbus data model consists of four data tables, and a convention
used by most manufacturers is to add a single-digit prefix to indicate register type:
0xxxxx — Discrete Output Coils (000001 to 065536)
1xxxxx — Discrete Input Contacts (100001 to 165536)
3xxxxx — Analog Input Registers (300001 to 365536)
4xxxxx — Analog Output Holding Registers (400001 to 465536)
In this convention, register references use a 1-index, while the actual values used in
the data address field of Modbus messages are 0-based (0 to 65535). Thus, a holding
register reference number 400201 would be read with function code 03 at data
address field 0200.
In this document, all Modbus registers are expressed using this de facto convention
(single-digit prefix to indicate register type, plus offset of 1 from the data address
used in the actual Modbus message).
Modbus Memory Map The CyTime SER-3200 / SER-2408 provides access 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 32 concurrent Modbus
TCP connections are supported. All registers in the SER are read-only holding regis-
ters unless otherwise noted.
Note: The SER-3200 / SER-2408 responds to ID=1 in
the “unit identifier” field in the Modbus Application The SER-3200 / SER-2408 features a non-volatile event log for SER applications and a
Protocol header. second data logging space for Emergency Power Supply Systems (EPSS) reporting.
The Modbus memory map contains all the required data to support both functions,
as illustrated below.
Register
EPSS Data Logs:
address Data Log File Contents
Groups 01 to 16
(variable) ( FIFO)
409501 – 465500
(56000 registers)
The CyTime SER-3200 / SER-2408 primary register map is organized into a fixed-
Note: In general, data from I/O channels 1 to 32 is register section with designated data fields and two variable memory sections—the
organized into contiguous blocks of 32 registers or first for EPSS data logs and the second for event records, accessible using Function
32-bit bitmaps, regardless of whether the channels Code 20. The EPSS data log area consists of sixteen (16) user-configurable data log
consist of 32 inputs (model SER-3200) or 24 inputs groups to enable EPSS reporting. The record size depends on the number of inputs
and 8 outputs (SER-2408). In some cases, relay (or outputs) assigned to the group by the user. Up to 56000 registers can be allo-
output data is also duplicated separately, and the cated by the user to all data logs.
user has the choice of which register access is best
suited to a given software application. The follow- For sequence of events recording (SER) a total of 8192 events are stored in non-
ing pages provide details on the register maps for volatile memory; each event record consists of 8 registers. Additional details are
the SER-3200 and SER-2408. provided in the next sections. See the figure above and the next sections for details.
Byte Order Modbus protocol is based on 16-bit registers, each of which can contain up to 2
bytes. Unsigned values greater than 65535 are encoded as 32-bit integers using 2
registers, 4 bytes total. The order in which these bytes are stored must therefore be
known for the data to be retrieved and correctly interpreted. Modbus declares itself
Note: Where applicable, the SER uses “big-endian” as a ‘big-endian” protocol, per Modbus Application Protocol Specification, V1.1.b:
encoding, consistent with Modbus standards. That
is, the most significant byte or word is stored in the “Modbus uses a ‘big-endian’ representation for addresses and data items. This means
first position, or lowest register. The one exception is that when a numerical quantity larger than a single byte is transmitted, the most signifi-
the event log—here encoding is reversed (“little- cant byte is sent first.”
endian”) to maintain compatibility with legacy Following this convention, the SER stores all values as “big-endian” except where
event recorders. noted otherwise.
A copy of the Modbus protocol specification is available for free download from the
Modbus web site: www.modbus-IDA.org.
Date/Time Conventions The CyTime SER-3200 / SER-2408 provides a user-configurable setting for time-zone
offset: the time in hours to add to or subtract from Coordinated Universal Time (UTC)
to adjust for local time. All date/time values shown in this document are expressed
in local standard time, based on the value for time-zone offset stored in the XML
setup file.
The CyTime SER supports adjustments for Daylight Saving Time (DST) or Summer
Time (added in firmware version 2.14). However, Cyber Sciences recommends that
event timestamps be based exclusively on standard time, since discontinuities
introduce potential for confusion and make comparisons of historical values more
difficult. If an adjustment for DST is desired, this should be made by application soft-
ware at the end point of consumption (for display or analysis). This topic is discussed
in more detail later in this document.
Three (3) different conventions are used by the SER to store the current date/time,
depending on the context:
●● Expanded (7-register) format, in which each element (year, month, day, hour,
minute, second), is stored in a separate register. Example: present date/time, in
registers 400203 to 400209.
●● Condensed (3 or 4-register) format, in which two elements are stored per
Note: The accuracy of NTP time sync depends on register (month/day in MSB/LSB, year/hour in next register, etc.). The 4th
external factors; therefore, when the SER time source register (for milliseconds) is optional. See Table 1-1 below for details. Example:
is NTP, the SER uses only two states for Time Quality present date/time, condensed, in registers 400210 to 400212.
as follows: Time Quality = “2:OK (NTP)” if locked to a
server, or “3: Bad (no sync)” if no NTP server is found. ●● Compressed (2-register, 32-bit unsigned integer) 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: To get the year, add 1900 to the value in register 2 high-byte (e.g., a value of 112 in
register 2/high-byte represents 112 + 1900 = the year 2012).
Please see Section 8 for more details on the convention used in IEEE 1588 to express interval settings in terms of log-base 2.
Outputs 9-16 are “virtual relays,” they are controlled via Modbus for event logging only and do not control any physical outputs.
404203 Time zone offset integer -1200 to +1300 Divide by 100 to get hours
1 = Unicast
404226 PTP communications model integer 2 (fixed)
2 = Multicast
0 = UDPv4,
404227 PTP network transport protocol integer 0 (fixed) 1 = UDPv6,
2 = 802.3 (Layer 2)
2 = two-step
404228 PTP operating mode integer 2 (fixed)
1 = one-step
1 = End-to-End (E2E)
404229 PTP path delay mechanism integer 1 (fixed)
2 = Peer-to-Peer (P2P)
signed
404230 PTP announce interval (master) 1 (fixed = 2 sec) log-base2 of value in seconds
integer
404231 PTP announce receipt time-out (master) integer 3 (fixed) multiple of announce interval
signed
404232 PTP sync interval (master) 0 (fixed = 1 sec) log-base2 of value in seconds
integer
signed
404233 PTP delay request interval (master) 5 (fixed = 32 sec) log-base2 of value in seconds
integer
404234 PTP packet time to live (TTL) integer 64 (fixed)
404235 PTP priority1 integer 0 to 255 PTP master only
404236 PTP priority2 integer 0 to 255 PTP master only
SETUP DATA—INPUTS/OUTPUTS
0 = Normal, 1 = Inverted
bit 00 – Input 1
Inputs—inverted bit 01 – Input 2
404248 bitmap 0x0000 – 0xFFFF
(Inputs 1-16) bit 02 – Input 3
:
bit 15 – Input 16
0 = Normal, 1 = Inverted
Inputs—inverted bit 00 – Input 17
(SER-3200: Inputs 17-32) bit 01 – Input 18
404249 bitmap 0x0000 – 0x00FF
(SER-2408: Inputs 17-24) bit 02 – Input 19
:
bit 15 – Input 32
0 = disabled, 1 = enabled
bit 00 – Output R1
Event recording—Outputs R1 through R8 bit 01 – Output R2
404250 bitmap 0x0000 – 0x00FF
(SER-2408 only) bit 02 – Output R3
:
bit 07 – Output R8
Please see Section 8 for more details on the convention used in IEEE 1588 to express interval settings in terms of log-base 2.
bit 00 – Input 1
405651 High-speed trigger output—Inputs 1 to 16 bitmap 0x0000 – 0xFFFF bit 01 – Input 2
bit 02 – Input 3
:
bit 15 – Input 16
0 = disabled, 1 = enabled
bit 00 – Input 17
High-speed trigger output—Inputs 17 to 32 bit 01 – Input 18
405652 bitmap 0x0000 – 0x00FF
(SER-2408: Inputs 17 to 24) bit 02 – Input 19
:
bit 15 – Input 32
406001 to Outputs R1 to R8—Output names character
(SER-2408 only)
406128 (32 characters, 16 registers each) array
406257 to Outputs R1 to R8—off text character
(SER-2408 only)
406384 (16 characters, 8 registers each) array
406513 to Outputs R1 to R8—on text character
(SER-2408 only)
406640 (16 characters, 8 registers each) array
COMMAND INTERFACE
Command register
408001 integer 0 to 65535 See Section 4 for details
(used to initiate all commands)
COMPATIBILITY REGISTERS
Event Log Contents The CyTime SER-3200 / SER-2408 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
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.
Example 1: Example 2:
Total # of events = 5000 Total # of events = 8192
Event Log Registers Registers 402001 through 402005 are read using Modbus function code 03, while
event records (8 registers per event record) are read using Modbus function code 20
for efficient file record access.
Table 3-2 – Event Log Registers
Register Description Type Range Notes
(ID = 1) EVENT LOG REGISTERS
402001 Number of events in event log integer 1 to 8192
402002 Position of first event record integer 0 to 8191
402003 Position of last event record integer 0 to 8191
402004 to 32-bit note: reg 402004 = high word
Sequence number of last event record 0 to 4,294,967,295
402005 integer (big-endian—MSW first)
EVENT LOG FILE RECORD (TYPICAL FOR 8192)
bit 00 —
bit 01
bit 02 – event type, 0 to 31
bit 03 (see event codes)
bit 04 —
bit 05 — SER-3200:
bit 06 0 to 31 = inputs 1 - 32
bit 07 – SER-2408:
bit 08 0 to 23 = inputs 1 - 24,
1 Event description, part 1 bitmap 0x0000 – 0xFFFF
bit 09 — 24 to 31 = R1 - R8
8 to 15 = VR9 - VR16
bit 10 —- Input/Output status
(0 = OFF, 1 = ON)
bit 11 —- DST (0 = STD, 1 = DST)
bit 12 —
bit 13
bit 14 — reserved
bit 15 —
bit 00 —
bit 01
bit 02
bit 03
bit 04 — ms, 0 to 999
bit 05
bit 06
bit 07
bit 08
bit 09 —
2 Event description, part 2 bitmap 0x0000 – 0xFFFF
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)
32-bit note: reg 3 = low word
3 and 4 No. of seconds since Jan 1, 1984 (LSW, MSW) 0 to 4,294,967,295
integer (little-endian—LSW first)
32-bit note: reg 5 = low word
5 and 6 Event sequence number (LSW, MSW) 0 to 4,294,967,295
integer (little-endian—LSW first)
7 and 8 reserved
Record Sequence Numbers Unique sequence numbers are assigned to each event record in the file, ranging
from 0 to 4,294,967,295. Sequence numbers may be useful with application software
to verify the sequence of event data uploaded over a period of time, even if the SER
event record rolls over internally after its 8192 limit. In addition, if the event log is
cleared, the unique sequence numbers distinguish new events from those previ-
ously recorded.
Event Codes The event codes shown below are used in the event log file record to describe the
type of event recorded by the SER.
Type 2 Buffer (Compatibility Mode) To maintain backwards compatibility with some legacy devices, the CyTime SER sup-
ports an additional method for retrieving event records. The table below shows the
registers used (ID=1). The procedure is as follows:
1. Read coil (FC 01) at address 000001 until a “1” is returned.
2. Next, read holding register (FC 03) at address 400103 to get the total number
Note: with this method, only one master may of events in buffer (0 to 22).
retrieve event records, since the event log is cleared
3. Then read holding registers 400111 through 400198 (or fewer if buffer con-
as events are read. This does not affect access to
tains less than 22 events).
event log using File Record Access method (FC 20)
described previously. 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.
EPSS Data Log Overview The CyTime SER-3200 / SER-2408 has 16 data log files each containing a variable
number of event records. Each record consists of at least 5 registers describing the
event, depending on the number of inputs (and outputs) in the data log group:
●● date and time of the event (adjusted for local time, 4 registers)
●● input or output status at time of event (one register per group member)
Unlike the SER event log, the EPSS data logs record the details of an input or output
whose status changes and also the status of all group members at the time of the
event. This can be used by EPSS software to report the status change of one group
member to trigger an event, such as an ATS switching to emergency power, while
simultaneously reporting the condition of associated equipment in the emergency
power supply system.
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. Each log file’s TOC contains information describ-
ing the file’s contents, including pointers to a header record at the beginning of each
file which, in turn, contains the registers pointing to the status of group members.
Refer to the diagram below for an explanation of this file structure.
402020 – location
402021 – file type Pointers:
402022 – file size register reference
(variable)
:
Log File TOC :
:
402027 – location
File header
(Start of logged data)
EPSS data logs: EPSS data logs:
group 01 to 16 group 01 to 16
EPSS Data Log File Structure The SER-3200 / SER-2408 EPSS data log structure is composed of variable-length
records, depending on the number of inputs or outputs assigned to a data log
group. Each data file location (starting register number) is specified in the file’s “Table
of Contents” (TOC). The first record in each EPSS data log file is a header record
matching the register structure of all data records, but its values contain the channel
number(s) whose status values are stored.
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)
Starting
Register No. Date/Time Status of Inputs/Outputs in Group
409501 MM/DD YY/HH MM/SS ms status reg status reg ... status reg Header
member 1 member 2 member n
409501 + RL Record 1
409501 + RL x n Record n
Record n
.
.
.
Header
Record 1
Record 2
Group
16
Record 3
.
.
.
Record n
5—COMMAND INTERFACE
Command Interface Example 1: Clear Example: To clear the event log using the command interface:
Event Log 1. Write value of 1 to parameter register 408002.
2. Write command code 4210 (0x1072) to command register 408001.
3. The SER clears the event log, records an “Event Log Cleared” event (code 10),
then resets automatically.
4. Upon restart, new events are recorded for Reset, Power Fail, Power On, and
Time Source Lock (if applicable).
Note: The command interface registers can be written 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 2: Initiate Example 2: To initiate auto-test using the command interface:
Auto Test 1. Write value of 24 to parameter register 408002.
2. Write command code 21930 (0x55AA) to command register 408001.
3. The SER enters test mode and generates “Test Status Change” events (code 27),
off-to-on and on-to-off, for each input at 1 ms intervals, as well as test mode
on/off events (codes 24 and 25).
4. Repeat process to initiate another test, if desired.
Setup File Overview SER-3200 / SER-2408 setup data is stored in non-volatile memory on its SD flash
memory card in an XML file format. While the normal method for configuring the
unit is through its embedded web pages, setup changes can also be made simply
by editing the XML setup file using a text editor, such as Windows Notepad. In this
Note: the XML setup file should only be modified by way, standard setup templates can be created and replicated quickly across multiple
advanced users familiar with XML structure, since units.
errors could cause the SER to malfunction. The setup file (“_SETUP.XML”) can be accessed in one of two ways:
●● Direct access of SD memory card’s file system (FAT32) using SD card reader
●● FTP access over a network
SD Card Direct Access To access the SD memory card’s file system directly, first remove control power
from the SER-3200 / SER-2408, then remove the SD card as shown below. Insert
the SD card into a card reader slot of a PC or external card reader and access the file
system using Windows Explorer. When replacing the card, ensure the card remains
“unlocked” to allow read/write access.
a) SD cover in place. b) SD cover removed. c) Push SD card in; card then pops d) SD card removed.
up for access.
FTP Access over Ethernet To access the XML Setup file via ftp (over Ethernet):
1. Open Windows Explorer, type FTP:// followed by the IP address of the CyTime
SER-3200 / SER-2408 (e.g., FTP://169.254.0.10), then hit Enter.
2. When prompted, enter the CyTime SER user name and password (default =
admin / admin).
3. Select the file called “_SETUP.XML” to highlight it.
Note: setup changes made by editing the XML file 4. Right-click the file, then click “Copy to Folder...” (or hit <CTRL + C>) to copy this
directly are not recorded as a “Setup Change” event file to the clipboard.
in the event log.
5. Now click a local folder on the PC, such as the Desktop and hit <CTRL+V> to
paste the file to this location.
6. Edit the _SETUP.XML file using a text editor such as Windows Notepad and
save desired changes.
7. Right-click the modified file, then click “Copy to Folder...” (or hit <CTRL + C>),
navigate to the SER IP address again, click in an open area, right-click and
choose “Paste” (or hit <CTRL + V>). Confirm overwrite and close Explorer.
XML Setup File Example SER-3200 / SER-2408 setup data is stored in XML file format on the SD card. Most
system file names start with an underscore to make it easier to distinguish them
from files added by the user. (See information box at left.) The XML setup file is called
“_SETUP.XML” An excerpt of the XML setup file is shown below.
..
Note: An XML schema document (ser.xsd) is pro- .
vided to help an advanced user ensure that changes
do not result in invalid data. The schema defines the
specific structure and allowable limits of each setup
element. The _SETUP.XML file can be considered an
instance document of its parent class, defined by the
ser.xsd schema document. ..
.
As shown within the XML setup file itself, the schema
(xsd file) is found at:
http://www.cyber-sciences.com/products/xsd/
ser.xsd ..
.
Cyber Sciences strongly recommends that manual
changes to the XML setup file be validated against
this schema using a standard XML validation tool.
7—CUSTOM PAGES
Customization To enable user extensions, the SER-3200 / SER-2408 provides a means for integrating
custom web pages into its standard navigation structure. Clicking the “Monitoring”
tab, then the “Custom” link brings up the following screen:
_CUSTOM.HTM
(1000 x 647 pixels)
Details The custom page includes links to the SER-3200/2408 user’s guide and reference
guide, and the Cyber Sciences web site. It also serves as a placeholder to allow users
to create their own web page(s) customized for a given application. For example,
you may want to add instruction bulletins or project drawings to the CyTime SER
online storage system (SD memory card), and then create a custom web page with
links to these documents.
The default custom page is named “_CUSTOM.HTM” and is stored on the removable
SD card. This file can be modified or replaced to add customized functionality. Users
can leverage the HTML5 web interface based on a “REST-ful” API to create these
custom pages.
For more information on modifying or creating your own custom web pages for
the SER-3200/2408, please contact Cyber Sciences at [email protected] or
615-890-6709.
PTP Settings and Attributes Supported When SER-3200/2408 Event Recorders are used as both the PTP master and PTP
slaves, then they support the simplified PTP settings and attributes indicated below.
For compatibility with a third-party clock used as grandmaster, SER-3200/2408 PTP
slaves can support a wider range of settings and attributes, as shown on right.
Announce Receipt Time-out (master) 3 (Multiple of Announce Interval) 2 to 10 (Multiple of Announce Interval)
Clock Identity (Usually based in part on MAC address) (Usually based in part on MAC address)
1 = Initializing (transient state) 1 = Initializing (transient state)
2 = Faulty (error condition) 2 = Faulty (error condition)
3 = Disabled (PTP not used) 3 = Disabled (PTP not used)
4 = Listening (waiting for sync) 4 = Listening (waiting for sync)
Port State 5 = Pre-master (transient state) 5 = Pre-master (not applicable)
6 = Master (normal state for PTP master) 6 = Master (not applicable)
7 = Passive (only for multiple masters) 7 = Passive (not applicable)
8 = Uncalibrated (transient state) 8 = Uncalibrated (transient state)
9 = Slave (normal state for PTP slave) 9 = Slave (normal state for PTP slave)
06 = Normal (PTP Timescale)
07 = Holdover (PTP Timescale)
13 = Normal (UTC)
13 = Normal (UTC)
14 = Holdover (UTC)
Clock Class 14 = Holdover (UTC)
58 = Out-of-spec (UTC)
52 = Out-of-spec (PTP Timescale)
255 = Slave-only
58 = Out-of-spec (UTC)
255 = Slave-only
16 (0x10) = Atomic clock 16 (0x10) = Atomic clock
32 (0x20) = GPS 32 (0x20) = GPS
64 (0x40) = PTP 64 (0x40) = PTP
Clock Source * 80 (0x50) = NTP 80 (0x50) = NTP
96 (0x60) = Hand-set (manual) 96 (0x60) = Hand-set (manual)
144 (0x90) = Other 144 (0x90) = Other
160 (0xA0) = Internal (none) 160 (0xA0) = Internal (none)
32 (0x20) = 25 ns
39 (0x27) = 100 µs 33 (0x21) = 100 ns
41 (0x29) = 1 ms 39 (0x27) = 100 µs
43 (0x2B) = 10 ms 41 (0x29) = 1 ms
Clock Accuracy * 45 (0x2D) = 100 ms 43 (0x2B) = 10 ms
47 (0x2F) = 1s 45 (0x2D) = 100 ms
49 (0x31) = >10s 47 (0x2F) = 1s
254 (0xFE) = unknown 49 (0x31) = >10s
254 (0xFE) = unknown
PTP Packet Time-To-Live (TTL) 64 1 to 64
* for PTP slaves, this value is obtained from the PTP grandmaster.
Timescales and Leap Seconds There are three different timescales used for time synchronization: UTC, TAI and GPS.
UTC is adjusted periodically for changes in the rate of the earth’s rotation by adding
or subtracting leap seconds, whereas, TAI and GPS are not affected. PTP specifies TAI
Relationships of Timescales as its default timescale. Today, the use of TAI vs. UTC is somewhat academic; most
devices use UTC as their time reference but ignore any advance warning of “leap
GPS = Global Positioning System second coming” even if present, such as the announce bit in the IRIG-B standard.
TAI = International Atomic Time Furthermore, it’s not clear how they would use this information even if they did sup-
UTC = Coordinated Universal Time port it. There have been several instances of leap seconds in the past 20 years, the
TAI is always ahead of GPS time by 19 seconds. At most recent in 2016. Timestamps of events recorded just before or just after the leap
the time of this publication, there have been 36 second may produce confusing data, but otherwise, devices are expected to operate
leap seconds. This gives the following relationships: normally without incident.
TAI = GPS + 19 s The PTP standard also allows for other timescales (primarily UTC), but these are des-
ignated by alternate attribute codes. Any timescale other than TAI is called “Arbitrary”
UTC = GPS - 17 s (and counting)
(or “ARB” ) or “application specific.”
UTC = TAI - 36 s (and counting)
Please refer to the summary chart at left for a comparison of the three timescales, as
well as their relationship to each other.
Adjusting for Local Time Zone Historical events are stored with date/timestamps relative to a known time refer-
ence, such as UTC (Coordinated Universal Time). There are two accepted methods for
adjusting timestamps for a local time zone: adjust once at the final point of con-
sumption (Figure 8-1), or set each intermediate device to use the appropriate time
zone offset, but still transfer the time reference to each via UTC (Figure 8-2).
Figure 8-1. Local time adjusted at end-use point (EPMS software). Figure 8-2. Local time adjusted at each device in system.
Adjusting for Local Time Zone (cont.) The example in Fig 8-1 is attractive for its simplicity, and the example in Fig 8-2 is
sometimes considered more intuitive. However, this second option requires that all
devices be equipped with a local time zone setting, which is not always the case.
Consider the example in Fig 8-3 which includes a PowerLogic CM4000T meter from
Note: The option to adjust the SER time-sync output Schneider Electric. Without some way to adjust the time reference in the DCF77
for local time zone offset was introduced in SER signal to the meter, the CM4000T will simply display the time as received (UTC).
firmware v.2.12. Earlier firmware versions must be
To solve this interoperability problem, the CyTime SER-3200/2408 offers a setup
updated to v.2.12 or later to use this feature.
option to “apply local time zone offset” to one or more of its output signals (IRIG-B of
DCF77 via PLX accessory or ASCII/RS-485 output native to the SER). Fig. 8-4 illustrates
the solution for the CM4000T 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.
Figure 8-3. Local time adjusted at each device—except one. Figure 8-4. Local time adjusted at (or to) each device.
Adjusting for Local Time Zone (cont.) One final example of adjusting clocks for local time zone offset is shown in Fig. 8-5
below. In this example, a third-party GPS clock is configured as PTP master, and
transmits its time reference in terms of TAI. PTP slave devices such as the CyTime
SER automatically adjust from TAI timescale to UTC timescale. Then, if desired, each
device adjusts its own clock for the local time zone according to its user setting.
Figure 8-5. Local time adjusted at each device in system (GPS clock as PTP master).
Daylight Saving Time (DST) Cyber Sciences recommends that event timestamps be based exclusively on stan-
dard time, since discontinuities introduce potential for confusion and make compari-
sons of historical values more difficult. For example, if events occur around the time
of the start of DST (“Spring forward”), their timestamps may appear one hour further
apart than the actual elapsed time.
Even worse, events recorded during the ending changeover (“Fall back”), can have
the same timestamps as events actually occurring one hour apart, with no way to
distinguish the truth. Clearly, the concept of Daylight Saving Time is not compatible
with timestamps in sequence of events recording.
To provide maximum flexibility, the CyTime SER supports adjustments for Daylight
Saving Time (DST) or Summer Time (firmware version 2.14 and later). However,
if possible, all event timestamps should be stored in reference to UTC, and then
adjusted for DST by application software at the point of consumption (edge) for
display or analysis.
9—TROUBLESHOOTING
The service marks, “Reliable Power Starts With Reliable Data.” and “I-Heart-1588”,
CyTime, and the Cyber Sciences stylized logo are trademarks of Cyber Sciences.
All other trademarks are the property of their respective owners.