Communications module

Functions for configuring the communications module. More...

Modules
	BLE-related submodules
	This section contains information about the BLE-related submodules that are part of the Smart Remote 3 nRF52 firmware.

Typedefs
typedef void(*	m_coms_free_func_t )(void *)
	Free function that handles send buffers.

Enumerations
enum	m_coms_audio_service_t
	Services that can transmit audio data.
enum	m_coms_data_process_status_t { M_COMS_STATUS_SUCCESS = NRF_SUCCESS, M_COMS_STATUS_SD_BUFFER_FULL, M_COMS_STATUS_QUEUE_EMPTY, M_COMS_STATUS_CANNOT_SEND }
	Module-specifc status codes. More...

Functions
void	m_coms_audio_service_disable (m_coms_audio_service_t service)
	Disable sending of audio data via given Service. More...
void	m_coms_audio_service_enable (m_coms_audio_service_t service)
	Enable sending of audio data via given Service. More...
bool	m_coms_event_handler (const event_t *p_event)
	Event Bus event handler. More...
ret_code_t	m_coms_init (bool delete_bonds)
	Initialize the communications module. More...
ret_code_t	m_coms_send_audio (m_audio_frame_t *p_audio_frame)
	Send audio data. More...

Detailed Description

Functions for configuring the communications module.

Enumeration Type Documentation

enum m_coms_data_process_status_t

Module-specifc status codes.

Enumerator
M_COMS_STATUS_SUCCESS	Data successfully processed
M_COMS_STATUS_SD_BUFFER_FULL	SoftDevice buffer is full
M_COMS_STATUS_QUEUE_EMPTY	Data queue is empty
M_COMS_STATUS_CANNOT_SEND	Data cannot be sent at this time

Function Documentation

void m_coms_audio_service_disable

(

m_coms_audio_service_t

service

)

Disable sending of audio data via given Service.

Parameters

[in]

service

Audio Service to disable

Returns

NRF_SUCCESS

NRF_ERROR_NOT_SUPPORTED

void m_coms_audio_service_enable

(

m_coms_audio_service_t

service

)

Enable sending of audio data via given Service.

Note

If no audio service is enabled, m_coms_send_audio will have no effect

Parameters

[in]

service

Audio Service to enable

Returns

NRF_SUCCESS

NRF_ERROR_NOT_SUPPORTED

bool m_coms_event_handler

(

const event_t *

p_event

)

Event Bus event handler.

Parameters

[in]

p_event

Pointer to the event structure.

Returns

true if further processing of the given event should be abandoned.

ret_code_t m_coms_init

(

bool

delete_bonds

)

Initialize the communications module.

Parameters

[in]

delete_bonds

Set to true to remove all bonds during initialization.

Returns

NRF_SUCCESS on success, otherwise an error code.

ret_code_t m_coms_send_audio

(

m_audio_frame_t *

p_audio_frame

)

Send audio data.

Parameters

[in]

p_audio_frame

Audio frame to transmit.

Returns

NRF_SUCCESS on success, otherwise an error code.