1,583
edits
Changes
Template:FMM I/O settings (view source)
Revision as of 12:32, 21 August 2019
, 12:32, 21 August 2019Created page with "__TOC__ 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..."
__TOC__
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==
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===
Record is generated when input value leaves a range between low and high level limits.
[[Image:Fmb120_on_exit.png|x150px|none]]
===Operand On Entrance===
----
Record is generated when input value enters a range between low and high level limits.
[[Image:Fmb120_on_entrance.png|x150px|none]]
===Operand On Both===
----
Record is generated by both ''On Exit'' and ''On Entrance'' operands' logic at same time.
[[Image:Fmb120_on_both.png|x150px|none]]
===Operand Monitoring===
----
No event at all. Values are recorded only when other triggers worked.
[[Image:Fmb120_operand_monitoring.png|x150px|none]]
===Operand On Hysteresis===
----
Record is generated when input value crosses the high limit value from below the low limit value or vice versa.
[[Image:Fmb120_on_hysteresis.png|350px|none]]
===Operand On Change===
----
Record is generated when input value changes.
[[Image:Fmb120_on_change.png|x150px|none]]
===Operand On Delta Change===
----
Record is generated when input value changes and the absolute change becomes equal to or higher than the limit value.
[[Image:Fmb120_on_delta_change.png|x150px|none]]
==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:
[[Image:Fmb120_avg_const.png|300px|none]]
For Boolean values of 5τ, values is used, that means value change is taken when new values is averaged to more than 99.3%.
==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>
<p>'''Composed format:'''</p><p>Composed format may consist of text and defined commands which start with '''%''' symbol.</p><p>'''Supported commands:'''</p>
{{{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>
|}
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==
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===
Record is generated when input value leaves a range between low and high level limits.
[[Image:Fmb120_on_exit.png|x150px|none]]
===Operand On Entrance===
----
Record is generated when input value enters a range between low and high level limits.
[[Image:Fmb120_on_entrance.png|x150px|none]]
===Operand On Both===
----
Record is generated by both ''On Exit'' and ''On Entrance'' operands' logic at same time.
[[Image:Fmb120_on_both.png|x150px|none]]
===Operand Monitoring===
----
No event at all. Values are recorded only when other triggers worked.
[[Image:Fmb120_operand_monitoring.png|x150px|none]]
===Operand On Hysteresis===
----
Record is generated when input value crosses the high limit value from below the low limit value or vice versa.
[[Image:Fmb120_on_hysteresis.png|350px|none]]
===Operand On Change===
----
Record is generated when input value changes.
[[Image:Fmb120_on_change.png|x150px|none]]
===Operand On Delta Change===
----
Record is generated when input value changes and the absolute change becomes equal to or higher than the limit value.
[[Image:Fmb120_on_delta_change.png|x150px|none]]
==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:
[[Image:Fmb120_avg_const.png|300px|none]]
For Boolean values of 5τ, values is used, that means value change is taken when new values is averaged to more than 99.3%.
==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>
<p>'''Composed format:'''</p><p>Composed format may consist of text and defined commands which start with '''%''' symbol.</p><p>'''Supported commands:'''</p>
{{{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>
|}