Template:SMS and Email alerts Triggered by BAT120: Difference between revisions

From Teltonika Networks Wiki
No edit summary
No edit summary
Line 22: Line 22:


==Use Case Topology==
==Use Case Topology==
[[File: Power Supply BAT120 Use Case v1.png|center|Power Supply BAT120 Use Case]]
[[File:Power Supply BAT120 Use Case v1.png|border|class=tlt-border]]


'''Where:'''<br>
'''Where:'''<br>
Line 35: Line 35:


'''1.''' Navigate to '''System -> Administration -> Recipients -> E-mail Users''' type in the Name and add a New Instance
'''1.''' Navigate to '''System -> Administration -> Recipients -> E-mail Users''' type in the Name and add a New Instance
[[File:Adding New Recipient 1 - Copy.png|center]]
[[File:Adding New Recipient 1 - Copy.png|border|class=tlt-border]]
'''2.''' An advanced configuration window will open, in there, type in the details for your E-mail account. In this example, Gmail account is being used, therefore the following configuration is required:
'''2.''' An advanced configuration window will open, in there, type in the details for your E-mail account. In this example, Gmail account is being used, therefore the following configuration is required:


Line 45: Line 45:
• Password: '''e-mail account password''' <br>
• Password: '''e-mail account password''' <br>
• Senders email: '''Usually it is the Username''' <br>
• Senders email: '''Usually it is the Username''' <br>
[[File:Adding New Recipient 2 2 2.png|center|Adding New Recipient]]
[[File:Adding New Recipient 2 2 2.png|border|class=tlt-border]]
'''Note:''' It also might be required to allow '''"less secure apps"''' to access your email account, which is being used to send the letter. This can be changed via your email settings.
'''Note:''' It also might be required to allow '''"less secure apps"''' to access your email account, which is being used to send the letter. This can be changed via your email settings.


