Difference between revisions of "Template:FMB I/O settings"

From Wiki Knowledge Base | Teltonika GPS
m
(36 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__TOC__
+
When no I/O element is enabled, AVL packet comes with GNSS information only. After enabling I/O element(s) AVL packet along with GNSS information contains current value(s) of enabled I/O elements.<br/>If the device is connected to configurator all current I/O values are displayed in ''Current value'' column.<br/>''Priority'' field allows enabling I/O element(s) and setting them a priority so they are added to the data packet, which issent to the server. By default 12 I/O elements with low priority are enabled: ''Ignition'', ''Movement'', ''Data Mode'', ''GSM Signal'', ''Sleep Mode'', ''GNSS Status'', ''GNSS PDOP'', ''GNSS HDOP'', ''External Voltage'', ''Speed'', ''Battery Voltage'' and ''Battery Current''. ''Priority'' level (AVL packet priority) can be Low, High or Panic. All records made by FMB120 are regular. Regular packets are sent as low priority records. When low priority event is triggered, FMB120 makes an additional record with indication that the reason for the event was an I/O element change (depends on ''Operand'' configuration). When high priority is selected, module makes additional record with high priority flag and sends event packet immediately to the server through GPRS. Panic priority triggers same actions as high priority, but if GPRS fails, it sends an AVL packet using SMS data if SMS data sending is enabled and the number is given in ''SMS/Call Settings''.<br/>''High'' and ''Low'' levels define I/O value range. If I/O value enters or exits this range, FMB120 generates an event. ''Operand'' parameter defines when to generate event: On Exit, On Entrance, On Both, On Hysteresis and On Delta Change.<br/>When ''Event Only'' is selected, I/O element status value will be appended only to eventual records, otherwise, I/O element status value will appear in each AVL record.
  
When no I/O element is enabled, AVL packet comes with GNSS information only. After enabling I/O element(s) AVL packet contains current value(s) of enabled I/O element(s) along with GNSS information.
 
==Input Name==
 
I/O element name.
 
==Current Value==
 
If device is connected to '''Configurator''' all current I/O values are displayed in this column. Also I/O current values can be seen in [[{{{model|FMB1YX}}}_Status_info#I.2FO_Info|Status→I/O Info]] tab.
 
==Units==
 
Units of measurement.
 
==Priority==
 
This field allows to enable I/O elements and setting them a priority so they are added to the data packet, which is sent to the server. By default '''{{{txt_count|12}}} I/O elements''' with '''Low priority''' are enabled: <code> {{{txt_elems| Ignition}}}, Movement, Data Mode, GSM Signal, Sleep Mode, GNSS Status, GNSS PDOP, GNSS HDOP, {{{txt_elems| External Voltage, Speed, Battery Current}}}, Battery Voltage</code>. All records made by {{{model|FMB1YX}}} are regular, and regular packets are sent as low priority records.<p>Priority level (AVL packet priority) can be:</p>
 
===None Priority===
 
Module doesn't make additional record.
 
===Low Priority===
 
Module makes an additional record with an indication that the '''event was caused by an I/O element change''' (depending on [[#Operands|Operands]] configuration).
 
===High Priority===
 
Module makes an additional record with High priority flag and '''sends event packet immediately''' to the server using '''GPRS'''.
 
===Panic Priority===
 
This priority triggers same actions as '''High priority''', but if GPRS fails, it sends an AVL packet using '''SMS data''' if SMS data sending is enabled and the number is provided in [[{{{model|FMB1YX}}}_SMS/Call_settings|SMS/Call Settings]].
 
==High and Low Level==
 
These levels define I/O value range. If I/O value '''enters or exits''' this range, {{{model|FMB1YX}}} '''generates an event'''.
 
==Event Only==
 
When this is selected, I/O element status value will be '''appended only to eventual records''', otherwise I/O element status value will appear in each AVL record.
 
 
==Operands==
 
==Operands==
Defines when to generate event: [[#Operand On Exit|On Exit]], [[#Operand On Entrance|On Entrance]], [[#Operand On Both|On Both]], [[#Operand Monitoring|Monitoring]], [[#Operand On Hysteresis|On Hysteresis]], [[#Operand On Change|On Change]] or [[#Operand On Delta Change|On Delta Change]].
+
 
 
===Operand On Exit===
 
===Operand On Exit===
Record is generated when input value leaves a range between low and high level limits.
+
Record is generated when actual value input increases and becomes higher than high level or decreases and become lower than low level.
[[Image:Fmb120_on_exit.png|x150px|none]]
+
[[Image:Fmb120_on_exit.png|x150px|center]]
 +
 
 
===Operand On Entrance===
 
===Operand On Entrance===
 
----
 
----
Record is generated when input value enters a range between low and high level limits.
+
Record is generated when actual value input increases or decreases and becomes between high and low level values.
[[Image:Fmb120_on_entrance.png|x150px|none]]
+
[[Image:Fmb120_on_entrance.png|x150px|center]]
 +
 
 
===Operand On Both===
 
===Operand On Both===
 
----
 
----
Record is generated by both ''On Exit'' and ''On Entrance'' operands' logic at same time.
+
Record is generated by both (On Exit and On Entrance) operands logic at same time.
[[Image:Fmb120_on_both.png|x150px|none]]
+
[[Image:Fmb120_on_both.png|x150px|center]]
 +
 
 
===Operand Monitoring===
 
===Operand Monitoring===
 
----
 
----
No event at all. Values are recorded only when other triggers worked.
+
No event at all. Values are recorded only when other trigger have worked.
[[Image:Fmb120_operand_monitoring.png|x150px|none]]
+
[[Image:Fmb120_operand_monitoring.png|x150px|center]]
 +
 
 
===Operand On Hysteresis===
 
===Operand On Hysteresis===
 
----
 
----
Record is generated when input value crosses the high limit value from below the low limit value or vice versa.
+
Record is generated when actual value input inceases from lower than low value to higher
[[Image:Fmb120_on_hysteresis.png|350px|none]]
+
than high level value or decreasing from higher than high level to lower than low level.
 +
[[Image:Fmb120_on_hysteresis.png|350px|center]]
 +
 
 
===Operand On Change===
 
===Operand On Change===
 
----
 
----
Record is generated when input value changes.
+
Record is generated when value changes.
[[Image:Fmb120_on_change.png|x150px|none]]
+
[[Image:Fmb120_on_change.png|x150px|center]]
 +
 
 
===Operand On Delta Change===
 
===Operand On Delta Change===
 
----
 
----
Record is generated when input value changes and the absolute change becomes equal to or higher than the limit value.
+
Record is generated when value changes and absolute value of last value minus actual input value becomes equal or higher than high level value.
[[Image:Fmb120_on_delta_change.png|x150px|none]]
+
[[Image:Fmb120_on_delta_change.png|x150px|center]]
 +
 
 
==Avg Const==
 
==Avg Const==
If ''Avg Const'' value is 10, new value must be present for 1 second to register the change to a new value. Internal sampling is done every 40 ms, so 25 samples are taken per second. To configure 5 seconds of averaging multiply 10 by 5 yielding 50 as ''Avg Const'' value. The same logic works if the device is in [[{{{model|FMB1YX}}}_Sleep_modes#Deep_Sleep_mode|Deep Sleep mode]].<br />Averaging follows RC exponential curve, see image below:
+
If avg const value is 10, new value must be present for 1 second to register change to new value. Internally sampling is done every 40ms, so 25 samples are taken in second. To configure 5 seconds averaging multiply 10 by 5 yielding 50. The same logic works even if device is in deep sleep mode.<br/>Averaging follows RC exponential curves, see image below:
[[Image:Fmb120_avg_const.png|300px|none]]
+
[[Image:Fmb120_avg_const.png|300px|center]]
For Boolean values of 5τ, values is used, that means value change is taken when new values is averaged to more than 99.3%.
+
For Boolean values 5τ, values is used, that means value change is taken when new values is averaged to more then 99.3%.
 
 
[[File:Alert.png|x30px|]]'''''NOTE: Average Constant is not used as an activation timer or delay timer. But it is used as a filter.'''
 
''
 
 
 
Event is generated at different times due to variations in voltage. Average constant is designed to filter jumps instead of event generation time.
 
 
 
For example: generation is set to happen at  14500mV, and actual voltage is set to 15000mV, that record will be generated earlier than 10s with avg const set to 100. This is because avg const is calculating time it takes for device to get to actual voltage (in this case 15000 mV), while device will be generating records when it hits 14500mV.
 
 
 
==Send SMS To==
 
Sends SMS notification about event to selected number from [[{{{model|FMB1YX}}}_SMS/Call_settings|SMS/Call Settings]] '''GSM Predefined Numbers''' list if event priority is set to [[#Low Priority|Low]], [[#High Priority|High]] or [[#Panic Priority|Panic]].
 
==SMS Text==
 
The SMS Text field can be altered and any text can be entered. Maximum message length is '''160''' symbols (numbers, letters and symbols in ASCII, except for comma “,”).
 
  
<p>SMS Event Text may be either in default or composed format.</p><p>'''Default format:'''</p><p><code>Date, time, longitude, latitude, 'SMS text', value</code></p><p>Example:</p><p><code>2018/11/02 12:00:00 Lon:0.000000 Lat:0.000000 Alarm 1</code></p>
+
==OBD II (Bluetooth) and LVCAN I/O elements==
<p>'''Composed format:'''</p><p>Composed format may consist of text and defined commands which start with '''%''' symbol.</p><p>'''Supported commands:'''</p>
+
In OBD II (Bluetooth) column are shown I/O elements which information can be obtained from OBD II Bluetooth dongle connected to FMB120 device and in LVCAN column are shown I/O elements whitch information can be obtained from LV-CAN200 or ALL-CAN300 connected to FMB120 device. All I/O configuration is the same as described in [[FMB120 I/O settings|I/O settings]] section, except OBD II (Bluetooth) I/O element don’t have averaging constant parameter.<br/>Detailed description about LVCAN I/O element configuration described in [[FMB120 CAN adapters|FMB120 with LV-CAN200 and ALL-CAN300 CAN adapters]].
{{{sms_text_fmb|<table class="wikitable">
 
<tr>
 
<th style="color:white; background:black">Command</th>
 
<th style="color:white; background:black">Description</th>
 
</tr>
 
<tr>
 
<th scope="col">imei</th>
 
<td>IMEI</td>
 
</tr>
 
<tr>
 
<th scope="col">fw</th>
 
<td>Firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">fullfw</th>
 
<td>Full firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">modem</th>
 
<td>Modem firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">gnss</th>
 
<td>GPS firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">vin</th>
 
<td>OBD VIN number</td>
 
</tr>
 
<tr>
 
<th scope="col">lat</th>
 
<td>Latitude (non-float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">lon</th>
 
<td>Longitude (non-float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">sat</th>
 
<td>Satellites in use</td>
 
</tr>
 
<tr>
 
<th scope="col">time</th>
 
<td>Timestamp</td>
 
</tr>
 
<tr>
 
<th scope="col">din1</th>
 
<td>Digital Input 1</td>
 
</tr>
 
<tr>
 
<th scope="col">din2</th>
 
<td>Digital Input 2</td>
 
</tr>
 
<tr>
 
<th scope="col">din3</th>
 
<td>Digital Input 3</td>
 
</tr>
 
<tr>
 
<th scope="col">ain1</th>
 
<td>Analog Input 1</td>
 
</tr>
 
<tr>
 
<th scope="col">out1</th>
 
<td>Digital Output 1</td>
 
</tr>
 
<tr>
 
<th scope="col">out2</th>
 
<td>Digital Output 2</td>
 
</tr>
 
<tr>
 
<th scope="col">pdp</th>
 
<td>PDOP</td>
 
</tr>
 
<tr>
 
<th scope="col">hdp</th>
 
<td>HDOP</td>
 
</tr>
 
<tr>
 
<th scope="col">exv</th>
 
<td>External Voltage</td>
 
</tr>
 
<tr>
 
<th scope="col">gmap</th>
 
<td>Google Maps link</td>
 
</tr>
 
<tr>
 
<th scope="col">mov</th>
 
<td>Movement</td>
 
</tr>
 
<tr>
 
<tr>
 
<th scope="col">odo</th>
 
<td>Trip Odometer</td>
 
</tr>
 
<tr>
 
<th scope="col">op</th>
 
<td>GSM operator</td>
 
</tr>
 
<tr>
 
<th scope="col">spd</th>
 
<td>Speed</td>
 
</tr>
 
<tr>
 
<th scope="col">ib</th>
 
<td>iButton</td>
 
</tr>
 
<tr>
 
<th scope="col">mod</th>
 
<td>Data Mode</td>
 
</tr>
 
<tr>
 
<th scope="col">sig</th>
 
<td>GSM signal</td>
 
</tr>
 
<tr>
 
<th scope="col">slp</th>
 
<td>Sleep Mode</td>
 
</tr>
 
<tr>
 
<th scope="col">cel</th>
 
<td>Cell ID</td>
 
</tr>
 
<tr>
 
<th scope="col">lac</th>
 
<td>Area Code</td>
 
</tr>
 
<tr>
 
<th scope="col">tmp</th>
 
<td>Dallas Temperature 1</td>
 
</tr>
 
<tr>
 
<th scope="col">mac</th>
 
<td>BT MAC address</td>
 
</tr>
 
<tr>
 
<th scope="col">dtc</th>
 
<td>OBD fault codes</td>
 
</tr>
 
<tr>
 
<th scope="col">flat</th>
 
<td>Latitude (float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">flon</th>
 
<td>Longitude (float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">date</th>
 
<td>Date in yyyy/mm/dd format</td>
 
</tr>
 
<tr>
 
<th scope="col">datetime</th>
 
<td>Time in hh:mm:ss format</td>
 
</tr>
 
<tr>
 
<th scope="col">val</th>
 
<td>Eventual IO value</td>
 
</tr>
 
<tr>
 
<th scope="col">io'par_id'</th>
 
<td>Element value by parameter ID</td>
 
</tr>
 
</table>}}}
 
{{{sms_text_tmt|<table class="wikitable">
 
<tr>
 
<th style="color:white; background:black">Command</th>
 
<th style="color:white; background:black">Description</th>
 
</tr>
 
<tr>
 
<th scope="col">imei</th>
 
<td>IMEI</td>
 
</tr>
 
<tr>
 
<th scope="col">fw</th>
 
<td>Firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">fullfw</th>
 
<td>Full firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">modem</th>
 
<td>Modem firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">gnss</th>
 
<td>GPS firmware version</td>
 
</tr>
 
<tr>
 
<th scope="col">lat</th>
 
<td>Latitude (non-float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">lon</th>
 
<td>Longitude (non-float value)</td>
 
</tr>
 
<tr>
 
<th scope="col">sat</th>
 
<td>Satellites in use</td>
 
</tr>
 
<tr>
 
<th scope="col">time</th>
 
<td>Timestamp</td>
 
</tr>
 
<tr>
 
<th scope="col">pdp</th>
 
<td>PDOP</td>
 
</tr>
 
<tr>
 
<th scope="col">hdp</th>
 
<td>HDOP</td>
 
</tr>
 
<tr>
 
<th scope="col">mov</th>
 
<td>Movement</td>
 
</tr>
 
<tr>
 
<th scope="col">op</th>
 
<td>GSM operator</td>
 
</tr>
 
<tr>
 
<th scope="col">spd</th>
 
<td>Speed</td>
 
</tr>
 
<tr>
 
<th scope="col">sig</th>
 
<td>GSM signal</td>
 
</tr>
 
<tr>
 
<th scope="col">slp</th>
 
<td>Sleep Mode</td>
 
</tr>
 
<tr>
 
<th scope="col">cel</th>
 
<td>Cell ID</td>
 
</tr>
 
<tr>
 
<th scope="col">lac</th>
 
<td>Area Code</td>
 
</tr>
 
<tr>
 
<th scope="col">datetime</th>
 
<td>time in hh:mm:ss format</td>
 
</tr>
 
<tr>
 
<th scope="col">val</th>
 
<td>Eventual IO value</td>
 
</tr>
 
<tr>
 
<th scope="col">io'par_id'</th>
 
<td>Element value by parameter ID</td>
 
</tr>
 
<tr>
 
<th scope="col">gmap</th>
 
<td>Google Maps link</td>
 
</tr>
 
</table>}}}
 
<p>'''Composed text example:'''</p><p><code>%imei Movement %io50010</code></p><p>'''Event SMS text:'''</p><p><code>352094082828606 Movement 1</code></p>
 
{|
 
|-
 
|[[File:Alert.png|left|80px|link=]]||<b>If {{{model|FMB1YX}}} is in [[{{{model|FMB1YX}}}_Sleep_modes#Deep_Sleep_mode|Deep Sleep]] or [[{{{model|FMB1YX}}}_Sleep_modes#Ultra_Deep_Sleep_mode|Ultra Deep Sleep]] mode and an SMS event occurs with [[#Low Priority|Low priority]] (which does not wake up {{{model|FMB1YX}}}), then the device does not send the message. It is saved to device memory until it wakes up from [[{{{model|FMB1YX}}}_Sleep_modes#Deep_Sleep_mode|Deep Sleep]] or [[{{{model|FMB1YX}}}_Sleep_modes#Ultra_Deep_Sleep_mode|Ultra Deep Sleep]] mode and GSM modem starts working normally. After it wakes up, all the messages that are saved to memory will be sent, but keep in mind that only 10 messages can be saved to memory – all other messages will not be saved, until there is free memory space.</b>
 
|}
 

Revision as of 13:50, 12 April 2018

When no I/O element is enabled, AVL packet comes with GNSS information only. After enabling I/O element(s) AVL packet along with GNSS information contains current value(s) of enabled I/O elements.
If the device is connected to configurator all current I/O values are displayed in Current value column.
Priority field allows enabling I/O element(s) and setting them a priority so they are added to the data packet, which issent to the server. By default 12 I/O elements with low priority are enabled: Ignition, Movement, Data Mode, GSM Signal, Sleep Mode, GNSS Status, GNSS PDOP, GNSS HDOP, External Voltage, Speed, Battery Voltage and Battery Current. Priority level (AVL packet priority) can be Low, High or Panic. All records made by FMB120 are regular. Regular packets are sent as low priority records. When low priority event is triggered, FMB120 makes an additional record with indication that the reason for the event was an I/O element change (depends on Operand configuration). When high priority is selected, module makes additional record with high priority flag and sends event packet immediately to the server through GPRS. Panic priority triggers same actions as high priority, but if GPRS fails, it sends an AVL packet using SMS data if SMS data sending is enabled and the number is given in SMS/Call Settings.
High and Low levels define I/O value range. If I/O value enters or exits this range, FMB120 generates an event. Operand parameter defines when to generate event: On Exit, On Entrance, On Both, On Hysteresis and On Delta Change.
When Event Only is selected, I/O element status value will be appended only to eventual records, otherwise, I/O element status value will appear in each AVL record.

Operands

Operand On Exit

Record is generated when actual value input increases and becomes higher than high level or decreases and become lower than low level.

Fmb120 on exit.png

Operand On Entrance


Record is generated when actual value input increases or decreases and becomes between high and low level values.

Fmb120 on entrance.png

Operand On Both


Record is generated by both (On Exit and On Entrance) operands logic at same time.

Fmb120 on both.png

Operand Monitoring


No event at all. Values are recorded only when other trigger have worked.

Fmb120 operand monitoring.png

Operand On Hysteresis


Record is generated when actual value input inceases from lower than low value to higher than high level value or decreasing from higher than high level to lower than low level.

Fmb120 on hysteresis.png

Operand On Change


Record is generated when value changes.

Fmb120 on change.png

Operand On Delta Change


Record is generated when value changes and absolute value of last value minus actual input value becomes equal or higher than high level value.

Fmb120 on delta change.png

Avg Const

If avg const value is 10, new value must be present for 1 second to register change to new value. Internally sampling is done every 40ms, so 25 samples are taken in second. To configure 5 seconds averaging multiply 10 by 5 yielding 50. The same logic works even if device is in deep sleep mode.
Averaging follows RC exponential curves, see image below:

Fmb120 avg const.png

For Boolean values 5τ, values is used, that means value change is taken when new values is averaged to more then 99.3%.

OBD II (Bluetooth) and LVCAN I/O elements

In OBD II (Bluetooth) column are shown I/O elements which information can be obtained from OBD II Bluetooth dongle connected to FMB120 device and in LVCAN column are shown I/O elements whitch information can be obtained from LV-CAN200 or ALL-CAN300 connected to FMB120 device. All I/O configuration is the same as described in I/O settings section, except OBD II (Bluetooth) I/O element don’t have averaging constant parameter.
Detailed description about LVCAN I/O element configuration described in FMB120 with LV-CAN200 and ALL-CAN300 CAN adapters.