Custom Scenarios: Difference between revisions

From Teltonika Telematics Wiki
No edit summary
No edit summary
Line 1: Line 1:
==Introduction to Custom Scenarios functionality==
==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.
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 generate 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.
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.
Line 8: Line 8:
==Custom Scenarios functionality logic==
==Custom Scenarios functionality logic==
[[File:Custom Scenarios Topology.png|right|thumb|800px|Figure 1. “Custom Scenarios” functionality logic]]
[[File:Custom Scenarios Topology.png|right|thumb|800px|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.
The Custom Scenarios functionality enables configuration of up to three independent scenarios, each with up to three unique triggers. Triggers are defined using data as source 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 source 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.
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.
Line 38: Line 38:
! Custom Scenario 1 ID !! Custom Scenario 2 ID !! Custom Scenario 3 ID !! style="width:6%;" | Min !! style="width:6%;" | Max
! Custom Scenario 1 ID !! Custom Scenario 2 ID !! Custom Scenario 3 ID !! style="width:6%;" | Min !! style="width:6%;" | Max
|-
|-
| rowspan="4" | Priority || rowspan="4" | 19101 || rowspan="4" | 19131 || rowspan="4" | 19161 || rowspan="4" | 0 || rowspan="4" | 3 || rowspan="4" | 0 || 0 || None || style="text-align:left;" | No priority is set for the scenario. Eventual records are not generated.
| rowspan="4" | Priority || rowspan="4" | 19101 || rowspan="4" | 19131 || rowspan="4" | 19161 || rowspan="4" | 0 || rowspan="4" | 3 || rowspan="4" | 0 || 0 || None || style="text-align:left;" | No priority is set for the scenario, eventual records will not be generated.
|-
|-
| 1 || Low || style="text-align:left;" | Low priority is set for the scenario.
| 1 || Low || style="text-align:left;" | Low priority is set for the scenario.
Line 54: Line 54:
| 3 || DOUT3 || style="text-align:left;" | Specifies that DOUT3 is controlled by the scenario.
| 3 || DOUT3 || style="text-align:left;" | Specifies that DOUT3 is controlled by the scenario.
|-
|-
| rowspan="2" | Permanent Output Control || rowspan="2" | 19124 || rowspan="2" | 19154 || rowspan="2" | 19184 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 0 || 0 || Disabled || style="text-align:left;" | Continuous DOUT control is disabled.
| rowspan="2" | Permanent Output Control || rowspan="2" | 19124 || rowspan="2" | 19154 || rowspan="2" | 19184 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 0 || 0 || Disabled || style="text-align:left;" | DOUT will be controlled continously on and off according to DOUT ON Duration and DOUT OFF Duration parameters.
|-
|-
| 1 || Enabled || style="text-align:left;" | Continuous DOUT control is enabled as long as conditions are met.
| 1 || Enabled || style="text-align:left;" | DOUT will be constantly ON while scenario is active.
|-
|-
| DOUT ON Duration || 19102 || 19132 || 19162 || 100 || 65000000 || 200 || - || milliseconds || style="text-align:left;" | Duration for which DOUT remains ON when the scenario is active.
| DOUT ON Duration || 19102 || 19132 || 19162 || 100 || 65000000 || 200 || - || milliseconds || style="text-align:left;" | Duration for which DOUT remainsturned ON
|-
|-
| DOUT OFF Duration || 19103 || 19133 || 19163 || 0 || 65000000 || 200 || - || milliseconds || style="text-align:left;" | Duration for which DOUT remains OFF. A value of 0 means the DOUT stays ON continuously.
| DOUT OFF Duration || 19103 || 19133 || 19163 || 0 || 65000000 || 200 || - || milliseconds || style="text-align:left;" | Duration for which DOUT remains OFF. If Permanent Output Control and DOUT OFF Duration values are set to 0, DOUT will be turned on for the period configured in DOUT ON Duration parameter.
|-
|-
| Trigger #1 || 19105 || 19135 || 19165 || Min IO ID || Max IO ID || Device-specific || - || - || style="text-align:left;" | Primary trigger for the scenario. This trigger cannot be ignored.
| Source #1 || 19105 || 19135 || 19165 || Min IO ID || Max IO ID || Device-specific || - || AVL ID || style="text-align:left;" | Data source for primary trigger for the scenario. This trigger can not be ignored.
|-
|-
| Trigger #2 || 19110 || 19140 || 19170 || Min IO ID || Max IO ID || Device-specific || - || - || style="text-align:left;" | Secondary trigger for the scenario. This trigger can be ignored.
| Source #2 || 19110 || 19140 || 19170 || Min IO ID || Max IO ID || Device-specific || - || AVL ID || style="text-align:left;" | Data source for secondary trigger for the scenario. This trigger can be ignored.
|-
|-
| Trigger #3 || 19116 || 19146 || 19176 || Min IO ID || Max IO ID || Device-specific || - || - || style="text-align:left;" | Tertiary trigger for the scenario. This trigger can be ignored.
| Source #3 || 19116 || 19146 || 19176 || Min IO ID || Max IO ID || Device-specific || - || AVL ID || style="text-align:left;" | Data source for Tertiary trigger for the scenario. This trigger can be ignored.
|-
|-
| rowspan="7" | Operand || rowspan="7" | 19106 || rowspan="7" | 19136 || rowspan="7" | 19166 || rowspan="7" | 0 || rowspan="7" | 6 || rowspan="7" | 0 || 0 || On Exit || style="text-align:left;" | Trigger activates on exit of the defined condition.
| rowspan="7" | Operand || rowspan="7" | 19106 || rowspan="7" | 19136 || rowspan="7" | 19166 || rowspan="7" | 0 || rowspan="7" | 6 || rowspan="7" | 0 || 0 || On Exit || style="text-align:left;" | Trigger activates on exit of the defined condition.
Line 86: Line 86:
| High Level || 19108 || 19138 || 19168 || Dynamic || Dynamic || 0 || - || - || style="text-align:left;" | Sets the upper threshold value for the trigger.
| High Level || 19108 || 19138 || 19168 || Dynamic || Dynamic || 0 || - || - || style="text-align:left;" | Sets the upper threshold value for the trigger.
|-
|-
| Activation Delay Timer || 19109 || 19139 || 19169 || 0 || 65535 || 0 || - || seconds || style="text-align:left;" | Time (in seconds) the condition must remain true for activation.
| Activation Delay Timer || 19109 || 19139 || 19169 || 0 || 65535 || 0 || - || seconds || style="text-align:left;" | Time the trigger must remain true for activation of the scenario.
|-
|-
| rowspan="2" | Ignore || rowspan="2" | 19114 || rowspan="2" | 19144 || rowspan="2" | 19174 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 1 || 0 || No || style="text-align:left;" | The trigger will not be ignored and is actively checked.
| rowspan="2" | Ignore || rowspan="2" | 19114 || rowspan="2" | 19144 || rowspan="2" | 19174 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 1 || 0 || No || style="text-align:left;" | The trigger will not be ignored and is actively checked.
Line 92: Line 92:
| 1 || Yes || style="text-align:left;" | The trigger will be ignored and will not affect scenario activation.
| 1 || Yes || style="text-align:left;" | The trigger will be ignored and will not affect scenario activation.
|-
|-
| rowspan="2" | Logic || rowspan="2" | 19115 || rowspan="2" | 19145 || rowspan="2" | 19175 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 1 || 0 || OR || style="text-align:left;" | Trigger evaluation logic: any trigger activates the scenario.
| rowspan="2" | Logic || rowspan="2" | 19115 || rowspan="2" | 19145 || rowspan="2" | 19175 || rowspan="2" | 0 || rowspan="2" | 1 || rowspan="2" | 1 || 0 || OR || style="text-align:left;" | Trigger evaluation logic: any enabled trigger activates the scenario.
|-
|-
| 1 || AND || style="text-align:left;" | Trigger evaluation logic: all triggers must be true to activate the scenario.
| 1 || AND || style="text-align:left;" | Trigger evaluation logic: all enabled triggers must be true to activate the scenario.
|}
|}




