sauter SMS EAGLE User manual

  • Hello! I am an AI chatbot trained to assist you with the sauter SMS EAGLE User manual. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
SMS EAGLE
for SAUTER device
Ph. Huwyler, 15.01.2017, v.1.3 2/26
Content
Introduction ................................................................................................................................................................................................................................ 3
Main arguments ........................................................................................................................................................................................................................ 3
SMS EAGLE first steps .............................................................................................................................................................................................................. 4
1. What’s in The BOX .................................................................................................................................................................................................. 4
2. Prepare for first start ............................................................................................................................................................................................. 4
Step 1: Connect GSM antenna ................................................................................................................................................................................. 4
Step 2: Insert SIM Card ............................................................................................................................................................................................... 4
Step 3: Power the device ............................................................................................................................................................................................ 4
Step 4: Configure IP settings ..................................................................................................................................................................................... 4
Get to know with Connectors, Ports and LEDs ................................................................................................................................................................ 7
SMS Eagle features ................................................................................................................................................................................................................... 8
3. Plugins ........................................................................................................................................................................................................................ 8
Autoreply plugin ........................................................................................................................................................................................................... 8
Network Monitoring .................................................................................................................................................................................................... 8
Email to SMS plugin ..................................................................................................................................................................................................... 9
SMS to Email plugin ..................................................................................................................................................................................................... 9
Callback URL plugin ..................................................................................................................................................................................................... 9
SMS Eagle API ................................................................................................................................................................................................................ 9
External Software integration ................................................................................................................................................................................... 9
Basic usage of the E-Mail To SMS plugin ......................................................................................................................................................................... 9
SAUTER device / software configuration examples ..................................................................................................................................................... 10
4. Preamble ................................................................................................................................................................................................................. 10
5. moduWeb ............................................................................................................................................................................................................... 11
6. moduWebVision ................................................................................................................................................................................................... 13
7. SAUTER Vision Center ......................................................................................................................................................................................... 15
8. SAUTER novaPro Open with AAM .................................................................................................................................................................. 17
NETWORK MONITOR ............................................................................................................................................................................................................ 19
9. Define what you want to monitor ................................................................................................................................................................... 19
10. Define a schedule ........................................................................................................................................................................................... 19
11. Control a status of your tasks ..................................................................................................................................................................... 19
12. Define a SMS alert message ....................................................................................................................................................................... 20
SMS EAGLE Database ............................................................................................................................................................................................................ 20
API ................................................................................................................................................................................................................................................ 22
How to use SMS EAGLE with FQDN .................................................................................................................................................................................. 22
Troubleshooting ...................................................................................................................................................................................................................... 24
13. Essential steps.................................................................................................................................................................................................. 24
14. Useful commands for SMS.EAGLE (CLI using SSH): ............................................................................................................................. 24
15. Gateway is not sending messages. Modem log reports "Error sending SMS: No SMSC number given.":........................ 26
Ph. Huwyler, 15.01.2017, v.1.3 3/26
Introduction
SMS Eagle is a professional hardware SMS gateway for sending and receiving SMS messages
in an automated manner. The device is designed with focus on reliability and stability.
SMS Eagle is based on ARM11 processor with Linux 4.1 operating system on-board. It has a
modern responsive web-interface, stable database backend, and built-in 3G modem with fail-
over mechanisms (based on software watchdog) which monitor the work of a 3G modem.
Thank to built-in 3G modem, SMS messages are sent/received directly to/from GSM network
without using any external 3rd party solutions. The device is equipped with external antenna
with 3.5dBi gain important especially in poor signal reception conditions (eg. Server rooms).
SMS Eagle has a built-in SQL database for secure storage of sent and received messages.
Built-in SNMP agent allows to constantly monitor a performance of the SMS Eagle. The
device has a range of built-in plugins (Email2SMS plugin, SMS2Email plugin, Network
Monitoring plugin, and other) that enable additional functionalities. SMS Eagle has easy to
use API for integration with external applications.
Main arguments
- Sending SMS without Internet connection: If you want to be sure that your SMS will
get through even if your Internet connection fails: SMS Eagle hardware SMS gateway
sends SMS directly to GSM network without using Internet connection.
- Cost control: SMS Eagle device uses your SIM card. This allows you to have a contract
with your own carrier the bests suits you. You can control costs of sending/receiving
messages and adjust your SIM contract to your needs
- SMS Eagle is a product that combines custom hardware, modern UI and software all
built on the top of first-class open-source solutions. Graphical User Interface of SMS
Eagle is accessible via web browser of your choice. Web-GUI allows the user to setup
the device. It also contains many features for managing SMS operations.
- Email To SMS plugin allows you to convert an email to SMS message.
- Network monitoring: with SMS Eagle you have a tool for monitoring your services or
servers. Just define what and when should be monitored. SMS Eagle will send you
SMS alerts when your services/servers go down. Be informed immediately, keep
reaction time low, and let your customers be happy with your services.
Ph. Huwyler, 15.01.2017, v.1.3 4/26
SMS EAGLE first steps
1. What’s in The BOX
SMS Eagle box contains:
SMS Eagle hardware SMS gateway
External omnidirectional 3.5dBi GSM antenna (with magnetic foot)
AC/DC power supply (input voltage: 100-240V)
Warranty card
2. Prepare for first start
SMS Eagle is designed so that you can set it up quickly and start using it right away. Follow
the steps below to get started.
Step 1: Connect GSM antenna
Plug in GSM antenna connector to the device.
Step 2: Insert SIM Card
Please install SIM Card when the device is SWITCHED OFF.
SIM Card slot is located at the bottom of the device. Use a
ball-pen or small screwdriver to eject SIM Card tray. Insert
card into tray and push it gently into slot.
Step 3: Power the device
The device is powered with AC/DC power supply adaptor delivered in the box. The device
needs a power source of 12V DC to 30V with 27W power.
In order to power the device simply plug in a connector from AC/DC adaptor into the device.
Step 4: Configure IP settings
Ph. Huwyler, 15.01.2017, v.1.3 5/26
SMS EAGLE DEFAULT NETWORK CONFIGURATION:
DHCP CLIENT IS ON
(IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER)
A) CONNECT SMS EAGLE TO YOUR LAN AND OBTAIN IP ADDRESS AUTOMATICALLY
connect the device to your LAN using Ethernet cable
SMS Eagle will obtain IP address automatically from your DHCP
read assigned IP address on your DHCP server
B) OR SET IP ADDRESS FOR SMS EAGLE MANUALLY
connect a display using HDMI connector, connect a keyboard to USB port (note:
cables are not provided)
login to the SSH console using root credentials (these were provided with your
device)
edit configuration file with command: mcedit /mnt/nand-user/SMS Eagle/syscfg
change the following lines: HOST_IP= (set IP address for your device) GW_IP= (default
gateway IP address
NET_MASK= (set subnet mask) START_DHCP=Y (set to START_DHCP=N to disable
DHCP client)
save and exit the file
shutdown the device
now connect SMS Eagle to your LAN using Ethernet cable
C) LOG IN TO SMS EAGLE
Open an internet browser on your PC and go to the IP address assigned to your gateway
SMS EAGLE DEFAULT USER IS:
Username: admin
Password: password
Ph. Huwyler, 15.01.2017, v.1.3 6/26
D) CONFIGURE STATIC IP SETTINGS (OPTIONAL but recommended)
Click on menu position “Settings” and navigate to tab “IP Settings”.
Disable DHCP server. Enter your IP settings. Press Save” button.
E) SETTING SIM-CARD PIN NUMBER
This step should ONLY be done if your SIM-card requires PIN.
If your SIM-card requires PIN number at startup, go to Settings > Maintenance Tab.
Enter your PIN number in the field “SIM Card PIN”:
Press “Save” button.
F) REBOOT THE DEVICE
Go to Settings > Maintenance Tab. Press Reboot button.
Ph. Huwyler, 15.01.2017, v.1.3 7/26
Get to know with Connectors, Ports and LEDs
Element
Label
Description
Connector 1
C1
Power connector and serial ports
SIM Card Slot
SIM1, SIM2 (optional)
SIM card slot(s)
HDMI port
HDMI
HDMI port (cable not included)
USB port
USB
USB port (cable not included)
Ethernet Port
ETH
Ethernet RJ45 socket
Antenna
ANT
Antenna socket
Power LED
PWR
LED indicating power-on
User LED
USER
LED for user application purpose (not used)
SIM1,2 LEDs
3G modem 1, 3G modem 2 (optional)
LED indicator for modem status
Ready LED
RDY
LED indication device status
Reset
RST
Switch for rebooting the device
User Switch
SW
Switch for restoring to factory settings
Ph. Huwyler, 15.01.2017, v.1.3 8/26
SMS Eagle features
Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items)
Sending to single users or groups of users
SMS Scheduling by specified date and time or delay
Smartphone-like conversation mode (messages are nicely grouped by phone
number). You can easily track history of what you send and receive
Message templates (save, edit your own templates)
Contact book (single users, groups)
Multiuser support (each user has access to a private Inbox, Outbox, Sent Items)
Powerful Network Monitoring service and SMS alerting
Auto-reply to incoming SMS
Email to SMS forwarding
SMS to Email forwarding
Forward incoming SMS to remote script (callback url)
Unicode support (support of national characters)
HTTP/HTTPS API for sending and receiving SMS from external applications & systems
SNMP client installed
NTP client installed
3G modem watchdog installed (automatic modem health control)
Failover support (HA cluster of 2 devices)
Monitoring services (eg Web server, Mail server) and sms alerting
Sending/Receiving Throughput:
- Incoming transmission rate: up to 30 SMS/min
- Outgoing transmission rate: up to 20 SMS/min
- API send sms requests: up to 60 SMS/min (messages are queued for sending in a
database)
3. Plugins
Autoreply plugin
If the plugin is set to ‘Active’ SMS Eagle responds to each received message with automatic
fixed text response. Text response can be defined within plugin settings. If within last hour
text response has been already sent to a given phone number, text response is not being
sent again to that number.
Network Monitoring
SMS Eagle is equipped with powerful (yet simple to use) network services monitoring
features. With that features you can monitor any service that has listening port open. SMS
Eagle is trying to connect to each defined port in Network Monitoring feature and sends
defined SMS alert when port is unavailable. Go to our website www.SMS Eagle.eu for the
details of this feature.
Ph. Huwyler, 15.01.2017, v.1.3 9/26
Email to SMS plugin
Email to SMS plugin allows you to convert an email to SMS message and send to the given
telephone number. Go to our website www.SMS Eagle.eu for the details of this feature.
SMS to Email plugin
SMS to Email plugin allows you to forward your SMS messages to email address. It forwards
all the incoming messages to one email address. Plugin uses an external SMTP server for
sending emails. Go to our website www.SMS Eagle.eu for the details of this feature.
Callback URL plugin
Callback URL plugin allows you to forward incoming SMS message to a defined URL address.
If the plugin is enabled, on each incoming sms message SMS Eagle will trigger HTTP request
to a defined URL. HTTP request can be of type GET or POST. Go to our website www.SMS
Eagle.eu for the details of this feature.
SMS Eagle API
SMS Eagle has some powerful built-in API functionalities. With API you can use the device to
send and receive messages from any external system or application. For the detailed
description of API functionality go to our internet site: http://www.SMS Eagle.eu/api/
External Software integration
SMS Eagle has a number of ready-to-use plugins for integration with external software
(monitoring systems and other). For a complete list of plugins please go to: http://www.SMS
Eagle.eu/integration-plugins/
Basic usage of the E-Mail To SMS plugin
If the plugin is enabled, email sent to the email address:
PHONE_NUMBER@[IP_ADDRESS_OF_SMS EAGLE]
will be converted to SMS message.
PHONE_NUMBER is a destination phone number
IP_ADDRESS_OF_SMS EAGLE is the IP address of your device.
The text of the email is the text of the SMS message (optionally you can append email
subject at the beginning of SMS message).
To enable this plugin, go to Email to SMS web-page and enable it.
Ph. Huwyler, 15.01.2017, v.1.3 10/26
Example: email message sent to the address: 123456789@[192.168.0.101] will be converted
to SMS message and delivered to phone number 123456789.
Further information, example and details can be found under http://www.SMS
Eagle.eu/email-to-sms/
SAUTER device / software configuration examples
4. Preamble
The following points has to be configured before you begin configuring a SAUTER device:
- SMS EAGLE network settings (ip address, …)
- The SMS EAGLE plugin E-Mail To SMS is enabled. Please read first the chapter “Basic
usage of the E-Mail To SMS plugin”
- The SAUTER device can reach the SMS EAGLE device on the ethernet network via the
TCP port 25 (smtp)
Ph. Huwyler, 15.01.2017, v.1.3 11/26
5. moduWeb
The following test has been done with moduWeb firmware version 2.8.0.
Define the recipient e-mail address in the moduWeb user settings
Set the SMS EAGLE ip-address as smtp server address in the moduWeb Notification Setting
> “Server Settings”
Send a test e-mail via the moduWeb website
Ph. Huwyler, 15.01.2017, v.1.3 12/26
Verify the outgoing mail to sms notification in the SMS EAGLE Outbox (or Sent Items)
Ph. Huwyler, 15.01.2017, v.1.3 13/26
6. moduWebVision
The following test has been done with the moduWeb Vision firmware version 1.7.0b196.
moduWeb Vision in opposition to moduWeb does verify the e-mail address format and does
not accept an ip-address as Fully Qualified Domain Name (FQDN). It is also possible to use
FQDN in an email address sent to SMS Eagle box (eg.: [email protected]gle). To do this
please read the chapter “How to use SMS EAGLE with FQDN”.
To avoid using a FQDN, we will use the SMS functionality of moduWeb Vision.
Set the smtp server settings for moduWeb Vision (SMTP server ip = ip address from the SMS
EAGLE device)
Ph. Huwyler, 15.01.2017, v.1.3 14/26
Define the default SMS Format in the Alarm settings. Here we will use a placeholder as
mobile phone and the ip address of the SMS EAGLE device as FQDN.
Configure the mobile phone number of the moduWeb Vision users you want to send SMS to
and send a test SMS (e-mail).
Verify the outgoing mail to sms notification in the SMS EAGLE Outbox (or Sent Items)
Ph. Huwyler, 15.01.2017, v.1.3 15/26
Manage notification rules
7. SAUTER Vision Center
The following test has been done with SVC software version 4.0
Define the recipient e-mail address in the SVC user settings.
Define smtp settings: SMTP address is the ip address of the SMS EAGLE device.
Check the smtp server connection
Ph. Huwyler, 15.01.2017, v.1.3 16/26
The test mail should be listed in the SMS EAGLE outbox (or sent items)
Test from filter rules
The test mail should be listed in the SMS EAGLE outbox (or sent items)
Ph. Huwyler, 15.01.2017, v.1.3 17/26
8. SAUTER novaPro Open with AAM
The following test has been done with nPO software version 3.1
Define the recipient e-mail address in the nPO user settings.
Define smtp settings: SMTP address is the ip address of the SMS EAGLE device.
Ph. Huwyler, 15.01.2017, v.1.3 18/26
Send a Test-alarm and check in the SMS EAGLE sent item
Ph. Huwyler, 15.01.2017, v.1.3 19/26
NETWORK MONITOR
SMS Eagle give you a tool for monitoring your services or servers. Just define what and when
should be monitored. SMS Eagle will send a SMS alerts when a services/servers go down.
9. Define what you want to monitor
choose a name for the task
enter a host (IP address or Hostname)
choose ICMP (ping) to monitor a server with
ICMP protocol
…or PORT to monitor your service on a selected
port (SMS Eagle will check if port is open)
increase the default timeout value for busy
servers (by default we set it to 30 seconds)
10. Define a schedule
choose if task should be always enabled…
…or disable it in chosen times
(during a night, when a machine goes through
planned restarts, during resource intensive
backups, etc.)
enter a phone number or choose a group
of users to send your SMS alert to
select when to send SMS alert (when
host/service goes down, when host/service
goes up after failure)
11. Control a status of your tasks
see a settings’ overview for all of your tasks
check which server/service is currently
unavailable
see when a specific server/service was last
down (last downtime)
check what happened at last downtime
(see server/service response)
edit/delete your tasks
disable tasks when needed (eg. when
doing a machine upgrades)
Ph. Huwyler, 15.01.2017, v.1.3 20/26
12. Define a SMS alert message
Define your SMS messages when host or service
becomes unavailable/comes back to life. Choose
field placeholders for your SMS text:
{TASKNAME} puts a taskname inside
SMS text
{HOST} hostname or IP address
{RESPONSE} message received (in case
of no response from server/service)
{TIMESTAMP} timestamp of an error
SMS EAGLE Database
SMS EAGLE has a built-in PostgreSQL database server. To connect the database server you
can use e.g. the pgAdmin Software (https://www.pgadmin.org/).
SMS Eagle’s database operates on PostgreSQL database engine. It is possible to connect to
the database from external application using the following credentials: POSTGRESQL
DATABASE CREDENTIALS
Host: IP address of your SMS Eagle
Database name: SMS Eagle
User: postgres
Password: postgreeagle
/