mesh_light_hsl_client.c

/*
 * Copyright 2016-2023, Cypress Semiconductor Corporation (an Infineon company) or
 * an affiliate of Cypress Semiconductor Corporation.  All rights reserved.
 *
 * This software, including source code, documentation and related
 * materials ("Software") is owned by Cypress Semiconductor Corporation
 * or one of its affiliates ("Cypress") and is protected by and subject to
 * worldwide patent protection (United States and foreign),
 * United States copyright laws and international treaty provisions.
 * Therefore, you may use this Software only as provided in the license
 * agreement accompanying the software package from which you
 * obtained this Software ("EULA").
 * If no EULA applies, Cypress hereby grants you a personal, non-exclusive,
 * non-transferable license to copy, modify, and compile the Software
 * source code solely for use in connection with Cypress's
 * integrated circuit products.  Any reproduction, modification, translation,
 * compilation, or representation of this Software except as specified
 * above is prohibited without the express written permission of Cypress.
 *
 * Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress
 * reserves the right to make changes to the Software without notice. Cypress
 * does not assume any liability arising out of the application or use of the
 * Software or any product or circuit described in the Software. Cypress does
 * not authorize its products for use in any products where a malfunction or
 * failure of the Cypress product may reasonably be expected to result in
 * significant property damage, injury or death ("High Risk Product"). By
 * including Cypress's product in a High Risk Product, the manufacturer
 * of such system or application assumes all risk of such use and in doing
 * so agrees to indemnify Cypress against all liability.
 */

/** @file
 *
 *
 * This file shows how to create a device which implements mesh Mesh Light HSL Client.
 */

#ifdef WICED_BT_MESH_MODEL_LIGHT_HSL_CLIENT_INCLUDED

#include "wiced_bt_ble.h"
#include "wiced_bt_gatt.h"
#include "wiced_bt_mesh_models.h"
#include "wiced_bt_trace.h"
#include "wiced_bt_mesh_app.h"

#ifdef HCI_CONTROL
#include "wiced_transport.h"
#include "hci_control_api.h"
#endif

#define MESH_LIGHT_HSL_CLIENT_ELEMENT_INDEX   0

/******************************************************
 *          Structures
 ******************************************************/

/******************************************************
 *          Function Prototypes
 ******************************************************/
void mesh_light_hsl_client_message_handler(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data);
static void mesh_light_hsl_client_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_target_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_hue_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_hue_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_saturation_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_saturation_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_range_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_range_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_default_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_client_default_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_light_hsl_hci_event_send_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_status_data_t *p_data);
static void mesh_light_hsl_hci_event_send_target_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_target_status_data_t *);
static void mesh_light_hsl_hci_event_send_hue_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_hue_status_data_t *p_data);
static void mesh_light_hsl_hci_event_send_saturation_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_saturation_status_data_t *p_data);
static void mesh_light_hsl_hci_event_send_default_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_default_data_t *p_data);
static void mesh_light_hsl_hci_event_send_range_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_range_status_data_t *p_data);

/******************************************************
 *          Variables Definitions
 ******************************************************/

/*
 * Process event received from the Light HSL Server.
 */
