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

Header file - Goodix UART Service Client. More...

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

Go to the source code of this file.

## Classes
struct | gus_c_handles_t
| Handles on the connected peer device needed to interact with it. More...
struct | gus_c_evt_t
| Goodix UART Service Client event. More...

## Macros
#define | GUS_C_CONNECTION_MAX 10
| Maximum number of GUS Client connections. More...
#define | GUS_SVC_UUID
| UUID of GUS Service. More...
#define | GUS_TX_CHAR_UUID
| UUID of GUS Tx characterisitc. More...
#define | GUS_RX_CHAR_UUID
| UUID of GUS Rx characterisitc. More...
#define | GUS_FLOW_CTRL_UUID
| UUID of GUS Flow Control characterisitc. More...

## Typedefs
typedef uint8_t | gus_c_flow_ctrl_state_t
| Underlying type used for the GUS Client flow control state. More...
typedef void(* | gus_c_evt_handler_t) (gus_c_evt_t *p_evt)
| Goodix UART Service Client event handler type. More...

## Enumerations
enum | gus_c_evt_type_t { GUS_C_EVT_INVALID, GUS_C_EVT_DISCOVERY_COMPLETE, GUS_C_EVT_DISCOVERY_FAIL, GUS_C_EVT_TX_NTF_SET_SUCCESS, GUS_C_EVT_FLOW_CTRL_NTF_SET_SUCCESS, GUS_C_EVT_PEER_DATA_RECEIVE, GUS_C_EVT_TX_CPLT, GUS_C_EVT_TX_FLOW_OFF, GUS_C_EVT_TX_FLOW_ON, GUS_C_EVT_RX_FLOW_UPDATE_CPLT, GUS_C_EVT_WRITE_OP_ERR }
| Goodix UART Service Client event type. More...
enum | gus_c_flow_ctrl_state { GUS_C_FLOW_CTRL_STATE_OFF = 0, GUS_C_FLOW_CTRL_STATE_ON }
| Flow control state for GUS Client service. More...

## Functions
sdk_err_t | gus_client_init (gus_c_evt_handler_t evt_handler)
| Register GUS Client event handler. More...
sdk_err_t | gus_c_disc_srvc_start (uint8_t conn_idx)
| Discovery GUS on peer. More...
sdk_err_t | gus_c_tx_notify_set (uint8_t conn_idx, bool is_enable)
| Enable or disable peer GUS Tx characteristic notify. More...
sdk_err_t | gus_c_flow_ctrl_notify_set (uint8_t conn_idx, bool is_enable)
| Enable or disable peer device GUS flow control notify. More...
sdk_err_t | gus_c_tx_data_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
| Send data to the server. More...
sdk_err_t | gus_c_rx_flow_ctrl_set (uint8_t conn_idx, gus_c_flow_ctrl_state_t flow_ctrl)
| Send GUS Client Rx flow control state to peer device. More...

## Detailed Description

Header file - Goodix UART Service Client.

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 gus_c.h.