nRF51 SDK
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

Cycling Speed and Cadence Service Sample Application main file. More...

Macros

#define WAKEUP_BUTTON_PIN   NRF6310_BUTTON_0
 
#define BONDMNGR_DELETE_BUTTON_PIN_NO   NRF6310_BUTTON_1
 
#define DEVICE_NAME   "Nordic_CSC"
 
#define MANUFACTURER_NAME   "NordicSemiconductor"
 
#define APP_ADV_INTERVAL   40
 
#define APP_ADV_TIMEOUT_IN_SECONDS   180
 
#define APP_TIMER_PRESCALER   0
 
#define APP_TIMER_MAX_TIMERS   3
 
#define APP_TIMER_OP_QUEUE_SIZE   4
 
#define BATTERY_LEVEL_MEAS_INTERVAL   APP_TIMER_TICKS(2000, APP_TIMER_PRESCALER)
 
#define MIN_BATTERY_LEVEL   81
 
#define MAX_BATTERY_LEVEL   100
 
#define BATTERY_LEVEL_INCREMENT   1
 
#define SPEED_AND_CADENCE_MEAS_INTERVAL   1000
 
#define WHEEL_CIRCUMFERENCE_MM   2100
 
#define KPH_TO_MM_PER_SEC   278
 
#define MIN_SPEED_KPH   10
 
#define MAX_SPEED_KPH   40
 
#define SPEED_KPH_INCREMENT   1
 
#define DEGREES_PER_REVOLUTION   360
 
#define RPM_TO_DEGREES_PER_SEC   6
 
#define MIN_CRANK_RPM   20
 
#define MAX_CRANK_RPM   110
 
#define CRANK_RPM_INCREMENT   3
 
#define MIN_CONN_INTERVAL   MSEC_TO_UNITS(500, UNIT_1_25_MS)
 
#define MAX_CONN_INTERVAL   MSEC_TO_UNITS(1000, UNIT_1_25_MS)
 
#define SLAVE_LATENCY   0
 
#define CONN_SUP_TIMEOUT   MSEC_TO_UNITS(4000, UNIT_10_MS)
 
#define FIRST_CONN_PARAMS_UPDATE_DELAY   APP_TIMER_TICKS(5000, APP_TIMER_PRESCALER)
 
#define NEXT_CONN_PARAMS_UPDATE_DELAY   APP_TIMER_TICKS(5000, APP_TIMER_PRESCALER)
 
#define MAX_CONN_PARAMS_UPDATE_COUNT   3
 
#define SEC_PARAM_TIMEOUT   30
 
#define SEC_PARAM_BOND   1
 
#define SEC_PARAM_MITM   0
 
#define SEC_PARAM_IO_CAPABILITIES   BLE_GAP_IO_CAPS_NONE
 
#define SEC_PARAM_OOB   0
 
#define SEC_PARAM_MIN_KEY_SIZE   7
 
#define SEC_PARAM_MAX_KEY_SIZE   16
 
#define FLASH_PAGE_SYS_ATTR   (BLE_FLASH_PAGE_END - 3)
 
#define FLASH_PAGE_BOND   (BLE_FLASH_PAGE_END - 1)
 
#define DEAD_BEEF   0xDEADBEEF
 

Functions

void app_error_handler (uint32_t error_code, uint32_t line_num, const uint8_t *p_file_name)
 Function for error handling, which is called when an error has occurred. More...
 
void assert_nrf_callback (uint16_t line_num, const uint8_t *p_file_name)
 Callback function for asserts in the SoftDevice. More...
 
static void battery_level_update (void)
 Function for performing a battery measurement, and update the Battery Level characteristic in the Battery Service.
 
static void battery_level_meas_timeout_handler (void *p_context)
 Function for handling the Battery measurement timer timeout. More...
 
static void csc_sim_measurement (ble_cscs_meas_t *p_measurement)
 Function for populating simulated cycling speed and cadence measurements.
 
static void csc_meas_timeout_handler (void *p_context)
 Function for handling the Cycling Speed and Cadence measurement timer timeouts. More...
 
static void leds_init (void)
 Function for the LEDs initialization. More...
 
static void timers_init (void)
 Function for the Timer initialization. More...
 
static void gap_params_init (void)
 Function for the GAP initialization. More...
 
static void advertising_init (void)
 Function for initializing the Advertising functionality. More...
 
ble_scpt_response_t sc_ctrlpt_event_handler (ble_sc_ctrlpt_t *p_sc_ctrlpt, ble_sc_ctrlpt_evt_t *p_evt)
 Function for handling Speed and Cadence Control point events. More...
 
static void services_init (void)
 Function for initializing services that will be used by the application. More...
 
static void sensor_sim_init (void)
 Function for initializing the sensor simulators.
 
static void sec_params_init (void)
 Function for initializing security parameters.
 
static void application_timers_start (void)
 Function for starting application timers.
 
static void advertising_start (void)
 Function for starting advertising.
 
static void on_conn_params_evt (ble_conn_params_evt_t *p_evt)
 Function for handling the Connection Parameter events. More...
 
static void conn_params_error_handler (uint32_t nrf_error)
 Function for handling a Connection Parameters error. More...
 
static void conn_params_init (void)
 Function for initializing the Connection Parameters module.
 
static void on_ble_evt (ble_evt_t *p_ble_evt)
 Function for handling the Application's BLE Stack events. More...
 
static void ble_evt_dispatch (ble_evt_t *p_ble_evt)
 Function for dispatching a BLE stack event to all modules with a BLE stack event handler. More...
 
static void ble_stack_init (void)
 Function for initializing the BLE stack. More...
 
static void buttons_init (void)
 Function for initializing buttons.
 
static void bond_manager_error_handler (uint32_t nrf_error)
 Function for handling a Bond Manager error. More...
 
static void bond_manager_init (void)
 Function for the Bond Manager initialization.
 
static void radio_notification_init (void)
 Function for initializing the Radio Notification event.
 
static void power_manage (void)
 Function for the Power manager.
 
int main (void)
 Function for application main entry.
 

Variables

static uint16_t m_conn_handle = BLE_CONN_HANDLE_INVALID
 
static ble_gap_sec_params_t m_sec_params
 
static ble_gap_adv_params_t m_adv_params
 
static ble_bas_t m_bas
 
static ble_cscs_t m_cscs
 
static ble_sensorsim_cfg_t m_battery_sim_cfg
 
static ble_sensorsim_state_t m_battery_sim_state
 
static ble_sensorsim_cfg_t m_speed_kph_sim_cfg
 
static ble_sensorsim_state_t m_speed_kph_sim_state
 
static ble_sensorsim_cfg_t m_crank_rpm_sim_cfg
 
static ble_sensorsim_state_t m_crank_rpm_sim_state
 
static app_timer_id_t m_battery_timer_id
 
static app_timer_id_t m_csc_meas_timer_id
 
static uint32_t m_cumulative_wheel_revs
 
static bool m_auto_calibration_in_progress
 
static ble_sensor_location_t supported_locations []
 

Detailed Description

This file contains the source code for a sample application using the Cycling Speed and Cadence Service. It also includes the sample code for Battery and Device Information services. This application uses the srvlib_conn_params module.

This application implements supports for both Wheel revolution Data and Crank Revolution Data. In addition, this application also has support for all 'Speed and Cadence Control Point'.

Macro Definition Documentation

#define WAKEUP_BUTTON_PIN   NRF6310_BUTTON_0

Button used to wake up the application.

#define BONDMNGR_DELETE_BUTTON_PIN_NO   NRF6310_BUTTON_1

Button used for deleting all bonded masters during startup.

#define DEVICE_NAME   "Nordic_CSC"

Name of device. Will be included in the advertising data.

#define MANUFACTURER_NAME   "NordicSemiconductor"

Manufacturer. Will be passed to Device Information Service.

#define APP_ADV_INTERVAL   40

The advertising interval (in units of 0.625 ms. This value corresponds to 25 ms).

#define APP_ADV_TIMEOUT_IN_SECONDS   180

The advertising timeout in units of seconds.

#define APP_TIMER_PRESCALER   0

Value of the RTC1 PRESCALER register.

#define APP_TIMER_MAX_TIMERS   3

Maximum number of simultaneously created timers.

#define APP_TIMER_OP_QUEUE_SIZE   4

Size of timer operation queues.

#define BATTERY_LEVEL_MEAS_INTERVAL   APP_TIMER_TICKS(2000, APP_TIMER_PRESCALER)

Battery level measurement interval (ticks).

#define MIN_BATTERY_LEVEL   81

Minimum battery level as returned by the simulated measurement function.

#define MAX_BATTERY_LEVEL   100

Maximum battery level as returned by the simulated measurement function.

#define BATTERY_LEVEL_INCREMENT   1

Value by which the battery level is incremented/decremented for each call to the simulated measurement function.

