# 26 SMS Receiver



# 26.1 Introduction

SMS receiver is a service responsible for command execution that were received via text message. The service is available on WCC Lite with modem. To use this service a working SIM card is also required. This chapter will describe command types, configuration for WCC Lite as well as an example of said configuration.

# 26.2 SMS Receiver

There are two types of command signals used in SMS Receiver:

1. System: 
    - reboot wcc/reboot modem – when sending a message with text *reboot, the* device starts rebooting and after a successful reload sends back a message to the sender with text REBOOT OK.
    - switch sim – after sending a message with text *switch-sim, the* device should switch sim and send an SMS from the new sim card with the interface name and IP address.
    - show ip – the sender can request the IP address of the receiving device.
2. Signal: 
    - publish – executes *publish* to a certain tag after sending a text message, which will be indicated in the configuration field tag\_job\_todo. For example, if tag\_job\_todo is led=%f, after sending a text message *led=1*, a publish will happen to a tag that's linked with this signal.

##### Configuration

Devices sheet:

<table border="1" id="bkmrk-parameter-type-descr" style="border-collapse: collapse; width: 100%; height: 312.162px;"><tbody><tr style="height: 50.075px;"><td rowspan="2" style="width: 12.2343%; height: 80.1625px;">**Parameter**  
  
</td><td rowspan="2" style="width: 9.51557%; height: 80.1625px;">**Type**  
  
</td><td rowspan="2" style="width: 30.4004%; height: 80.1625px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 11.9871%; height: 80.1625px;">**Required**  
  
</td><td class="align-center" rowspan="2" style="width: 14.2116%; height: 80.1625px;">**Default Value**

(when not specified)

</td><td class="align-center" colspan="2" style="width: 21.5027%; height: 50.075px;">**Range**  
  
</td></tr><tr style="height: 30.0875px;"><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Min</td><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Max</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">name</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%; height: 46.4px;">User-friendly name for a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">description</td><td style="width: 9.51557%; height: 46.4px;">sting</td><td style="width: 30.4004%; height: 46.4px;">Description of a device</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">device\_alias</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%; height: 46.4px;">Alphanumeric string to identify a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">enable</td><td style="width: 9.51557%; height: 46.4px;">boolean</td><td style="width: 30.4004%; height: 46.4px;">Enabling/disabling of a device</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">1</td><td style="width: 10.7514%; height: 46.4px;">0</td><td style="width: 10.7514%; height: 46.4px;">1</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">protocol</td><td style="width: 9.51557%; height: 46.4px;">string</td><td style="width: 30.4004%;">Protocol to be used

</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td colspan="2" style="width: 21.574%; height: 49.5938px;">sms receiver</td></tr><tr><td style="width: 12.2343%;">host</td><td style="width: 9.51557%;">string</td><td style="width: 30.4004%;">Telephone number from which to receive SMS

</td><td style="width: 11.9871%;">Yes</td><td style="width: 14.2116%;">  
</td><td colspan="2">\[all, +37061111111\] (case-sensitive, separated by command or space)</td></tr></tbody></table>

When the host is set to all, only the job\_todo=signal type is allowed.

Signals sheet:

<table border="1" id="bkmrk-parameter-type-descr-0" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; width: 100%; height: 312.162px;"><tbody><tr style="height: 50.075px;"><td rowspan="2" style="width: 12.2343%; height: 80.1625px;">**Parameter**  
  
</td><td rowspan="2" style="width: 9.88631%; height: 80.1625px;">**Type**  
  
</td><td rowspan="2" style="width: 30.0297%; height: 80.1625px;">**Description**  
  
</td><td class="align-center" rowspan="2" style="width: 11.9871%; height: 80.1625px;">**Required**  
  
</td><td class="align-center" rowspan="2" style="width: 14.2116%; height: 80.1625px;">**Default Value**

(when not specified)

</td><td class="align-center" colspan="2" style="width: 21.5027%; height: 50.075px;">**Range**  
  
