Bluenet  5.7.0
Bluenet, firmware for nRF52 smart home devices
Loading...
Searching...
No Matches
nrf_mesh_config_app.h File Reference
#include "cfg/cs_Config.h"
#include "fds.h"
#include "fds_internal_defs.h"
#include "sdk_config.h"
Include dependency graph for nrf_mesh_config_app.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define NRF_MESH_LOG_ENABLE   NRF_LOG_BACKEND_RTT_ENABLED
 Enable logging module. More...
 
#define LOG_LEVEL_DEFAULT   7
 Default log level. More...
 
#define LOG_ENABLE_RTT   NRF_LOG_BACKEND_RTT_ENABLED
 Enable logging with RTT callback. More...
 
#define MESH_FEATURE_RELAY_ENABLED   (1)
 Relay feature. More...
 
#define PERSISTENT_STORAGE   0
 Enable persistent storage. More...
 
#define MESH_EXTERNAL_PERSISTENT_STORAGE   0
 
#define SCANNER_ACTIVE_SCANNING   1
 Enable active scanning. More...
 
#define DEVICE_COMPANY_ID   (CROWNSTONE_COMPANY_ID)
 Device company identifier. More...
 
#define DEVICE_PRODUCT_ID   (0x0000)
 Device product identifier. More...
 
#define DEVICE_VERSION_ID   (0x0000)
 Device version identifier. More...
 
#define REPLAY_CACHE_ENTRIES   255
 Number of entries in the replay protection cache. More...
 
#define ACCESS_DEFAULT_TTL   (CS_MESH_DEFAULT_TTL)
 The default TTL value for the node. More...
 
#define ACCESS_MODEL_COUNT
 The number of models in the application. More...
 
#define ACCESS_ELEMENT_COUNT   (1)
 The number of elements in the application. More...
 
#define HEALTH_SERVER_ELEMENT_COUNT   (1)
 The number of instances of the health server model. More...
 
#define ACCESS_SUBSCRIPTION_LIST_COUNT   (ACCESS_MODEL_COUNT)
 The number of allocated subscription lists for the application. More...
 
#define ACCESS_FLASH_PAGE_COUNT   (1)
 The number of pages of flash storage reserved for the access layer for persistent data storage. More...
 
#define ACCESS_RELIABLE_TRANSFER_COUNT
 Number of the allowed parallel transfers (size of the internal context pool). More...
 
#define MODEL_ACKNOWLEDGED_TRANSACTION_TIMEOUT   (SEC_TO_US(3))
 Define for acknowledging message transaction timeout, in micro seconds. More...
 
#define DSM_SUBNET_MAX   (4)
 Maximum number of subnetworks. More...
 
#define DSM_APP_MAX   (1)
 Maximum number of applications. More...
 
#define DSM_DEVICE_MAX   (1)
 Maximum number of device keys. More...
 
#define DSM_VIRTUAL_ADDR_MAX   (2)
 Maximum number of virtual addresses. More...
 
#define DSM_NONVIRTUAL_ADDR_MAX   (ACCESS_MODEL_COUNT + 1)
 Maximum number of non-virtual addresses. More...
 
#define DSM_FLASH_PAGE_COUNT   (1)
 Number of flash pages reserved for the DSM storage. More...
 
#define FLASH_MANAGER_RECOVERY_PAGE_OFFSET_PAGES   (2 + FDS_PHY_PAGES)
 Number of flash pages to be reserved between the flash manager recovery page and the bootloader. More...
 

Macro Definition Documentation

◆ ACCESS_DEFAULT_TTL

#define ACCESS_DEFAULT_TTL   (CS_MESH_DEFAULT_TTL)

The default TTL value for the node.

◆ ACCESS_ELEMENT_COUNT

#define ACCESS_ELEMENT_COUNT   (1)

The number of elements in the application.

Warning
If the application is to support multiple instances of the same model, these instances cannot be in the same element and a separate element is needed for each new instance of the same model.

◆ ACCESS_FLASH_PAGE_COUNT

#define ACCESS_FLASH_PAGE_COUNT   (1)

The number of pages of flash storage reserved for the access layer for persistent data storage.

◆ ACCESS_MODEL_COUNT

#define ACCESS_MODEL_COUNT
Value:
(1 /* Configuration server */ \
+ 1 /* Health server */ \
+ 1 /* Crownstone multicast model */ \
+ 1 /* Crownstone multicast acked model */ \
+ 1 /* Crownstone unicast model */ \
+ 1 /* Crownstone multicast neighbours model */)

The number of models in the application.

