Classes | Macros | Typedefs | Enumerations | Functions
otas_c.h File Reference

Over The Air Service Client API. More...

`#include "ble_prf_types.h"`
`#include "gr_includes.h"`
`#include "custom_config.h"`
`#include <stdint.h>`
`#include <stdbool.h>`
Include dependency graph for otas_c.h:

Go to the source code of this file.

## Classes
struct | otas_c_handles_t
| Handles on the connected peer device needed to interact with it. More...
struct | otas_c_evt_t
| OTA Service Client event. More...

## Macros
#define | OTAS_C_CONNECTION_MAX 10
| Maximum number of OTAS Client connections. More...
#define | OTAS_SVC_UUID
| UUID of OTA Service. More...
#define | OTAS_TX_CHAR_UUID
| UUID of OTA TX Characteristic. More...
#define | OTAS_RX_CHAR_UUID
| UUID of OTA RX Characteristic. More...
#define | OTAS_CTRL_CHAR_UUID
| UUID of OTA Control Characteristic. More...
#define | OTAS_C_CTRL_PT_OP_DFU_ENTER 0x474f4f44
| Control point opcode for entering DFU mode. More...

## Typedefs
typedef void(* | otas_c_evt_handler_t) (otas_c_evt_t *p_evt)
| OTA Service Client event handler type. More...

## Enumerations
enum | otas_c_evt_type_t { OTAS_C_EVT_INVALID, OTAS_C_EVT_DISCOVERY_COMPLETE, OTAS_C_EVT_DISCOVERY_FAIL, OTAS_C_EVT_TX_NTF_SET_SUCCESS, OTAS_C_EVT_CTRL_SUCCESS, OTAS_C_EVT_PEER_DATA_RECEIVE, OTAS_C_EVT_TX_CPLT, OTAS_C_EVT_WRITE_OP_ERR }
| OTA Service Client event type. More...

## Functions
sdk_err_t | otas_client_init (otas_c_evt_handler_t evt_handler)
| Register THS Client event handler. More...
sdk_err_t | otas_c_disc_srvc_start (uint8_t conn_idx)
| Discovery OTAS on peer. More...
sdk_err_t | otas_c_tx_notify_set (uint8_t conn_idx, bool is_enable)
| Enable or disable peer OTA tx characteristic notify. More...
sdk_err_t | otas_c_ctrl_data_send (uint8_t conn_idx, uint32_t data)
| Send control data to peer. More...
sdk_err_t | otas_c_tx_data_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
| Send data to peer. More...

## Detailed Description

Over The Air Service Client API.

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form 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. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND 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.

Definition in file otas_c.h.