void mesh_light_hsl_client_message_handler(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
{
#if defined HCI_CONTROL
    wiced_bt_mesh_hci_event_t *p_hci_event;
#endif
    wiced_bt_mesh_light_hsl_status_data_t *p_status;
    wiced_bt_mesh_light_hsl_target_status_data_t *p_target_status;
    wiced_bt_mesh_light_hsl_hue_status_data_t *p_hue_status;
    wiced_bt_mesh_light_hsl_saturation_status_data_t *p_saturation_status;
    wiced_bt_mesh_light_hsl_range_status_data_t *p_range_status;
    wiced_bt_mesh_light_hsl_default_data_t *p_default_status;

    WICED_BT_TRACE("light hsl clnt msg:%d\n", event);

    switch (event)
    {
    case WICED_BT_MESH_TX_COMPLETE:
        WICED_BT_TRACE("tx complete status:%d\n", p_event->status.tx_flag);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            wiced_bt_mesh_send_hci_tx_complete(p_hci_event, p_event);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_STATUS:
        p_status = (wiced_bt_mesh_light_hsl_status_data_t *)p_data;
        WICED_BT_TRACE("light status present light:%d hue:%d saturation:%d remain time:%d\n",
                p_status->present.lightness, p_status->present.hue, p_status->present.saturation, p_status->remaining_time);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_status(p_hci_event, p_status);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_TARGET_STATUS:
        p_target_status = (wiced_bt_mesh_light_hsl_target_status_data_t *)p_data;
        WICED_BT_TRACE("light status target light:%d hue:%d saturation:%d remain time:%d\n",
            p_target_status->target.lightness, p_target_status->target.hue, p_target_status->target.saturation, p_target_status->remaining_time);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_target_status(p_hci_event, p_target_status);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_HUE_STATUS:
        p_hue_status = (wiced_bt_mesh_light_hsl_hue_status_data_t *)p_data;
        WICED_BT_TRACE("light status hue present:%d target:%d remain time:%d\n",
            p_hue_status->present_hue, p_hue_status->target_hue, p_hue_status->remaining_time);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_hue_status(p_hci_event, p_hue_status);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_SATURATION_STATUS:
        p_saturation_status = (wiced_bt_mesh_light_hsl_saturation_status_data_t *)p_data;
        WICED_BT_TRACE("light status saturation present:%d target:%d remain time:%d\n",
            p_saturation_status->present_saturation, p_saturation_status->target_saturation, p_saturation_status->remaining_time);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_saturation_status(p_hci_event, p_saturation_status);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_DEFAULT_STATUS:
        p_default_status = (wiced_bt_mesh_light_hsl_default_data_t *)p_data;
        WICED_BT_TRACE("default lightness:%d hue:%d saturation:%d\n",
            p_default_status->default_status.lightness, p_default_status->default_status.hue, p_default_status->default_status.saturation);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_default_status(p_hci_event, p_default_status);
#endif
        break;

    case WICED_BT_MESH_LIGHT_HSL_RANGE_STATUS:
        p_range_status = (wiced_bt_mesh_light_hsl_range_status_data_t *)p_data;
        WICED_BT_TRACE("range status:%d hue min/max:%d/%d saturation:%d/%d\n", p_range_status->status,
            p_range_status->hue_min, p_range_status->hue_max, p_range_status->saturation_min, p_range_status->saturation_max);
#if defined HCI_CONTROL
        if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
            mesh_light_hsl_hci_event_send_range_status(p_hci_event, p_range_status);
#endif
        break;

    default:
        break;
    }
    wiced_bt_mesh_release_event(p_event);
}

/*
 * In 2 chip solutions MCU can send commands to change onoff state.
 */
uint32_t mesh_light_hsl_client_proc_rx_cmd(uint16_t opcode, uint8_t *p_data, uint32_t length)
{
#ifdef HCI_CONTROL
    wiced_bt_mesh_event_t *p_event;

    switch (opcode)
    {
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_TARGET_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_RANGE_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_RANGE_SET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_DEFAULT_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_DEFAULT_SET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_HUE_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_HUE_SET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SATURATION_GET:
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SATURATION_SET:
        break;

    default:
        return WICED_FALSE;
    }
    p_event = wiced_bt_mesh_create_event_from_wiced_hci(opcode, MESH_COMPANY_ID_BT_SIG, WICED_BT_MESH_CORE_MODEL_ID_LIGHT_HSL_CLNT, &p_data, &length);
    if (p_event == NULL)
    {
        WICED_BT_TRACE("light hsl bad hdr\n");
        return WICED_TRUE;
    }
    switch (opcode)
    {
    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_GET:
        mesh_light_hsl_client_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SET:
        mesh_light_hsl_client_set(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_TARGET_GET:
        mesh_light_hsl_client_target_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_RANGE_GET:
        mesh_light_hsl_client_range_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_RANGE_SET:
        mesh_light_hsl_client_range_set(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_DEFAULT_GET:
        mesh_light_hsl_client_default_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_DEFAULT_SET:
        mesh_light_hsl_client_default_set(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_HUE_GET:
        mesh_light_hsl_client_hue_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_HUE_SET:
        mesh_light_hsl_client_hue_set(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SATURATION_GET:
        mesh_light_hsl_client_saturation_get(p_event, p_data, length);
        break;

    case HCI_CONTROL_MESH_COMMAND_LIGHT_HSL_SATURATION_SET:
        mesh_light_hsl_client_saturation_set(p_event, p_data, length);
        break;
    }
#endif
    return WICED_TRUE;
}

/*
 * Send Light HSL get command
 */
void mesh_light_hsl_client_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_get(p_event);
}

/*
 * Send Light HSL set command
 */
void mesh_light_hsl_client_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_light_hsl_set_t set_data;

    STREAM_TO_UINT16(set_data.target.lightness, p_data);
    STREAM_TO_UINT16(set_data.target.hue, p_data);
    STREAM_TO_UINT16(set_data.target.saturation, p_data);
    STREAM_TO_UINT32(set_data.transition_time, p_data);
    STREAM_TO_UINT16(set_data.delay, p_data);

    wiced_bt_mesh_model_light_hsl_client_send_set(p_event, &set_data);
}

/*
 * Send Light HSL Target get command
 */
void mesh_light_hsl_client_target_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_target_get(p_event);
}

/*
 * Send Light HSL Hue Get command
 */
void mesh_light_hsl_client_hue_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_hue_get(p_event);
}

/*
 * Send Light Hue Set command
 */
void mesh_light_hsl_client_hue_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_light_hsl_hue_set_t set_data;

    STREAM_TO_UINT16(set_data.level, p_data);
    STREAM_TO_UINT32(set_data.transition_time, p_data);
    STREAM_TO_UINT16(set_data.delay, p_data);

    wiced_bt_mesh_model_light_hsl_client_send_hue_set(p_event, &set_data);
}

