BlueNRG-MS pack for STM32CubeMX: ACI_GATT_SERVER

STM32CubeMX BlueNRG-MS

previous page next page
BlueNRG-MS pack for STM32CubeMX  V4.4.0
The BlueNRG-MS pack is an additional software for STM32CubeMX.
Data Structures | Macros
ACI_GATT_SERVER
HIGH_LEVEL_INTERFACE » ACI_GATT

API for GATT SERVER layer. More...

Data Structures

struct  _charactFormat
 

Macros

#define ATT_MTU   (23)
 

Well-Known UUIDs

#define PRIMARY_SERVICE_UUID   (0x2800)
 
#define SECONDARY_SERVICE_UUID   (0x2801)
 
#define INCLUDE_SERVICE_UUID   (0x2802)
 
#define CHARACTERISTIC_UUID   (0x2803)
 
#define CHAR_EXTENDED_PROP_DESC_UUID   (0x2900)
 
#define CHAR_USER_DESC_UUID   (0x2901)
 
#define CHAR_CLIENT_CONFIG_DESC_UUID   (0x2902)
 
#define CHAR_SERVER_CONFIG_DESC_UUID   (0x2903)
 
#define CHAR_FORMAT_DESC_UUID   (0x2904)
 
#define CHAR_AGGR_FMT_DESC_UUID   (0x2905)
 
#define GATT_SERVICE_UUID   (0x1801)
 
#define GAP_SERVICE_UUID   (0x1800)
 
#define SERVICE_CHANGED_UUID   (0x2A05)
 

Access permissions

Access permissions for an attribute

#define ATTR_NO_ACCESS   (0x00)
 
#define ATTR_ACCESS_READ_ONLY   (0x01)
 
#define ATTR_ACCESS_WRITE_REQ_ONLY   (0x02)
 
#define ATTR_ACCESS_READ_WRITE   (0x03)
 
#define ATTR_ACCESS_WRITE_WITHOUT_RESPONSE   (0x04)
 
#define ATTR_ACCESS_SIGNED_WRITE_ALLOWED   (0x08)
 
#define ATTR_ACCESS_WRITE_ANY   (0x0E)
 

Characteristic properties.

#define CHAR_PROP_BROADCAST   (0x01)
 
#define CHAR_PROP_READ   (0x02)
 
#define CHAR_PROP_WRITE_WITHOUT_RESP   (0x04)
 
#define CHAR_PROP_WRITE   (0x08)
 
#define CHAR_PROP_NOTIFY   (0x10)
 
#define CHAR_PROP_INDICATE   (0x20)
 
#define CHAR_PROP_SIGNED_WRITE   (0x40)
 
#define CHAR_PROP_EXT   (0x80)
 

Security permissions for an attribute.

#define ATTR_PERMISSION_NONE   (0x00)
 
#define ATTR_PERMISSION_AUTHEN_READ   (0x01)
 
#define ATTR_PERMISSION_AUTHOR_READ   (0x02)
 
#define ATTR_PERMISSION_ENCRY_READ   (0x04)
 
#define ATTR_PERMISSION_AUTHEN_WRITE   (0x08)
 
#define ATTR_PERMISSION_AUTHOR_WRITE   (0x10)
 
#define ATTR_PERMISSION_ENCRY_WRITE   (0x20)
 

Type of UUID (16 bit or 128 bit).

#define UUID_TYPE_16   (0x01)
 
#define UUID_TYPE_128   (0x02)
 

Type of service (primary or secondary)

#define PRIMARY_SERVICE   (0x01)
 
#define SECONDARY_SERVICE   (0x02)
 

Gatt Event Mask

Type of event generated by GATT server

#define GATT_DONT_NOTIFY_EVENTS   (0x00)
 
#define GATT_NOTIFY_ATTRIBUTE_WRITE   (0x01)
 
#define GATT_NOTIFY_WRITE_REQ_AND_WAIT_FOR_APPL_RESP   (0x02)
 
#define GATT_NOTIFY_READ_REQ_AND_WAIT_FOR_APPL_RESP   (0x04)
 

Type of characteristic length

See aci_gatt_add_char()

#define CHAR_VALUE_LEN_CONSTANT   (0x00)
 
