Linux SDK (lite-qmi)  MBPL_SDK_R25_ENG3
pack_loc_GeofenceEditReq_t Struct Reference

#include <loc.h>

Data Fields

uint32_t geofenceId
 
uint32_t transactionId
 
uint32_t * pGeofenceState
 
uint8_t * pBreachMask
 
uint32_t * pResponsiveness
 

Detailed Description

Qmi Loc Edit Geofence Req

Parameters
geofenceId
  • Goefence ID.
    • Identifier for the Geofence to edit..
transactionId
  • Transaction ID.
    • Transaction ID specified in the Edit Geofence request. This parameter is always present when the status field is set to SUCCESS.
pGeofenceState
  • Specifies whether to actively monitor the Geofence.
    • Valid values:
      • eQMI_LOC_GEOFENCE_STATE_ACTIVE (1) - Geofence is being actively monitored
      • eQMI_LOC_GEOFENCE_STATE_SUSPEND (2) - Geofence monitoring is suspended
pBreachMask
  • Breach Event Mask
  • Specifies the breach events in which the client is interested.
    • Valid values:
      • 0x01 - GEOFENCE_BREACH_ENTERING_MASK
      • 0x02 - GEOFENCE_BREACH_LEAVING_MASK
pResponsiveness
  • Responsiveness
  • Specifies the rate of detection for a Geofence breach. This may impact the time lag between the actual breach event and when it is reported.
  • This parameter has power implications and must be fine-tuned to optimize power savings.
    • Valid values:
      • eQMI_LOC_GEOFENCE_RESPONSIVENESS_LOW (0x01) - The Geofence is monitored for a breach at a low rate of 15 minutes. The gap between the actual breach and the time it is reported is higher. This setting results in lower power usage.
      • eQMI_LOC_GEOFENCE_RESPONSIVENESS_MED (0x02) - The Geofence is monitored for a breach at a medium rate of 2 minutes. This is the default setting.
      • eQMI_LOC_GEOFENCE_RESPONSIVENESS_HIGH (0x03) - The Geofence is monitored for a breach at a high rate of 10 seconds. The gap between the actual breach and the time it is reported is low. This results in higher power usage.
      • eQMI_LOC_GEOFENCE_RESPONSIVENESS_ULTRA_HIGH (0x04) - The Geofence is monitored for a breach at a very high rate of 1 second. The gap between the actual breach and the time it is reported is very low. This results in very high power usage. This setting must be avoided whenever possible because of the drastic power implications.
      • eQMI_LOC_GEOFENCE_RESPONSIVENESS_CUSTOM (0x05) - The Geofence is monitored for a breach at a user defined rate. The gap between the actual breach and the time it is reported depends on the user setting. The power implication is inversely proportional to the responsiveness value set by the user. The higher the responsiveness value, the lower the power implications, and vice-versa.

The documentation for this struct was generated from the following file: