config_client.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CONFIG_CLIENT_H__
#define CONFIG_CLIENT_H__

#include <stdint.h>
#include "config_messages.h"
#include "config_opcodes.h"

#include "access.h"
#include "device_state_manager.h"

#ifndef CONFIG_CLIENT_ACKED_TRANSACTION_TIMEOUT
#define CONFIG_CLIENT_ACKED_TRANSACTION_TIMEOUT (SEC_TO_US(60))
#endif

typedef struct
{
 uint16_t element_address;
 nrf_mesh_address_t publish_address;
 uint16_t appkey_index;
 bool frendship_credential_flag;
 uint8_t publish_ttl;
 access_publish_period_t publish_period;
 uint8_t retransmit_count;
 uint8_t retransmit_interval;
 access_model_id_t model_id;
} config_publication_state_t;

typedef enum
{
 CONFIG_CLIENT_EVENT_TYPE_TIMEOUT,
 CONFIG_CLIENT_EVENT_TYPE_CANCELLED,
 CONFIG_CLIENT_EVENT_TYPE_MSG
} config_client_event_type_t;

typedef union
{
 config_msg_appkey_status_t appkey_status;
 config_msg_net_beacon_status_t net_beacon_status;
 config_msg_publication_status_t publication_status;
 config_msg_subscription_status_t subscription_status;
 config_msg_netkey_status_t netkey_status;
 config_msg_proxy_status_t proxy_status;
 config_msg_key_refresh_phase_status_t key_refresh_phase_status;
 config_msg_friend_status_t friend_status;
 config_msg_heartbeat_publication_status_t heartbeat_publication_status;
 config_msg_heartbeat_subscription_status_t heartbeat_subscription_status;
 config_msg_default_ttl_status_t default_ttl_status;
 config_msg_app_status_t app_status;
 config_msg_identity_status_t identity_status;
 config_msg_composition_data_status_t composition_data_status;
 config_msg_relay_status_t relay_status;
 config_msg_appkey_list_t appkey_list;
 config_msg_sig_model_app_list_t sig_model_app_list;
 config_msg_vendor_model_app_list_t vendor_model_app_list;
 config_msg_sig_model_subscription_list_t sig_model_subscription_list;
 config_msg_vendor_model_subscription_list_t vendor_model_subscription_list;
} config_msg_t;

typedef struct
{
 config_opcode_t opcode;
 const config_msg_t * p_msg;
} config_client_event_t;

typedef void (*config_client_event_cb_t)(config_client_event_type_t event_type, const config_client_event_t * p_event, uint16_t length);


uint32_t config_client_init(config_client_event_cb_t event_cb);

uint32_t config_client_server_set(dsm_handle_t server_devkey_handle, dsm_handle_t server_address_handle);

uint32_t config_client_server_bind(dsm_handle_t server_devkey_handle);

uint32_t config_client_composition_data_get(uint8_t page_number);

uint32_t config_client_appkey_add(uint16_t netkey_index, uint16_t appkey_index, const uint8_t * p_appkey);

uint32_t config_client_appkey_delete(uint16_t netkey_index, uint16_t appkey_index);

uint32_t config_client_appkey_get(uint16_t netkey_index);

uint32_t config_client_appkey_update(uint16_t netkey_index, uint16_t appkey_index, const uint8_t * p_appkey);

uint32_t config_client_netkey_add(uint16_t netkey_index, const uint8_t * p_netkey);

uint32_t config_client_netkey_delete(uint16_t netkey_index);

uint32_t config_client_netkey_get(void);

uint32_t config_client_netkey_update(uint16_t netkey_index, const uint8_t * p_netkey);

uint32_t config_client_model_publication_get(uint16_t element_address, access_model_id_t model_id);

uint32_t config_client_model_publication_set(const config_publication_state_t * p_publication_state);

uint32_t config_client_model_subscription_add(uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id);

uint32_t config_client_model_subscription_delete(uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id);

uint32_t config_client_model_subscription_delete_all(uint16_t element_address, access_model_id_t model_id);

uint32_t config_client_model_subscription_get(uint16_t element_address, access_model_id_t model_id);

uint32_t config_client_model_subscription_overwrite(uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id);

uint32_t config_client_model_app_bind(uint16_t element_address, uint16_t appkey_index, access_model_id_t model_id);

uint32_t config_client_model_app_get(uint16_t element_address, access_model_id_t model_id);

uint32_t config_client_model_app_unbind(uint16_t element_address, uint16_t appkey_index, access_model_id_t model_id);

uint32_t config_client_default_ttl_get(void);

uint32_t config_client_default_ttl_set(uint8_t ttl);

uint32_t config_client_relay_get(void);

uint32_t config_client_relay_set(config_relay_state_t relay_state, uint8_t retransmit_count, uint8_t retransmit_interval_steps);

uint32_t config_client_network_transmit_get(void);

uint32_t config_client_network_transmit_set(uint8_t transmit_count, uint8_t transmit_interval_steps);

uint32_t config_client_net_beacon_get(void);

uint32_t config_client_net_beacon_set(config_net_beacon_state_t state);

uint32_t config_client_node_reset(void);

uint32_t config_client_key_refresh_phase_get(uint16_t netkey_index);

uint32_t config_client_key_refresh_phase_set(uint16_t netkey_index, nrf_mesh_key_refresh_phase_t phase);

uint32_t config_client_friend_get(void);

uint32_t config_client_friend_set(config_friend_state_t state);

uint32_t config_client_gatt_proxy_get(void);

uint32_t config_client_gatt_proxy_set(config_gatt_proxy_state_t state);

uint32_t config_client_node_identity_get(uint16_t netkey_index);

uint32_t config_client_node_identity_set(uint16_t netkey_index, config_identity_state_t state);

uint32_t config_client_heartbeat_publication_get(void);

uint32_t config_client_heartbeat_publication_set(const config_msg_heartbeat_publication_set_t * p_publication);

uint32_t config_client_heartbeat_subscription_get(void);

uint32_t config_client_heartbeat_subscription_set(const config_msg_heartbeat_subscription_set_t * p_subscription);

uint32_t config_client_low_power_node_polltimeout_get(uint16_t lpn_address);

void config_client_pending_msg_cancel(void);

#endif /* CONFIG_CLIENT_H__ */