tx_power.h File Reference

TX Service declarations.

Copyright (c) 2017-2018 Microchip Technology Inc. and its subsidiaries.

#include "ble_manager.h"

Data Structures
struct	gatt_txps_char_handler

Macros
#define	MAX_TX_POWER_CHAR_SIZE   (1)
#define	TXPS_CLIENT   0
#define	TXPS_INVALID_CHAR_HANDLE   (0)
#define	TXPS_INVALID_POWER_VALUE   (0xFF)
#define	TXPS_POWER_READ_LENGTH   (1)
#define	TXPS_POWER_READ_OFFSET   (0)
#define	TXPS_SERVER   0

Typedefs
typedef struct gatt_txps_char_handler	gatt_txps_char_handler_t

Functions
at_ble_status_t	txps_power_read (at_ble_handle_t conn_handle, at_ble_handle_t char_handle)
	Send the Read Request to Tx Power service. More...
int8_t	txps_power_read_response (at_ble_characteristic_read_response_t *char_read_resp, gatt_txps_char_handler_t *txps_handler)
	Read a Tx Power. More...

#define MAX_TX_POWER_CHAR_SIZE   (1)

#define TXPS_CLIENT   0

#define TXPS_INVALID_CHAR_HANDLE   (0)

Referenced by txps_power_read().

#define TXPS_INVALID_POWER_VALUE   (0xFF)

Referenced by txps_power_read_response().

#define TXPS_POWER_READ_LENGTH   (1)

Referenced by txps_power_read(), and txps_power_read_response().

#define TXPS_POWER_READ_OFFSET   (0)

Referenced by txps_power_read(), and txps_power_read_response().

#define TXPS_SERVER   0

typedef struct gatt_txps_char_handler gatt_txps_char_handler_t

at_ble_status_t txps_power_read	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	char_handle
	)

Send the Read Request to Tx Power service.

Read value will be reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event

Parameters

[in]	conn_handle	handle of the connection
[in]	char_handle	handle of the characteristic

Returns

AT_BLE_SUCCESS operation completed successfully

AT_BLE_INVALID_PARAM Invalid arguments.

AT_BLE_FAILURE Generic error.

References AT_BLE_ATT_INVALID_HANDLE, at_ble_characteristic_read(), TXPS_INVALID_CHAR_HANDLE, TXPS_POWER_READ_LENGTH, and TXPS_POWER_READ_OFFSET.

Referenced by pxp_monitor_discovery_complete_handler().

int8_t txps_power_read_response	(	at_ble_characteristic_read_response_t *	char_read_resp,
		gatt_txps_char_handler_t *	txps_handler
	)

Read a Tx Power.

Parameters

[in]

read_value

read response data available form at_ble_characteristic_read_response_t

Returns

TX power in dBm .

TXPS_INVALID_POWER_VALUE if is not valid result

References AT_BLE_SUCCESS, gatt_txps_char_handler::char_data, gatt_txps_char_handler::char_handle, at_ble_characteristic_read_response_t::char_handle, at_ble_characteristic_read_response_t::char_value, DBG_LOG, at_ble_characteristic_read_response_t::status, TXPS_INVALID_POWER_VALUE, TXPS_POWER_READ_LENGTH, and TXPS_POWER_READ_OFFSET.

Referenced by pxp_monitor_characteristic_read_response().