TactigonDoc  1.3 - 2018-28-12
Documentation of Tactigon libraries exposed in Arduino IDE
Public Member Functions | List of all members
T_BLE_Characteristic Class Reference

#include <tactigon_BLE.h>

Public Member Functions

 T_BLE_Characteristic ()
 
 T_BLE_Characteristic (uint16_t h_char, uint8_t size, uint16_t h_service)
 
uint8_t update (uint8_t *pData)
 
uint16_t getHandle (void)
 
uint8_t setWcb (wCBType pFunc)
 

Detailed Description

T_BLE_Characteristic class. This is the class neede to menage a single characteristic of the BLE interface

Constructor & Destructor Documentation

◆ T_BLE_Characteristic() [1/2]

T_BLE_Characteristic::T_BLE_Characteristic ( )

BLE Characteristic Default Class constructor

◆ T_BLE_Characteristic() [2/2]

T_BLE_Characteristic::T_BLE_Characteristic ( uint16_t  h_char,
uint8_t  size,
uint16_t  h_service 
)

BLE Characteristic Class constructor. Don't use it, T_BLE::addNewChar() do it for you.

Parameters
h_charhandle to thencharacteristic
sizesize of the characteristic (max 20 byte)
h_servicehandle to the characteristic
Returns
status: 0:ok, !=0: not ok

Member Function Documentation

◆ getHandle()

uint16_t T_BLE_Characteristic::getHandle ( void  )

return the handle to characteristic

Returns
characteristic handle

◆ setWcb()

uint8_t T_BLE_Characteristic::setWcb ( wCBType  pFunc)

in PERIPHERAL role set a CallBack on Data write event on characteristic

Parameters
pFuncuser provided callback. It Must be of type: void calBackName(uint8_t *pointer_to_data, uint8_t byte_data_size)
Returns
status: 0:ok, !=0: not ok

◆ update()

uint8_t T_BLE_Characteristic::update ( uint8_t *  pData)

update characteristic with new data

Parameters
pDatapointer to data to write in characteristic (characteristic must have CHAR_PROP_WRITE_WITHOUT_RESP proprty)
Returns
status: 0:ok, !=0: not ok

The documentation for this class was generated from the following files: