Bluenet  5.7.0
Bluenet, firmware for nRF52 smart home devices
Loading...
Searching...
No Matches
characteristic_config_t Struct Reference

#include <cs_CharacteristicStructs.h>

Public Attributes

bool read = false
 Whether the characteristic is readable. More...
 
bool write = false
 Whether the characteristic can be written to with or without response. More...
 
bool notify = false
 Whether the characteristic supports notifications and indications. More...
 
bool autoNotify = false
 Whether the characteristic should automatically notify the value when you updated the value. More...
 
bool notificationChunker = false
 Whether to notify the value in multiple notifications. More...
 
bool encrypted = false
 Whether to encrypt the characteristic value. More...
 
bool sharedEncryptionBuffer = false
 Whether to use a shared encryption buffer. More...
 
EncryptionAccessLevel minAccessLevel = ADMIN
 The minimum encryption level to be used for this characteristic. More...
 
ConnectionEncryptionType encryptionType = ConnectionEncryptionType::CTR
 Type of encryption to use. More...
 

Member Data Documentation

◆ autoNotify

bool characteristic_config_t::autoNotify = false

Whether the characteristic should automatically notify the value when you updated the value.

◆ encrypted

bool characteristic_config_t::encrypted = false

Whether to encrypt the characteristic value.

◆ encryptionType

ConnectionEncryptionType characteristic_config_t::encryptionType = ConnectionEncryptionType::CTR

Type of encryption to use.

◆ minAccessLevel

EncryptionAccessLevel characteristic_config_t::minAccessLevel = ADMIN

The minimum encryption level to be used for this characteristic.

If the characteristic value is set, it will encrypt itself with the key of this access level. If the characteristic value was written by the central, the user level must be at least this access level.

◆ notificationChunker

bool characteristic_config_t::notificationChunker = false

Whether to notify the value in multiple notifications.

This uses a bluenet specific protocol. This has a side effect that it changes the (encrypted) value of this characteristic. So the connected device won't be able to read the (encrypted) value anymore, it has to be done via notifications.

When not using this option, autoNotify will only send the first MAX_NOTIFICATION_LEN bytes.

When using a shared buffer, the data on this buffer should not be changed until all notifications are sent.

◆ notify

bool characteristic_config_t::notify = false

Whether the characteristic supports notifications and indications.

◆ read

bool characteristic_config_t::read = false

Whether the characteristic is readable.

◆ sharedEncryptionBuffer

bool characteristic_config_t::sharedEncryptionBuffer = false

Whether to use a shared encryption buffer.

If false, a buffer is allocated for the characteristic If true, the global EncryptionBuffer is used. This option has no effect when encryption is disabled.

◆ write

bool characteristic_config_t::write = false

Whether the characteristic can be written to with or without response.


The documentation for this struct was generated from the following file: