EN Digital Output User Manual
EN Digital Output User Manual
EN Digital Output User Manual
User Manual
2021
DOUTs can be used to inform the driver about various events in progress, such as overspeeding or GSM
jamming. For this functionality to work, a peripheral must be connected to the tracking device in order for
it to be activated by the set conditions. This functionality works with the following peripherals:
LED/Buzzer
Blocking
Custom DOUT applications
GSM jamming block
Immobilizer
More information about peripheral devices and connections can be found on our documentation website:
doc.ruptela.lt.
1.1 Compatibility
This functionality is compatible with the following devices with the latest firmware version:
HCV5 FM-Pro4
LCV5 FM-Eco4
Pro5 FM-Eco4 S
Trace5 FM-Eco4 T
FM-Tco4 HCV FM-Eco4 RS T
FM-Tco4 LCV
You can get the latest firmware and configurator from our documentation website: doc.ruptela.lt
Note
Be aware, that the Inverted checkbox inverts the logic of the selected DOUT.
DOUT activation with conditions is described further on separately in the Configuring DOUT activation with
conditions chapter.
An example, in which both buzzer and LED are connected is shown below:
2.3 Blocking
This mode allows blocking the engine from being started under certain conditions. A changeover relay is
used to disable the engine starter, when the relay is connected to the DOUT and Blocking is configured
on. When the DOUT is in an active state, the engine starter is disabled until the DOUT is deactivated.
Blocking can only be configured on one DOUT at a time.
Blocking is commonly used with driver registration. An in-depth description of the functionality can be
found in the Driver registration document. Blocking may also be used together with other DOUT modes
such as LED or Buzzer.
A relay connection example in which DOUT1 is used is shown below:
2.4 Custom
This mode allows the FM device to emit a customizable pattern when the DOUT is triggered. Custom mode
can be used with the Geofencing functionality or the DOUT activation by conditions. Custom can only be
enabled on one DOUT at a time. A more detailed description is provided in the Configurable DOUT patterns
chapter of this document.
Note
To use the jamming detection functionality with LTE Cat M1 models, the modem firmware version must
be BG96MAR02A07M1G_01.018.01.018 or newer. The modem firmware version can be checked using the
modrev SMS command.
2.6 Immobilizer
This mode allows immobilizing the vehicle. “Immobilizer” mode can only be activated and
deactivated via an SMS command. This functionality can be enabled only on one of the DOUTs. To
configure this mode, select Immobilizer in the DOUT drop-down list. Additionally, you can set a pattern
for this DOUT. A more detailed description is provided in Configurable DOUT patterns chapter.
If the conditions are met, the device will output a continuous signal according to the set pattern.
Case 2
One of the cases is sending the immobilizer SMS command to an FM device with a lower speed setting
compared to the actual speed. For example, the actual speed is 80 km/h, the immobilizer command is
sent with a 60 km/h limit (pass immobilizer 60). If the ignition is on, the immobilizer will not activate in
any case until the GPS or CAN speed has first lowered below the set 60 km/h limit and afterwards reached
the set limit.
Case 3
Additionally, to the previous case, the reset SMS command (or any other case when the device resets)
should be also described. The reset command resets the FM device. The reset command has no effect on
the immobilizer command and functionality unless at that moment the ignition is off. If the immobilizer is
active, the reset command will not disable it. If the case of the first example is in effect (and the Ignition
is ON), GPS or CAN speed is 80 km/h and a pass immobilizer 60 command is sent, it will still not activate
the immobilizer until the vehicle speed first drops below the set limit.
If the status was disabled – the device keeps the DOUT inactive and waits for the speed parameter.
If the status was enabled – the device activates the DOUT. If there is an activated pattern, it is
restarted.
If the last known status is not available, the device keeps the DOUT inactive and waits until the
GPS fix and speed parameter are acquired.
Note
Be aware, that the Inverted checkbox inverts the logic of the selected DOUT.
4. Click the Activation conditions button, this will open the settings for DOUT activation under
conditions.
5. In the settings window, the user can select under what condition the DOUTs will be activated.
This covers the general process of the configuration. The configuration for each condition is described
further on separately.
After the configuration is complete, close the window and send the configuration to the FM device.
DOUT activation by speed working principle:
After the configuration is complete, close the window and send the configuration to the FM device.
DOUT activation by AIN working principle:
After the configuration is complete, close the window and send the configuration to the FM device.
After the configuration is complete, close the window and send the configuration to the FM device.
After configuring DOUT activation by rollover, close the window and send the configuration to the device.
6. Locate the IO events section in the Profile settings and click the Options button.
7. A new IO setting window will open. In the Digital outputs section, locate the DOUT1 and select
Blocking from the drop-down list.
Note
Only DOUT1 can be controlled via server.
4. In the general settings section, tick the Ignition blocking is configured checkbox.
5. Optional step. If the SMS password is set in the Authorized numbers settings, then the password
also has to be set in TrustTrack system. Otherwise, skip this step. In the Only for FM enter the
same SMS password in the FM password input field.
At the end of parameters configuration table, click the Save button to enable the functionality.
5. A confirmation dialog box will open. Click Block to confirm the vehicle’s ignition blocking.
th tl ch cl n
State
Pattern examples
1. Pattern parameters: th = 1000, tl = 1000, ch = 500, cl = -500, n=3 and state = H.
5.2 Configuration
Set DOUT pattern parameters
1. Open the FM device configurator and select your device model in the drop-down list.
2. In the IO events section click on the Options button. A IO settings window will open, where
IO parameters can be enabled or disabled.
3. In the bottom right corner select one of the DOUTs. In its drop-down menu select Custom. The
Pattern field will be displayed below.
Close the Settings of Geozones window and send the configuration to the device.
Registration types:
Dual registration
Driver registration
Mandatory Registration
Block/unblock
A full functionality description can be found on our documentation website, Driver registration.
Note
The IO parameter iButton ID must be enabled in order to see the ID number in TrustTrack system reports.
The configuration is the same for iButton and for 1-Wire RFID devices.
1. Open the IO settings window as described previously. Select an empty slot in which the newly
selected parameter will be set. (Empty slots are marked as disabled, in the example below the slot
is already named after the parameter since the Enable checkbox was already marked).
2. Open the ID drop-down list and select iButton driver ID.
3. Tick the Enable checkbox to activate the parameter. If the checkbox is not ticked, the parameter
will not be set in the selected slot.
4. Set Event on to Change.
5. Set the Priority to High.
6. Now the parameter is enabled and configured, you can safely close the window or continue
enabling and configuring other parameters.
Note
IO parameters (8B or 16B) DS1971 iButton ID must be enabled in order to see the ID number in TrustTrack
system reports.
1. Enable the Send I/O data with v1.1 protocol checkbox in the Protocol selection section.
2. Enable the 1-Wire checkbox in the Interfaces section.
3. Select DS1971 from the drop-down list and click the Config button.
4. Tick one of the Data length checkboxes to select how many bytes of data should be read. In an
offset, the device will read bytes that are situated after skipped symbols. The default value is 8
bytes.
5. Set the Offset field value. It defines how many starting symbols from the ID should be skipped
when reading the DS1971 iButton. The default offset value is 0. Value range – from 0 to 31.
6. Click the Enable IO button. A new Configured IO window will open.
7. Click the Save button to enable the selected IO parameters. All properties for the selected IO
parameters will be automatically set. If needed, the IO parameters can be configured manually.
Note
Reading the EEPROM from the DS1971 iButton takes longer than reading a usual iButton, it is highly
recommended to hold the iButton a couple of seconds longer when scanning the DS1971 iButton.
Important!
If DS1971 iButton EEPROM reading is configured on 1-Wire, other 1-Wire peripherals connected to the FM
device will not work!
Note
When the RS232 RFID reader is used for identification, you need to configure one of the FM device’s ports
to receive RFID data. Also, the RFID IO parameter (RFID PortA or RFID PortB) has to be enabled in order
receive the driver ID to the server.
1. Open the IO settings window as described previously. Select an empty slot in which the newly
selected parameter will be set. (Empty slots are marked by disabled, in the example below the slot
is already named after the parameter since the Enable checkbox was already marked).
2. Open the ID drop-down list and select RFID PortA or RFID PortB.
3. Tick the Enable checkbox to activate the parameter. If the checkbox is not ticked, the parameter
will not be set in the selected slot.
4. Set Event on to Change.
5. Set the Priority to High.
6. In the Interfaces section, check the PortA or PortB checkbox, this will enable a drop-down list
to the right of the checkbox name. Select RFID reader in the drop-down list.
7. Now the parameter is enabled and configured, you can safely close the window or continue
enabling and configuring other parameters.
Indication
Buzzer/LED duration and Alert duration fields can be used to configure various indication aspects.
Important!
If you leave the Registration function drop-down menu as disabled, digital outputs will do nothing and
the ID is sent only once (the ID is not held until the ignition is switched off).
Passenger registration
All registration modes except dual registration can be combined with the passenger registration option.
More details about this can be found in Passenger registration chapter.
6.5.1 Registration
Registration option allows optional driver registration over an iButton or Magnetic card identification
sources.
Registration Output
In the Output selection field, you can select peripherals that were previously configured on the DOUTs
(LED/Buzzer). Please note that if you select Registration or Mandatory registration mode and select
Blocking output (if it is configured on DOUTs), the engine will not be blocked. Blocking function works
ONLY when Blocking is selected as a Registration source.
6.5.4 Blocking
If you do not need the authorized IDs list, you can deselect Enable checkbox for the Authorized IDs list -
in this case, any iButton/RFID card can unlock the engine – untick the Enable checkbox
Go to IO events settings and select Blocking on one of DOUTs.
Blocking Output
Go to Driver registration in the main configurator window. Select the Registration function as
Blocking. On Output select Blocking (if you do not select it, blocking will not work). If LED/Buzzer is
configured in the DOUTs section, select it in the Output field. LED will blink/Buzzer will make a sound upon
successful/unsuccessful registration.
Note
If an authorized ID was used to start the engine and then an unauthorized ID was scanned, the record is
made with this unauthorized ID, but the ignition is NOT blocked.
6.5.5 Passenger registration
This checkbox allows passengers to register with an iButton/DS1971 iButton or 1 Wire RFID. This feature
works with all registration modes except dual registration. Passenger registration requires one of the
following IO parameters to be enabled:
Note
It is important to select the IO ID in accordance with the selected data length (8B or 16B). Data will be
read based on that configuration.
To enable one of these IO parameters you must use extended protocol v1.1.
iButton IO can generate records with events on Monitoring, Change and Hysteresis. Averaging does not
work.
When the iButton ID is read and DIN3=0, ID will be written to IO ID 34 (iButton ID).
When the iButton ID is read and DIN3=1, ID will be written to IO ID 536 (iButton passenger ID)
iButton DS1971 can generate records with events on Monitoring or Change. Averaging is not available.
When DS1971 iButton ID is read and DIN3=0, ID will be written to IO ID 620 (DS1971 iButton internal
8B driver ID) or to IO ID 621 (DS1971 iButton internal 16B driver ID) – depends on the data length
configuration.
When DS1971 iButton ID is read and DIN3=1, ID will be written to IO ID 623 (DS1971 iButton internal
8B passenger ID) or to IO ID 624 (DS1971 iButton internal 16B passenger ID) – depends on the data
length configuration.
iButton passenger ID IO is reset together with Driver ID (IO 34) (Same for the DS1971 iButton IO)
according to the device configuration. Passenger ID is not verified with authorized ID list, it does not
unblock engine for blocking mode and normally it does not disable buzzer/LED for mandatory registration.
Once the DOUT is activated by a condition, it cannot be disabled by a transition to any sleep mode
or by changing a profile.
Once the FM device goes into sleep/deep sleep mode, activation by speed will not work.
If DOUT activation by speed is armed or activated, the device cannot go to sleep/deep
sleep/custom sleep mode. In custom sleep mode, if DOUT activation by speed changes status
to armed or activated, the device wakes up.
If DOUT activation by speed is armed or activated, the device cannot go to sleep/deep
sleep/custom sleep mode. In custom sleep mode, if DOUT activation by GSM jamming changes
status to armed or activated, the device wakes up.
If DIN state is HIGH, the device cannot go to sleep mode, if DIN status is LOW, the device can
go to sleep mode, but will wake up if the DIN state changes to HIGH.
DOUT activation by conditions behavior in custom sleep mode depends fully on the configuration
of the custom sleep mode.
If the device goes to sleep mode or deep sleep mode, DOUT activation from GSM jamming will not
work.
Since DOUTs can be activated by other functionalities apart from DOUT activation with conditions, a
hardcoded priority list of DOUT activations is implemented to set priorities for functionalities. If a DOUT is
activated by functionality or a condition, all other activation conditions, which are lower in the priority
list are temporarily deactivated while the DOUT is active. The priority is set as follows:
1. Driver registration
2. Activation by GSM jamming
3. Activation by rollover
4. Geofencing
5. Activation by speed
6. Activation by AIN
7. Activation by DIN
Note
It is recommended to use one DOUT for the ativation with conditions functionality while leaving the other
DOUT for functionalities such as driver registration and Geofencing to avoid confusion.
Example: DOUTs are activated by geofencing, while the DOUTs are active, activation by speed, AIN and
DIN will be temporarily ineffective.
Examples
Request:
password setio 0,1
Response:
SETIO configuration data ok
Note
“Setio” SMS command will not work with several FM device configurations. If a DOUT is configured to
“Blocking” and driver registration is enabled and registration function is set to blocking or “DOUT activation
with conditions” enabled and DOUT is set as an output channel, then “setio” SMS command will have no
effect.
Operation principle
When the FM device receives the setiotime command, it stores the status of DOUT’s and after the sequence
restores the previous status. If one setiotime command interrupts another, the state is UNDEFINED ('1' or
'0') after both sequences are finished. In this case, interrupt means that several consecutive setiotime
commands were sent, one overlapping the other.
Sending several setiotime commands in fast succession will make the DOUT stuck, thus requiring a device
reboot. It is highly recommended to wait until a response is received for the first sent setiotime command,
before sending the next. Value of ‘0’ means GND and ‘1’ – no GND.
Note
If one of the DOUT is configured as LED, Buzzer blocking or Jamming blocking, setiotime cannot be used.
It is possible to set a number of repeats sequence.
Examples
Request:
DOUT1 DOUT2
password setiotime ⏞
1
⏟500 0
⏟500 1 ⏟500 , ⏞
⏟300 … 0 0
⏟200 1⏟300 1
⏟300 … 0
⏟500
Slot1 Slot2 Slot3 Slot10 | Slot1 Slot2 Slot3 Slot10
DOUT1 DOUT2
password setiotime ⏞
1
⏟500 0
⏟500 1
⏟300 … 0
⏟500 n=10
⏟ ,⏞
0
⏟200 1⏟300 1
⏟300 … 0⏟500 n=20
⏟
Slot1 Slot2 Slot3 Slot10 | Slot1 Slot2 Slot3 Slot10
Repetitions Repetitions
Note
Only one DOUT can be set at a time.
Note
If the DOUT state is reset via an SMS command, they can only be reactivated after the deactivation
conditions are met.