michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: Mesh: Add option to call update cb on every retransmission

Browse source 
A user may want to control message parameters (for example, delay
parameter) on every retransmission of a published message (for example,
see section 1.4.1 of the mesh model specification). This is essential
for lighting messages as time gap between messages retransmitted via
the publish-retransmit mechanism introduces unwanted jitter/pop-corn
when such retransmissions are received by a large 'group' of lights.

This commit adds an option to `struct bt_mesh_model_pub` to make the
access layer call `bt_mesh_model_pub.update` callback on every
retransmission. This also addes few macros and functions that can be
used for further calculations.

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
This commit is contained in:
Pavel Vasilyev 2021-11-05 16:25:51 +01:00 • committed by Johan Hedberg
commit 70b0734b5e
3 changed files with 61 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

42
include/bluetooth/mesh/access.h
View file

@ -343,6 +343,29 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_PUB_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 50)
/** @def BT_MESH_PUB_MSG_TOTAL
*
* @brief Get total number of messages within one publication interval including initial
* publication.
*
* @param pub Model publication context.
*
* @return total number of messages.
*/
#define BT_MESH_PUB_MSG_TOTAL(pub) (BT_MESH_PUB_TRANSMIT_COUNT((pub)->retransmit) + 1)
/** @def BT_MESH_PUB_MSG_NUM
*
* @brief Get message number within one publication interval.
*
* Meant to be used inside @ref bt_mesh_model_pub.update.
*
* @param pub Model publication context.
*
* @return message number starting from 1.
*/
#define BT_MESH_PUB_MSG_NUM(pub) (BT_MESH_PUB_TRANSMIT_COUNT((pub)->retransmit) + 1 - (pub)->count)
/** Model publication context.
*
* The context should primarily be created using the
@ -356,7 +379,8 @@ struct bt_mesh_model_pub {
uint16_t key:12, /**< Publish AppKey Index. */
cred:1, /**< Friendship Credentials Flag. */
send_rel:1, /**< Force reliable sending (segment acks) */
fast_period:1; /**< Use FastPeriodDivisor */
fast_period:1, /**< Use FastPeriodDivisor */
retr_update:1; /**< Call update callback on every retransmission. */
uint8_t ttl; /**< Publish Time to Live. */
uint8_t retransmit; /**< Retransmit Count & Interval Steps. */
@ -386,6 +410,9 @@ struct bt_mesh_model_pub {
* If the callback returns non-zero, the publication is skipped
* and will resume on the next periodic publishing interval.
*
* When @ref bt_mesh_model_pub.retr_update is set to 1,
* the callback will be called on every retransmission.
*
* @param mod The Model the Publication Context belogs to.
*
* @return Zero on success or (negative) error code otherwise.
@ -572,6 +599,19 @@ int bt_mesh_model_send(struct bt_mesh_model *model,
*/
int bt_mesh_model_publish(struct bt_mesh_model *model);
/** @brief Check if a message is being retransmitted.
*
* Meant to be used inside the @ref bt_mesh_model_pub.update callback.
*
* @param model Mesh Model that supports publication.
*
* @return true if this is a retransmission, false if this is a first publication.
*/
static inline bool bt_mesh_model_pub_is_retransmission(const struct bt_mesh_model *model)
{
return model->pub->count != BT_MESH_PUB_TRANSMIT_COUNT(model->pub->retransmit);
}
/** @brief Get the element that a model belongs to.
*
* @param mod Mesh model.