/*
 * Send Light HSL Saturation Get command
 */
void mesh_light_hsl_client_saturation_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_saturation_get(p_event);
}

/*
 * Send Light Saturation Set command
 */
void mesh_light_hsl_client_saturation_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_light_hsl_saturation_set_t set_data;

    STREAM_TO_UINT16(set_data.level, p_data);
    STREAM_TO_UINT32(set_data.transition_time, p_data);
    STREAM_TO_UINT16(set_data.delay, p_data);

    wiced_bt_mesh_model_light_hsl_client_send_saturation_set(p_event, &set_data);
}

/*
 * Send Light HSL Get Default command
 */
void mesh_light_hsl_client_default_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_default_get(p_event);
}

/*
 * Send power Light HSL Set Default command
 */
void mesh_light_hsl_client_default_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_light_hsl_default_data_t set_data;

    STREAM_TO_UINT16(set_data.default_status.lightness, p_data);
    STREAM_TO_UINT16(set_data.default_status.hue, p_data);
    STREAM_TO_UINT16(set_data.default_status.saturation, p_data);

    wiced_bt_mesh_model_light_hsl_client_send_default_set(p_event, &set_data);
}

/*
 * Send Light HSL Range Get command
 */
void mesh_light_hsl_client_range_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_model_light_hsl_client_send_range_get(p_event);
}

/*
 * Send Light HSL Range Set command
 */
void mesh_light_hsl_client_range_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_light_hsl_range_set_data_t set_data;

    STREAM_TO_UINT16(set_data.hue_min, p_data);
    STREAM_TO_UINT16(set_data.hue_max, p_data);
    STREAM_TO_UINT16(set_data.saturation_min, p_data);
    STREAM_TO_UINT16(set_data.saturation_max, p_data);

    wiced_bt_mesh_model_light_hsl_client_send_range_set(p_event, &set_data);
}

#ifdef HCI_CONTROL
/*
 * Send Ligt HSL Status event over transport
 */
void mesh_light_hsl_hci_event_send_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_status_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT16_TO_STREAM(p, p_data->present.lightness);
    UINT16_TO_STREAM(p, p_data->present.hue);
    UINT16_TO_STREAM(p, p_data->present.saturation);
    UINT32_TO_STREAM(p, p_data->remaining_time);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

/*
* Send Ligt HSL Target Status event over transport
*/
void mesh_light_hsl_hci_event_send_target_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_target_status_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT16_TO_STREAM(p, p_data->target.lightness);
    UINT16_TO_STREAM(p, p_data->target.hue);
    UINT16_TO_STREAM(p, p_data->target.saturation);
    UINT32_TO_STREAM(p, p_data->remaining_time);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_TARGET_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

/*
 * Send Light HSL Hue Status event over transport
 */
void mesh_light_hsl_hci_event_send_hue_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_hue_status_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT16_TO_STREAM(p, p_data->present_hue);
    UINT16_TO_STREAM(p, p_data->target_hue);
    UINT32_TO_STREAM(p, p_data->remaining_time);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_HUE_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

/*
 * Send Light HSL Saturation Status event over transport
 */
void mesh_light_hsl_hci_event_send_saturation_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_saturation_status_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT16_TO_STREAM(p, p_data->present_saturation);
    UINT16_TO_STREAM(p, p_data->target_saturation);
    UINT32_TO_STREAM(p, p_data->remaining_time);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_SATURATION_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

/*
* Send Light HSL Range Status event over transport
*/
void mesh_light_hsl_hci_event_send_range_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_range_status_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT8_TO_STREAM(p, p_data->status);
    UINT16_TO_STREAM(p, p_data->hue_min);
    UINT16_TO_STREAM(p, p_data->hue_max);
    UINT16_TO_STREAM(p, p_data->saturation_min);
    UINT16_TO_STREAM(p, p_data->saturation_max);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_RANGE_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

/*
 * Send Light HSL Default Status event over transport
 */
void mesh_light_hsl_hci_event_send_default_status(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_light_hsl_default_data_t *p_data)
{
    uint8_t *p = p_hci_event->data;

    UINT16_TO_STREAM(p, p_data->default_status.lightness);
    UINT16_TO_STREAM(p, p_data->default_status.hue);
    UINT16_TO_STREAM(p, p_data->default_status.saturation);

    mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_LIGHT_HSL_DEFAULT_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}

#endif

#endif