Line 51: Line 51:
'''1.''' Open your '''Routers (RUT955)''' WebUI <br>
'''1.''' Open your '''Routers (RUT955)''' WebUI <br>
'''2.''' Navigate to: '''Services -> Input/Output -> I/O Juggler -> Actions -> Add two New Instances''': one with type SMS and another one with type Email. A configuration window will open, you need to select accordingly. <br>
'''2.''' Navigate to: '''Services -> Input/Output -> I/O Juggler -> Actions -> Add two New Instances''': one with type SMS and another one with type Email. A configuration window will open, you need to select accordingly. <br>
'''2.1''' Adding SMS Action:[[File:Add SMS Action.png|center|Add SMS Action]] <br>
'''2.1''' Adding SMS Action:[[File:Add SMS Action.png|border|class=tlt-border]] <br>
'''2.2''' Configuring SMS Action: <br>
'''2.2''' Configuring SMS Action: <br>
• Type: '''SMS''' <br>
• Type: '''SMS''' <br>
Line 58: Line 58:
• Click '''Save & Apply'''. <br><br>
• Click '''Save & Apply'''. <br><br>
'''Note:''' You could send the SMS alerts to '''more than one phone number''' as well, this is called '''Phone Groups'''. To create one, the process is very similar to creating an Email Recipient described above, you would need to navigate to ''' System -> Administration -> Recipients -> Phone Groups'''. Once created, your created Phone groups will be available for selection within our I/O Juggler. <br>
'''Note:''' You could send the SMS alerts to '''more than one phone number''' as well, this is called '''Phone Groups'''. To create one, the process is very similar to creating an Email Recipient described above, you would need to navigate to ''' System -> Administration -> Recipients -> Phone Groups'''. Once created, your created Phone groups will be available for selection within our I/O Juggler. <br>
[[File:SMS Instance.png|center|SMS Instance]]
[[File:SMS Instance.png|border|class=tlt-border]]
'''2.3''' Adding Email Action: <br>
'''2.3''' Adding Email Action: <br>
[[File:Add Email Action.png|center|Add Email Action]]
[[File:Add Email Action.png|border|class=tlt-border]]
'''2.4''' Configuring Email Action: <br>
'''2.4''' Configuring Email Action: <br>
• Type: '''Email''' <br>
• Type: '''Email''' <br>
Line 67: Line 67:
• Email account: '''Recipient (Created earlier)''' <br>
• Email account: '''Recipient (Created earlier)''' <br>
• Recipient’s email address: '''Recipient’s e-mail address''' <br> <br>
• Recipient’s email address: '''Recipient’s e-mail address''' <br> <br>
[[File:Email Instance.png|center|Email Instance]]
[[File:Email Instance.png|border|class=tlt-border]]
'''2.5''' Once finished, your configuration should look like this:
'''2.5''' Once finished, your configuration should look like this:
[[File:Actions Configured.png|center|Actions Configured]]
[[File:Actions Configured.png|border|class=tlt-border]]
=== I/O Juggler General Configuration===
=== I/O Juggler General Configuration===
'''1.''' Navigate to: '''Services -> Input/Output -> General -> Add new Instance -> Select Role Input (3)''' and click on '''Add''' <br>
'''1.''' Navigate to: '''Services -> Input/Output -> General -> Add new Instance -> Select Role Input (3)''' and click on '''Add''' <br>
[[File:Adding Input.png|center|Adding Input]]
[[File:Adding Input.png|border|class=tlt-border]]
'''2.''' Another configuration window will open, you would need to select: <br>
'''2.''' Another configuration window will open, you would need to select: <br>
• Enabled: '''on''' <br>
• Enabled: '''on''' <br>
Line 78: Line 78:
• Add actions: '''BAT_SMS''' and '''BAT_Email''' that you have configured previously. <br>
• Add actions: '''BAT_SMS''' and '''BAT_Email''' that you have configured previously. <br>
• Click '''Save & Apply'''. <br>
• Click '''Save & Apply'''. <br>
[[File:Input Output Input 3 Configuration.png|center|Input Output Input 3 Configuration]] <br>
[[File:Input Output Input 3 Configuration.png|border|class=tlt-border]] <br>
'''3.''' Navigate to '''Services -> Input/Output -> General -> General drop-down menu and enable I/O Juggler''' and click on '''Save & Apply''' <br>
'''3.''' Navigate to '''Services -> Input/Output -> General -> General drop-down menu and enable I/O Juggler''' and click on '''Save & Apply''' <br>
[[File:Enabling Juggler.png|center|Enabling Juggler]]
[[File:Enabling Juggler.png|border|class=tlt-border]]
==Verification==
==Verification==
Once Configured according to this example, in the case of RUT955 (or any other Teltonika Networks Router/Gateway) losing connection to its main Power Source '''BAT120''' will take over and will forward an up to '''12V Alarm Signal''' to '''INPUT PIN 3'''.<br>
Once Configured according to this example, in the case of RUT955 (or any other Teltonika Networks Router/Gateway) losing connection to its main Power Source '''BAT120''' will take over and will forward an up to '''12V Alarm Signal''' to '''INPUT PIN 3'''.<br>
This Alarm Signal will work as a trigger for I/O Juggler and you should receive alarms similar to the ones bellow. <br>
This Alarm Signal will work as a trigger for I/O Juggler and you should receive alarms similar to the ones bellow. <br>
'''SMS Alert:'''<br>
'''SMS Alert:'''<br>
[[File:SMS Alert New.png|center|SMS Alert]]<br>
[[File:SMS Alert New.png||border|class=tlt-border]]<br>
'''Email Alert:'''<br>
'''Email Alert:'''<br>
[[File:Email Alert.png|center|Email Alert]] <br>
[[File:Email Alert.png||border|class=tlt-border]] <br>
==See Also==
==See Also==
* https://wiki.teltonika-networks.com/view/RUT955_Powering_Options
* https://wiki.teltonika-networks.com/view/RUT955_Powering_Options
* https://wiki.teltonika-networks.com/view/RUT955_Input/Output#I.2FO_Juggler
* https://wiki.teltonika-networks.com/view/RUT955_Input/Output#I.2FO_Juggler

Revision as of 14:47, 13 April 2022

