#include <loc.h>
|
uint32_t | transactionId |
|
CircularGeofenceArguments_t | circularGeofenceArguments |
|
uint8_t | breachMask |
|
uint8_t | includePosition |
|
uint32_t * | pResponsiveness |
|
uint32_t * | pConfidence |
|
uint32_t * | pCustomResponsivenessValue |
|
uint32_t * | pDwellTime |
|
uint8_t * | pDwellTypeMask |
|
Qmi Loc Add Circular Geofence Req
- Parameters
-
transactionId |
- Transaction ID.
- Identifies the transaction. The transaction ID is returned in the Add Circular Geofence indication.
|
circularGeofenceArguments |
|
breachMask |
- 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
- Parameters
-
includePosition |
- Specifies whether the Geofence engine is to include the position in a breach event.
|
- Valid values:
- 0x01 (TRUE) - Position is reported with the breach event
- 0x00 (FALSE) - Position is not reported with the breach event.
- Parameters
-
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.
|
pConfidence |
- Confidence
- Given a breach event, the confidence determines the probability that the breach happened at the Geofence boundary.
- This parameter has power implications and must be fine-tuned to optimize power savings.
- Valid values:
- eQMI_LOC_GEOFENCE_CONFIDENCE_LOW (0x01) - Geofence engine indicates a breach with low confidence; this setting results in lower power usage, and it can impact the yield because incorrect breach events can be sent
- eQMI_LOC_GEOFENCE_CONFIDENCE_MED (0x02) - (Default) Geofence engine indicates a breach with medium confidence
- eQMI_LOC_GEOFENCE_CONFIDENCE_HIGH (0x03) - Geofence engine indicates a breach with high confidence; this setting results in higher power usage
|
pCustomResponsivenessValue |
- Custom Responsiveness Value
- Specifies in seconds the user-defined rate of detection for a Geofence breach. This may impact the time lag between the actual breach event and when it is reported.
- 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. If this field is set, the responsiveness is always treated as
- eQMI_LOC_GEOFENCE_RESPONSIVENESS_CUSTOM. The minimum value supported in this field is 1 second, and the maximum value is 65535 seconds.
- An error is returned if an attempt is made to set this to an unsupported value. If this field is set, the responsiveness is always treated as
- eQMI_LOC_GEOFENCE_RESPONSIVENESS_CUSTOM, which means that the other responsiveness types, such as eQMI_LOC_GEOFENCE_RESPONSIVENESS_LOW,
- eQMI_LOC_GEOFENCE_RESPONSIVENESS_MEDIUM, eQMI_LOC_GEOFENCE_RESPONSIVENESS_HIGH, and eQMI_LOC_GEOFENCE_RESPONSIVENESS_ULTRA_HIGH are all disregarded.
- If this field is not set, the responsiveness is treated as eQMI_LOC_GEOFENCE_RESPONSIVENESS_LOW, eQMI_LOC_GEOFENCE_RESPONSIVENESS_MEDIUM,
- eQMI_LOC_GEOFENCE_RESPONSIVENESS_HIGH, or eQMI_LOC_GEOFENCE_RESPONSIVENESS_ULTRA_HIGH.
|
pDwellTime |
- Dwell Time of Geofence
- Dwell time is the time in seconds a user spends in the Geofence before a dwell event is sent.
|
pDwellTypeMask |
- Type of dwell event in which the user is interested.
- Valid values:
- QMI_LOC_GEOFENCE_DWELL_TYPE_INSIDE_MASK (0x01) - If this mask is set, a dwell event is reported when a user dwells inside the Geofence for a specified time
- QMI_LOC_GEOFENCE_DWELL_TYPE_OUTSIDE_MASK (0x02) - If this mask is set, a dwell event is reported when a user dwells outside the Geofence for a specified time
|
The documentation for this struct was generated from the following file: