/** **************************************************************************************** * * @file mm_lightc_ln.c * * @brief Mesh Model Light Lightness Client Module * **************************************************************************************** */ /** **************************************************************************************** * @addtogroup MM_LIGHTC_LN * @{ **************************************************************************************** */ /* * INCLUDE FILES **************************************************************************************** */ #include "mm_itf.h" #include "mm_lightc.h" /* * TYPE DEFINITIONS **************************************************************************************** */ /// Structure for Light Lightness Client model environment typedef struct mm_lightc_ln_env { /// Basic model environment - Must be first element in the structure - DO NOT MOVE mm_mdl_env_t env; } mm_lightc_ln_env_t; /* * MESSAGE HANDLERS **************************************************************************************** */ /** **************************************************************************************** * @brief Handler for Light Lightness Status and Light Lightness Linear Status messages. * Note that both messages have same content. * * @param[in] p_buf Pointer to buffer containing the received message * @param[in] src Source address of the message * @param[in] linear True if message is a Light Lightness Linear Status message, else * False **************************************************************************************** */ __STATIC void mm_lightc_ln_handler_status(mesh_buf_t *p_buf, uint16_t src, bool linear) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf); // Present lightness value uint16_t lightness = read16p(p_data + MM_LIGHT_LN_STATUS_LIGHTNESS_POS); // Target lightness value uint16_t lightness_tgt; // Remaining time in milliseconds uint32_t rem_time_ms; // Check if optional parameters are provided if (p_buf->data_len == MM_LIGHT_LN_STATUS_LEN) { lightness_tgt = read16p(p_data + MM_LIGHT_LN_STATUS_TGT_LIGHTNESS_POS); rem_time_ms = mm_get_trans_time_ms(*(p_data + MM_LIGHT_LN_STATUS_REM_TIME_POS)); } else { lightness_tgt = 0; rem_time_ms = 0; } // Inform the application about the received Light Lightness or Light Lightness Linear state value mm_cli_state_ind_send(src, (linear) ? MM_STATE_LIGHT_LN_LIN : MM_STATE_LIGHT_LN, lightness, lightness_tgt, rem_time_ms); } /** **************************************************************************************** * @brief Handler for Light Lightness Last Status message * * @param[in] p_buf Pointer to buffer containing the received message * @param[in] src Source address of the message **************************************************************************************** */ __STATIC void mm_lightc_ln_handler_status_last(mesh_buf_t *p_buf, uint16_t src) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf); // Light Lightness Last state value uint16_t lightness_last = read16p(p_data + MM_LIGHT_LN_LAST_STATUS_LIGHTNESS_POS); // Inform the application about the received Light Lightness Last state value mm_cli_state_ind_send(src, MM_STATE_LIGHT_LN_LAST, lightness_last, 0, 0); } /** **************************************************************************************** * @brief Handler for Light Lightness Default Status message * * @param[in] p_buf Pointer to buffer containing the received message * @param[in] src Source address of the message **************************************************************************************** */ __STATIC void mm_lightc_ln_handler_status_dflt(mesh_buf_t *p_buf, uint16_t src) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf); // Light Lightness Default state value uint16_t lightness_dflt = read16p(p_data + MM_LIGHT_LN_DFLT_STATUS_LIGHTNESS_POS); // Inform the application about the received Light Lightness Default state value mm_cli_state_ind_send(src, MM_STATE_LIGHT_LN_DFLT, lightness_dflt, 0, 0); } /** **************************************************************************************** * @brief Handler for Light Lightness Range Status message * * @param[in] p_buf Pointer to buffer containing the received message * @param[in] src Source address of the message **************************************************************************************** */ __STATIC void mm_lightc_ln_handler_status_range(mesh_buf_t *p_buf, uint16_t src) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf); // Light Lightness Range state value (minimum) uint16_t lightness_min = read16p(p_data + MM_LIGHT_LN_RANGE_STATUS_MIN_POS); // Light Lightness Range state value (maximum) uint16_t lightness_max = read16p(p_data + MM_LIGHT_LN_RANGE_STATUS_MAX_POS); // Inform the application about the received Light Lightness Range state value mm_cli_state_ind_send(src, MM_STATE_LIGHT_LN_RANGE, lightness_min, lightness_max, 0); } /* * INTERNAL CALLBACK FUNCTIONS **************************************************************************************** */ /** **************************************************************************************** * @brief Inform Light Lightness Client model about reception of a message * * @param[in] p_env Pointer to the environment allocated for the model * @param[in] p_buf Pointer to buffer containing the received message * @param[in] p_route_env Pointer to routing environment containing information about the * received message **************************************************************************************** */ __STATIC void mm_lightc_ln_cb_rx(mm_mdl_env_t *p_env, mesh_buf_t *p_buf, mm_route_env_t *p_route_env) { // Call the appropriate handler for the received message switch (p_route_env->opcode) { case (MM_MSG_LIGHT_LN_STATUS): case (MM_MSG_LIGHT_LN_LINEAR_STATUS): { mm_lightc_ln_handler_status(p_buf, p_route_env->u_addr.src, (p_route_env->opcode == MM_MSG_LIGHT_LN_LINEAR_STATUS)); } break; case (MM_MSG_LIGHT_LN_LAST_STATUS): { mm_lightc_ln_handler_status_last(p_buf, p_route_env->u_addr.src); } break; case (MM_MSG_LIGHT_LN_DFLT_STATUS): { mm_lightc_ln_handler_status_dflt(p_buf, p_route_env->u_addr.src); } break; case (MM_MSG_LIGHT_LN_RANGE_STATUS): { mm_lightc_ln_handler_status_range(p_buf, p_route_env->u_addr.src); } break; default: { } break; } } /** **************************************************************************************** * @brief Inform Light Lightness Client model about a received opcode in order * to check if the model is authorized to handle the associated message * * @param[in] p_env Pointer to the environment allocated for the model * @param[in] opcode Opcode value to be checked * * @return An error status (@see enum mesh_err) **************************************************************************************** */ __STATIC uint8_t mm_lightc_ln_cb_opcode_check(mm_mdl_env_t *p_env, uint32_t opcode) { uint8_t status; if ((opcode == MM_MSG_LIGHT_LN_STATUS) || (opcode == MM_MSG_LIGHT_LN_LINEAR_STATUS) || (opcode == MM_MSG_LIGHT_LN_LAST_STATUS) || (opcode == MM_MSG_LIGHT_LN_DFLT_STATUS) || (opcode == MM_MSG_LIGHT_LN_RANGE_STATUS)) { status = MESH_ERR_NO_ERROR; } else { status = MESH_ERR_MDL_INVALID_OPCODE; } return (status); } /** **************************************************************************************** * @brief Get Light Lightness Get or Light Lightness Linear Get or Light Lightness Last * Get or Light Lightness Default Get or Light Lightness Range Get state value * * - Light Lightness Get: Light Lightness state value * - Light Lightness Linear Get: Light Lightness Linear state value * - Light Lightness Last Get: Light Lightness Last state value * - Light Lightness Default Get: Light Lightness Default state value * - Light Lightness Range Get: Light Lightness Range state value * * @param[in] p_env Pointer to the environment allocated for the model * @param[in] dst Address of node's element from which state value must be retrieved * @param[in] get_option Get option (@see enum mm_get_type_light_ln) * * @return An error status (@see enum mesh_err) **************************************************************************************** */ __STATIC uint8_t mm_lightc_ln_cb_get(mm_mdl_env_t *p_env, m_lid_t app_key_lid, uint16_t dst, uint16_t get_info) { // Status uint8_t status = MESH_ERR_NO_ERROR; // Get type uint8_t get_type = get_info; // Check option value if (get_type <= MM_GET_TYPE_LIGHT_LN_MAX) { // Pointer to the buffer that will contain the message mesh_buf_t *p_buf_get; // Allocate a new buffer for the message p_buf_get = mm_route_buf_alloc(0); if (p_buf_get) { // Get pointer to environment mm_route_env_t *p_buf_env = (mm_route_env_t *)&p_buf_get->env; // Prepare environment p_buf_env->app_key_lid = app_key_lid; p_buf_env->u_addr.dst = dst; p_buf_env->info = 0; p_buf_env->mdl_lid = p_env->mdl_lid; if (get_type == MM_GET_TYPE_LIGHT_LN_ACTUAL) { p_buf_env->opcode = MM_MSG_LIGHT_LN_GET; } else if (get_type == MM_GET_TYPE_LIGHT_LN_LINEAR) { p_buf_env->opcode = MM_MSG_LIGHT_LN_LINEAR_GET; } else if (get_type == MM_GET_TYPE_LIGHT_LN_DFLT) { p_buf_env->opcode = MM_MSG_LIGHT_LN_DFLT_GET; } else if (get_type == MM_GET_TYPE_LIGHT_LN_LAST) { p_buf_env->opcode = MM_MSG_LIGHT_LN_LAST_GET; } else // (option == MM_GET_TYPE_LIGHT_LN_RANGE) { p_buf_env->opcode = MM_MSG_LIGHT_LN_RANGE_GET; } // Send the message mm_route_send(p_buf_get); } else { status = MESH_ERR_INSUFFICIENT_RESOURCES; } } else { status = MESH_ERR_INVALID_PARAM; } return (status); } /** **************************************************************************************** * @brief Set Light Lightness or Light Lightness Linear state value. Note that Light Lightness * Set/Set Unacknowledged and Light Lightness Linear Set/Set Unacknowledged have the same * content. * * @param[in] p_env Pointer to the environment allocated for the model * @param[in] dst Address of node's element on which state value must be set * @param[in] state_1 State value 1 * @param[in] state_2 State value 2 * @param[in] trans_time_ms Transition time in milliseconds * @param[in] delay_ms Delay in milliseconds * @param[in] trans_info Transition information * * @return An error status (@see enum mesh_err) **************************************************************************************** */ __STATIC uint8_t mm_lightc_ln_cb_trans(mm_mdl_env_t *p_env, m_lid_t app_key_lid, uint16_t dst, uint32_t state_1, uint32_t state_2, uint32_t trans_time_ms, uint16_t delay_ms, uint16_t trans_info) { // Transition type uint8_t trans_type = GETF(trans_info, MM_TRANS_INFO_TYPE); // Status uint8_t status = MESH_ERR_NO_ERROR; if (trans_type <= MM_TRANS_TYPE_LIGHT_LN_MAX) { // Long message or not bool long_set = (GETB(trans_info, MM_TRANS_INFO_LONG) || trans_time_ms || delay_ms); // Pointer to the buffer that will contain the message mesh_buf_t *p_buf_set = mm_route_buf_alloc( (long_set) ? MM_LIGHT_LN_SET_LEN : MM_LIGHT_LN_SET_MIN_LEN); if (p_buf_set) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf_set); // Get pointer to environment mm_route_env_t *p_buf_env = (mm_route_env_t *)&p_buf_set->env; // Prepare environment p_buf_env->app_key_lid = app_key_lid; p_buf_env->u_addr.dst = dst; p_buf_env->info = 0; p_buf_env->mdl_lid = p_env->mdl_lid; // Set opcode if (trans_type == MM_TRANS_TYPE_LIGHT_LN_LIN) { p_buf_env->opcode = (GETB(trans_info, MM_TRANS_INFO_ACK)) ? MM_MSG_LIGHT_LN_LINEAR_SET : MM_MSG_LIGHT_LN_LINEAR_SET_UNACK; } else { p_buf_env->opcode = (GETB(trans_info, MM_TRANS_INFO_ACK)) ? MM_MSG_LIGHT_LN_SET : MM_MSG_LIGHT_LN_SET_UNACK; } // Fill the message write16p(p_data + MM_LIGHT_LN_SET_LIGHTNESS_POS, state_1); *(p_data + MM_LIGHT_LN_SET_TID_POS) = GETF(trans_info, MM_TRANS_INFO_TID); if (long_set) { // Set transition time and delay values *(p_data + MM_LIGHT_LN_SET_TRANS_TIME_POS) = mm_get_trans_time(trans_time_ms); *(p_data + MM_LIGHT_LN_SET_DELAY_POS) = delay_ms / 5; } // Send the message mm_route_send(p_buf_set); } else { status = MESH_ERR_INSUFFICIENT_RESOURCES; } } else { status = MESH_ERR_INVALID_PARAM; } return (status); } /** **************************************************************************************** * @brief Set Light Lightness Default or Light Lightness Range state value * * @param[in] p_env Pointer to the environment allocated for the model * @param[in] dst Address of node's element on which state value must be set * @param[in] state_1 State value 1 * @param[in] state_2 State value 2 * @param[in] set_info Set information * * @return An error status (@see enum mesh_err) **************************************************************************************** */ __STATIC uint8_t mm_lightc_ln_cb_set(mm_mdl_env_t *p_env, m_lid_t app_key_lid, uint16_t dst, uint32_t state_1, uint32_t state_2, uint16_t set_info) { // Set type uint8_t set_type = GETF(set_info, MM_SET_INFO_TYPE); // Status uint8_t status = MESH_ERR_NO_ERROR; // Check provided set type if (set_type <= MM_SET_TYPE_LIGHT_LN_MAX) { // Pointer to the buffer that will contain the message mesh_buf_t *p_buf_set; // Opcode uint32_t opcode; // Length uint8_t length; if (set_type == MM_SET_TYPE_LIGHT_LN_DFLT) { length = MM_LIGHT_LN_DFLT_SET_LEN; opcode = GETB(set_info, MM_SET_INFO_ACK) ? MM_MSG_LIGHT_LN_DFLT_SET : MM_MSG_LIGHT_LN_DFLT_SET_UNACK; } else // (set_type == MM_SET_TYPE_LIGHT_LN_RANGE) { length = MM_LIGHT_LN_RANGE_SET_LEN; opcode = GETB(set_info, MM_SET_INFO_ACK) ? MM_MSG_LIGHT_LN_RANGE_SET : MM_MSG_LIGHT_LN_RANGE_SET_UNACK; } // Allocate a new buffer for the publication p_buf_set = mm_route_buf_alloc(length); if (p_buf_set) { // Get pointer to data uint8_t *p_data = MESH_BUF_DATA(p_buf_set); // Get pointer to environment mm_route_env_t *p_buf_env = (mm_route_env_t *)&p_buf_set->env; // Prepare environment p_buf_env->app_key_lid = app_key_lid; p_buf_env->u_addr.dst = dst; p_buf_env->info = 0; p_buf_env->mdl_lid = p_env->mdl_lid; p_buf_env->opcode = opcode; // Fill the message if (set_type == MM_SET_TYPE_LIGHT_LN_DFLT) { write16p(p_data + MM_LIGHT_LN_DFLT_SET_LIGHTNESS_POS, state_1); } else // (set_type == MM_SET_TYPE_LN_RANGE) { write16p(p_data + MM_LIGHT_LN_RANGE_SET_MIN_POS, state_1); write16p(p_data + MM_LIGHT_LN_RANGE_SET_MAX_POS, state_2); } // Send the message mm_route_send(p_buf_set); } else { status = MESH_ERR_INSUFFICIENT_RESOURCES; } } else { status = MESH_ERR_INVALID_PARAM; } return (status); } /* * GLOBAL FUNCTIONS **************************************************************************************** */ __STATIC mm_cli_cb_t mm_lightc_ln_cb = { .cb_get = mm_lightc_ln_cb_get, .cb_set = mm_lightc_ln_cb_set, .cb_trans = mm_lightc_ln_cb_trans, }; uint8_t mm_lightc_ln_register(void) { // Register the model m_lid_t mdl_lid = ms_register_model(MM_ID_LIGHTC_LN, 0, MM_CFG_PUBLI_AUTH_BIT); if (mdl_lid != MESH_INVALID_LID) //if (status == MESH_ERR_NO_ERROR) { // Inform the Model State Manager about registered model mm_lightc_ln_env_t *p_env_ln = (mm_lightc_ln_env_t *)mm_state_register(0, MM_ID_LIGHTC_LN, mdl_lid, MM_ROLE_CLI, sizeof(mm_lightc_ln_env_t)); if (p_env_ln) { // Get client-specific callback functions //mm_cli_cb_t *p_cb_cli = p_env_ln->env.cb.u.p_cb_cli; // Set internal callback functions p_env_ln->env.mdl_cb.cb_rx = mm_lightc_ln_cb_rx; p_env_ln->env.mdl_cb.cb_opcode_check = mm_lightc_ln_cb_opcode_check; //p_cb_cli->cb_get = mm_lightc_ln_cb_get; //p_cb_cli->cb_set = mm_lightc_ln_cb_set; //p_cb_cli->cb_trans = mm_lightc_ln_cb_trans; p_env_ln->env.mdl_cb.p_cb_cli = &mm_lightc_ln_cb; // Inform application about registered model mm_register_ind_send(MM_ID_LIGHTC_LN, 0, mdl_lid); } } return (mdl_lid); } /// @} end of group