Vincent (pan-) Coubard / X_NUCLEO_IDB0XA1

My fork of X_NUCLEO_IDB0XA1

Fork of X_NUCLEO_IDB0XA1 by ST

Embed: (wiki syntax)

« Back to documentation index

BlueNRGGATTSERVER
Functions

BlueNRGGATTSERVER

BlueNRG BLE_API GattServer Adaptation. More...

Functions

virtual ble_error_t addService (GattService &)
 Adds a new service to the GATT table on the peripheral.
virtual ble_error_t read (GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP)
 Reads the value of a characteristic, based on char handle.
virtual ble_error_t read (Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP)
 Reads the value of a characteristic, based on the connection and char handle.
ble_error_t Read_Request_CB (uint16_t attributeHandle)
 Reads a value according to the handle provided.
GattCharacteristic * getCharacteristicFromHandle (uint16_t charHandle)
 Returns the GattCharacteristic according to the handle provided.
virtual ble_error_t reset (void)
 Clear BlueNRGGattServer's state.

Detailed Description

BlueNRG BLE_API GattServer Adaptation.

Function Documentation

ble_error_t addService ( GattService &  service ) [virtual, inherited]

Adds a new service to the GATT table on the peripheral.

[in] service Pointer to instance of the Gatt Server to add

Returns:
ble_error_t
Return values:
BLE_ERROR_NONEEverything executed properly

EXAMPLE

 

Definition at line 68 of file BlueNRGGattServer.cpp.











      

        

          GattCharacteristic * getCharacteristicFromHandle 
          (
          uint16_t 
           attrHandle )
           [inherited]
        

      







Returns the GattCharacteristic according to the handle provided. 


Parameters:

  

    
[in]attrHandleThe handle of the attribute

  

  




Returns:
ble_error_t


Return values:

  

    
BLE_ERROR_NONEEverything executed properly

  

  





EXAMPLE


 

Definition at line 630 of file BlueNRGGattServer.cpp.











      

        

          ble_error_t read 
          (
          Gap::Handle_t 
           connectionHandle, 
        

        

          
          
          GattAttribute::Handle_t 
           attributeHandle, 
        

        

          
          
          uint8_t 
           buffer[], 
        

        

          
          
          uint16_t * 
           lengthP 
        

        

          
          )
           [virtual, inherited]
        

      







Reads the value of a characteristic, based on the connection and char handle. 


Parameters:

  

    
[in]connectionHandleThe handle of the connection 

    
[in]attributeHandleThe handle of the GattCharacteristic to write to 

    
[in]bufferData to use when updating the characteristic's value (raw byte array in LSB format) 

    
[in]lengthPThe number of bytes in buffer

  

  




Returns:
ble_error_t


Return values:

  

    
BLE_ERROR_NONEEverything executed properly

  

  





EXAMPLE


 

Definition at line 426 of file BlueNRGGattServer.cpp.











      

        

          ble_error_t read 
          (
          GattAttribute::Handle_t 
           attributeHandle, 
        

        

          
          
          uint8_t 
           buffer[], 
        

        

          
          
          uint16_t * 
           lengthP 
        

        

          
          )
           [virtual, inherited]
        

      







Reads the value of a characteristic, based on char handle. 


Parameters:

  

    
[in]attributeHandleThe handle of the GattCharacteristic to read from 

    
[in]bufferBuffer to hold the the characteristic's value (raw byte array in LSB format) 

    
[in]lengthPThe number of bytes read into the buffer

  

  




Returns:
ble_error_t


Return values:

  

    
BLE_ERROR_NONEEverything executed properly

  

  





EXAMPLE


 

Definition at line 381 of file BlueNRGGattServer.cpp.











      

        

          ble_error_t Read_Request_CB 
          (
          uint16_t 
           attributeHandle )
           [inherited]
        

      







Reads a value according to the handle provided. 


Parameters:

  

    
[in]attributeHandleThe handle of the attribute to read from

  

  




Returns:
ble_error_t


Return values:

  

    
BLE_ERROR_NONEEverything executed properly

  

  





EXAMPLE


 

Definition at line 556 of file BlueNRGGattServer.cpp.











      

        

          ble_error_t reset 
          (
          void 
           )
           [virtual, inherited]
        

      







Clear BlueNRGGattServer's state. 


Returns:
ble_error_t


Return values:

  

    
BLE_ERROR_NONEEverything executed properly 

  

  





Definition at line 698 of file BlueNRGGattServer.cpp.









Generated on Wed Jul 13 2022 03:04:51 by 

doxygen 1.7.2