Note
To fit the configuration and health models, this value must equal at least the number of models needed by the application plus two.

◆ ACCESS_RELIABLE_TRANSFER_COUNT

#define ACCESS_RELIABLE_TRANSFER_COUNT
Value:
(1 /* Configuration server */ \
+ 1 /* Health server */ \
+ 1 /* Crownstone unicast model */)

Number of the allowed parallel transfers (size of the internal context pool).

◆ ACCESS_SUBSCRIPTION_LIST_COUNT

#define ACCESS_SUBSCRIPTION_LIST_COUNT   (ACCESS_MODEL_COUNT)

The number of allocated subscription lists for the application.

Note
This value must equal ACCESS_MODEL_COUNT minus the number of models operating on shared states.

◆ DEVICE_COMPANY_ID

#define DEVICE_COMPANY_ID   (CROWNSTONE_COMPANY_ID)

Device company identifier.

◆ DEVICE_PRODUCT_ID

#define DEVICE_PRODUCT_ID   (0x0000)

Device product identifier.

◆ DEVICE_VERSION_ID

#define DEVICE_VERSION_ID   (0x0000)

Device version identifier.

◆ DSM_APP_MAX

#define DSM_APP_MAX   (1)

Maximum number of applications.

◆ DSM_DEVICE_MAX

#define DSM_DEVICE_MAX   (1)

Maximum number of device keys.

◆ DSM_FLASH_PAGE_COUNT

#define DSM_FLASH_PAGE_COUNT   (1)

Number of flash pages reserved for the DSM storage.

◆ DSM_NONVIRTUAL_ADDR_MAX

#define DSM_NONVIRTUAL_ADDR_MAX   (ACCESS_MODEL_COUNT + 1)

Maximum number of non-virtual addresses.

One for each of the servers and a group address.

  • Generic OnOff publication
  • Health publication
  • Subscription address

◆ DSM_SUBNET_MAX

#define DSM_SUBNET_MAX   (4)

Maximum number of subnetworks.

◆ DSM_VIRTUAL_ADDR_MAX

#define DSM_VIRTUAL_ADDR_MAX   (2)

Maximum number of virtual addresses.

◆ FLASH_MANAGER_RECOVERY_PAGE_OFFSET_PAGES

#define FLASH_MANAGER_RECOVERY_PAGE_OFFSET_PAGES   (2 + FDS_PHY_PAGES)

Number of flash pages to be reserved between the flash manager recovery page and the bootloader.

Note
This value will be ignored if FLASH_MANAGER_RECOVERY_PAGE is set.

◆ HEALTH_SERVER_ELEMENT_COUNT

#define HEALTH_SERVER_ELEMENT_COUNT   (1)

The number of instances of the health server model.

◆ LOG_ENABLE_RTT

#define LOG_ENABLE_RTT   NRF_LOG_BACKEND_RTT_ENABLED

Enable logging with RTT callback.

◆ LOG_LEVEL_DEFAULT

#define LOG_LEVEL_DEFAULT   7

Default log level.

Messages with lower criticality is filtered.

◆ MESH_EXTERNAL_PERSISTENT_STORAGE

#define MESH_EXTERNAL_PERSISTENT_STORAGE   0

◆ MESH_FEATURE_RELAY_ENABLED

#define MESH_FEATURE_RELAY_ENABLED   (1)

Relay feature.

◆ MODEL_ACKNOWLEDGED_TRANSACTION_TIMEOUT

#define MODEL_ACKNOWLEDGED_TRANSACTION_TIMEOUT   (SEC_TO_US(3))

Define for acknowledging message transaction timeout, in micro seconds.

◆ NRF_MESH_LOG_ENABLE

#define NRF_MESH_LOG_ENABLE   NRF_LOG_BACKEND_RTT_ENABLED

Enable logging module.

◆ PERSISTENT_STORAGE

#define PERSISTENT_STORAGE   0

Enable persistent storage.

◆ REPLAY_CACHE_ENTRIES

#define REPLAY_CACHE_ENTRIES   255

Number of entries in the replay protection cache.

Note
The number of entries in the replay protection list directly limits the number of elements a node can receive messages from on the current IV index. This means if your device has a replay protection list with 40 entries, a message from a 41st unicast address (element )will be dropped by the transport layer.
The replay protection list size does not affect the node's ability to relay messages.
This number is indicated in the device composition data of the node and provisioner can make use of this information to prevent unwarranted filling of the replay list on a given node in a mesh network.

◆ SCANNER_ACTIVE_SCANNING

#define SCANNER_ACTIVE_SCANNING   1

Enable active scanning.