escs.h File Reference

Eddystone Configuration Service API. More...

#include "es_app_config.h"
#include "es.h"
#include "ble_prf_types.h"
#include "ble_sdk_error.h"
#include "es_utility.h"
#include "es_nvds.h"
#include "es_gatts_read_write.h"
#include <stdbool.h>
#include <stdint.h>
+ Include dependency graph for escs.h:

Go to the source code of this file.

Classes

struct  slot_lock_code_t
 Structure for storing a slot key. More...
 
struct  escs_eid_t
 Structure for storing EID slot key. More...
 
struct  ble_escs_init_params_t
 EddyStone Configuration Service environment variable. More...
 

Enumerations

enum  escs_attr_idx_t {
  ESEC_IDX_SVC, ESCS_BROADCAST_CAP_RD_CHAR, ESCS_BROADCAST_CAP_RD_VALUE, ESCS_ACTIVE_SLOT_RW_CHAR,
  ESCS_ACTIVE_SLOT_RW_VALUE, ESCS_ADV_INTERVAL_RW_CHAR, ESCS_ADV_INTERVAL_RW_VALUE, ESCS_RADIO_TX_PWR_RW_CHAR,
  ESCS_RADIO_TX_PWR_RW_VALUE, ESCS_ADV_TX_PWR_RW_CHAR, ESCS_ADV_TX_PWR_RW_VALUE, ESCS_LOCK_STATE_RW_CHAR,
  ESCS_LOCK_STATE_RW_VALUE, ESCS_UNLOCK_RW_CHAR, ESCS_UNLOCK_RW_VALUE, ESCS_PUBLIC_ECDH_KEY_RD_CHAR,
  ESCS_PUBLIC_ECDH_KEY_RD_VALUE, ESCS_EID_ID_KEY_RD_CHAR, ESCS_EID_ID_KEY_RD_VALUE, ESCS_RW_ADV_SLOT_RW_CHAR,
  ESCS_RW_ADV_SLOT_RW_VALUE, ESCS_FACTORY_RESET_SET_CHAR, ESCS_FACTORY_RESET_SET_VALUE, ESCS_REMAIN_CONNECTABLE_RW_CHAR,
  ESCS_REMAIN_CONNECTABLE_RW_VALUE, ESCSS_IDX_NB
}
 ESCS Service Attributes Indexes.
 

Functions

bool es_adv_remain_connectable_get (void)
 get eddystone remain connectable state More...
 
void es_adv_remain_connectable_set (bool remain_connectable)
 set eddystone remain connectable state More...
 
void es_public_ecdh_key_get (uint8_t *p_ecdh_key_buf)
 get public ecdh key More...
 
void es_public_ecdh_key_set (uint8_t *p_ecdh_key_buf)
 set public ecdh key More...
 
void es_security_key_set (uint8_t *p_security_key, bool is_eid_write)
 set security key for slot More...
 
bool es_beacon_has_eid_adv (void)
 to konw if a beacon has EID slot More...
 
void es_active_slot_number_set (uint8_t slot_no)
 set number of the actived slot More...
 
uint8_t es_active_slot_number_get (void)
 get number of the actived slot More...
 
bool is_active_slot_eid (void)
 to know if the actived slot is a n EID slot
 
void set_beacon_locked (void)
 lock a beacon
 
void set_beacon_unlocked (void)
 unlock a beacon
 
int8_t es_adv_tx_power_get (void)
 get the radio tx power More...
 
void es_adv_tx_power_set (int8_t adv_tx_power)
 set the radio tx power More...
 
int8_t es_slot_tx_power_get (void)
 get advertised tx power of a slot More...
 
void es_slot_tx_power_set (int8_t tx_power)
 set advertised tx power of a slot More...
 
uint16_t es_adv_interval_get (void)
 get advertising interval for slot More...
 
void es_adv_interval_set (uint16_t adv_interval)
 set advertising interval for slot More...
 
sdk_err_t esec_service_init (ble_escs_init_params_t *p_escs_init)
 Initialize Eddystone Configuration Service,and data for the service. More...
 

Detailed Description

Eddystone Configuration 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.