Gymtrack / nRF51822_1

SG RFID nRF51822 fork

Fork of nRF51822 by Nordic Semiconductor

Embed: (wiki syntax)

« Back to documentation index

Running Speed and Cadence Service
Data Structures | Typedefs | Enumerations | Functions

Running Speed and Cadence Service

Running Speed and Cadence Service module. More...

Data Structures

struct  ble_rscs_evt_t
 Running Speed and Cadence Service event. More...
struct  ble_rscs_init_t
 Running Speed and Cadence Service init structure. More...
struct  ble_rscs_s
 Running Speed and Cadence Service structure. More...
struct  ble_rscs_meas_s
 Running Speed and Cadence Service measurement structure. More...

Typedefs

typedef struct ble_rscs_s ble_rscs_t
 Running Speed and Cadence Service structure.
typedef void(* ble_rscs_evt_handler_t )(ble_rscs_t *p_rscs, ble_rscs_evt_t *p_evt)
 Running Speed and Cadence Service event handler type.
typedef struct ble_rscs_meas_s ble_rscs_meas_t
 Running Speed and Cadence Service measurement structure.

Enumerations

enum  ble_rscs_evt_type_t { BLE_RSCS_EVT_NOTIFICATION_ENABLED, BLE_RSCS_EVT_NOTIFICATION_DISABLED }
 

Running Speed and Cadence Service event type.

More...

Functions

uint32_t ble_rscs_init (ble_rscs_t *p_rscs, const ble_rscs_init_t *p_rscs_init)
 Function for initializing the Running Speed and Cadence Service.
void ble_rscs_on_ble_evt (ble_rscs_t *p_rscs, ble_evt_t *p_ble_evt)
 Function for handling the Application's BLE Stack events.
uint32_t ble_rscs_measurement_send (ble_rscs_t *p_rscs, ble_rscs_meas_t *p_measurement)
 Function for sending running speed and cadence measurement if notification has been enabled.

Detailed Description

Running Speed and Cadence Service module.

This module implements the Running Speed and Cadence Service. If enabled, notification of the Running Speead and Candence Measurement is performed when the application calls ble_rscs_measurement_send().

If an event handler is supplied by the application, the Running Speed and Cadence Service will generate Running Speed and Cadence Service events to the application.

Note:
The application must propagate BLE stack events to the Running Speead and Candence Service module by calling ble_rscs_on_ble_evt() from the from the ble_stack_handler function.
Attention! To maintain compliance with Nordic Semiconductor ASA Bluetooth profile qualification listings, this section of source code must not be modified.

Typedef Documentation

typedef void(* ble_rscs_evt_handler_t)(ble_rscs_t *p_rscs, ble_rscs_evt_t *p_evt)

Running Speed and Cadence Service event handler type.

Definition at line 67 of file ble_rscs.h.

typedef struct ble_rscs_meas_s ble_rscs_meas_t

Running Speed and Cadence Service measurement structure.

This contains a Running Speed and Cadence measurement.

typedef struct ble_rscs_s ble_rscs_t

Running Speed and Cadence Service structure.

This contains various status information for the service.

Definition at line 64 of file ble_rscs.h.

Enumeration Type Documentation

enum ble_rscs_evt_type_t

Running Speed and Cadence Service event type.

Enumerator:
BLE_RSCS_EVT_NOTIFICATION_ENABLED 

Running Speed and Cadence value notification enabled event.

BLE_RSCS_EVT_NOTIFICATION_DISABLED 

Running Speed and Cadence value notification disabled event.

Definition at line 51 of file ble_rscs.h.

Function Documentation

uint32_t ble_rscs_init ( ble_rscs_t *  p_rscs,
const ble_rscs_init_t *  p_rscs_init 
)

Function for initializing the Running Speed and Cadence Service.

Parameters:
[out]p_rscsRunning Speed and Cadence Service structure. This structure will have to be supplied by the application. It will be initialized by this function, and will later be used to identify this particular service instance.
[in]p_rscs_initInformation needed to initialize the service.
Returns:
NRF_SUCCESS on successful initialization of service, otherwise an error code.
uint32_t ble_rscs_measurement_send ( ble_rscs_t *  p_rscs,
ble_rscs_meas_t *  p_measurement 
)

Function for sending running speed and cadence measurement if notification has been enabled.

The application calls this function after having performed a Running Speed and Cadence measurement. If notification has been enabled, the measurement data is encoded and sent to the client.

Parameters:
[in]p_rscsRunning Speed and Cadence Service structure.
[in]p_measurementPointer to new running speed and cadence measurement.
Returns:
NRF_SUCCESS on success, otherwise an error code.
void ble_rscs_on_ble_evt ( ble_rscs_t *  p_rscs,
ble_evt_t *  p_ble_evt 
)

Function for handling the Application's BLE Stack events.

Handles all events from the BLE stack of interest to the Running Speed and Cadence Service.

Parameters:
[in]p_rscsRunning Speed and Cadence Service structure.
[in]p_ble_evtEvent received from the BLE stack.
Generated on Tue Jul 12 2022 15:07:45 by  doxygen 1.7.2