Immobilise assets via the API - 0x0100
Table of Contents
Before you start
Ensure you have reviewed:
A full list of API calls can be found at: https://api.oemserver.com/swagger/index.html.
Description
This can be used to immobilise an vehicle.
It operates by toggling any device digital ouptuts with function configured as Immobiliser. When the output is connected to control an automotive relay, the starter motor is cut.
Ensure that you follow the setup instructions below.
-
Immobilise asset from the server
- This wiring config is typical for when we are only using ‘server based’ immobilisation (command from server disables asset)
- This wiring config is typical for when we are only using ‘server based’ immobilisation (command from server disables asset)
-
Immobiliser Install - Asset starts after valid Driver ID Scan
- This wiring config is typical for setups where the asset will not start until a Driver ID tag is scanned.
- However, sending a command from the server will also disable the asset - such that even a valid tag will not start the vehicle.
Payload
Offset |
Length |
Data Type |
Description |
0 |
1 |
BYTE |
The data message has 2 bits.
Bit 0 (immobilisation): True = immobiliser on. This is the logical level – physical levels
Bit 1 (Override) True = override on. This locks the Bit 0 state and unlocking 0 = default, immobiliser off 1 = default, immobiliser on 2 = override, immobiliser off 3 = override, immobiliser on |
cURL Example
curl -X 'POST' \
'https://api.oemserver.com/v1/AsyncMessaging/Send?serial=439705' \
-H 'accept: text/plain' \
-H 'Authorization: Basic XXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{
"MessageType": 256,
"CANAddress": 4294967295,
"ExpiryDateUTC": "2025-03-29T23:27:48.558Z",
"Data": [1]
}'
Determining Immobilisation Status
We can determine if our message has been actioned and the current status in the following ways:
-
Field ID 2 – Digital Data
We can simply check the status of the Digital Output we have set up with function Immobiliser in the next message(s) up from the device.
-
Log Reason 38 (Immobiliser On) and 39 (Immobiliser Off)
The device will generate these logs when immobilisation is turned on or off.