#define SPEED_AND_CADENCE_MEAS_INTERVAL   1000

Speed and cadence measurement interval (milliseconds).

#define WHEEL_CIRCUMFERENCE_MM   2100

Simulated wheel circumference in millimeters.

#define KPH_TO_MM_PER_SEC   278

Constant to convert kilometers per hour into millimeters per second.

#define MIN_SPEED_KPH   10

Minimum speed in kilometers per hour for use in the simulated measurement function.

#define MAX_SPEED_KPH   40

Maximum speed in kilometers per hour for use in the simulated measurement function.

#define SPEED_KPH_INCREMENT   1

Value by which speed is incremented/decremented for each call to the simulated measurement function.

#define DEGREES_PER_REVOLUTION   360

Constant used in simulation for calculating crank speed.

#define RPM_TO_DEGREES_PER_SEC   6

Constant to convert revolutions per minute into degrees per second.

#define MIN_CRANK_RPM   20

Minimum cadence in RPM for use in the simulated measurement function.

#define MAX_CRANK_RPM   110

Maximum cadence in RPM for use in the simulated measurement function.

#define CRANK_RPM_INCREMENT   3

Value by which cadence is incremented/decremented in the simulated measurement function.

#define MIN_CONN_INTERVAL   MSEC_TO_UNITS(500, UNIT_1_25_MS)

Minimum acceptable connection interval (0.5 seconds).

#define MAX_CONN_INTERVAL   MSEC_TO_UNITS(1000, UNIT_1_25_MS)

Maximum acceptable connection interval (1 second).

#define SLAVE_LATENCY   0

Slave latency.

#define CONN_SUP_TIMEOUT   MSEC_TO_UNITS(4000, UNIT_10_MS)

Connection supervisory timeout (4 seconds).

#define FIRST_CONN_PARAMS_UPDATE_DELAY   APP_TIMER_TICKS(5000, APP_TIMER_PRESCALER)

Time from initiating event (connect or start of notification) to first time sd_ble_gap_conn_param_update is called (5 seconds).

#define NEXT_CONN_PARAMS_UPDATE_DELAY   APP_TIMER_TICKS(5000, APP_TIMER_PRESCALER)

Time between each call to sd_ble_gap_conn_param_update after the first (30 seconds).

#define MAX_CONN_PARAMS_UPDATE_COUNT   3

Number of attempts before giving up the connection parameter negotiation.

#define SEC_PARAM_TIMEOUT   30

Timeout for Pairing Request or Security Request (in seconds).

#define SEC_PARAM_BOND   1

Perform bonding.

#define SEC_PARAM_MITM   0

Man In The Middle protection not required.

#define SEC_PARAM_IO_CAPABILITIES   BLE_GAP_IO_CAPS_NONE

No I/O capabilities.

#define SEC_PARAM_OOB   0

Out Of Band data not available.

#define SEC_PARAM_MIN_KEY_SIZE   7

Minimum encryption key size.

#define SEC_PARAM_MAX_KEY_SIZE   16

Maximum encryption key size.

#define FLASH_PAGE_SYS_ATTR   (BLE_FLASH_PAGE_END - 3)

Flash page used for bond manager system attribute information.

#define FLASH_PAGE_BOND   (BLE_FLASH_PAGE_END - 1)

Flash page used for bond manager bonding information.

#define DEAD_BEEF   0xDEADBEEF

Value used as error code on stack dump, can be used to identify stack location on stack unwind.

Function Documentation

void app_error_handler ( uint32_t  error_code,
uint32_t  line_num,
const uint8_t *  p_file_name 
)
Warning
This handler is an example only and does not fit a final product. You need to analyze how your product is supposed to react in case of error.
Parameters
[in]error_codeError code supplied to the handler.
[in]line_numLine number where the handler is called.
[in]p_file_namePointer to the file name.
void assert_nrf_callback ( uint16_t  line_num,
const uint8_t *  p_file_name 
)

This function will be called in case of an assert in the SoftDevice.

Warning
This handler is an example only and does not fit a final product. You need to analyze how your product is supposed to react in case of Assert.
On assert from the SoftDevice, the system can only recover on reset.
Parameters
[in]line_numLine number of the failing ASSERT call.
[in]file_nameFile name of the failing ASSERT call.
static void battery_level_meas_timeout_handler ( void *  p_context)
static

This function will be called each time the battery level measurement timer expires.

Parameters
[in]p_contextPointer used for passing some arbitrary information (context) from the app_start_timer() call to the timeout handler.
static void csc_meas_timeout_handler ( void *  p_context)
static

