Exported Functions

group HB_Exported_Functions

Functions

bool hb_init(hb_data_cb pcb)

initialize heartbeat module

Parameters:

pcb – [in] heartbeat callback function

void hb_deinit(void)

deinitialize heartbeat module

void hb_timer_start(uint8_t timer)

start the heartbeat timer

Parameters:

timer – [in] HB_TIMER_PUB or HB_TIMER_SUB

Returns:

none

void hb_timer_stop(uint8_t timer)

stop the heartbeat timer

Parameters:

timer – [in] HB_TIMER_PUB or HB_TIMER_SUB

Returns:

none

bool hb_receive_filter(uint16_t src, uint16_t dst)

detect if the message need be processed

Parameters:

• src – [in] message source addr

• dst – [in] message destination addr

Return values:

• true – need process

• false – do not process

Returns:

operation result

bool hb_handle_msg(mesh_msg_p pmesh_msg)

process the message

Parameters:

pmesh_msg – [in] mesh message

Return values:

• true – processed

• false – not processed

Returns:

operation result

void hb_msg_send(hb_trigger_type_t type)

send hb message

Parameters:

type – [in] the trigger source type

Returns:

none

void hb_handle_timeout(uint8_t timer)

timeout handler

Parameters:

timer – [in] publish or subscribe

Returns:

none

void hb_publication_set(hb_pub_t pub)

set heartbeat publication parameter

Parameters:

pub – [in] heartbeat publication parameter

hb_pub_t hb_publication_get(void)

get heartbeat publication parameter

Returns:

heartbeat publication parameter

void hb_subscription_set(hb_sub_t sub)

set heartbeat subscription parameter

Parameters:

sub – [in] heartbeat subscription parameter

hb_sub_t hb_subscription_get(void)

get heartbeat subscription parameter

Returns:

heartbeat subscription parameter

uint8_t hb_log2_greater(uint16_t value)

log value

Parameters:

value – [in] value to log, 2exp(n-1) is greater than or equal to value

Returns:

log value

uint8_t hb_log2_less(uint16_t value)

log value

Parameters:

value – [in] value to log, 2exp(n-1) is less than or equal to value

Returns:

log value

uint16_t hb_exp2(uint8_t log_value)

exp value

Parameters:

log_value – [in] value to exp

Returns:

exp value