XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs
BleLocationAndNavigation_Service.h File Reference
#include "bleTypes.h"
+ Include dependency graph for BleLocationAndNavigation_Service.h:

Data Structures

struct  BleLocationAndNavigationServiceLocationAndSpeed
 
union  LocationAndSpeedFlags
 

Macros

#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_INSTANTANEOUS_SPEED   0
 
#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION   0
 
#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_REMAINING_DISTANCE   0
 
#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_TOTAL_DISTANCE   0
 
#define BLE_SUPPORT_LOCATIONANDNAVIGATION_SERVICE   0
 
#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_CONTROLPOINT_CLIENTCONFIG   (0xC2u)
 
#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_LOCATIONANDSPEED_CLIENTCONFIG   (0xC0u)
 
#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_NAVIGATION_CLIENTCONFIG   (0xC1u)
 
#define BLELNSSERVICE_FLAGBITMASK_DESTINATIONREACHED   (0x0100u)
 
#define BLELNSSERVICE_FLAGBITMASK_HEADINGSOURCE   (0x0020u)
 
#define BLELNSSERVICE_FLAGBITMASK_INSTANTANEOUSSPEEDPRESENT   (0x0001u)
 
#define BLELNSSERVICE_FLAGBITMASK_NAVIGATION_POSITIONSTATUS   (0x0018u)
 
#define BLELNSSERVICE_FLAGBITMASK_NAVIGATIONINDICATORTYPE   (0x0040u)
 
#define BLELNSSERVICE_FLAGBITMASK_REMAININGDISTANCEPRESENT   (0x0001u)
 
#define BLELNSSERVICE_FLAGBITMASK_SPEEDANDDISTANCEFORMAT   (0x0200u)
 
#define BLELNSSERVICE_FLAGBITMASK_TOTALDISTANCEPRESENT   (0x0002u)
 