This function will be called each time the cycling speed and cadence measurement timer expires.

Parameters
[in]p_contextPointer used for passing some arbitrary information (context) from the app_start_timer() call to the timeout handler.
static void leds_init ( void  )
static

Initializes all LEDs used by this application.

static void timers_init ( void  )
static

Initializes the timer module. This creates and starts application timers.

static void gap_params_init ( void  )
static

This function shall be used to setup all the necessary GAP (Generic Access Profile) parameters of the device. It also sets the permissions and appearance.

static void advertising_init ( void  )
static

Encodes the required advertising data and passes it to the stack. Also builds a structure to be passed to the stack when starting advertising.

ble_scpt_response_t sc_ctrlpt_event_handler ( ble_sc_ctrlpt_t p_sc_ctrlpt,
ble_sc_ctrlpt_evt_t p_evt 
)

Function for handling Speed and Cadence Control point events This function parses the event and in case the set cumulative value event is received, sets the wheel cumulative value to the received value.

static void services_init ( void  )
static

Initialize the Cycling Speed and Cadence, Battery and Device Information services.

static void on_conn_params_evt ( ble_conn_params_evt_t p_evt)
static

This function will be called for all events in the Connection Parameters Module which are passed to the application.

Note
All this function does is to disconnect. This could have been done by simply setting the disconnect_on_fail config parameter, but instead we use the event handler mechanism to demonstrate its use.
Parameters
[in]p_evtEvent received from the Connection Parameters Module.
static void conn_params_error_handler ( uint32_t  nrf_error)
static
Parameters
[in]nrf_errorError code containing information about what went wrong.
static void on_ble_evt ( ble_evt_t p_ble_evt)
static
Parameters
[in]p_ble_evtBluetooth stack event.
static void ble_evt_dispatch ( ble_evt_t p_ble_evt)
static

This function is called from the BLE Stack event interrupt handler after a BLE stack event has been received.

Parameters
[in]p_ble_evtBluetooth stack event.
static void ble_stack_init ( void  )
static

Initializes the SoftDevice and the BLE event interrupt.

static void bond_manager_error_handler ( uint32_t  nrf_error)
static
Parameters
[in]nrf_errorError code containing information about what went wrong.

Variable Documentation

uint16_t m_conn_handle = BLE_CONN_HANDLE_INVALID
static

Handle of the current connection.

ble_gap_sec_params_t m_sec_params
static

Security requirements for this application.

ble_gap_adv_params_t m_adv_params
static

Parameters to be passed to the stack when starting advertising.

ble_bas_t m_bas
static

Structure used to identify the battery service.

ble_cscs_t m_cscs
static

Structure used to identify the cycling speed and cadence service.

ble_sensorsim_cfg_t m_battery_sim_cfg
static

Battery Level sensor simulator configuration.

ble_sensorsim_state_t m_battery_sim_state
static

Battery Level sensor simulator state.

ble_sensorsim_cfg_t m_speed_kph_sim_cfg
static

Speed simulator configuration.

ble_sensorsim_state_t m_speed_kph_sim_state
static

Speed simulator state.

ble_sensorsim_cfg_t m_crank_rpm_sim_cfg
static

Crank simulator configuration.

ble_sensorsim_state_t m_crank_rpm_sim_state
static

Crank simulator state.

app_timer_id_t m_battery_timer_id
static

Battery timer.

app_timer_id_t m_csc_meas_timer_id
static

CSC measurement timer.

uint32_t m_cumulative_wheel_revs
static

Cumulative wheel revolutions.

bool m_auto_calibration_in_progress
static

Set when an autocalibration is in progress.

ble_sensor_location_t supported_locations[]
static
Initial value:
= {
BLE_SENSOR_LOCATION_FRONT_WHEEL ,
BLE_SENSOR_LOCATION_LEFT_CRANK ,
BLE_SENSOR_LOCATION_RIGHT_CRANK ,
BLE_SENSOR_LOCATION_LEFT_PEDAL ,
BLE_SENSOR_LOCATION_RIGHT_PEDAL ,
BLE_SENSOR_LOCATION_FRONT_HUB ,
BLE_SENSOR_LOCATION_REAR_DROPOUT,
BLE_SENSOR_LOCATION_CHAINSTAY ,
BLE_SENSOR_LOCATION_REAR_WHEEL ,
BLE_SENSOR_LOCATION_REAR_HUB ,
}