mesh_property_server.c

/*
 * Copyright 2016-2022, 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 publishes user_property level.
 */
#include "wiced_bt_uuid.h"
#include "wiced_bt_ble.h"
#include "wiced_bt_gatt.h"
#include "wiced_bt_mesh_models.h"
#include "wiced_bt_trace.h"
#include "wiced_timer.h"
#include "wiced_bt_mesh_app.h"

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

#include "wiced_bt_cfg.h"
extern wiced_bt_cfg_settings_t wiced_bt_cfg_settings;

/******************************************************
 *          Constants
 ******************************************************/
#define MESH_PID                0x301C
#define MESH_VID                0x0002

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

/******************************************************
 *          Function Prototypes
 ******************************************************/
static void mesh_app_init(wiced_bool_t is_provisioned);
static uint32_t mesh_app_proc_rx_cmd(uint16_t opcode, uint8_t *p_data, uint32_t length);
static void mesh_property_server_message_handler(uint8_t element_idx, uint16_t event, void *p_data);
static void mesh_property_server_status_changed(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_property_process_status(int8_t element_idx, wiced_bt_mesh_property_status_data_t* p_set);

#ifdef HCI_CONTROL
static void mesh_property_hci_event_send_status(int8_t element_idx, wiced_bt_mesh_property_status_data_t* p_data);
#endif

extern wiced_bt_mesh_core_config_t  mesh_config;

/******************************************************
 *          Variables Definitions
 ******************************************************/
// mesh_appearance in stream format is needed for mesh_element1_properties
uint8_t mesh_appearance[WICED_BT_MESH_PROPERTY_LEN_DEVICE_APPEARANCE]      = { BIT16_TO_8(APPEARANCE_GENERIC_TAG) };
uint8_t mesh_mfr_name[WICED_BT_MESH_PROPERTY_LEN_DEVICE_MANUFACTURER_NAME] = { 'C', 'y', 'p', 'r', 'e', 's', 's', 0 };
uint8_t mesh_model_num[WICED_BT_MESH_PROPERTY_LEN_DEVICE_MODEL_NUMBER]     = { '1', '2', '3', '4', 0, 0, 0, 0 };
uint8_t mesh_system_id[8]                                                  = { 0xbb, 0xb8, 0xa1, 0x80, 0x5f, 0x9f, 0x91, 0x71 };

uint8_t mesh_property_motion_threashold[]     = { 50 };

wiced_bt_mesh_core_config_model_t   mesh_element1_models[] =
{
    WICED_BT_MESH_DEVICE,
    WICED_BT_MESH_MODEL_USER_PROPERTY_SERVER,
    WICED_BT_MESH_MODEL_ADMIN_PROPERTY_SERVER,
    WICED_BT_MESH_MODEL_MANUFACTURER_PROPERTY_SERVER,
    WICED_BT_MESH_MODEL_CLIENT_PROPERTY_SERVER,
};
#define MESH_APP_NUM_MODELS  (sizeof(mesh_element1_models) / sizeof(wiced_bt_mesh_core_config_model_t))

wiced_bt_mesh_core_config_property_t mesh_element1_properties[] =
{
    {
        .id          = WICED_BT_MESH_PROPERTY_DEVICE_APPEARANCE,
        .type        = WICED_BT_MESH_PROPERTY_TYPE_MANUFACTURER,
        .user_access = WICED_BT_MESH_PROPERTY_ID_READABLE,
        .max_len     = WICED_BT_MESH_PROPERTY_LEN_DEVICE_APPEARANCE,
        .value       = mesh_appearance
    },
    {
        .id          = WICED_BT_MESH_PROPERTY_DEVICE_MANUFACTURER_NAME,
        .type        = WICED_BT_MESH_PROPERTY_TYPE_MANUFACTURER,
        .user_access = WICED_BT_MESH_PROPERTY_ID_READABLE,
        .max_len     = WICED_BT_MESH_PROPERTY_LEN_DEVICE_MANUFACTURER_NAME,
        .value       = mesh_mfr_name
    },
    {
        .id          = WICED_BT_MESH_PROPERTY_DEVICE_SERIAL_NUMBER,
        .type        = WICED_BT_MESH_PROPERTY_TYPE_MANUFACTURER,
        .user_access = WICED_BT_MESH_PROPERTY_ID_READABLE,
        .max_len     = WICED_BT_MESH_PROPERTY_LEN_DEVICE_SERIAL_NUMBER,
        .value       = mesh_model_num
    },
    {
        .id          = WICED_BT_MESH_PROPERTY_MOTION_THRESHOLD,
        .type        = WICED_BT_MESH_PROPERTY_TYPE_ADMIN,
        .user_access = WICED_BT_MESH_PROPERTY_ID_READABLE | WICED_BT_MESH_PROPERTY_ID_WRITABLE,
        .max_len     = WICED_BT_MESH_PROPERTY_LEN_MOTION_THRESHOLD,
        .value       = mesh_property_motion_threashold
    },
};
#define MESH_APP_NUM_PROPERTIES (sizeof(mesh_element1_properties) / sizeof(wiced_bt_mesh_core_config_property_t))

#define MESH_PROPERTY_SERVER_ELEMENT_INDEX   0

wiced_bt_mesh_core_config_element_t mesh_elements[] =
{
    {
        .location = MESH_ELEM_LOC_MAIN,                                 // location description as defined in the GATT Bluetooth Namespace Descriptors section of the Bluetooth SIG Assigned Numbers
        .default_transition_time = MESH_DEFAULT_TRANSITION_TIME_IN_MS,  // Default transition time for models of the element in milliseconds
        .onpowerup_state = WICED_BT_MESH_ON_POWER_UP_STATE_RESTORE,     // Default element behavior on power up
        .default_level = 0,                                             // Default value of the variable controlled on this element (for example power, lightness, temperature, hue...)
        .range_min = 1,                                                 // Minimum value of the variable controlled on this element (for example power, lightness, temperature, hue...)
        .range_max = 0xffff,                                            // Maximum value of the variable controlled on this element (for example power, lightness, temperature, hue...)
        .move_rollover = 0,                                             // If true when level gets to range_max during move operation, it switches to min, otherwise move stops.
        .properties_num = MESH_APP_NUM_PROPERTIES,                      // Number of properties in the array models
        .properties = mesh_element1_properties,                         // Array of properties in the element.
        .sensors_num = 0,                                               // Number of sensors in the sensor array
        .sensors = NULL,                                                // Array of sensors of that element
        .models_num = MESH_APP_NUM_MODELS,                              // Number of models in the array models
        .models = mesh_element1_models,                                 // Array of models located in that element. Model data is defined by structure wiced_bt_mesh_core_config_model_t
    },
};

wiced_bt_mesh_core_config_t  mesh_config =
{
    .company_id         = MESH_COMPANY_ID_CYPRESS,                  // Company identifier assigned by the Bluetooth SIG
    .product_id         = MESH_PID,                                 // Vendor-assigned product identifier
    .vendor_id          = MESH_VID,                                 // Vendor-assigned product version identifier
#if defined(LOW_POWER_NODE) && (LOW_POWER_NODE == 1)
    .features           = WICED_BT_MESH_CORE_FEATURE_BIT_LOW_POWER, // A bit field indicating the device features. In Low Power mode no Relay, no Proxy and no Friend
    .friend_cfg         =                                           // Empty Configuration of the Friend Feature
    {
        .receive_window = 0,                                        // Receive Window value in milliseconds supported by the Friend node.
        .cache_buf_len  = 0,                                        // Length of the buffer for the cache
        .max_lpn_num    = 0                                         // Max number of Low Power Nodes with established friendship. Must be > 0 if Friend feature is supported.
    },
    .low_power          =                                           // Configuration of the Low Power Feature
    {
        .rssi_factor           = 2,                                 // contribution of the RSSI measured by the Friend node used in Friend Offer Delay calculations.
        .receive_window_factor = 2,                                 // contribution of the supported Receive Window used in Friend Offer Delay calculations.
        .min_cache_size_log    = 3,                                 // minimum number of messages that the Friend node can store in its Friend Cache.
        .receive_delay         = 100,                               // Receive delay in 1 ms units to be requested by the Low Power node.
        .poll_timeout          = 36000                              // Poll timeout in 100ms units to be requested by the Low Power node.
    },
#else
    .features = WICED_BT_MESH_CORE_FEATURE_BIT_FRIEND | WICED_BT_MESH_CORE_FEATURE_BIT_RELAY | WICED_BT_MESH_CORE_FEATURE_BIT_GATT_PROXY_SERVER,   // Supports Friend, Relay and GATT Proxy
    .friend_cfg         =                                           // Configuration of the Friend Feature(Receive Window in Ms, messages cache)
    {
        .receive_window        = 20,
        .cache_buf_len         = 300,                               // Length of the buffer for the cache
        .max_lpn_num           = 4                                  // Max number of Low Power Nodes with established friendship. Must be > 0 if Friend feature is supported.
    },
    .low_power          =                                           // Configuration of the Low Power Feature
    {
        .rssi_factor           = 0,                                 // contribution of the RSSI measured by the Friend node used in Friend Offer Delay calculations.
        .receive_window_factor = 0,                                 // contribution of the supported Receive Window used in Friend Offer Delay calculations.
        .min_cache_size_log    = 0,                                 // minimum number of messages that the Friend node can store in its Friend Cache.
        .receive_delay         = 0,                                 // Receive delay in 1 ms units to be requested by the Low Power node.
        .poll_timeout          = 0                                  // Poll timeout in 100ms units to be requested by the Low Power node.
    },
#endif
    .gatt_client_only          = WICED_FALSE,                       // Can connect to mesh over GATT or ADV
    .elements_num  = (uint8_t)(sizeof(mesh_elements) / sizeof(mesh_elements[0])),   // number of elements on this device
    .elements      = mesh_elements                                  // Array of elements for this device
};

/*
 * Mesh application library will call into application functions if provided by the application.
 */
wiced_bt_mesh_app_func_table_t wiced_bt_mesh_app_func_table =
{
    mesh_app_init,          // application initialization
    NULL,                   // Default SDK platform button processing
    NULL,                   // GATT connection status
    NULL,                   // attention processing
    NULL,                   // notify period set
    mesh_app_proc_rx_cmd,   // WICED HCI command
    NULL,                   // LPN sleep
    NULL                    // factory reset
};

/******************************************************
 *               Function Definitions
 ******************************************************/
void mesh_app_init(wiced_bool_t is_provisioned)
{
#if 0
    // Set Debug trace level for mesh_models_lib and mesh_provisioner_lib
    wiced_bt_mesh_models_set_trace_level(WICED_BT_MESH_CORE_TRACE_INFO);
#endif
#if 0
    // Set Debug trace level for all modules but Info level for CORE_AES_CCM module
    wiced_bt_mesh_core_set_trace_level(WICED_BT_MESH_CORE_TRACE_FID_ALL, WICED_BT_MESH_CORE_TRACE_DEBUG);
    wiced_bt_mesh_core_set_trace_level(WICED_BT_MESH_CORE_TRACE_FID_CORE_AES_CCM, WICED_BT_MESH_CORE_TRACE_INFO);
#endif

    wiced_bt_cfg_settings.device_name = (uint8_t *)"Property Server";
    wiced_bt_cfg_settings.gatt_cfg.appearance = APPEARANCE_GENERIC_TAG;
    mesh_appearance[0] = (uint8_t)wiced_bt_cfg_settings.gatt_cfg.appearance;
    mesh_appearance[1] = (uint8_t)(wiced_bt_cfg_settings.gatt_cfg.appearance >> 8);

    // Adv Data is fixed. Spec allows to put URI, Name, Appearance and Tx Power in the Scan Response Data.
    if (!is_provisioned)
    {
        wiced_bt_ble_advert_elem_t  adv_elem[3];
        uint8_t                     buf[2];
        uint8_t                     num_elem = 0;
        adv_elem[num_elem].advert_type = BTM_BLE_ADVERT_TYPE_NAME_COMPLETE;
        adv_elem[num_elem].len = (uint16_t)strlen((const char*)wiced_bt_cfg_settings.device_name);
        adv_elem[num_elem].p_data = wiced_bt_cfg_settings.device_name;
        num_elem++;

        adv_elem[num_elem].advert_type = BTM_BLE_ADVERT_TYPE_APPEARANCE;
        adv_elem[num_elem].len = 2;
        buf[0] = (uint8_t)wiced_bt_cfg_settings.gatt_cfg.appearance;
        buf[1] = (uint8_t)(wiced_bt_cfg_settings.gatt_cfg.appearance >> 8);
        adv_elem[num_elem].p_data = buf;
        num_elem++;

        wiced_bt_mesh_set_raw_scan_response_data(num_elem, adv_elem);
    }

    wiced_bt_mesh_model_property_server_init(MESH_PROPERTY_SERVER_ELEMENT_INDEX, mesh_property_server_message_handler, is_provisioned);
}

/*
 * Process event received from the Property Client.
 */
void mesh_property_server_message_handler(uint8_t element_idx, uint16_t event, void *p_data)
{
#if defined HCI_CONTROL
    wiced_bt_mesh_hci_event_t *p_hci_event;
#endif
    WICED_BT_TRACE("user_property srv msg:%d\n", event);

    switch (event)
    {
    case WICED_BT_MESH_USER_PROPERTY_STATUS:
        mesh_property_process_status(element_idx, (wiced_bt_mesh_property_status_data_t *)p_data);
        break;

    default:
        WICED_BT_TRACE("unknown\n");
    }
}

/*
 * In 2 chip solutions MCU can send commands to change user_property state.
 */
uint32_t mesh_app_proc_rx_cmd(uint16_t opcode, uint8_t *p_data, uint32_t length)
{
    wiced_bt_mesh_event_t *p_event;

    WICED_BT_TRACE("[%s] cmd_opcode 0x%02x\n", __FUNCTION__, opcode);

    switch (opcode)
    {
    case HCI_CONTROL_MESH_COMMAND_PROPERTY_SET:
        p_event = wiced_bt_mesh_create_event_from_wiced_hci(opcode, MESH_COMPANY_ID_BT_SIG, WICED_BT_MESH_CORE_MODEL_ID_GENERIC_USER_PROPERTY_SRV, &p_data, &length);
        if (p_event == NULL)
        {
            WICED_BT_TRACE("bad hdr\n");
            return WICED_TRUE;
        }
        mesh_property_server_status_changed(p_event, p_data, length);
        break;

    default:
        WICED_BT_TRACE("unknown\n");
        return WICED_FALSE;
    }
    return WICED_TRUE;
}

/*
 * Send Property Status event
 */
void mesh_property_server_status_changed(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
    uint8_t  type;
    uint16_t id;
    int i;

    STREAM_TO_UINT8(type, p_data);
    STREAM_TO_UINT16(id, p_data);

    // If value of the User Property ID field that does not identify any existing User Property, Send Reply without bothering the app.
    for (i = 0; i < mesh_config.elements[p_event->element_idx].properties_num; i++)
    {
        if (mesh_config.elements[p_event->element_idx].properties[i].id == id)
        {
            STREAM_TO_ARRAY(mesh_config.elements[p_event->element_idx].properties[i].value, p_data, length - 7);

            if (type == 0)
                p_event->model_id = WICED_BT_MESH_CORE_MODEL_ID_GENERIC_ADMIN_PROPERTY_SRV;
            else if (type == 1)
                p_event->model_id = WICED_BT_MESH_CORE_MODEL_ID_GENERIC_MANUFACT_PROPERTY_SRV;
            else
                p_event->model_id = WICED_BT_MESH_CORE_MODEL_ID_GENERIC_USER_PROPERTY_SRV;

            wiced_bt_mesh_model_property_server_send_property_status(p_event, type, &mesh_config.elements[p_event->element_idx].properties[i]);
            return;
        }
    }
}

/*
 * Sample implementation of the command from the Property client to set the state
 */
void mesh_property_process_status(int8_t element_idx, wiced_bt_mesh_property_status_data_t *p_set)
{
    int i;

    WICED_BT_TRACE("user_property srv set id:%04x len:%d val:%02x\n", p_set->id, p_set->len, p_set->value[0]);

    for (i = 0; i < mesh_config.elements[MESH_PROPERTY_SERVER_ELEMENT_INDEX].properties_num; i++)
    {
        if (mesh_config.elements[MESH_PROPERTY_SERVER_ELEMENT_INDEX].properties[i].id == p_set->id)
        {
            mesh_config.elements[MESH_PROPERTY_SERVER_ELEMENT_INDEX].properties[i].user_access = p_set->access;
            if (p_set->len != 0)
            {
                memcpy (mesh_config.elements[MESH_PROPERTY_SERVER_ELEMENT_INDEX].properties[i].value, p_set->value, p_set->len);
                WICED_BT_TRACE("prop ID:%02x value:%02x\n", p_set->id, mesh_config.elements[MESH_PROPERTY_SERVER_ELEMENT_INDEX].properties[i].value[0]);
            }
            break;
        }
    }

#if defined HCI_CONTROL
    // In some cases we do not know the state of the user_property and need to ask MCU whenever client asks
     mesh_property_hci_event_send_status(element_idx, p_set);
#endif
}

#ifdef HCI_CONTROL

/*
 * Send Property Status event over transport
 */
void mesh_property_hci_event_send_status(int8_t element_idx, wiced_bt_mesh_property_status_data_t *p_data)
{
    wiced_bt_mesh_hci_event_t* p_hci_event = wiced_bt_mesh_alloc_hci_event(element_idx);
    if (p_hci_event)
{
    uint8_t *p = p_hci_event->data;

        UINT8_TO_STREAM(p, p_data->type);
        UINT8_TO_STREAM(p, p_data->access);
        UINT16_TO_STREAM(p, p_data->id);
        ARRAY_TO_STREAM(p, p_data->value, p_data->len);

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

#endif