Usage
This page documents usage of the Ignition 8.1 build of the Teltonika module. For the current release, see the latest documentation.
Alarm Pipeline
Add a Notification Block that uses a Teltonika profile in your Alarm Pipeline.
Notification Block Property
The Teltonika profile exposes a single notification property:
| Property | Type | Description |
|---|---|---|
| Message | Expression | Content of the SMS to send. Evaluated as an Ignition expression against the alarm event(s). |
Message Templates
The Message property is an Ignition expression, so it can reference alarm event properties.
Default message:
At {eventTime|hh:mm:ss}, alarm "{name}" at "{displayPath}" transitioned to {eventState}.
Common tokens
| Token | Description |
|---|---|
{name} | Alarm name |
{displayPath} | Alarm display path |
{eventTime|hh:mm:ss} | Event timestamp with a format string |
{eventState} | Alarm event state |
{priority} | Alarm priority |
Available tokens are those provided by Ignition's alarm-event expression context (the same context used by other alarm notification profiles). The default template above is the one shipped with this build.
Examples
Simple notification:
ALARM: {name} is {eventState} at {eventTime|HH:mm}
Detailed notification:
[{priority}] {name} at {displayPath} - {eventState} - {eventTime|yyyy-MM-dd HH:mm:ss}
Per-alarm override
If an alarm defines a Custom Message in its Extended Config (see Configuration), that expression is used instead of the block's Message for that alarm.
Phone Number Handling
The module normalizes the recipient's stored SMS number by removing the first character and prepending 00:
| Stored value | Sent as |
|---|---|
+33612345678 | 0033612345678 |
+1234567890 | 001234567890 |
The first character is always stripped, regardless of what it is. Store numbers in international + format so the leading + is the character that gets removed. A number that does not start with + will have its first digit removed.
API Communication
All requests are plain HTTP to the Host (with the port embedded in Host if non-standard).
REST API flow
1. POST http://<Host>/api/login
Body: {"username":"...","password":"..."}
-> read token from data.token (cached ~5 min / 299s)
2. POST http://<Host>/api/messages/actions/send
Authorization: Bearer <token>
Body: { "data": { "number": "...", "message": "...", "modem": "..." } }
-> success read from the "success" field of the response
Legacy API flow
GET http://<Host>/cgi-bin/sms_send?username=<user>&password=<pass>&number=<num>&text=<msg>
Audit Logging
When an audit profile is configured on the profile, each notification attempt logs a record per alarm event:
- Action:
Teltonika Message - Actor: path of the Ignition user notified
- Target: alarm source path with the event ID
- Value:
SUCCESSorFAILURE - Timestamp
Troubleshooting
| Issue | Possible Cause | Solution |
|---|---|---|
| No SMS sent, warning about trial | Trial expired | Activate a license — see Licensing |
| Profile won't start | Modem empty in REST mode | Set the Modem Name field, or enable Legacy Mode |
| Authentication error (REST) | Wrong credentials or unsupported firmware | Verify Username/Password; try Legacy Mode |
| SMS not received | Bad number format | Ensure the SMS contact starts with + and full country code |
| SMS not received | No signal / SIM issue | Check signal and SIM status on the router itself |
| Cannot reach router | Wrong Host/port | Include the port in Host if not 80; verify HTTP connectivity |
Enable DEBUG logging on com.operametrix.ignition.teltonika.gateway.profile.TeltonikaNotificationProfile in the gateway logger to see request URLs, payloads, and router responses.