update_units

To add, remove, or clear units monitored in the session, use the events/update_units method.

To monitor resources as well as units, use events/update_items. For new integrations, use events/update_items.

The request format depends on the operation mode.

To add specific units to the session, use the following request:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": <long>,
      "detect": {
        "<detector_name>": <long>
      }
    },
    ...
  ],
  "evt_flags": <uint>   /* optional */
}

To remove specific units from the session, use the following request:

svc=events/update_units&params={
  "mode": "remove",
  "units": [
    <long>
  ]
}

To remove all units from the session, use the following request:

svc=events/update_units&params={
  "mode": "clear"
}

The following event detectors can be configured in the detect object. For each detector, specify a filter value that selects the events to monitor: a specific ID or type, or 0 to monitor all events of this detector.

"detect":{"<detector_name>":<filter_value>}

The table lists the detectors available for units. To monitor driver assignments registered on a resource, use the resource_drivers detector with events/update_items and specify a resource ID.

The eco_driving detector isn’t available in Wialon Local.

To add all available event detectors, use:

"detect":{"*":0}

In add mode, only units to which the current user has view access are added. If a listed unit is already monitored, its detector configuration is replaced. Invalid individual detector filter values are ignored.

The evt_flags parameter is stored in the session and controls how event updates are delivered. Its default value is 0.

Combine the detail flags below with 0x200. If no detail flags are specified, the value 0x7 is used (0x1 | 0x2 | 0x4).

For example, evt_flags = 0x207 enables the units_update mode (0x200) with basic event data, detector-specific data, and visible message parameters (0x1 | 0x2 | 0x4 = 0x7).

The following examples show how to set the detect object when adding units to the session.

To monitor events from all ignition sensors and all other sensors of the unit with ID 1001, use one of the following requests:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "ignition": 0,
        "sensors": 0
      }
    }
  ]
}

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "ignition,sensors": 0
      }
    }
  ]
}

To monitor events from the fuel level sensor with ID 2 and another sensor with ID 6, use the following request:

svc=events/update_units&params={
  "mode": "add",
  "units": [
    {
      "id": 1001,
      "detect": {
        "lls": 2,
        "sensors": 6
      }
    }
  ]
}

If the request is completed successfully, the following response is returned:

{
  "units": <uint>   /* total number of units monitored in the session */
}

Otherwise, an error code is returned.