Difference between revisions of "Template:FMB I/O settings"
| (8 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
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. | 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 | + | ==Input name== |
I/O element name. | I/O element name. | ||
| − | ==Current | + | ==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. | 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== | ||
| Line 52: | Line 52: | ||
[[Image:Fmb120_on_delta_change.png|x150px|none]] | [[Image:Fmb120_on_delta_change.png|x150px|none]] | ||
==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 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]] | [[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%. | 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== | ==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]]. | 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== | ==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 “,”). | 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 “,”). | ||
| − | + | {{{sms_text_tmt| | |
| − | <p>SMS Event Text may be either in default or composed format.</p><p>'''Default format:'''</p><p> | + | <p>SMS Event Text may be either in default or composed format.</p><p>'''Default format:'''</p><p>"Date, time, longitude, 'SMS text', value"</p><p>Example:</p><p>2018/11/02 12:00:00 Lon:0.000000 Lat:0.000000 Alarm 1</p> |
| − | <p>'''Composed format:'''</p><p>Composed format may consist of text and defined commands which start with | + | <p>'''Composed format:'''</p><p>Composed format may consist of text and defined commands which start with % symbol.</p><p>'''Supported TMT250 commands:'''</p> |
| − | + | <table class="wikitable"> | |
<tr> | <tr> | ||
| − | <th | + | <th>Command</th> |
| − | <th | + | <th>Description</th> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>imei</td> |
<td>IMEI</td> | <td>IMEI</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>fw</td> |
<td>Firmware version</td> | <td>Firmware version</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>fullfw</td> |
<td>Full firmware version</td> | <td>Full firmware version</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>modem</td> |
<td>Modem firmware version</td> | <td>Modem firmware version</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>gnss</td> |
<td>GPS firmware version</td> | <td>GPS firmware version</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | + | <td>lat</td> | |
| − | <td | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td>Latitude (non-float value)</td> | <td>Latitude (non-float value)</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>lon</td> |
<td>Longitude (non-float value)</td> | <td>Longitude (non-float value)</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>sat</td> |
<td>Satellites in use</td> | <td>Satellites in use</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>time</td> |
<td>Timestamp</td> | <td>Timestamp</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>pdp</td> |
<td>PDOP</td> | <td>PDOP</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>hdp</td> |
<td>HDOP</td> | <td>HDOP</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>mov</td> |
<td>Movement</td> | <td>Movement</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>op</td> |
<td>GSM operator</td> | <td>GSM operator</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>spd</td> |
<td>Speed</td> | <td>Speed</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>sig</td> |
<td>GSM signal</td> | <td>GSM signal</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>slp</td> |
<td>Sleep Mode</td> | <td>Sleep Mode</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>cel</td> |
<td>Cell ID</td> | <td>Cell ID</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>lac</td> |
<td>Area Code</td> | <td>Area Code</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>datetime</td> |
<td>time in hh:mm:ss format</td> | <td>time in hh:mm:ss format</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>val</td> |
<td>Eventual IO value</td> | <td>Eventual IO value</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>io'par_id'</td> |
<td>Element value by parameter ID</td> | <td>Element value by parameter ID</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | < | + | <td>gmap</td> |
<td>Google Maps link</td> | <td>Google Maps link</td> | ||
</tr> | </tr> | ||
| − | </table> | + | </table> |
| − | <p>'''Composed text | + | <p>Example:</p><p>'''Composed text:'''</p><p>%imei Battery Level %io50690</p><p>'''Event SMS text:'''</p><p>352094082828606 Battery Level 50</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> | + | | [[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 16:38, 2 November 2018
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 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 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 Current, Battery Voltage. All records made by FMB1YX are regular, and regular packets are sent as low priority records.
Priority level (AVL packet priority) can be:
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 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 SMS/Call Settings.
High and Low Level
These levels define I/O value range. If I/O value enters or exits this range, 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: On Exit, On Entrance, On Both, Monitoring, On Hysteresis, On Change or On Delta Change.
Operand On Exit
Record is generated when input value leaves a range between low and high level limits.
Operand On Entrance
Record is generated when input value enters a range between low and high level limits.
Operand On Both
Record is generated by both On Exit and On Entrance operands' logic at same time.
Operand Monitoring
No event at all. Values are recorded only when other triggers worked.
Operand On Hysteresis
Record is generated when input value crosses the high limit value from below the low limit value or vice versa.
Operand On Change
Record is generated when input value changes.
Operand On Delta Change
Record is generated when input value changes and the absolute change becomes equal to or higher than the limit value.
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 Deep Sleep mode.
Averaging follows RC exponential curve, see image below:
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 SMS/Call Settings GSM Predefined Numbers list if event priority is set to Low, High or 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 “,”).
SMS Event Text may be either in default or composed format.
Default format:
"Date, time, longitude, 'SMS text', value"
Example:
2018/11/02 12:00:00 Lon:0.000000 Lat:0.000000 Alarm 1
Composed format:
Composed format may consist of text and defined commands which start with % symbol.
Supported TMT250 commands:
| Command | Description |
|---|---|
| imei | IMEI |
| fw | Firmware version |
| fullfw | Full firmware version |
| modem | Modem firmware version |
| gnss | GPS firmware version |
| lat | Latitude (non-float value) |
| lon | Longitude (non-float value) |
| sat | Satellites in use |
| time | Timestamp |
| pdp | PDOP |
| hdp | HDOP |
| mov | Movement |
| op | GSM operator |
| spd | Speed |
| sig | GSM signal |
| slp | Sleep Mode |
| cel | Cell ID |
| lac | Area Code |
| datetime | time in hh:mm:ss format |
| val | Eventual IO value |
| io'par_id' | Element value by parameter ID |
| gmap | Google Maps link |
Example:
Composed text:
%imei Battery Level %io50690
Event SMS text:
352094082828606 Battery Level 50
 |
If FMB1YX is in Deep Sleep or Ultra Deep Sleep mode and an SMS event occurs with Low priority (which does not wake up FMB1YX), then the device does not send the message. It is saved to device memory until it wakes up from Deep Sleep or 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. |