#define CHAR_VALUE_LEN_VARIABLE   (0x01)
 

Encryption key size

#define MIN_ENCRY_KEY_SIZE   (7)
 
#define MAX_ENCRY_KEY_SIZE   (0x10)
 

Characteristic Presentation Format

typedef __packed struct _charactFormat charactFormat
 

Format

#define FORMAT_UINT8   0x04
 
#define FORMAT_UINT16   0x06
 
#define FORMAT_SINT16   0x0E
 
#define FORMAT_SINT24   0x0F
 

Unit

#define UNIT_UNITLESS   0x2700
 
#define UNIT_TEMP_CELSIUS   0x272F
 
#define UNIT_PRESSURE_BAR   0x2780
 

Detailed Description

API for GATT SERVER layer.

Macro Definition Documentation

◆ ATT_MTU

#define ATT_MTU   (23)

ATT MTU size

◆ ATTR_ACCESS_READ_ONLY

#define ATTR_ACCESS_READ_ONLY   (0x01)

◆ ATTR_ACCESS_READ_WRITE

#define ATTR_ACCESS_READ_WRITE   (0x03)

◆ ATTR_ACCESS_SIGNED_WRITE_ALLOWED

#define ATTR_ACCESS_SIGNED_WRITE_ALLOWED   (0x08)

◆ ATTR_ACCESS_WRITE_ANY

#define ATTR_ACCESS_WRITE_ANY   (0x0E)

Allows all write procedures

◆ ATTR_ACCESS_WRITE_REQ_ONLY

#define ATTR_ACCESS_WRITE_REQ_ONLY   (0x02)

◆ ATTR_ACCESS_WRITE_WITHOUT_RESPONSE

#define ATTR_ACCESS_WRITE_WITHOUT_RESPONSE   (0x04)

◆ ATTR_NO_ACCESS

#define ATTR_NO_ACCESS   (0x00)

◆ ATTR_PERMISSION_AUTHEN_READ

#define ATTR_PERMISSION_AUTHEN_READ   (0x01)

Need authentication to read

◆ ATTR_PERMISSION_AUTHEN_WRITE

#define ATTR_PERMISSION_AUTHEN_WRITE   (0x08)

Need authentication to write

◆ ATTR_PERMISSION_AUTHOR_READ

#define ATTR_PERMISSION_AUTHOR_READ   (0x02)

Need authorization to read

◆ ATTR_PERMISSION_AUTHOR_WRITE

#define ATTR_PERMISSION_AUTHOR_WRITE   (0x10)

Need authorization to write

◆ ATTR_PERMISSION_ENCRY_READ

#define ATTR_PERMISSION_ENCRY_READ   (0x04)

Link must be encrypted to read

◆ ATTR_PERMISSION_ENCRY_WRITE

#define ATTR_PERMISSION_ENCRY_WRITE   (0x20)

Link must be encrypted for write

◆ ATTR_PERMISSION_NONE

#define ATTR_PERMISSION_NONE   (0x00)

No security.

◆ CHAR_AGGR_FMT_DESC_UUID

#define CHAR_AGGR_FMT_DESC_UUID   (0x2905)

◆ CHAR_CLIENT_CONFIG_DESC_UUID

#define CHAR_CLIENT_CONFIG_DESC_UUID   (0x2902)

◆ CHAR_EXTENDED_PROP_DESC_UUID

#define CHAR_EXTENDED_PROP_DESC_UUID   (0x2900)

◆ CHAR_FORMAT_DESC_UUID

#define CHAR_FORMAT_DESC_UUID   (0x2904)

◆ CHAR_PROP_BROADCAST

#define CHAR_PROP_BROADCAST   (0x01)

◆ CHAR_PROP_EXT

#define CHAR_PROP_EXT   (0x80)

◆ CHAR_PROP_INDICATE

#define CHAR_PROP_INDICATE   (0x20)

◆ CHAR_PROP_NOTIFY

#define CHAR_PROP_NOTIFY   (0x10)

◆ CHAR_PROP_READ

#define CHAR_PROP_READ   (0x02)

◆ CHAR_PROP_SIGNED_WRITE

#define CHAR_PROP_SIGNED_WRITE   (0x40)

◆ CHAR_PROP_WRITE

