Contact Us

    If you still have questions or prefer to get help directly from an agent, please submit a request.
    We’ll get back to you as soon as possible.

    Please fill out the contact form below and we will reply as soon as possible.

    • Digital Matter Site
    • Contact Us

    Immobilise assets via the API - 0x0100

    Written by Iman Kareem

    Updated at March 27th, 2025

      Contact Us

      If you still have questions or prefer to get help directly from an agent, please submit a request.
      We’ll get back to you as soon as possible.

      Contact Support
      • Home
      • Device Manager
      • Device Manager API
      • Device Control - Asynchronous Messages

      Table of Contents

      Before you start Description Payload cURL Example

      Before you start

      Ensure you have reviewed:

      • Welcome to the Device Manager API
      • Device Manager ASYNC Messaging Architecture

      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) 
           
      • 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
      (active high/low) are determined by system parameters.

       

      Bit 1 (Override)

      True = override on. This locks the Bit 0 state and unlocking 
      immobilisation via Driver Id is ignored. 

      Examples:

      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:

      1. 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.

      1. Log Reason 38 (Immobiliser On) and 39 (Immobiliser Off)

      The device will generate these logs when immobilisation is turned on or off. 

      api integration lock assets

      Was this article helpful?

      Yes
      No
      Give feedback about this article

      Related Articles

      • Bolt2 - Getting Started
      • Hawk - Under Voltage Lockout
      • Hawk - Configure MaxBotix MB7040 I²C Ultrasonic Range Sensor

      Subscribe to Partner News

      Subscribe to our mailing list to receive Digital Matter news, product and tehnical updates, and more.

      Subscribe

      Copyright © Digital Matter . All Rights Reserved.

      Privacy Contact Support

      Knowledge Base Software powered by Helpjuice

      DM Logo
      Expand