pcs.h File Reference

Power Consumption Service API. More...

#include "gr_includes.h"
#include "custom_config.h"
+ Include dependency graph for pcs.h:

Go to the source code of this file.

Classes

struct  pcs_evt_t
 PCS Service event. More...
 
struct  pcs_init_t
 PCS Service init stucture. More...
 

Macros

#define PCS_CONNECTION_MAX   10
 Maximum number of Power Consumption Service connections. More...
 
#define PCS_MAX_DATA_LEN   244
 Maximum length of application data packet which is transmitted via PCS. More...
 
#define PCS_SERVICE_UUID
 The UUID of Power Consumption Service for setting advertising data. More...
 
#define PCS_SET_PARAM_SUCCESS   0x00
 PCS parameters set successfully. More...
 
#define PCS_SET_PARAM_FAIL   0x81
 PCS parameters set unsuccessfully. More...
 
#define PCS_SET_ADV_DATA_3B   0x03
 Set 3 byte advertising data. More...
 
#define PCS_SET_ADV_DATA_10B   0x0a
 Set 10 byte advertising data. More...
 
#define PCS_SET_ADV_DATA_17B   0x11
 Set 17 byte advertising data. More...
 
#define PCS_SET_ADV_DATA_24B   0x18
 Set 24 byte advertising data. More...
 
#define PCS_SET_ADV_DATA_31B   0x1f
 Set 31 byte advertising data. More...
 

Typedefs

typedef void(* pcs_evt_handler_t) (pcs_evt_t *p_evt)
 PCS Service event handler type. More...
 

Enumerations

enum  pcs_evt_type_t {
  PCS_EVT_INVALID, PCS_EVT_TX_ENABLE, PCS_EVT_TX_DISABLE, PCS_EVT_SETTING_ENABLE,
  PCS_EVT_SETTING_DISABLE, PCS_EVT_TX_DATA_SENT, PCS_EVT_PARAM_SET, PCS_EVT_DISCONNECTED
}
 PCS Service event types. More...
 
enum  pcs_setting_type_t {
  PCS_SETTING_TYPE_ADV_INTERVAL, PCS_SETTING_TYPE_CONN_PARAM, PCS_SETTING_TYPE_PHY, PCS_SETTING_TYPE_ADV_DATA,
  PCS_SETTING_TYPE_TX_POWER
}
 PCS Service settings types. More...
 

Functions

sdk_err_t pcs_service_init (pcs_init_t *p_pcs_init)
 Initialize a PCS Service instance and add in the database. More...
 
sdk_err_t pcs_tx_data_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send data to peer device. More...
 
sdk_err_t pcs_setting_reply (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Reply parameters set result. More...
 

Detailed Description

Power Consumption Service 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 pcs.h.