#define CHAR_PROP_WRITE   (0x08)

◆ CHAR_PROP_WRITE_WITHOUT_RESP

#define CHAR_PROP_WRITE_WITHOUT_RESP   (0x04)

◆ CHAR_SERVER_CONFIG_DESC_UUID

#define CHAR_SERVER_CONFIG_DESC_UUID   (0x2903)

◆ CHAR_USER_DESC_UUID

#define CHAR_USER_DESC_UUID   (0x2901)

◆ CHAR_VALUE_LEN_CONSTANT

#define CHAR_VALUE_LEN_CONSTANT   (0x00)

◆ CHAR_VALUE_LEN_VARIABLE

#define CHAR_VALUE_LEN_VARIABLE   (0x01)

◆ CHARACTERISTIC_UUID

#define CHARACTERISTIC_UUID   (0x2803)

◆ FORMAT_SINT16

#define FORMAT_SINT16   0x0E

◆ FORMAT_SINT24

#define FORMAT_SINT24   0x0F

◆ FORMAT_UINT16

#define FORMAT_UINT16   0x06

◆ FORMAT_UINT8

#define FORMAT_UINT8   0x04

◆ GAP_SERVICE_UUID

#define GAP_SERVICE_UUID   (0x1800)

◆ GATT_DONT_NOTIFY_EVENTS

#define GATT_DONT_NOTIFY_EVENTS   (0x00)

Do not notify events.

◆ GATT_NOTIFY_ATTRIBUTE_WRITE

#define GATT_NOTIFY_ATTRIBUTE_WRITE   (0x01)

The application will be notified when a client writes to this attribute. An EVT_BLUE_GATT_ATTRIBUTE_MODIFIED will be issued.

◆ GATT_NOTIFY_READ_REQ_AND_WAIT_FOR_APPL_RESP

#define GATT_NOTIFY_READ_REQ_AND_WAIT_FOR_APPL_RESP   (0x04)

The application will be notified when a read request of any type is received for this attribute. An EVT_BLUE_GATT_READ_PERMIT_REQ will be issued.

◆ GATT_NOTIFY_WRITE_REQ_AND_WAIT_FOR_APPL_RESP

#define GATT_NOTIFY_WRITE_REQ_AND_WAIT_FOR_APPL_RESP   (0x02)

The application will be notified when a write request, a write cmd or a signed write cmd are received by the server for this attribute. An EVT_BLUE_GATT_WRITE_PERMIT_REQ will be issued.

◆ GATT_SERVICE_UUID

#define GATT_SERVICE_UUID   (0x1801)

◆ INCLUDE_SERVICE_UUID

#define INCLUDE_SERVICE_UUID   (0x2802)

◆ MAX_ENCRY_KEY_SIZE

#define MAX_ENCRY_KEY_SIZE   (0x10)

Maximum encryption key size

◆ MIN_ENCRY_KEY_SIZE

#define MIN_ENCRY_KEY_SIZE   (7)

Minimum encryption key size

◆ PRIMARY_SERVICE

#define PRIMARY_SERVICE   (0x01)

◆ PRIMARY_SERVICE_UUID

#define PRIMARY_SERVICE_UUID   (0x2800)

◆ SECONDARY_SERVICE

#define SECONDARY_SERVICE   (0x02)

◆ SECONDARY_SERVICE_UUID

#define SECONDARY_SERVICE_UUID   (0x2801)

◆ SERVICE_CHANGED_UUID

#define SERVICE_CHANGED_UUID   (0x2A05)

◆ UNIT_PRESSURE_BAR

#define UNIT_PRESSURE_BAR   0x2780

◆ UNIT_TEMP_CELSIUS

#define UNIT_TEMP_CELSIUS   0x272F

◆ UNIT_UNITLESS

#define UNIT_UNITLESS   0x2700

◆ UUID_TYPE_128

#define UUID_TYPE_128   (0x02)

◆ UUID_TYPE_16

#define UUID_TYPE_16   (0x01)

Typedef Documentation

◆ charactFormat

typedef __packed struct _charactFormat charactFormat
Generated on Mon Apr 15 2019 18:10:40 for BlueNRG-MS pack for STM32CubeMX by   doxygen 1.8.13
previous page start next page