Template:FTX Input/Output (I/O): Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 11:12, 17 September 2025

Input / output (I/O)

Search

Enter the keyword to search for the desired permanent I/O.

More Filters

It provides additional filter options such as Priority, Operand, and rows with currently available values.

View Columns

Filters the necessary tabs when making configuration changes or viewing. Priority, Operand, Low Level, High Level, and Event Only Options are available filters. The Input name and Current Values are permanent columns.

Current Value

If the device is connected to the Telematics Configuration Tool, then all the current I/O values can be seen here.

Units

Units of measurement.

Priority

This field allows the enabling of the I/O elements and sets them a priority so they are added to the data packet, which is sent to the server.

By default I/O elements with Low priority are enabled: Total odometer GSM Signal, Battery Voltage, Battery Current, PCB temperature, GNSS PDOP, GNSS HDOP, Ignition, Movement, External voltage.

These records made by {{{model}}} device are regular, and regular packets are sent as low priority records.

Priority level (AVL packet priority) can be:

None Priority

The module doesn't make additional records.

Low Priority

The 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

The module makes an additional record with High priority flag and sends event packet immediately to the server using GPRS.

High and Low Level

These levels define I/O value range. If I/O value enters or exits this range, {{{model}}} 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 Monitoring

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

Operand On Change

Record is generated when input value changes.

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 On Hysteresis

Record is generated when input value crosses the high limit value from below the low limit value or vice versa.

Operand On Delta Change

Record is generated when input value changes and the absolute change becomes equal to or higher than the limit value.

Permanent I/O

When no permanent I/O elements are 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.

[[Category:{{{model}}} Configuration]]

@@ Line 69: / Line 69: @@
 ==Permanent I/O==
+[[File:FTX permanent io.png|center|500px]]
 When no permanent I/O elements are enabled, AVL packet comes with GNSS information only.
-[[File:FTX permanent io.png|center|thumb|1100x1100px]]
+After enabling I/O element(s) AVL packet contains current value(s) of enabled I/O element(s) along with GNSS information.
+<!-- If model supports DOUT1, then show -->
+{{#if: {{FTX_Pin_Support List|model={{{model}}}|pin=DOUT1}} |
+===General I/O Settings===
+[[File:General IO settings - menu.png|right|500px]]
+When a device has at least one DOUT, the "General I/O Settings" menu button is displayed on the top right. This menu allows configuring general settings for DOUTS. Select a particular DOUT and configure its settings.
+====Overcurrent recovery====
+Parameter ID = 350
+The feature will attempt to recover DOUT state when an overcurrent is detected in the circuit.
+Principle of recovery: The DOUT is toggled to HIGH and the device checks whether the overcurrent event is still present. If yes, DOUT is toggled to LOW. This toggling to HIGH and LOW have the duration of ~2 ms and ~3 ms respectively, thus the whole cycle takes ~5 ms. This is repeated until the overcurrent event is no longer detected or the maximum number of attempts (1000) is reached (takes ~5 seconds in total).
+====Inversion====
+Parameter ID = 360
+This feature inverts the digital output value. All scenarios and commands will have an inverted effect for the digital output. For example, when DOUT is inverted - it will be ON by default and triggering any scenario will turn it OFF.
+Normal behavior: DOUT ON - HIGH (1), DOUT OFF - LOW (0).
+Inverted behavior: DOUT ON - LOW (0), DOUT OFF - HIGH (1).
-After enabling I/O element(s) AVL packet contains current value(s) of enabled I/O element(s) along with GNSS information.
+'''IMPORTANT! DOUT state I/O element that is sent in the records represents the real state of the DOUT pin.'''
+}}
 <!-- If model supports Manual CAN, then show -->
-{{#switch: {{{model|FTC305}}}
+{{#if: {{FTX Pin Support List|model={{{model}}}|pin=Manual CAN}} |
-| FTC305
-| FTM305 =
-==Manual CAN==
+== Manual CAN ==
-Manual CAN functionality allows user to read data from CAN BUS without requiring an additional CAN protocol development from the firmware side.
+[[File:Manual CAN - menu.png|right|500px]]
+The user can configure 70 Manual CAN I/O element by setting Priority, CAN Type, CAN ID, Data Mask, Operand. Each CAN I/O has its own parameters and can be configured independentely.
-'''Note:''' Before using Manual CAN, make sure to select the correct CAN settings: [[{{{model}}} Accessories#CAN|CAN]].
+When configuring CAN IO elements, each parameter (like priority, operand, CAN type, CAN ID, etc.) requires a unique '''configuration ID'''. These IDs follow specific formulas to ensure no overlap with other parameters in the system. This guide explains how to calculate them.
-Up to '''70''' Manual CAN I/Os can be configured:
+==='''Formula:'''===
+Parameter_ID = 1,000,000 + (AVL_ID * 100) + OPTION Parameter_ID = 1,000,000 + (AVL_ID * 100) + OPTION
-[[File:FTX manual can.png|center|thumb|1100x1100px]]
+* 1,000,000: Base offset for CAN-related parameters.
+* AVL_ID: The CAN AVL IO element identifier (within certain allowed ranges).
+* OPTION: A small integer offset indicating which setting is being adjusted (e.g., priority or operand).
-Configurable settings:
+'''Valid AVL Ranges '''
-*'''Priority''' - defines the priority of '''Manual CAN I/O''':
+* [10216:10235]
-**'''Low''' - enables the I/O element, adding its value to periodic or eventual record packets based on the "Operand" and "Event only" settings. Events are sent along with periodic data according to the "Data acquisition" configuration.
+* [10298:10347]
-**'''High''' - enables the I/O element with high priority, immediately sending its value to the server in a high-priority eventual record. If the "Operand" is set to "Monitoring," it functions the same as "Low Priority."
+'''
+Example:''' If AVL_ID is 10216 and the OPTION for “priority” is 1, then
+Parameter ID=1,000,000+(10216×100)+1=1,000,000+1,021,600+1=2,021,601
-*'''CAN type''' - defines which CAN ID type will be received and requested:
+=== '''MCAN IO Parameter Calculation''' ===
-**'''Standard''' - uses '''11 bits''' to read the CAN ID, allowing for 2,048 unique IDs (0x000 to 0x7FF).'''
+For MCAN IO elements (e.g., MCAN0, MCAN1, MCAN2…), each has three specific parameters: '''CAN Type, CAN ID,''' and '''Data Mask'''. The '''MCAN IO''' '''number''' is the index of the MCAN entry (starting at 0, 1, 2, etc.).
-**'''Extended''' - uses '''29 bits''' to read the CAN ID, allowing for 536,870,912 unique IDs (0x00000000 to 0x1FFFFFFF).
-*'''CAN ID''' – depends on CAN Type parameter and defines which CAN ID will be received by device.
+'''''Formulas'''''
-**This identifier is composed of '''4 bytes'''.
+.	'''CAN Type'''
-**For '''SAE J1939''', the first and last bytes can vary depending on the vehicle make or model, while the bytes in between remain the same for all vehicles. Although the first and last bytes may hold any value, it is recommended to use FF for both.
+Parameter ID=17,000+(10×MCAN IO number)
+.	'''CAN ID'''
+Parameter ID=17,001+(10×MCAN IO number)
+.	'''Data Mask'''
+Parameter ID=17,002+(10×MCAN IO number)
-*'''Data mask''' – defines which data bytes are sent to the server (sometimes not all data bytes are necessary). Up to 8 particular data bytes can be selected for each CAN ID.
+'''Examples'''
+* '''MCAN0''' (IO number = 0):
-*'''Operand''' – defines when to generate event:
+** '''CAN Type:''' 17000 + (10 × 0) = 17000
-**'''Monitoring''' - continuously monitors the current I/O element value in with every periodical record. No eventual records are created when using the "Monitoring" operand.
+** '''CAN ID:''' 17001 + (10 × 0) = 17001
-**'''On Change''' - generates an eventual record whenever the input value changes.
+** '''Data Mask:''' 17002 + (10 × 0) = 17002
+* '''MCAN1''' (IO number = 1):
+** '''CAN Type:''' 17000 + (10 × 1) = 17010
+** '''CAN ID:''' 17001 + (10 × 1) = 17011
+** '''Data Mask:''' 17002 + (10 × 1) = 17012
+* '''MCAN69''' (IO number = 69):
+** '''CAN Type:''' 17000 + (10 × 69) = 17690
+** '''CAN ID:''' 17001 + (10 × 69) = 17691
+** '''Data Mask:''' 17002 + (10 × 69) = 17692
+'''Putting It All Together''' <br>
+.	'''Check Your AVL ID Range''' <br>
+* If your CAN IO element has an AVL ID in [10216–10235] or [10298–10347], use the '''first formula''' for Parameter_ID = 1,000,000 + (AVL_ID * 100) + OPTION. <br>
+.	'''Identify Your MCAN IO Number''' <br>
+* If you have an MCAN entry (e.g., MCAN0, MCAN1), use the '''second set of formulas''' to find the corresponding '''CAN Type, CAN ID, and Data Mask''' parameter IDs. <br>
+.	'''Plug In the Numbers''' <br>
+* Calculate step by step, ensuring you add the correct base offsets and multipliers. <br>
+.	'''Configure Your Device''' <br>
+* Once you have the parameter IDs, set or modify them in your configuration tool to match the desired priority, operand, or other CAN-related settings.<br>
+}}
+<!-- If model supports Manual CAN, then show -->
+{{#if: {{FTX Pin Support List|model={{{model}}}|pin=Manual CAN}} |
 ==Manual CAN Commands==
 Manual CAN Commands functionality allows user to send configurable commands to CAN BUS.
-'''Note:''' Before using Manual CAN, make sure to select the correct CAN settings: [[{{{model}}} Accessories#CAN|CAN]].
+'''Note:''' Before using Manual CAN, make sure to select the correct CAN settings: [[{{{model}}} Accessories#CAN|{{{model}}} CAN settings]].
 Up to '''10''' Manual CAN Command I/Os can be configured:
@@ Line 146: / Line 196: @@
 **If set to '''0''' - command will be sent '''infinitely''' until it is turned off by the user.
-After configuring, Manual CAN commands can be triggered with SMS/GPRS commands: [[{{{model}}} SMS/GPRS_Commands#CAN Commands|{{{model}}} SMS/GPRS Commands]].
+*'''Command Enabler''' - toggles command.
+**If enabled - command will send CAN messages.
+**If disabled, the command will not be available to trigger sending, even if configured.
+After configuring, Manual CAN commands can be triggered with SMS/GPRS commands: [[{{{model}}} SMS/GPRS Command List#CAN Commands|{{{model}}} SMS/GPRS Commands]].
 }}
 [[Category:{{{model}}} Configuration]]