Events

Owned by Maximilian Loy
Last updated: Jun 10, 2024 by Oliver Dutta
2 min read

Currently there are 8 categories of events generated by the platform:

  • Alarm (alarm)

  • Command Result (commandResult)

  • Geofence (geofenceEnter, geofenceExit)

  • Ignition (ignitionOn, ignitionOff)

  • Maintenance (maintenance)

  • Motion (deviceMoving, deviceStopped)

  • Overspeed (deviceOverspeed)

  • Status (deviceOnline, deviceOffline)

To forward those events to your own system / backend see BikeTrax API | Webhook Integration

Alarm

This type of event generated when a new position contains the alarm attribute. The device emits these alarms when it has been armed.

Command Result

Answers on commands (like arm / disarm) are stored in the result attribute. The platform generates this type of event if the position contains the result attribute.

Geofence

Generated when device enters or exits a geofence.

Ignition

BikeTrax devices can report the ignition status, which is the external power supply. When the bike is switched on, power for BikeTrax is switched on too and the “Ignition ON” event is generated (previous position contained attribute ignition false, current position contains attribute ignition true).
Ignition OFF Event is triggered if previous position contained attribute ignition true and current position contains attribute ignition false.

Maintenance

Our platform can help control maintenance intervals of devices. There are two attributes to configure: maintenance.start and maintenance.interval. They can be set in device or group attributes.

The maintenance event is generated every time totalDistance attribute gets over maintenance.start + maintenance.interval * N value where N is a natural number.

Example:

maintenance.start=6000000, maintenance.interval=8000000
Events will be generated when totalDistance goes over 6000 km, 14000 km, 22000 km and so on.

Motion

This event is generated if device started or stopped moving. If the reported speed is more than 2km/h BikeTrax is considered moving, and if speed is less than that BikeTrax is considered to have stopped.

Currently, if there is no ignition status because there is no external power supply or the supply is not turned on, then there will be several stops recorded during a given bike ride.

Overspeed

The server generates this event if device exceeds the configured speed limit. Speed limit value can be set via the device or group attribute speedLimit.

Status

The server generates this event type when device status changes (online/offline/unknown). Online means that BikeTrax is connected to the server and sending reports. Offline means that BikeTrax is not connected to the server, or did not send anything in the past 3 minutes.