EasyIO NTP service Applicable for EasyIO 30P and EasyIO FG Series

Transcription

1 EasyIO NTP service Applicable for EasyIO 30P and EasyIO FG Series

2 Document Change Log 05 th January 2012 Document created. 17 th February 2013 Added for EasyIO FG Series. Document name change to Sedona EasyIO NTP Service User Guide.

3 Disclaimer EasyIO 30P is a product by EasyIO Holdings Pte Ltd The EasyIO 30P contains the Sedona Framework. EasyIO FG-32 and EasyIO FG-20 are products by EasyIO Holdings Pte Ltd The EasyIO FG Series contains the Sedona Framework. Sedona Framework is a trademark of Tridium, Inc.

4 Contents Introduction... 5 Easyio NTP service object... 6 NtpService... 7 Configuring NTP service for EasyIO 30P Configuring NTP service for EasyIO FG Series Technical Support... 17

5 Introduction EasyIO 30P Sedona and EasyIO FG Series has the ability to time sync to a NTP server through the internet. This feature keeps the controller built in real time clock (RTC) from drifting. However, in order to use this feature the controller must have an internet connection.

6 Easyio NTP service object The Ntp service object provides Time Synchronization Service for a Sedona device, over an Internet enabled network to a user defined time server. Most commonly use time server is time.windows.com and also the object default NTP server. Kit Name easyiontp easyiofgntp Remarks Only applicable for EasyIO 30P Only applicable for EasyIO FG Series Image below shows the NTP service object from the 2 kits mention above. To use these objects just drag and drop into the wire sheet. NTP service object in the easyiontp kit For EasyIO 30P NTP service object in easyiofgntp kit for EasyIO FG Series

7 NtpService NtpService is a service that provides the device with the time synchronization service. This service is build by reference to Network Time Protocol (NTP) version 3 documentation (rfc1305). Explanations below are applicable to both Ntp Service from both kits. **Note: NtpService must be drop inside Service folder (Sedona -> App -> Service). Images below are referring to an EasyIO 30P. However it is applicable to EasyIO FG Series. The property sheet of the object is shown below

8 Enabled To enable or disable the NtpService, which is set by user. Fault Cause To show cause of the error, when there was NtpService failure. Host Name The Time Server Host, which will provide the time information for time synchronization. Example: time.windows.com Host Address The IP address corresponding to the Host Name; as a result return by DnsService. Last Update This parameter will show the last successful update time. Update Freq The NtpService update frequency, in the unit of Hour (hr). Default to its minimum value, 1 hr. Value of 1 hr means request will be sent every 1 hr. ReupdateFreq The NtpService re-update frequency when the first attempt of update is failed, in the unit of milliseconds (ms). Default to 60000ms, range from 30000ms to ms. Timeout User defined time length to wait, before the NtpService getting a response, in milliseconds (ms). Default to its minimum value, 2000ms. Origin Nanos The time in the unit of nanoseconds (ns), when the NtpService request sending to time server (Host Address). Receive Nanos The time in the unit of nanoseconds (ns), when the time server is received the request. Transmit Nanos The time in the unit of nanoseconds (ns), when the time server response is sending back to the device (send the request). Destination Nanos The time in the unit of nanoseconds (ns), when the NtpService is received the response from time server. Offset Offset is time difference between the device and the time server, which is also the time to be adjusted by device. Value can be either positive or negative. Offset = ( (Receive Nanos-Origin Nanos) + (Transmit Nanos-Destination Nanos) ) / 2

9 Round Trip Delay The total length of time it takes for the request to be sent and the response to be received from time server. Round Trip Delay = (Destination Nanos-Origin Nanos) - (Transmit Nanos-Receive Nanos) Force Update Force the NtpService to send the update request to time server instead of waiting for auto update.

10 Configuring NTP service for EasyIO 30P. In order to configure to the NTP service the easyiontp.kit,easyiodns.kit and easyiolicense.kit must be installed into the controller. Note : EasyioNTP kit and above and easyiodns kit and above DO NOT require easyiolicense kit to be installed. EasyioDns.kit is used to resolve the URL to IP address. EasyioLicense.kit is used to license the DNS, NTP and feature. Refer to EasyIO Advanced 03 License Service document for details. Below are the instructions to configure NTP service Instructions below are based on Sedona Worbench. Optionally CPT Tools can be used. Step 1 Connect to the controller with Sedona Workbench. Default login credentials are as below; IP address : Username : admin Password :<no password> (do not enter any password) Go to Kit Management to manage kit. Install easyiolicense, easyiontp and easyiodns into your controller. Note : EasyioNTP kit and above and easyiodns kit and above DO NOT require easyiolicense kit to be installed.

11 Step 2 Ignore Step 2 and Step 3 if you have easyiontp kit or later and easyiodns kit or later installed. Choose easyiolicense from Sedona Palette Drag & drop LicenseServ into your App.License Service object must be under the Service folder. Step 3 Double click on the License object to get into the Sedona Property sheet. Paste the provided license key into the Unlock Code field. Refer to the EasyIO Adv 03 License Service doc for details regarding the license key. Save the sedona apps and reboot the controller. A valid unlock code entered will display status = valid.

12 Step 4 Choose easyiodns from Sedona Palette Drag & drop DnsServ into your App. DNS Service object has to be under the Service folder. Step 5 Choose easyiontp from Sedona Palette Drag & drop NtpServ into your App.NTP Service object must be under the Service folder.

13 Step 6 Double click on the DnsServ object to display the Sedona Property sheet. Specify the NTP server host name/ address. By default the NTP server URL host name is time.windows.com. At the moment NTP host name only supports URL address and not IP address such as Step 7 To force sync, right click at the object >actions> force update Image shows Update Success Image shows Update Failed

14 Configuring NTP service for EasyIO FG Series. In order to configure to the NTP service the easyiofgntp.kit and easyiofgmail.kit must be installed into the controller. EasyioFGmail.kit contains the DNS service object as a URL to IP address resolver. Below are the instructions to configure NTP service in to EasyIO FG series. Instructions below are based on CPT Tools. Optionally Sedona workbench can be used. Step 1 Connect to the controller with CPT Tools. Default login credentials are as below; IP address : Username : admin Password :<no password> (do not enter any password) Go to Kit Management and install easyiofgntp kit. The kit management will prompt to automatically install any dependency kit which in this case the easyiofgmail kit. Hit Next and Finish when selection is done. The controller will reboots and connection will be lost. A manual reconnection to the controller is required. Step 2 Choose easyiofgmail from Sedona library. Drag & drop DnsServ into your App. DNS Service object has to be under the Service folder.

15 Step 3 Choose easyiofgntpfrom Sedona library. Drag & drop NtpServ into your App. Ntp Service object has to be under the Service folder. Step 4 Click at the Ntp Service object to display the property at the property side bar. Specify the NTP server host name/ address. By default the NTP server URL host name is time.windows.com. At the moment NTP host name only supports URL address and not IP address such as Step 5 The object will run the time sync processes with the update frequency specify. To run a force sync, right click at the object >actions> force update.

16 Image shows Update Success Image shows Update Failed

17 Technical Support For technical support issues please contact technical support person as below;