immediate_alert.h File Reference

Immediate Alert Service declarations.

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

#include "ble_manager.h"

Data Structures
struct	gatt_ias_char_handler

Macros
#define	IAS_CHARACTERISTIC_COUNT   (1)
	count of characteristics in immediate alert service More...
#define	IAS_CLIENT   0
#define	IAS_INCLUDED_SERVICE_COUNT   (0)
	count of included service in immediate alert service More...
#define	IAS_NO_SIGNED_WRITE   (false)
#define	IAS_SERVER   0
#define	IAS_WRITE_LENGTH   (1)
#define	IAS_WRITE_OFFSET   (0)
#define	IAS_WRITE_WITH_RESPONSE   (false)
#define	INVALID_IAS_PARAM   (0xff)
	Invalid parameter written. More...
#define	MAX_IAS_CHAR_SIZE   (1)

Typedefs
typedef struct gatt_ias_char_handler	gatt_ias_char_handler_t
typedef enum immediate_alert_level	immediate_alert_level_t

Enumerations
enum	immediate_alert_level {   IAS_NO_ALERT,   IAS_MID_ALERT,   IAS_HIGH_ALERT }

Functions
at_ble_status_t	ias_alert_level_write (at_ble_handle_t conn_handle, at_ble_handle_t char_handle, immediate_alert_level_t alert_level)
	write a characteristic to Immediate Alert Characteristics More...

#define IAS_CHARACTERISTIC_COUNT   (1)

count of characteristics in immediate alert service

#define IAS_CLIENT   0

#define IAS_INCLUDED_SERVICE_COUNT   (0)

count of included service in immediate alert service

#define IAS_NO_SIGNED_WRITE   (false)

Referenced by ias_alert_level_write().

#define IAS_SERVER   0

#define IAS_WRITE_LENGTH   (1)

Referenced by ias_alert_level_write().

#define IAS_WRITE_OFFSET   (0)

Referenced by ias_alert_level_write().

#define IAS_WRITE_WITH_RESPONSE   (false)

Referenced by ias_alert_level_write().

#define INVALID_IAS_PARAM   (0xff)

Invalid parameter written.

#define MAX_IAS_CHAR_SIZE   (1)

typedef struct gatt_ias_char_handler gatt_ias_char_handler_t

typedef enum immediate_alert_level immediate_alert_level_t

enum immediate_alert_level

Enumerator
IAS_NO_ALERT
IAS_MID_ALERT
IAS_HIGH_ALERT

at_ble_status_t ias_alert_level_write	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	char_handle,
		immediate_alert_level_t	alert_level
	)

write a characteristic to Immediate Alert Characteristics

if with_response is True, write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_RESPONSE event

Parameters

[in]	conn_handle	handle of the connection
[in]	char_handle	handle of the characteristic
[in]	alert	level need to write

Returns

AT_BLE_SUCCESS operation completed successfully

AT_BLE_FAILURE Generic error.

if with_response is True, write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_RESPONSE event

Parameters

[in]	conn_handle	handle of the connection
[in]	char_handle	handle of the characteristic
[in]	alert_level	alert level need to write

Returns

AT_BLE_SUCCESS operation completed successfully

AT_BLE_FAILURE Generic error.

References at_ble_characteristic_write(), IAS_NO_SIGNED_WRITE, IAS_WRITE_LENGTH, IAS_WRITE_OFFSET, and IAS_WRITE_WITH_RESPONSE.

Referenced by rssi_update().