Zephyr API Documentation  3.7.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Opcodes Aggregator Client model

Macros

#define BT_MESH_MODEL_OP_AGG_CLI
 Opcodes Aggregator Client model composition data entry.
 

Functions

int bt_mesh_op_agg_cli_seq_start (uint16_t net_idx, uint16_t app_idx, uint16_t dst, uint16_t elem_addr)
 Configure Opcodes Aggregator context.
 
int bt_mesh_op_agg_cli_seq_send (void)
 Opcodes Aggregator message send.
 
void bt_mesh_op_agg_cli_seq_abort (void)
 Abort Opcodes Aggregator context.
 
bool bt_mesh_op_agg_cli_seq_is_started (void)
 Check if Opcodes Aggregator Sequence context is started.
 
size_t bt_mesh_op_agg_cli_seq_tailroom (void)
 Get Opcodes Aggregator context tailroom.
 
int32_t bt_mesh_op_agg_cli_timeout_get (void)
 Get the current transmission timeout value.
 
void bt_mesh_op_agg_cli_timeout_set (int32_t timeout)
 Set the transmission timeout value.
 

Detailed Description

Macro Definition Documentation

◆ BT_MESH_MODEL_OP_AGG_CLI

#define BT_MESH_MODEL_OP_AGG_CLI

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Value:
BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_OP_AGG_CLI, _bt_mesh_op_agg_cli_op, \
NULL, NULL, &_bt_mesh_op_agg_cli_cb)
#define BT_MESH_MODEL_ID_OP_AGG_CLI
Opcodes Aggregator Client.
Definition: access.h:201
#define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)
Composition data SIG model entry with callback functions.
Definition: access.h:491

Opcodes Aggregator Client model composition data entry.

Function Documentation

◆ bt_mesh_op_agg_cli_seq_abort()

void bt_mesh_op_agg_cli_seq_abort ( void  )

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Abort Opcodes Aggregator context.

◆ bt_mesh_op_agg_cli_seq_is_started()

bool bt_mesh_op_agg_cli_seq_is_started ( void  )

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Check if Opcodes Aggregator Sequence context is started.

Returns
true if it is started, otherwise false.

◆ bt_mesh_op_agg_cli_seq_send()

int bt_mesh_op_agg_cli_seq_send ( void  )

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Opcodes Aggregator message send.

Uses previously configured context and sends aggregated message to target node.

Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_op_agg_cli_seq_start()

int bt_mesh_op_agg_cli_seq_start ( uint16_t  net_idx,
uint16_t  app_idx,
uint16_t  dst,
uint16_t  elem_addr 
)

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Configure Opcodes Aggregator context.

Parameters
net_idxNetKey index to encrypt with.
app_idxAppKey index to encrypt with.
dstTarget Opcodes Aggregator Server address.
elem_addrTarget node element address for the sequence message.
Returns
0 on success, or (negative) error code on failure.

◆ bt_mesh_op_agg_cli_seq_tailroom()

size_t bt_mesh_op_agg_cli_seq_tailroom ( void  )

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Get Opcodes Aggregator context tailroom.

Returns
Remaining tailroom of Opcodes Aggregator SDU.

◆ bt_mesh_op_agg_cli_timeout_get()

int32_t bt_mesh_op_agg_cli_timeout_get ( void  )

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Get the current transmission timeout value.

Returns
The configured transmission timeout in milliseconds.

◆ bt_mesh_op_agg_cli_timeout_set()

void bt_mesh_op_agg_cli_timeout_set ( int32_t  timeout)

#include <zephyr/bluetooth/mesh/op_agg_cli.h>

Set the transmission timeout value.

Parameters
timeoutThe new transmission timeout.