Difference between revisions of "Custom Scenarios"

From Wiki Knowledge Base | Teltonika GPS
Line 22: Line 22:
 
==Custom Scenarios functionality configuration==
 
==Custom Scenarios functionality configuration==
  
The **Custom Scenarios** functionality allows users to configure up to three independent scenarios, each comprising up to three triggers. These triggers utilize data from I/O elements, enabling flexible and autonomous control over the device’s digital outputs (DOUT).  
+
Below is a detailed explanation of configurable parameters for each scenario.
  
=== Configurable Parameters ===
+
{| class="wikitable" style="text-align:left; width:100%;"
Each scenario can be configured using the following parameters:
+
! Parameter Name !! Parameter ID !! Value Range !! Default !! Description
 
+
|-
* **Output Control**:
+
| Output Control || 19100, 19130, 19160 || 0–3 || 0 || Determines the DOUT controlled by the scenario:
  - Specifies which DOUT (DOUT1, DOUT2, or DOUT3) the scenario controls.
+
* 0 – None
  - Options:  
+
* 1 – DOUT1
    * 0 – None
+
* 2 – DOUT2
    * 1 – DOUT1
+
* 3 – DOUT3
    * 2 – DOUT2
+
|-
    * 3 – DOUT3
+
| Priority || 19101, 19131, 19161 || 0–3 || 0 || Sets the priority of the scenario:
 
+
* 0 – None
* **Priority**:
+
* 1 – Low
  - Determines the scenario's priority when multiple scenarios control the same DOUT.
+
* 2 – High
  - Options:
+
* 3 – Panic
    * 0 – None
+
|-
    * 1 – Low
+
| Permanent Output Control || 19124, 19154, 19184 || 0–1 || 0 || Enables or disables continuous DOUT control while the scenario conditions are met.
    * 2 – High
+
|-
    * 3 – Panic
+
| DOUT ON Duration || 19102, 19132, 19162 || 100–65,000,000 ms || 200 ms || Specifies the ON duration for the DOUT.
 
+
|-
* **Trigger Sources (#1, #2, #3)**:
+
| DOUT OFF Duration || 19103, 19133, 19163 || 0–65,000,000 ms || 200 ms || Specifies the OFF duration for the DOUT. If set to 0, the DOUT remains ON continuously.
  - Define the I/O sources to be monitored. Examples include ignition status, fuel level, RPM, or temperature readings.
+
|-
  - Source #1 is mandatory and cannot be disabled, while #2 and #3 can be ignored if unnecessary.
+
| Source #1, #2, #3 || 19105–19119, 19135–19149, 19165–19179 || IO element IDs || N/A || Defines the I/O source monitored for the trigger.
 
 
* **Operand**:
 
  - Defines the logic for evaluating source values.
 
  - Options:
 
    * 0 – On Exit
 
    * 1 – On Entrance
 
    * 2 – On Both
 
    * 3 – On Hysteresis
 
    * 4 – On Change
 
    * 5 – On Delta Change
 
    * 6 – Is (value within range)
 
 
 
* **Threshold Levels**:
 
  - **Low Level**: Minimum value for trigger activation.
 
  - **High Level**: Maximum value for trigger activation.
 
 
 
* **Activation Delay Timer**:
 
  - Specifies the time (in seconds) that a condition must remain true for the trigger to activate.
 
  - Range: 0 to 65,535 seconds.
 
 
 
* **Logic**:
 
  - Defines whether all or any triggers must be true for the scenario to activate.
 
  - Options:
 
    * 0 – OR (any trigger activates the scenario)
 
    * 1 – AND (all triggers must be true to activate the scenario)
 
 
 
=== Scenario Activation Logic ===
 
1. All configured triggers are evaluated every second.
 
2. If all conditions for a scenario are met:
 
  - The scenario activates.
 
  - A record is generated (if enabled).
 
  - The configured DOUT toggles ON or OFF based on the scenario's state.
 
3. Scenarios operate in deep-sleep mode if compatible I/O sources are used.
 
 
 
=== DOUT Control Options ===
 
* **Permanent Output Control**:
 
  - When enabled, DOUT remains ON as long as conditions are met.
 
* **ON/OFF Durations**:
 
  - If OFF duration > 0, DOUT blinks while the scenario is active.
 
  - If OFF duration = 0, DOUT stays ON continuously until the scenario deactivates.
 
 
 
=== Priority Management ===
 
Custom Scenarios follow a priority hierarchy:
 
* Scenario 1 has the highest priority.
 
* Scenario 3 has the lowest priority.
 
* If multiple scenarios control the same DOUT, the higher-priority scenario takes precedence.
 
 
 
For detailed examples and configuration steps, refer to the [[Configurator Page]].
 
 
 
---
 
 
 
This Wiki section ensures clear formatting, structured details, and alignment with the document content​:contentReference[oaicite:0]{index=0}.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
In case the vehicle has a variable voltage alternator, also known as a smart alternator, an alternative configuration is advised -- taking into account movement detection by accelerometer, in order to monitor the ignition status of the vehicle.
 
[[File:Ignitionaccel.PNG|left|thumb|600px|Figure 3. “Smart Ignition” recommended configuration for vehicles with smart alternators]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
'''<big>Parameter list</big>'''
 
{| class="wikitable"
 
|+
 
! rowspan="2" style="width: 150px; background: #003475; color: white;" |'''Parameter ID'''
 
! rowspan="2" style="width: 150px; background: #003475; color: white;" |'''Name'''
 
! colspan="3" style="width: 150px; background: #003475; color: white;" |'''Value range'''
 
! rowspan="2" style="width: 250px; background: #003475; color: white;" |'''Description'''
 
 
|-
 
|-
! style="width: 75px; background: #003475; color: white;" |Min
+
| Operand || 19106–19117, 19136–19147, 19166–19177 || 0–6 || 0 || Defines the logic applied to the source:
! style="width: 75px; background: #003475; color: white;" |Max
+
* 0 – On Exit
! style="width: 75px; background: #003475; color: white;" |Default
+
* 1 – On Entrance
 +
* 2 – On Both
 +
* 3 – On Hysteresis
 +
* 4 – On Change
 +
* 5 – On Delta Change
 +
* 6 – Is
 
|-
 
|-
!style="text-align: center; vertical-align: center;" |66201
+
| Low Level || 19107, 19137, 19167 || Varies || 0 || Sets the lower threshold for the source trigger.
|style="text-align: center; vertical-align: center;" |Smart Ignition
 
|style="text-align: center; vertical-align: center;" |0
 
|style="text-align: center; vertical-align: center;" |1
 
|style="text-align: center; vertical-align: center;" |1
 
|style="text-align: center;" |0 - Disabled; <br> 1 - Enabled
 
 
|-
 
|-
!style="text-align: center; vertical-align: center;" |66202
+
| High Level || 19108, 19138, 19168 || Varies || 0 || Sets the upper threshold for the source trigger.
|style="text-align: center; vertical-align: center;" |Smart Ignition Delta, mV
 
|style="text-align: center; vertical-align: center;" |100
 
|style="text-align: center; vertical-align: center;" |2000
 
|style="text-align: center; vertical-align: center;" |600
 
|style="text-align: center;" |How much external voltage must change, in miliVolts to detect ignition ON or OFF event.
 
 
|-
 
|-
!style="text-align: center; vertical-align: center;" |66203
+
| Activation Delay Timer || 19109, 19139, 19169 || 0–65,535 s || 0 || Time in seconds the condition must remain true to activate the trigger.
|style="text-align: center; vertical-align: center;" |Smart Ignition Duration, s
 
|style="text-align: center; vertical-align: center;" |2
 
|style="text-align: center; vertical-align: center;" |20
 
|style="text-align: center; vertical-align: center;" |3
 
|style="text-align: center;" |Time interval, in seconds, used for comparing current external voltage against historical external voltage configured seconds ago.
 
 
|-
 
|-
 +
| Logic || 19115, 19145, 19175 || 0–1 || 1 || Determines trigger evaluation logic:
 +
* 0 – OR (any trigger activates the scenario)
 +
* 1 – AND (all triggers must be true to activate the scenario)
 
|}
 
|}
  
 +
=== Configuration Process ===
 +
1. **Define Output Control**:
 +
  - Choose the DOUT (DOUT1, DOUT2, or DOUT3) to control when the scenario is active.
 +
 
 +
2. **Set Triggers**:
 +
  - Configure up to three sources (e.g., ignition, fuel level, RPM).
 +
  - Specify operands for each source to define the evaluation logic (e.g., "On Entrance," "Is").
 +
  - Adjust low and high threshold levels and set the activation delay timer.
 +
 +
3. **Set Priority**:
 +
  - Assign a priority level to ensure higher-priority scenarios override lower-priority ones when controlling the same DOUT.
 +
 +
4. **Configure DOUT Timing**:
 +
  - Define ON and OFF durations for DOUT blinking or continuous operation.
 +
  - Enable Permanent Output Control if the DOUT should remain ON as long as the scenario is active.
 +
 +
5. **Save and Apply**:
 +
  - Verify all parameters and save the configuration. Scenarios are checked every second for activation.
  
 +
=== Logic and Operations ===
 +
- Each scenario operates independently but checks its triggers every second.
 +
- A scenario activates if its conditions are met, generating a record (if enabled) and toggling the configured DOUT.
 +
- Scenarios are compatible with low-power and deep-sleep modes, provided the sources used support these states.
  
==Firmware and hardware compatibility==
+
=== Examples of Use ===
Smart ignition detection functionality is available for FMT100/FMX880 devices on the firmware 03.29.00.rev.980. You can download the firmware and configurator here. [[File:Download_zip.png|x30px|link=Special:Redirect/file/FMB.Ver.03.29.00.rev.980 and configurator.zip]]
+
- **Scenario 1**: Control a relay based on fuel level dropping below a specific threshold.
 +
- **Scenario 2**: Trigger an alarm when RPM exceeds a set limit and the ignition is on.
 +
- **Scenario 3**: Enable a buzzer if temperature values from a Bluetooth sensor go out of range.

Revision as of 16:37, 18 November 2024

Introduction to Custom Scenarios functionality

To meet the diverse and evolving needs of our clients, we have developed the Custom Scenarios feature. This solution allows users to define specific conditions using customizable parameters to trigger events or control a device’s digital outputs. By connecting the device to peripherals like alarms, buzzers, or relays, this functionality can notify drivers or perform targeted actions seamlessly.

The feature enables the device to operate autonomously based on predefined conditions, eliminating the need for constant monitoring of device status or complex backend integrations. With Custom Scenarios, any data the device can read becomes a potential input for controlling digital outputs, providing flexibility and efficiency.


Custom Scenarios functionality logic

Figure 1. “Custom Scenarios” functionality logic

The Custom Scenarios functionality enables configuration of up to three independent scenarios, each with up to three unique triggers. Triggers are defined using data from various I/O elements, such as: Fuel Level, Engine RPM, Seatbelt Status, DTC Faults, Movement Status, Ignition State, GSM Signal Level, 1-Wire/Bluetooth sensor temperature and etc. Each trigger is configured with specific logic operands (e.g., "On Entrance," "On Exit"), threshold values (Low and High levels), and an activation delay timer, which specifies how long a value must remain within the defined range before the trigger is activated.

When all triggers of a scenario evaluate as true, the scenario becomes active. This can generate a record (if configured) and control the digital output (DOUT) by toggling it on or off based on the active conditions. Additionally, if configured for continuous operation, the DOUT remains active as long as the conditions are met.

Key features include:

  • Support for dynamic trigger logic based on selected operands and conditions.
  • Autonomous device operation, even in low-power or deep-sleep modes, provided compatible I/O sources are used.
  • Adjustable ON/OFF durations or permanent output control, enabling versatile device behaviors such as blinking or continuous activation.
  • Custom Scenarios operate independently from the I/O menu, with priority management ensuring that higher-priority scenarios take precedence in controlling the DOUT when multiple scenarios are configured.


Custom Scenarios functionality configuration

Below is a detailed explanation of configurable parameters for each scenario.

Parameter Name Parameter ID Value Range Default Description
Output Control 19100, 19130, 19160 0–3 0 Determines the DOUT controlled by the scenario:
  • 0 – None
  • 1 – DOUT1
  • 2 – DOUT2
  • 3 – DOUT3
Priority 19101, 19131, 19161 0–3 0 Sets the priority of the scenario:
  • 0 – None
  • 1 – Low
  • 2 – High
  • 3 – Panic
Permanent Output Control 19124, 19154, 19184 0–1 0 Enables or disables continuous DOUT control while the scenario conditions are met.
DOUT ON Duration 19102, 19132, 19162 100–65,000,000 ms 200 ms Specifies the ON duration for the DOUT.
DOUT OFF Duration 19103, 19133, 19163 0–65,000,000 ms 200 ms Specifies the OFF duration for the DOUT. If set to 0, the DOUT remains ON continuously.
Source #1, #2, #3 19105–19119, 19135–19149, 19165–19179 IO element IDs N/A Defines the I/O source monitored for the trigger.
Operand 19106–19117, 19136–19147, 19166–19177 0–6 0 Defines the logic applied to the source:
  • 0 – On Exit
  • 1 – On Entrance
  • 2 – On Both
  • 3 – On Hysteresis
  • 4 – On Change
  • 5 – On Delta Change
  • 6 – Is
Low Level 19107, 19137, 19167 Varies 0 Sets the lower threshold for the source trigger.
High Level 19108, 19138, 19168 Varies 0 Sets the upper threshold for the source trigger.
Activation Delay Timer 19109, 19139, 19169 0–65,535 s 0 Time in seconds the condition must remain true to activate the trigger.
Logic 19115, 19145, 19175 0–1 1 Determines trigger evaluation logic:
  • 0 – OR (any trigger activates the scenario)
  • 1 – AND (all triggers must be true to activate the scenario)

Configuration Process

1. **Define Output Control**:

  - Choose the DOUT (DOUT1, DOUT2, or DOUT3) to control when the scenario is active.
  

2. **Set Triggers**:

  - Configure up to three sources (e.g., ignition, fuel level, RPM).
  - Specify operands for each source to define the evaluation logic (e.g., "On Entrance," "Is").
  - Adjust low and high threshold levels and set the activation delay timer.

3. **Set Priority**:

  - Assign a priority level to ensure higher-priority scenarios override lower-priority ones when controlling the same DOUT.

4. **Configure DOUT Timing**:

  - Define ON and OFF durations for DOUT blinking or continuous operation.
  - Enable Permanent Output Control if the DOUT should remain ON as long as the scenario is active.

5. **Save and Apply**:

  - Verify all parameters and save the configuration. Scenarios are checked every second for activation.

Logic and Operations

- Each scenario operates independently but checks its triggers every second. - A scenario activates if its conditions are met, generating a record (if enabled) and toggling the configured DOUT. - Scenarios are compatible with low-power and deep-sleep modes, provided the sources used support these states.

Examples of Use

- **Scenario 1**: Control a relay based on fuel level dropping below a specific threshold. - **Scenario 2**: Trigger an alarm when RPM exceeds a set limit and the ignition is on. - **Scenario 3**: Enable a buzzer if temperature values from a Bluetooth sensor go out of range.