Contact us LoginLIVE DEMOFREE 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
    TypeTriggered by event
    alarmcontrolCar alarm triggered
    antenna_disconnectGPS antenna cut
    autocontrolAutocontrol related rules
    backup_battery_lowBackup built-in battery low
    battery_offExternal power cut
    braceletBracelet sensor
    call_button_pressedCall button pressed
    case_intrusionCase intrusion
    crash_alarmCar crash
    detachTracker detach from the object
    door_alarmDoor opening in alarm mode
    driver_assistanceWarnings from driver-assistance systems (ADAS)
    driver_changeDriver change
    driver_identificationDriver identification
    g_sensorShock sensor
    gps_lost_recoverGNSS signal lost/recover
    gsm_dampGSM signal damp
    harsh_drivingHarsh driving
    hood_alarmHood opening in alarm mode
    idlingExcessive engine idling
    ignitionIgnition ON/OFF
    inoutzoneEntrance or exit from geofence
    input_changeInputs triggering
    light_sensorLight sensor
    location_responseLocation report on demand
    locking_unlockingLock is opened/closed
    lowpowerLow built-in battery
    obd_plug_unplugConnecting/Disconnecting with vehicle through OBDII interface
    offlineTracker switched OFF or lost connection
    on_offTracker switch ON/OFF
    output_changeOutputs triggering
    parkingUnauthorized movement
    poweronTracker switched ON
    routeDeviation from the route
    security_controlAlarm mode ON/OFF
    sensor_rangeParameter in range
    sosAlarm (SOS) button pressed
    speedupSpeed exceeding
    strap_boltStrap (bolt) is cut/inserted
    task_status_changeTask status change
    track_changeParking state detection
    vibrationVibration sensor
    work_status_changeChange of status
    fuel_level_leapFuel level change
    idling_softEngine excessive idling (software)
  • 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"
    }
    
  • param for
    • input_change – input number
    • output_change – output number
    • idling_soft – time threshold, minutes
    • offline – time threshold, minutes
    • speedup – speed threshold, kmh
  • 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
      }
      }
      
    • type=”driver_assistance”
      {
       "forward_collision_enable" : ${boolean}, // enable/disable notifications about forward collision warnings
       "headway_warning_enabled" :  ${boolean}, // notifications about headway warnings
       "lane_departure_enabled" : ${boolean} // notifications about lane departures
      }
    • type=”fuel_level_leap”
      {
         "sensor_id": 123
      }
    • type=”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
      }
      
    • type=”route”
      {
         "allow_exit_at_endpoints": ${boolean} // optional, disable notifications for deviations at start and end points
      }
  • 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 225 46 88

Mexico: +52 558 526 11 25

UK: +44 203 807 64 62

Russia: +7 495 128 35 56

We use сookies to improve our website, products and related services, analyze site traffic, and serve targeted advertisements. If you continue to use our services, you consent to our use of сookies. Read more

Log in