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

Data Structures

struct  BleCyclingPowerServiceMeasurement
 
union  BleCyclingPowerServiceMeasurementFlags
 

Macros

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_ACCUMULATED_ENERGY   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_ACCUMULATED_TORQUE   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_BOTTOM_DEAD_SPOT_ANGLE   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_CRANK_REVOLUTION_DATA   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_ANGLES   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_FORCE_MAGNITUDES   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_TORQUE_MAGNITUDES   0
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_PEDAL_POWER_BALANCE   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_SENSORLOCATION   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_TOP_DEAD_SPOT_ANGLE   1
 
#define BLE_CYCLINGPOWERSERVICE_SUPPORT_WHEEL_REVOLUTION_DATA   1
 
#define BLE_SUPPORT_CYCLINGPOWER_SERVICE   0
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDENERGYMEASUREMENT   (0x0800u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDTORQUEMEASUREMENT   (0x0004u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDTORQUESOURCEMEASUREMENT   (0x0008u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_BOTTOMDEADSPOTANGLEMEASUREMENT   (0x0400u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_CRANKREVOLUTIONDATAMEASUREMENT   (0x0020u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMANGLESMEASUREMENT   (0x0100u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMEFORCEMAGNITUDESMEASUREMENT   (0x0040u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMETORQUEMAGNITUDESMEASUREMENT   (0x0080u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_OFFSETCOMPENSATIONMEASUREMENT   (0x1000u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_PEDALPOWERBALANCEMEASUREMENT   (0x0001u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_PEDALPOWERBALANCEREFERENCEMEASUREMENT   (0x0002u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_TOPDEADSPOTANGLEMEASUREMENT   (0x0200u)
 
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_WHEELREVOLUTIONDATAMEASUREMENT   (0x0010u)
 
#define BLECYCLINGPOWERSERVICE_EVENT_CUMULATIVEWHEELVALUEUPDATED   0xAB
 
#define BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONSUPPORTED   0xAD
 
#define BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONUPDATED   0xAC
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_CHAINSTAY   11
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_CHEST   14
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_FRONTHUB   9
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_FRONTWHEEL   4
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_HIP   3
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_INSHOE   2
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_LEFTCRANK   5
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_LEFTPEDAL   7
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_OTHER   0
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARDROPOUT   10
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARHUB   13
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARWHEEL   12
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_RIGHTCRANK   6
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_RIGHTPEDAL   8
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_TOPOFSHOE   1
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_CHAINSTAY   (0x0800u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_CHEST   (0x4000u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_FRONTHUB   (0x0200u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_FRONTWHEEL   (0x0010u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_HIP   (0x0008u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_INSHOE   (0x0004u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_LEFTCRANK   (0x0020u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_LEFTPEDAL   (0x0080u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_OTHER   (0x0001u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARDROPOUT   (0x0400u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARHUB   (0x2000u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARWHEEL   (0x1000u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_RIGHTCRANK   (0x0040u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_RIGHTPEDAL   (0x0100u)
 
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_TOPOFSHOE   (0x0002u)
 
#define BLEINFOTYPE_CYCLINGPOWERESERVICE_CONTROLPOINT_CLIENTCONFIG   0xAB
 
#define BLEINFOTYPE_CYCLINGPOWERSERVICE_MEASUREMENT_CLIENTCONFIG   0xAA
 

Typedefs

typedef void(* BleCyclingPowerServiceCallBack )(BleCyclingPowerServiceEvent event, BleStatus status, void *parms)
 
typedef U8 BleCyclingPowerServiceEvent
 
typedef U16 BleCyclingPowerServiceFlags
 
typedef U8 BleCyclingPowerServiceSensorLocation
 
typedef U16 BleCyclingPowerServiceSensorLocationSupported
 

Macro Definition Documentation

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_ACCUMULATED_ENERGY   1

BLE_CYCLINGPOWERESERVICE_SUPPORT_ACCUMULATED_ENERGY Define if the the CYCLING POWER Sensor supports (1) or not (0) to set the Accumulated Energy values in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_ACCUMULATED_TORQUE   1

BLE_CYCLINGPOWERESERVICE_SUPPORT ACCUMULATED TORQUE SOURCE Define if the the CYCLING POWER Sensor supports (1) or not (0) to set the Accumulated Torque Source values in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_BOTTOM_DEAD_SPOT_ANGLE   1

BLE_CYCLINGPOWERESERVICE_SUPPORT_BOTTOM_DEAD_SPOT_ANGLE Define if the the CYCLING POWER Sensor supports (1) or not (0) to set the Top Dead Spot Angle values in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_CRANK_REVOLUTION_DATA   1

BLE_CYCLINGPOWERSERVICE_SUPPORT_CRANK_REVOLUTION_DATA Define if the the CYCLINGPOWER Sensor supports (1) or not (0) to set the Crank Revolution Data value in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_ANGLES   1

A server can not support simultaneous Extreme Torque and Extreme Force.

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_FORCE_MAGNITUDES   1

BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_FORCE_MAGNITUDES Define if the the CYCLINGPOWER Sensor supports (1) or not (0) to set the Extreme Force Magnitude value in a measurement. A server can not support simultaneous Extreme Torque and Extreme Force. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_TORQUE_MAGNITUDES   0

BLE_CYCLINGPOWERSERVICE_SUPPORT_EXTREME_TORQUE_MAGNITUDES Define if the the CYCLINGPOWER Sensor supports (1) or not (0) to set the Extreme Torque Magnitudes value in a measurement. A server can not support simultaneous Extreme Torque and Extreme Force. So : The default value is not supported (0)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_PEDAL_POWER_BALANCE   1

BLE_CYCLINGPOWERESERVICE_SUPPORT_SUPPORT_PEDAL_POWER_BALANCE Define if the the CYCLING POWER Sensor supports (1) or not (0) to set the Pedal Power Balance values in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_SENSORLOCATION   1

BLE_CYCLINGPOWERSERVICE_SUPPORT_SENSORLOCATION The Sensor Location of the device is used to describe the intended location of the sensor location measurement for the device. The value of the Sensor Location characteristic is static while in a connection.

If BLE_CYCLINGPOWER_SUPPORT_SENSORLOCATION is enabled (1), the BLECYCLINGPOWERSERVICE_SetCyclingPowerSensorLocation API will be enabled to allow the application to change the location when not connected.

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

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_TOP_DEAD_SPOT_ANGLE   1

BLE_CYCLINGPOWERESERVICE_SUPPORT_TOP_DEAD_SPOT_ANGLE Define if the the CYCLING POWER Sensor supports (1) or not (0) to set the Top Dead Spot Angle values in a measurement. The default value is supported (1)

#define BLE_CYCLINGPOWERSERVICE_SUPPORT_WHEEL_REVOLUTION_DATA   1

BLE_CYCLINGPOWERSERVICE_SUPPORT_WHEEL_REVOLUTION_DATA Define if the the CYCLINGPOWER Sensor supports (1) or not (0) to set the Wheel Revolution Data values in a measurement. The default value is supported (1)

#define BLE_SUPPORT_CYCLINGPOWER_SERVICE   0

BLE_SUPPORT_CYCLINGPOWER_SERVICE Defines if the BLE local device enables access to the local CYCLING POWER service and characteristic.

If enabled ( set to 1 ) it enables Profiles or directly an Application to get access to the CYCLING POWER Service and characteristic

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

#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDENERGYMEASUREMENT   (0x0800u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDTORQUEMEASUREMENT   (0x0004u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_ACCUMULATEDTORQUESOURCEMEASUREMENT   (0x0008u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_BOTTOMDEADSPOTANGLEMEASUREMENT   (0x0400u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_CRANKREVOLUTIONDATAMEASUREMENT   (0x0020u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMANGLESMEASUREMENT   (0x0100u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMEFORCEMAGNITUDESMEASUREMENT   (0x0040u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_EXTREMETORQUEMAGNITUDESMEASUREMENT   (0x0080u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_OFFSETCOMPENSATIONMEASUREMENT   (0x1000u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_PEDALPOWERBALANCEMEASUREMENT   (0x0001u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_PEDALPOWERBALANCEREFERENCEMEASUREMENT   (0x0002u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_TOPDEADSPOTANGLEMEASUREMENT   (0x0200u)
#define BLECYCLINGPOWERPSERVICE_FLAGBITMASK_WHEELREVOLUTIONDATAMEASUREMENT   (0x0010u)
#define BLECYCLINGPOWERSERVICE_EVENT_CUMULATIVEWHEELVALUEUPDATED   0xAB

BLECYCLINGPOWERSERVICE_EVENT_CUMULATIVEWHEELVALUEUPDATED Event received when a Collector has a new Cumulative Value for the cumulative wheel revolution. The Status field is always BLESTATUS_SUCCESS The parms field indicates the new cumulative value as a U32 U32 cumulativeWheelRevolution = *((U32 *) parms). NOTE : The Sensor shall apply/set the new cumulative value when receiving this event. This event is only applicable when BLE_CYCLINGPOWERSERVICE_SUPPORT_WHEEL_REVOLUTION_DATA is supported

#define BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONSUPPORTED   0xAD

BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONSUPPORTED Event received when a Collector would like to request the application to get the list of sensor location supported.

The status field is always BLESTATUS_SUCCESS Only received if the feauture MULTIPLE SENSOR LOCATIONS is supported

#define BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONUPDATED   0xAC

BLECYCLINGPOWERSERVICE_EVENT_SENSORLOCATIONUPDATED Event received when a Collector has a new Sensor Location Value for the sensor location in Cycling Power Sensor. The Status field is always BLESTATUS_SUCCESS The parms field indicates the new sensor location value as a U8 NOTE : The Sensor shall apply/set the new sensor location value when receiving this event in the database. This event is only applicable when the feature MULTIPLE SENSOR LOCATIONS is supported

#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_CHAINSTAY   11
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_CHEST   14
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_FRONTHUB   9
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_FRONTWHEEL   4
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_HIP   3
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_INSHOE   2
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_LEFTCRANK   5
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_LEFTPEDAL   7
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_OTHER   0
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARDROPOUT   10
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARHUB   13
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_REARWHEEL   12
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_RIGHTCRANK   6
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_RIGHTPEDAL   8
#define BLECYCLINGPOWERSERVICE_SENSORLOCATION_TOPOFSHOE   1
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_CHAINSTAY   (0x0800u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_CHEST   (0x4000u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_FRONTHUB   (0x0200u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_FRONTWHEEL   (0x0010u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_HIP   (0x0008u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_INSHOE   (0x0004u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_LEFTCRANK   (0x0020u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_LEFTPEDAL   (0x0080u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_OTHER   (0x0001u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARDROPOUT   (0x0400u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARHUB   (0x2000u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_REARWHEEL   (0x1000u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_RIGHTCRANK   (0x0040u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_RIGHTPEDAL   (0x0100u)
#define BLECYCLINGPOWERSERVICE_SENSORLOCATIONSUPPORTED_TOPOFSHOE   (0x0002u)
#define BLEINFOTYPE_CYCLINGPOWERESERVICE_CONTROLPOINT_CLIENTCONFIG   0xAB
#define BLEINFOTYPE_CYCLINGPOWERSERVICE_MEASUREMENT_CLIENTCONFIG   0xAA

Typedef Documentation

typedef void(* BleCyclingPowerServiceCallBack)(BleCyclingPowerServiceEvent event, BleStatus status, void *parms)

BleCyclingPowerServiceCallBack This callback receives the CYCLING POWER events. Each events may be assiociated with specified status and parameters. The callback is executed during the stack context, be careful to not doing heavy process in this function.

BleCyclingPowerServiceEvent type Define the different kind of events that could be received by the BleCyclingPowerServiceCallBack

BleCyclingPowerServiceFlags type Bitfield defining the available flags values.

BleCyclingPowerServiceSensorLocation type Define different emplacement of Sensor Location

The BleCyclingPowerServiceSensorLocationSupported type Define the different emplacement of Sensor Location could be supported by Cycling Power Sensor. It can be stocked in the list of sensor location supported


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