Skip to content
Permalink
61734ebbe7
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

mtb-example-btsdk-mesh-snip-onoff-client/mesh_onoff_client.c

Go to file
 
 
Cannot retrieve contributors at this time
437 lines (401 sloc) 24.9 KB
Raw Blame
/*
* 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 on/off client model.
*/
#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"
#if ( defined(DIRECTED_FORWARDING_SERVER_SUPPORTED) || defined(NETWORK_FILTER_SERVER_SUPPORTED))
#include "wiced_bt_mesh_mdf.h"
#endif
#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 0x3015
#define MESH_VID 0x0002
// Definitions for parameters of the wiced_bt_mesh_directed_forwarding_init():
#define MESH_DIRECTED_FORWARDING_DIRECTED_PROXY_SUPPORTED WICED_TRUE // WICED_TRUE if directed proxy is supported.
#define MESH_DIRECTED_FORWARDING_DIRECTED_FRIEND_SUPPORTED WICED_TRUE // WICED_TRUE if directed friend is supported.
#define MESH_DIRECTED_FORWARDING_DEFAULT_RSSI_THRESHOLD -120 // The value of the default_rssi_threshold is implementation specificand should be 10 dB above the receiver sensitivity.
#define MESH_DIRECTED_FORWARDING_MAX_DT_ENTRIES_CNT 2 // The maximum number of Discovery Table entries supported by the node in a given subnet.It shall be >= 2.
#define MESH_DIRECTED_FORWARDING_NODE_PATHS 20 // The minimum number of paths that the node supports when acting as a Path Origin or as a Path Target.It shall be >= 20.
#define MESH_DIRECTED_FORWARDING_RELAY_PATHS 20 // The minimum number of paths that the node supports when acting as an intermediate Directed Relay node.It shall be >= 20.
#define MESH_DIRECTED_FORWARDING_PROXY_PATHS 20 // The minimum number of paths that the node supports when acting as a Directed Proxy node. If directed proxy is supported, it shall be >= 20; otherwise it shall be 0.
#define MESH_DIRECTED_FORWARDING_FRIEND_PATHS 20 // The minimum number of paths that the node supports when acting as a Directed Friend node.
/******************************************************
* 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_onoff_client_message_handler(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data);
static void mesh_onoff_client_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_onoff_client_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length);
static void mesh_onoff_hci_event_send(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_onoff_status_data_t *p_data);
/******************************************************
* Variables Definitions
******************************************************/
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 };
wiced_bt_mesh_core_config_model_t mesh_element1_models[] =
{
WICED_BT_MESH_DEVICE,
#ifdef DIRECTED_FORWARDING_SERVER_SUPPORTED
WICED_BT_MESH_DIRECTED_FORWARDING_SERVER,
#endif
#ifdef NETWORK_FILTER_SERVER_SUPPORTED
WICED_BT_MESH_NETWORK_FILTER_SERVER,
#endif
WICED_BT_MESH_MODEL_ONOFF_CLIENT,
};
#if NUM_ONOFF_CLIENTS > 1
wiced_bt_mesh_core_config_model_t mesh_element2_models[] =
{
WICED_BT_MESH_MODEL_ONOFF_CLIENT,
};
#endif
#if NUM_ONOFF_CLIENTS > 2
wiced_bt_mesh_core_config_model_t mesh_element3_models[] =
{
WICED_BT_MESH_MODEL_ONOFF_CLIENT,
};
#endif
#if NUM_ONOFF_CLIENTS > 3
wiced_bt_mesh_core_config_model_t mesh_element4_models[] =
{
WICED_BT_MESH_MODEL_ONOFF_CLIENT,
};
#endif
#define MESH_ONOFF_CLIENT_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 = 0, // Number of properties in the array models
.properties = NULL, // 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 = sizeof(mesh_element1_models) / sizeof(wiced_bt_mesh_core_config_model_t), // 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
},
#if NUM_ONOFF_CLIENTS > 1
{
.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 = 0, // Number of properties in the array models
.properties = NULL, // 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 = sizeof(mesh_element2_models) / sizeof(wiced_bt_mesh_core_config_model_t), // Number of models in the array models
.models = mesh_element2_models, // Array of models located in that element. Model data is defined by structure wiced_bt_mesh_core_config_model_t
},
#endif
#if NUM_ONOFF_CLIENTS > 2
{
.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 = 0, // Number of properties in the array models
.properties = NULL, // 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 = sizeof(mesh_element3_models) / sizeof(wiced_bt_mesh_core_config_model_t), // Number of models in the array models
.models = mesh_element3_models, // Array of models located in that element. Model data is defined by structure wiced_bt_mesh_core_config_model_t
},
#endif
#if NUM_ONOFF_CLIENTS > 3
{
.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 = 0, // Number of properties in the array models
.properties = NULL, // 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 = sizeof(mesh_element4_models) / sizeof(wiced_bt_mesh_core_config_model_t), // Number of models in the array models
.models = mesh_element4_models, // Array of models located in that element. Model data is defined by structure wiced_bt_mesh_core_config_model_t
},
#endif
};
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 = 100 // 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 *)"Switch";
#if NUM_ONOFF_CLIENTS > 1
wiced_bt_cfg_settings.gatt_cfg.appearance = APPEARANCE_CONTROL_DEVICE_MULTI_SWITCH;
#else
wiced_bt_cfg_settings.gatt_cfg.appearance = APPEARANCE_CONTROL_DEVICE_SWITCH;
#endif
// 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);
}
#ifdef NETWORK_FILTER_SERVER_SUPPORTED
if (is_provisioned)
wiced_bt_mesh_network_filter_init();
#endif
#ifdef DIRECTED_FORWARDING_SERVER_SUPPORTED
wiced_bt_mesh_directed_forwarding_init(
MESH_DIRECTED_FORWARDING_DIRECTED_PROXY_SUPPORTED,
MESH_DIRECTED_FORWARDING_DIRECTED_FRIEND_SUPPORTED,
MESH_DIRECTED_FORWARDING_DEFAULT_RSSI_THRESHOLD,
MESH_DIRECTED_FORWARDING_MAX_DT_ENTRIES_CNT,
MESH_DIRECTED_FORWARDING_NODE_PATHS,
MESH_DIRECTED_FORWARDING_RELAY_PATHS,
MESH_DIRECTED_FORWARDING_PROXY_PATHS,
MESH_DIRECTED_FORWARDING_FRIEND_PATHS);
#endif
wiced_bt_mesh_model_onoff_client_init(0, mesh_onoff_client_message_handler, is_provisioned);
#if NUM_ONOFF_CLIENTS > 1
wiced_bt_mesh_model_onoff_client_init(1, mesh_onoff_client_message_handler, is_provisioned);
#endif
#if NUM_ONOFF_CLIENTS > 2
wiced_bt_mesh_model_onoff_client_init(2, mesh_onoff_client_message_handler, is_provisioned);
#endif
#if NUM_ONOFF_CLIENTS > 3
wiced_bt_mesh_model_onoff_client_init(3, mesh_onoff_client_message_handler, is_provisioned);
#endif
}
/*
* Process event received from the onoff Server.
*/
void mesh_onoff_client_message_handler(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
{
wiced_bt_mesh_onoff_status_data_t *p_onoff_status;
#if defined HCI_CONTROL
wiced_bt_mesh_hci_event_t *p_hci_event;
#endif
WICED_BT_TRACE("onoff clt 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_ONOFF_STATUS:
p_onoff_status = (wiced_bt_mesh_onoff_status_data_t *)p_data;
WICED_BT_TRACE("onoff present:%d target:%d remaining time:%d\n",
p_onoff_status->present_onoff, p_onoff_status->target_onoff, p_onoff_status->remaining_time);
#if defined HCI_CONTROL
if ((p_hci_event = wiced_bt_mesh_create_hci_event(p_event)) != NULL)
mesh_onoff_hci_event_send(p_hci_event, p_onoff_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_app_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_ONOFF_GET:
case HCI_CONTROL_MESH_COMMAND_ONOFF_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_GENERIC_ONOFF_CLNT, &p_data, &length);
if (p_event == NULL)
{
WICED_BT_TRACE("bad hdr\n");
return WICED_TRUE;
}
switch (opcode)
{
case HCI_CONTROL_MESH_COMMAND_ONOFF_GET:
mesh_onoff_client_get(p_event, p_data, length);
break;
case HCI_CONTROL_MESH_COMMAND_ONOFF_SET:
mesh_onoff_client_set(p_event, p_data, length);
break;
}
#endif
return WICED_TRUE;
}
/*
* Send onoff get command
*/
void mesh_onoff_client_get(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
WICED_BT_TRACE("onoff get elem:%04x dst:%04x key:%04x\n", p_event->element_idx, p_event->dst, p_event->app_key_idx);
wiced_bt_mesh_model_onoff_client_send_get(p_event);
}
/*
* Send onoff set command
*/
void mesh_onoff_client_set(wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint32_t length)
{
wiced_bt_mesh_onoff_set_data_t set_data;
STREAM_TO_UINT8(set_data.onoff, p_data);
STREAM_TO_UINT32(set_data.transition_time, p_data);
STREAM_TO_UINT16(set_data.delay, p_data);
WICED_BT_TRACE("onoff set elem:%04x dst:%04x key:%04x\n", p_event->element_idx, p_event->dst, p_event->app_key_idx);
wiced_bt_mesh_model_onoff_client_send_set(p_event, &set_data);
}
#ifdef HCI_CONTROL
/*
* Send onoff Status event over transport
*/
void mesh_onoff_hci_event_send(wiced_bt_mesh_hci_event_t *p_hci_event, wiced_bt_mesh_onoff_status_data_t *p_data)
{
uint8_t *p = p_hci_event->data;
UINT8_TO_STREAM(p, p_data->present_onoff);
UINT8_TO_STREAM(p, p_data->target_onoff);
UINT32_TO_STREAM(p, p_data->remaining_time);
mesh_transport_send_data(HCI_CONTROL_MESH_EVENT_ONOFF_STATUS, (uint8_t *)p_hci_event, (uint16_t)(p - (uint8_t *)p_hci_event));
}
#endif