Introduction

This article provides a guide on how to configure SMS and Email alerts using I/O Juggler on Teltonika Networks Routers and Gateways when the main power supply is being cut and the device switches onto the Backup Power from - BAT120.


  • First you want to make sure that you have ADVANCED mode enabled. This will allow you to choose from a larger variety of settings.


Prerequisites

For this particular configuration you will need:

  • One of Teltonika Networks Routers or Gateways (RUT955 is being used in the example)
  • BAT120
  • 2 SIM card, that allows sending SMS messages(One used by RUT955 and one by the client at the receiving end)
  • 2 Email accounts (Two accounts are being used in this example: one Google Mail and one Teltonika)

Preparation

  • Connect Power Supply to BAT120 IN PWR
  • Connect BAT120 OUT PWR to RUT955 Power Socket

Use Case Topology

Where:
1.Power is being cut from the main Power Supply for BAT120
2.Once BAT120 recognizes that IN PWR is no longer receiving any Input from Main Power supply, it sends a 12 VDC alarm via its OUT PWR
3. RUT955 receives an Alarm Signal from BAT120 via its INPUT PIN 3, which changes the pin state from Low to High
4. An E-mail and SMS alerts are being sent to the end user

Configuration

Adding e-mail user

1. Navigate to System -> Administration -> Recipients -> E-mail Users type in the Name and add a New Instance File:Adding New Recipient 1 - Copy.png 2. An advanced configuration window will open, in there, type in the details for your E-mail account. In this example, Gmail account is being used, therefore the following configuration is required:

• Secure Connection: on
• SMTP Server: smtp.gmail.com
• SMTP Server Port: 587
• Credentials: on
• Username: e-mail username
• Password: e-mail account password
• Senders email: Usually it is the Username
File:Adding New Recipient 2 2 2.png Note: It also might be required to allow "less secure apps" to access your email account, which is being used to send the letter. This can be changed via your email settings.

I/O Juggler actions Configuration

1. Open your Routers (RUT955) WebUI
2. Navigate to: Services -> Input/Output -> I/O Juggler -> Actions -> Add two New Instances: one with type SMS and another one with type Email. A configuration window will open, you need to select accordingly.
2.1 Adding SMS Action:File:Add SMS Action.png
2.2 Configuring SMS Action:
• Type: SMS
• Text Message: Your Preferred SMS text
• Recipient's phone number: Phone number of the recipient with the country code, for example, +370...
• Click Save & Apply.

Note: You could send the SMS alerts to more than one phone number as well, this is called Phone Groups. To create one, the process is very similar to creating an Email Recipient described above, you would need to navigate to System -> Administration -> Recipients -> Phone Groups. Once created, your created Phone groups will be available for selection within our I/O Juggler.
File:SMS Instance.png 2.3 Adding Email Action:
File:Add Email Action.png 2.4 Configuring Email Action:
• Type: Email
• Subject: Your preferred subject
• Text message: Your preferred text message
• Email account: Recipient (Created earlier)
• Recipient’s email address: Recipient’s e-mail address

File:Email Instance.png 2.5 Once finished, your configuration should look like this: File:Actions Configured.png

I/O Juggler General Configuration

1. Navigate to: Services -> Input/Output -> General -> Add new Instance -> Select Role Input (3) and click on Add
File:Adding Input.png 2. Another configuration window will open, you would need to select:
• Enabled: on
• Trigger: Rising
• Add actions: BAT_SMS and BAT_Email that you have configured previously.
• Click Save & Apply.
File:Input Output Input 3 Configuration.png
3. Navigate to Services -> Input/Output -> General -> General drop-down menu and enable I/O Juggler and click on Save & Apply

Verification

Once Configured according to this example, in the case of RUT955 (or any other Teltonika Networks Router/Gateway) losing connection to its main Power Source BAT120 will take over and will forward an up to 12V Alarm Signal to INPUT PIN 3.
This Alarm Signal will work as a trigger for I/O Juggler and you should receive alarms similar to the ones bellow.
SMS Alert:

Email Alert:

See Also