</td></tr><tr style="height: 30.0875px;"><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Min</td><td class="align-center" style="width: 10.7514%; height: 30.0875px;">Max</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">signal\_name</td><td style="width: 9.88631%; height: 46.4px;">string</td><td style="width: 30.0297%; height: 46.4px;">User-friendly signal name</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">device\_alias</td><td style="width: 9.88631%; height: 46.4px;">string </td><td style="width: 30.0297%; height: 46.4px;">Alphanumeric string to identify a device</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">signal\_alias</td><td style="width: 9.88631%; height: 46.4px;">string</td><td style="width: 30.0297%; height: 46.4px;">Unique alphanumeric name of the signal to be Yes used</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td><td style="width: 10.7514%; height: 46.4px;">  
</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">enable</td><td style="width: 9.88631%; height: 46.4px;">boolean</td><td style="width: 30.0297%; height: 46.4px;">Enabling/disabling of an individual signal</td><td style="width: 11.9871%; height: 46.4px;">No</td><td style="width: 14.2116%; height: 46.4px;">1</td><td style="width: 10.7514%; height: 46.4px;">0</td><td style="width: 10.7514%; height: 46.4px;">1</td></tr><tr style="height: 46.4px;"><td style="width: 12.2343%; height: 46.4px;">job\_todo</td><td data-colwidth="320" style="width: 9.88631%;">string

</td><td style="width: 30.0297%;">Choose command type</td><td style="width: 11.9871%; height: 46.4px;">Yes</td><td style="width: 14.2116%; height: 46.4px;">  
</td><td colspan="2" style="width: 21.5027%; height: 49.5938px;">\[SIGNAL, SYSTEM\]

(case-insensitive)

</td></tr><tr><td style="width: 12.2343%;">tag\_job\_todo</td><td style="width: 9.88631%;">string</td><td style="width: 30.0297%;">which command to execute

(if signal, then configure the SMS)

</td><td style="width: 11.9871%;">  
</td><td style="width: 14.2116%;">  
</td><td colspan="2" style="width: 21.5027%;">\[REBOOT WCC, REBOOT MODEM, SWITCH SIM, SHOW IP, &lt;CUSTOM&gt;%F\] (case-insensitive)</td></tr></tbody></table>

When configuring the publish signal, the command that will be received needs to be specified. Instead of %f a number will be sent to the receiver as a text message. For example, if the configuration specifies that tag\_job\_todo is led=%f, then after sending a message to a device led=50, the signal will publish a number 50 to an indicated tag.

##### Configuration example

The following example will show how to create a configuration for WCC Lite which would allow rebooting a device or modem, changing the active SIM card, showing the IP address, and turning on the red status LED, using SMS receiver and internal data. For this 2 working SIM cards and WCC Lite with modem will be needed.

The devices sheet should look like this:

[![image-1686311153046.png](https://wiki.elseta.com/uploads/images/gallery/2023-06/scaled-1680-/image-1686311153046.png)](https://wiki.elseta.com/uploads/images/gallery/2023-06/image-1686311153046.png)

For the device *SMS receiver admin* host should be changed to a phone number from which commands will be received, because for this device signals will be system type. For the device SMS receiver host can be either all or the same phone number.

Signals sheet:

[![image-1686050114765.png](https://wiki.elseta.com/uploads/images/gallery/2023-06/scaled-1680-/image-1686050114765.png)](https://wiki.elseta.com/uploads/images/gallery/2023-06/image-1686050114765.png)

Signal LED red fault is linked with signal sms-led as a source. This means that after sending an SMS message to a device with text led=1, red status led will turn on. The rest of the signals are system type so after sending an SMS message a certain event will happen. For example, after sending a message with the text reboot-wcc, the device should start rebooting and after the process is done it will send back a message "REBOOT WCCLITE OK". The same thing would happen after rebooting the modem. With system signals it is also possible to switch between SIM cards or request IP address via text message.

Configuration --&gt; [Download](https://wiki.elseta.com/attachments/106)

<p class="callout info">Note: SMS Receiver can only accept messages that contain less than 160 characters.</p>