Developer World
Spresense SDK Library v3.2.0-ebc0364
GEOFENCE
Collaboration diagram for GEOFENCE:

Modules

 IOCTL commands
 
 Defines
 

Macros

#define CXD56_GEOFENCE_IOCTL_START   1
 
#define CXD56_GEOFENCE_IOCTL_STOP   2
 
#define CXD56_GEOFENCE_IOCTL_ADD   3
 
#define CXD56_GEOFENCE_IOCTL_MODIFY   4
 
#define CXD56_GEOFENCE_IOCTL_DELETE   5
 
#define CXD56_GEOFENCE_IOCTL_ALL_DELETE   6
 
#define CXD56_GEOFENCE_IOCTL_GET_REGION_DATA   7
 
#define CXD56_GEOFENCE_IOCTL_GET_USED_ID   8
 
#define CXD56_GEOFENCE_IOCTL_GET_ALL_STATUS   9
 
#define CXD56_GEOFENCE_IOCTL_SET_MODE   10
 
#define CXD56_GEOFENCE_IOCTL_INVAL   0
 
#define CXD56_GEOFENCE_IOCTL_MAX   11
 

Detailed Description

Macro Definition Documentation

◆ CXD56_GEOFENCE_IOCTL_START

#define CXD56_GEOFENCE_IOCTL_START   1

Start geofence monitoring.
This command is used to start the geofence monitoring.

Parameters
argParameter is Unnecessary. Set Zero.

◆ CXD56_GEOFENCE_IOCTL_STOP

#define CXD56_GEOFENCE_IOCTL_STOP   2

Stop geofence monitoring.
This command is used to stop the geofence monitoring.

Parameters
argParameter is Unnecessary. Set Zero.

◆ CXD56_GEOFENCE_IOCTL_ADD

#define CXD56_GEOFENCE_IOCTL_ADD   3

Add region. This command is used to add the region.

Parameters
argParameter is struct cxd56_geofence_region_s.

◆ CXD56_GEOFENCE_IOCTL_MODIFY

#define CXD56_GEOFENCE_IOCTL_MODIFY   4

Modify region. This command is used to modify the region.

Parameters
argParameter is struct cxd56_geofence_region_s.

◆ CXD56_GEOFENCE_IOCTL_DELETE

#define CXD56_GEOFENCE_IOCTL_DELETE   5

Delete region. This command is used to delete the region.

Parameters
argParameter is region id.

◆ CXD56_GEOFENCE_IOCTL_ALL_DELETE

#define CXD56_GEOFENCE_IOCTL_ALL_DELETE   6

Delete all region. This command is used to delete all region.

Parameters
argParameter is Unnecessary. Set Zero.

◆ CXD56_GEOFENCE_IOCTL_GET_REGION_DATA

#define CXD56_GEOFENCE_IOCTL_GET_REGION_DATA   7

Get region data. This command is used to get region data.

Parameters
argParameter is struct cxd56_geofence_region_s pointer Latitude and longitude and radius data of specified id is stored.

◆ CXD56_GEOFENCE_IOCTL_GET_USED_ID

#define CXD56_GEOFENCE_IOCTL_GET_USED_ID   8

Get used id. This command is used to get used region id.

Parameters
argParameter is uint32_t data pointer. The used id is represented by bit field.
For example, when ID0 and ID19 are used, since bit0 and bit19 are set, the return value is 0x00080001.

◆ CXD56_GEOFENCE_IOCTL_GET_ALL_STATUS

#define CXD56_GEOFENCE_IOCTL_GET_ALL_STATUS   9

Get all status. This command is used to get all region status.

Parameters
argParameter is Unnecessary. Set Zero. All region status will stored in next read data.

◆ CXD56_GEOFENCE_IOCTL_SET_MODE

#define CXD56_GEOFENCE_IOCTL_SET_MODE   10

Set goefence operation mode.
This command is used to set operation mode.

Parameters
argParameter is struct cxd56_geofence_mode_s.