EasyIO service Applicable to EasyIO 30P and EasyIO FG Series

Transcription

1 EasyIO service Applicable to EasyIO 30P and EasyIO FG Series

2 Document Change Log 29 th January 2012 Document created. 8 th April 2014 Updated for EasyIO FG Series controller.

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 Service... 6 BooleanAlarm... 7 FloatAlarm... 9 FloatAlarmEd SmtpService Configuring service (SMTP service) Configuring service (points) Technical Support... 21

5 Introduction EasyIO 30P Sedona and EasyIO FG Series have the ability to sent alarm notifications via . At the moment only Boolean and Float points are supported. However, in order to use this feature the controller must have an internet connection.

6 Service service is a service that enables all EasyIO Sedona controllers to send alarm notifications via . At the time of this document, it only allows non-ssl SMTP mail server. Only Boolean and Float data type are allowed to send alarm notification via service. EasyIO 30P Sedona uses easyio kit while EasyIO FG Series uses easyiofgmail kit. Refer to below table for kit compatibility. Kit Name Hardware Dependent Remarks easyio EasyIO 30P only Only applicable for EasyIO 30P This kit depends to easyiodns kit. easyiofgmail No hardware dependent Applicable to EasyIO 30P and EasyIO FG Series This kit includes DNS service object. To use these objects just drag and drop into the wire sheet. Image shows easyio kit Images shows easyiofgmail kit

7 BooleanAlarm BoolAlarm is an object to monitor Boolean type of data, which will trigger the alarm once the Boolean value changed from false to true. Details below is applicable to both easyio and easyiofgmail kit. The property sheet of the object is shown below Status To show current status of the BoolAlarm, indicated by either Alarm or Normal. In Input point with Boolean type. Alarm will be triggered once it changed from false to true (normal to offnormal). Escalation Level1 Enabled To enable or disable the level1 of alarm escalation, which will be set by user. Escalation Time1 Delay time of the alarm escalation, in minute (min). 1 min means escalation alarm will occur 1 min after the first alarm. Default to its minimum value, 1 min. Escalation Level2 Enabled To enable or disable the level2 of alarm escalation, which will be set by user.

8 Escalation Time2 Delay time of the alarm escalation, in minute (min). 2 min means escalation alarm will occur 2 min after the first alarm. Default to its minimum value, 2 min. Escalation Level3 Enabled To enable or disable the level3 of alarm escalation, which will be set by user. Escalation Time3 Delay time of the alarm escalation, in minute (min). 3 min means escalation alarm will occur 3 min after the first alarm. Default to its minimum value, 3 min. To Offnormal Text The messages text to be sent as the information for recipients, as the Boolean input changed from normal to offnormal. To Normal Text The message text to be sent as the information for recipients, as the Boolean input changed from offnormal to normal. Off Normal Hold Time Minimum time period that the transition from normal to alarm needs to be in that state before an is generated. To Normal Hold Time Minimum time period that the transition from alarm to normal needs to be in that state before an is generated. True Text The true text as facets False Text The false text as facets Example of configuring the Boolean point for Alarm

9 FloatAlarm FloatAlarm is an object to monitor Float type of data, which will trigger the alarm once the Float value is out of its preset High or Low limit. Details below is applicable to both easyio and easyiofgmail kit. The property sheet of the object is shown below Status To show current status of the BoolAlarm, indicated by either Alarm or Normal. In Input point with Float type. Alarm will be triggered when its value out of either the preset High or Low limit. Escalation Level1 Enabled To enable or disable the level1 of alarm escalation, which will be set by user.

10 Escalation Time1 Delay time of the alarm escalation, in minute (min). 1 min means escalation alarm will occur 1 min after the first alarm. Default to its minimum value, 1 min. Escalation Level2 Enabled To enable or disable the level2 of alarm escalation, which will be set by user. Escalation Time2 Delay time of the alarm escalation, in minute (min). 2 min means escalation alarm will occur 2 min after the first alarm. Default to its minimum value, 2 min. Escalation Level3 Enabled To enable or disable the level3 of alarm escalation, which will be set by user. Escalation Time3 Delay time of the alarm escalation, in minute (min). 3 min means escalation alarm will occur 3 min after the first alarm. Default to its minimum value, 3 min. High Limit Text The text message to be sent as the information for recipients, as the Float input exceeds the High Limit. Low Limit Text The text message to be sent as the information for recipients, as the Float input less than the Low Limit. To Normal Text The text message to be sent as the information for recipients, as the Float input fall between High and Low limit. High Limit Upper limit for the Float type input. Low Limit Low limit for the Float type input. Deadband High alarm = High Limit + Deadband Low alarm = Low Limit Deadband Off Normal Hold Time Minimum time period that the transition from normal to offnormal needs to be in that state before an is generated. To Normal Hold Time Minimum time period that the transition from offnormal to normal needs to be in that state before an is generated. Precision Decimal for the alarm value.

11 Example of configuring the Float point for Alarm FloatAlarmEd FloatAlarmEd is an object to monitor Float type of data, which will trigger the alarm once the Float value is out of its preset High or Low limit. Details below is applicable to both easyio and easyiofgmail kit. The property sheet of the object is shown below

12 SmtpService SmtpService is an object to provide the service for the Alarm objects (BoolAlarm and FloatAlarm) mentioned above. When an alarm is triggered, SmtpService will send an as configured, to the recipient/receipients. **Note: SmtpService must be drop inside Service folder (Sedona -> App -> Service). ** Only NON-SSL smtp server are supported at the time of this document. The property sheet of the object is shown below Enabled To enable or disable the SmtpService, which will be set by user. Fault Cause To show cause of the error, when there was SmtpServicefailure.

13 Host Name The server host name, for the SmtpService to send the to recipients. Host IP The IP address corresponding to the Host Name. Port The port number that used by SmtpService to send . Socket Timeout User defined time length to wait, before the TCP Socket for communication is closed. Default to its minimum value, 5000ms. Request Timeout User defined time length to wait, before the SmtpService getting a response, in milliseconds (ms). Default to its minimum value, 5000ms. State State of the socket, whether Open or Close. To Offnormal To be set by user, whether true or false. If true, will be sent when BoolAlarm/FloatAlarm changed from normal to offnormal, vice versa when set to false. To Normal To be set by user, whether true or false. If true, will be sent when BoolAlarm/FloatAlarm changed from offnormal to normal, vice versa when set to false. Account account that will be used to send the . Password Password of the s Account. Subject s subject. Recipient Recipient(s) address. Support multiple recipients by using semicolon (;) or comma (,). Example: [email protected];[email protected] [email protected],[email protected] Greeting The greeting words at the beginning of the . User may customize the getting message to provide information such as device name and location. Example of sent:

14 Text The contents of last sent, by SmtpService. Test Text input area allowed users to enter contents, to test the functionality of SmtpService. All properties of SmtpService have to be properly set before invoke this action.

15 Configuring service (SMTP service). In order to configure the service the easyiodns.kit,easyio .kit and easyiolicense.kit must be installed into the EasyIO 30P controller. For EasyIO FG Series kits required are easyiofgmail only. EasyioDNS.kit is used to resolve the URL to IP address. For EasyIO FG series DNS service object is from the easyiofgmail kit. EasyioLicense.kit is used to license the DNS, NTP and feature. Refer to EasyIO Advanced 03 License Service document for details. EasyIO FG Series does not require this kit. Below are the steps to configure service Step 1 Connect to the controller with Sedona Workbench. Default login credentials for EasyIO 30P and EasyIO FG Series are display as below; EasyIO 30P IP address : Username : admin Password :<no password> EasyIO FG Series IP address : Username : admin Password :<no password> Manage kits to install easyiolicense, easyio and easyiodns into EasyIO 30P controller. For EasyIO FG Series only easyiofgmail needs to be installed.

16 Step 2 Skip this step if you are configuring EasyIO FG Series. Choose easyiolicense from Sedona Palette Drag & drop LicenseServ into your App.License Service object must be under the Service folder. Step 3 Skip this step if you are configuring EasyIO FG Series. 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. A valid unlock code keyed in will show status = valid.

17 Step 4 Choose easyiodns from Sedona Palette Drag and drop DnsServ into your App.DNS Service object must be under the Service folder. ** Note ** For EasyIO FG Series choose easyiofgmail from the Sedona palette. Drag and drop the DnsServ into the service folder. Step 5 Choose easyio from Sedona Palette Drag and drop SmtpServ into your App. Smtp Service object must be under the Service folder. For EasyIO FG Series choose easyiofgmail from the Sedona palette. Drag and drop the SmtpServ into the service folder.

18 Step 6 Double click on the SmtpServ object to get into the Sedona Property sheet. Configure the SMTP service according to the mail provider. Only NON-SSL smtp servers are supported at the time of this document.

19 Configuring service (points). Make sure SMTP service is configured correctly. service only support 2 data types; Boolean and Float. Below are the steps to configure a Boolean point to send an if any alarm occurred. Step 1 Choose easyio from Sedona Palette Drag & drop BoolAlarm object into your App. The BoolAlarm object can be anywhere within the Sedona app. A valid link is required to BoolAlarm object in order to generate an alarm. Step 2 Double click the BoolAlarm object into Sedona Property Sheet. Configure the Alarm Message Text and all others necessary. Step 3 Repeat step 1 to step 2 for a FloatAlarm. Configure the FloatAlarm Sedona property sheet for float value properties.

20 Step 4 An will be sent if the value is in the alarm range/value.

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