pb_remote_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 PB_REMOTE_CLIENT_H__
#define PB_REMOTE_CLIENT_H__

#include <stdint.h>
#include "access.h"
#include "access_reliable.h"
#include "nrf_mesh_prov.h"

#define PB_REMOTE_CLIENT_MODEL_ID (0x8004)

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

typedef enum
{
 PB_REMOTE_EVENT_SCAN_STARTED,
 PB_REMOTE_EVENT_SCAN_CANCELED,
 PB_REMOTE_EVENT_CANNOT_START_SCANNING,
 PB_REMOTE_EVENT_CANNOT_CANCEL_SCANNING,
 PB_REMOTE_EVENT_LINK_CLOSED,
 PB_REMOTE_EVENT_LINK_NOT_ACTIVE,
 PB_REMOTE_EVENT_LINK_ALREADY_OPEN,
 PB_REMOTE_EVENT_CANNOT_OPEN_LINK,
 PB_REMOTE_EVENT_CANNOT_CLOSE_LINK,
 PB_REMOTE_EVENT_INVALID_UNPROV_DEVICE_ID,
 PB_REMOTE_EVENT_TX_FAILED,
 PB_REMOTE_EVENT_REMOTE_UUID
} pb_remote_event_type_t;

typedef struct
{
 const uint8_t * p_uuid;
 uint8_t device_id;
} pb_remote_event_remote_uuid_t;

typedef struct
{
 pb_remote_event_type_t type;
 pb_remote_event_remote_uuid_t remote_uuid;
} pb_remote_event_t;

typedef void (*pb_remote_client_event_cb_t)(const pb_remote_event_t * p_evt);

typedef enum
{
 PB_REMOTE_CLIENT_STATE_NONE, 
 PB_REMOTE_CLIENT_STATE_IDLE, 
 PB_REMOTE_CLIENT_STATE_LINK_ESTABLISHED, 
 PB_REMOTE_CLIENT_STATE_WAIT_ACK_LINK,
 PB_REMOTE_CLIENT_STATE_WAIT_ACK_TRANSFER,
 PB_REMOTE_CLIENT_STATE_WAIT_ACK_SCAN,
} pb_remote_client_state_t;

typedef struct
{
 access_model_handle_t model_handle;
 prov_bearer_t prov_bearer;
 pb_remote_client_state_t state;
 access_reliable_t reliable;
 pb_remote_client_event_cb_t event_cb;
 uint8_t current_prov_pdu_type;
} pb_remote_client_t;

uint32_t pb_remote_client_init(pb_remote_client_t * p_client,
 uint16_t element_index,
 pb_remote_client_event_cb_t event_cb);

prov_bearer_t * pb_remote_client_bearer_interface_get(pb_remote_client_t * p_client);

uint32_t pb_remote_client_remote_scan_start(pb_remote_client_t * p_client);

uint32_t pb_remote_client_remote_scan_cancel(pb_remote_client_t * p_client);

#endif /* PB_REMOTE_CLIENT_H__ */