#define BLELNSSERVICE_FLAGBITMASK_WAYPOINTREACHED   (0x0080u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_CONTINUENAVIGATION   0x79
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_PAUSENAVIGATION   0x78
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SELECTROUTE   0x7C
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SKIPWAYPOINT   0x7A
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNAVIGATION   0x77
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNOTIFICATION   0x7B
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STOPNAVIGATION   0x76
 
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_TOTALDISTANCEUPDATED   0x75
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_CONTINUENAVIGATION   (0x03u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_PAUSENAVIGATION   (0x02u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_SKIPWAYPOINT   (0x04u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STARTNAVIGATION   (0x01u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STARTNOTIFICATION   (0x05u)
 
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STOPNAVIGATION   (0x00u)
 

Typedefs

typedef void(* BleLocationAndNavigationServiceCallBack )(BleLocationAndNavigationServiceEvent event, BleStatus status, void *parms)
 
typedef U8 BleLocationAndNavigationServiceControlNavigation
 
typedef U8 BleLocationAndNavigationServiceEvent
 
typedef U16 BleLocationAndNavigationServiceLocationAndSpeedFlags
 
typedef U16 BleLocationAndNavigationServiceNavigationFlags
 

Macro Definition Documentation

#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_INSTANTANEOUS_SPEED   0

BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_INSTANTANEOUS_SPEED Define if the LNS Sensor supports (1) or not (0) to set the instantaneous speed value in location and speed. The default value is not supported (0)

#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION   0

BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION Define if the LNS Sensor supports (1) or not (0) the navigation. The default value is not supported (0)

#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_REMAINING_DISTANCE   0

BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_REMAINING_DISTANCE Define if the LNS Sensor supports (1) or not (0) to set the remaining distance value in navigation. The default value is not supported (0)

#define BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_TOTAL_DISTANCE   0

BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_TOTAL_DISTANCE Define if the LNS Sensor supports (1) or not (0) to set the total Distance value in location and speed. The default value is not supported (0)

#define BLE_SUPPORT_LOCATIONANDNAVIGATION_SERVICE   0

BLE_SUPPORT_LOCATIONANDNAVIGATION_SERVICE Defines if the BLE local device enables access to the local LOCATION AND NAVIGATION service and characteristic.

If enabled ( set to 1 ) it enables Profiles to get access to the LOCATION AND NAVIGATION Service and characteristic

The default value for this option is disabled (0).

#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_CONTROLPOINT_CLIENTCONFIG   (0xC2u)
#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_LOCATIONANDSPEED_CLIENTCONFIG   (0xC0u)

BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_CLIENTCONFIG Unique descriptors ID for information to save in persistent memory representing the client config for a given remote bonded device and configured location and speed and navigation. It is the Unique identifier passed in the infotype fields when the PROFILE call the system APIs SYSTEM_SetPersistentInformation(BD_ADDR addr, U8 infoType, U8* infoValue,U8 InfoLen) and SYSTEM_GetPersistentInformation(BD_ADDR addr, U8 infoType, U8 **infoValue, U8 *InfoLen).

#define BLEINFOTYPE_LOCATIONANDNAVIGATIONSERVICE_NAVIGATION_CLIENTCONFIG   (0xC1u)
#define BLELNSSERVICE_FLAGBITMASK_DESTINATIONREACHED   (0x0100u)
#define BLELNSSERVICE_FLAGBITMASK_HEADINGSOURCE   (0x0020u)
#define BLELNSSERVICE_FLAGBITMASK_INSTANTANEOUSSPEEDPRESENT   (0x0001u)
#define BLELNSSERVICE_FLAGBITMASK_NAVIGATION_POSITIONSTATUS   (0x0018u)
#define BLELNSSERVICE_FLAGBITMASK_NAVIGATIONINDICATORTYPE   (0x0040u)
#define BLELNSSERVICE_FLAGBITMASK_REMAININGDISTANCEPRESENT   (0x0001u)
#define BLELNSSERVICE_FLAGBITMASK_SPEEDANDDISTANCEFORMAT   (0x0200u)
#define BLELNSSERVICE_FLAGBITMASK_TOTALDISTANCEPRESENT   (0x0002u)
#define BLELNSSERVICE_FLAGBITMASK_WAYPOINTREACHED   (0x0080u)
#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_CONTINUENAVIGATION   0x79

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_CONTINUENAVIGATION Event received when a COLLECTOR has sent a command to continue navigation and notifications of the navigation feature via the navigation control from the nearest waypoint. The Status field is always BLESTATUS_SUCCESS The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_PAUSENAVIGATION   0x78

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_PAUSENAVIGATION Event received when a COLLECTOR has sent a command to pause navigation and notifications of the navigation feature via the navigation control. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SELECTROUTE   0x7C

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SELECTROUTE Event received when a COLLECTOR has sent a command to select a route he wants to navigate via the navigation control. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SKIPWAYPOINT   0x7A

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_SKIPWAYPOINT Event received when a COLLECTOR has sent a command to skip a waypoint via the navigation control. It does not affect notifications. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNAVIGATION   0x77

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNAVIGATION Event received when a COLLECTOR has sent a command to start navigation and notifications of the navigation feature via the navigation control. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNOTIFICATION   0x7B

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STARTNOTIFICATION Event received when a COLLECTOR has sent a command to start notifications of the navigation feature via the navigation control from the nearest waypoint. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STOPNAVIGATION   0x76

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_STOPNAVIGATION Event received when a COLLECTOR has sent a command to stop navigation and notifications of the navigation feature via the navigation control. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the command specified of the navigation control. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_NAVIGATION is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_EVENT_TOTALDISTANCEUPDATED   0x75

BLELOCATIONANDNAVIGATIONSERVICE_EVENT_TOTALDISTANCEUPDATED Event received when a COLLECTOR has Set a new Cumulative Value for the total distance. The Status field is always BLESTATUS_SUCCESS. The parms field indicates the total distance value as a U32. U32 totalDistance = *((U32 *) parms). NOTE : The SENSOR shall apply/set the new Total Distance Value when receiving this event. This event is only applicable when BLE_LOCATIONANDNAVIGATIONSERVICE_SUPPORT_TOTAL_DISTANCE is supported.

#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_CONTINUENAVIGATION   (0x03u)
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_PAUSENAVIGATION   (0x02u)
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_SKIPWAYPOINT   (0x04u)
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STARTNAVIGATION   (0x01u)
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STARTNOTIFICATION   (0x05u)
#define BLELOCATIONANDNAVIGATIONSERVICE_NAVIGATIONCONTROL_STOPNAVIGATION   (0x00u)

Typedef Documentation

typedef void(* BleLocationAndNavigationServiceCallBack)(BleLocationAndNavigationServiceEvent event, BleStatus status, void *parms)

BleLocationAndNavigationServiceCallBack This callback receives the LOCATION AND NAVIGATION SERVICE events. Each events may be associated with specified parameters. The callback is executed during the stack context, be careful to not do heavy process in this function.

BleLocationAndNavigationServiceControlNavigation type Navigation control procedures in parameter of the LN Control Point

BleLocationAndNavigationServiceEvent type Define the different kind of events that could be received by the BleLocationAndNavigationServiceCallback

BleLocationAndNavigationServiceLocationAndSpeedFlags type Bitfield defining the available location and speed flags values.

BleLocationAndNavigationServiceNavigationFlags type Bitfield defining the available navigation flags values.


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:41 by doxygen 1.8.8