Contact us Login LIVE DEMO FREE TRIAL

rule/

A rule element consists of following fields:

{
"id": ${int},
"name": ${string},
"description": ${string},
"zone_id": ${int},
"trackers": [ ${int}, ... ], // list of tracker ids
"type": ${string},
"primary_text": ${string},
"secondary_text": ${string},
"param": ${int}, // common parameter
"alerts": {
"sms_phones": [ ${string}, ... ],
"phones": [ ${string}, ... ], // phones for voice calls
"emails": [ ${string}, ... ],
"push_enabled": ${boolean}
},
"suspended": ${boolean},
"schedule": [ ${schedule_interval}, ... ],
"extended_params": ${extended_params}, // optional. object specified for concrete rule type
"auto_created": ${boolean} // optional
}

where

  • type is one of pre-defined types of rules

    Type Triggered by event
    alarmcontrol Car alarm triggered
    antenna_disconnect GPS antenna cut
    autocontrol Autocontrol related rules
    backup_battery_low Backup built-in battery low
    battery_off External power cut
    bracelet Bracelet sensor
    call_button_pressed Call button pressed
    case_intrusion Case intrusion
    crash_alarm Car crash
    detach Tracker detach from the object
    door_alarm Door opening in alarm mode
    driver_change Driver change
    driver_identification Driver identification
    g_sensor Shock sensor
    gps_lost_recover GNSS signal lost/recover
    gsm_damp GSM signal damp
    harsh_driving Harsh driving
    hood_alarm Hood opening in alarm mode
    idling Excessive engine idling
    ignition Ignition ON/OFF
    inoutzone Entrance or exit from geofence
    input_change Inputs triggering
    light_sensor Light sensor
    location_response Location report on demand
    locking_unlocking Lock is opened/closed
    lowpower Low built-in battery
    obd_plug_unplug Connecting/Disconnecting with vehicle through OBDII interface
    offline Tracker switched OFF or lost connection
    on_off Tracker switch ON/OFF
    output_change Outputs triggering
    parking Unauthorized movement
    poweron Tracker switched ON
    route Deviation from the route
    security_control Alarm mode ON/OFF
    sensor_range Parameter in range
    sos Alarm (SOS) button pressed
    speedup Speed exceeding
    strap_bolt Strap (bolt) is cut/inserted
    task_status_change Task status change
    track_change Parking state detection
    vibration Vibration sensor
    work_status_change Change of status
  • schedule_interval is one of:
    • weekly_schedule_interval
      {
      "type": "weekly",
      "from": ${weekday_time},
      "to": ${weekday_time},
      "interval_id": ${int}
      }
      
    • fixed_schedule_interval
      {
      "type": "weekly",
      "from": ${date/time},
      "to": ${date/time},
      "interval_id": ${int}
      }
      

    Where weekday_time is:

    {
    "weekday": ${int}, // from 1 to 7
    "time": ${local_time} // for example: "01:00:00"
    }
    
  • extended_params for
    • any rule can include following fields
      {
      "zone_limit_inverted": ${boolean} // optional
      }
      
    • type=”autocontrol”
      Map of subrules settings.

      {
      "alarmcontrol": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true,
          "always_notify": false
      },
      "battery_off": {
          "enabled": true,
          "sms": true,
          "call": false,
          "email": true,
          "push": true
      },
      "door_alarm": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      },
      "hood_alarm": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      },
      "ignition": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      },
      "parking": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      },
      "gsm_damp": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      },
      "security_control": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true
      }
      }
      
    • sensor_range
      {
      "sensor_id": 123,
      "min": 1.0, // (double) optional. null means negative infinity
      "max": 3.0, // (double) optional. null means positive infinity
      "threshold": 0.03 // (double) optional
      }
      
  • date/time and local_time types are described at custom types description.

If you have more questions please contact our support team

Contacts

USA: +1 858 815 9045

Mexico: +52 334 1642158

UK: +44 808 1641499

Germany: +49 1573 5988250

Russia: +7 495 223 0427

Log in

Login

[clean-login]

CLOSE
Register

[clean-login-register]

CLOSE
Loading...