=== Configuration Process ===
=== Configuration Process ===


1. **Define Output Control**:
  - Assign the DOUT (DOUT1, DOUT2, or DOUT3) to be controlled by the scenario.
2. **Configure Triggers**:
  - Select up to three I/O sources (e.g., ignition, fuel level, temperature).
  - Define operands to specify logic (e.g., "On Entrance," "Is").
  - Set Low and High threshold values for each source.
  - Adjust the Activation Delay Timer for precise control.
3. **Set Priority**:
  - Choose the priority level for the scenario. Higher-priority scenarios override lower-priority ones for the same DOUT.
4. **Adjust DOUT Control Settings**:
  - Configure DOUT ON/OFF durations or enable Permanent Output Control for continuous activation.


5. **Save Configuration**:
  - Verify all parameters and save the configuration. The device evaluates scenario conditions every second.


=== Example Use Cases ===
=== Example Use Cases ===

Revision as of 16:51, 19 November 2024

Feature preview versions > Custom Scenarios

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 generate 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 as source 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 source 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 and parameters

Below is an UI example of configurable parameters:

Figure 1. “Custom Scenarios” functionality UI

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

Parameter Name Parameter ID Value Range Default Value Value Value Definition Description
Custom Scenario 1 ID Custom Scenario 2 ID Custom Scenario 3 ID Min Max
Priority 19101 19131 19161 0 3 0 0 None No priority is set for the scenario, eventual records will not be generated.
1 Low Low priority is set for the scenario.
2 High High priority is set for the scenario.
3 Panic Panic priority is set for the scenario.
Output Control 19100 19130 19160 0 3 0 0 None Specifies that no DOUT is controlled by the scenario.
1 DOUT1 Specifies that DOUT1 is controlled by the scenario.
2 DOUT2 Specifies that DOUT2 is controlled by the scenario.
3 DOUT3 Specifies that DOUT3 is controlled by the scenario.
Permanent Output Control 19124 19154 19184 0 1 0 0 Disabled DOUT will be controlled continously on and off according to DOUT ON Duration and DOUT OFF Duration parameters.
1 Enabled DOUT will be constantly ON while scenario is active.
DOUT ON Duration 19102 19132 19162 100 65000000 200 - milliseconds Duration for which DOUT remainsturned ON
DOUT OFF Duration 19103 19133 19163 0 65000000 200 - milliseconds Duration for which DOUT remains OFF. If Permanent Output Control and DOUT OFF Duration values are set to 0, DOUT will be turned on for the period configured in DOUT ON Duration parameter.
Source #1 19105 19135 19165 Min IO ID Max IO ID Device-specific - AVL ID Data source for primary trigger for the scenario. This trigger can not be ignored.
Source #2 19110 19140 19170 Min IO ID Max IO ID Device-specific - AVL ID Data source for secondary trigger for the scenario. This trigger can be ignored.
Source #3 19116 19146 19176 Min IO ID Max IO ID Device-specific - AVL ID Data source for Tertiary trigger for the scenario. This trigger can be ignored.
Operand 19106 19136 19166 0 6 0 0 On Exit Trigger activates on exit of the defined condition.
1 On Entrance Trigger activates on entrance of the defined condition.
2 On Both Trigger activates on both entrance and exit of the condition.
3 On Hysteresis Trigger activates on hysteresis of the condition.
4 On Change Trigger activates on any change in the condition.
5 On Delta Change Trigger activates on a specified delta change.
6 Is Trigger activates if the condition is true.
Low Level 19107 19137 19167 Dynamic Dynamic 0 - - Sets the lower threshold value for the trigger.
High Level 19108 19138 19168 Dynamic Dynamic 0 - - Sets the upper threshold value for the trigger.
Activation Delay Timer 19109 19139 19169 0 65535 0 - seconds Time the trigger must remain true for activation of the scenario.
Ignore 19114 19144 19174 0 1 1 0 No The trigger will not be ignored and is actively checked.
1 Yes The trigger will be ignored and will not affect scenario activation.
Logic 19115 19145 19175 0 1 1 0 OR Trigger evaluation logic: any enabled trigger activates the scenario.
1 AND Trigger evaluation logic: all enabled triggers must be true to activate the scenario.


Configuration Process

Example Use Cases

- **Scenario 1**: Control a relay when fuel level drops below 10%. - **Scenario 2**: Trigger a buzzer if RPM exceeds 3000 while ignition is ON. - **Scenario 3**: Activate an alarm when GSM signal strength drops below 20%.