Skip to content
Permalink
fd53d12b7f
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

mtb-example-btstack-freertos-multi-beacon/beacon_utils.h

Go to file
 
 
Cannot retrieve contributors at this time
200 lines (173 sloc) 8.78 KB
Raw Blame
/******************************************************************************
* File Name: beacon_utils.c
*
* Description:This is the source code for the eddystone utility
* functions
*
*******************************************************************************
* Copyright 2020-2024, Cypress Semiconductor Corporation (an Infineon company) or
* an affiliate of Cypress Semiconductor Corporation. All rights reserved.
*
* This software, including source code, documentation and related
* materials ("Software") is owned by Cypress Semiconductor Corporation
* or one of its affiliates ("Cypress") and is protected by and subject to
* worldwide patent protection (United States and foreign),
* United States copyright laws and international treaty provisions.
* Therefore, you may use this Software only as provided in the license
* agreement accompanying the software package from which you
* obtained this Software ("EULA").
* If no EULA applies, Cypress hereby grants you a personal, non-exclusive,
* non-transferable license to copy, modify, and compile the Software
* source code solely for use in connection with Cypress's
* integrated circuit products. Any reproduction, modification, translation,
* compilation, or representation of this Software except as specified
* above is prohibited without the express written permission of Cypress.
*
* Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress
* reserves the right to make changes to the Software without notice. Cypress
* does not assume any liability arising out of the application or use of the
* Software or any product or circuit described in the Software. Cypress does
* not authorize its products for use in any products where a malfunction or
* failure of the Cypress product may reasonably be expected to result in
* significant property damage, injury or death ("High Risk Product"). By
* including Cypress's product in a High Risk Product, the manufacturer
* of such system or application assumes all risk of such use and in doing
* so agrees to indemnify Cypress against all liability.
*******************************************************************************/
/*******************************************************************************
* Header Files
*******************************************************************************/
#ifndef __BEACON_UTILS_H__
#define __BEACON_UTILS_H__
#include "wiced_bt_ble.h"
#include "wiced_bt_gatt.h"
/******************************************************************************
* Constants
******************************************************************************/
/* Type of eddystone frame
https://github.com/google/eddystone/blob/master/protocol-specification.md */
#define EDDYSTONE_FRAME_TYPE_UID (0x00)
#define EDDYSTONE_FRAME_TYPE_URL (0x10)
#define EDDYSTONE_FRAME_TYPE_TLM (0x20)
#define EDDYSTONE_FRAME_TYPE_EID (0x30)
/* Definitions for UID frame format */
#define EDDYSTONE_UID_FRAME_LEN (20)
#define EDDYSTONE_UID_NAMESPACE_LEN (10)
#define EDDYSTONE_UID_INSTANCE_ID_LEN (6)
/******************************************************************************
* URL Scheme Prefix for Google Eddystone
* Decimal Hex Expansion
* 0 0x00 http://www.
* 1 0x01 https://www.
* 2 0x02 http://
* 3 0x03 https://
*
******************************************************************************/
#define EDDYSTONE_URL_SCHEME_0 (0x00)
#define EDDYSTONE_URL_SCHEME_1 (0x01)
#define EDDYSTONE_URL_SCHEME_2 (0x02)
#define EDDYSTONE_URL_SCHEME_3 (0x03)
/* Definitions for URL frame format */
#define EDDYSTONE_URL_FRAME_LEN (20)
#define EDDYSTONE_URL_VALUE_MAX_LEN (17)
/* Eddystone UUID*/
#define EDDYSTONE_UUID16 (0xFEAA)
/* Number of advertisement elements for Eddystone */
#define EDDYSTONE_NUM_ELEM_URL (3)
/* Max ADV data length */
#define BEACON_ADV_DATA_MAX (31)
#define EDDYSTONE_ADV_INDEX0 (0)
#define EDDYSTONE_ADV_INDEX1 (1)
#define EDDYSTONE_ADV_INDEX2 (2)
#define EDDYSTONE_ADV_DATA_INDEX0 (0)
#define EDDYSTONE_ADV_DATA_INDEX1 (1)
#define EDDYSTONE_ADV_DATA_INDEX2 (2)
#define EDDYSTONE_ADV_DATA_INDEX3 (3)
#define EDDYSTONE_UUID_INDEX0 (0)
#define EDDYSTONE_UUID_INDEX1 (1)
#define EDDYSTONE_URL_COM_LENGTH (3)
#define EDDYSTONE_SERVICE_DATA_LENGTH (3)
#define ADV_PKT_FLAG_LENGTH (2)
#define ADV_PKT_16SRV_LENGTH (3)
#define UUID_LENGTH (2)
/* iBeacon type */
#define IBEACON_TYPE (0x01)
#define IBEACON_PROXIMITY (0x02),(0x15)
/* iBeacon company ID */
#define IBEACON_COMPANY_ID_APPLE (0x4c),(0x00)
/* iBeacon data length */
#define IBEACON_DATA_LENGTH (0x19)
/* iBeacon adv packet length */
#define IBEACON_ADV_PKT_LENGTH (IBEACON_DATA_LENGTH + 1)
/* Number of elements in advertisement */
#define IBEACON_ELEM_NUM (2)
#define IBEACON_MAJOR_NUMER (0x01)
#define IBEACON_MINOR_NUMER (0x02)
#define TX_POWER_LEVEL (0xB3)
#define IBEACON_ADV_INDEX0 (0)
#define IBEACON_ADV_INDEX1 (1)
#define IBEACON_DATA_INDEX2 (2)
#define IBEACON_DATA_INDEX3 (3)
#define IBEACON_DATA_INDEX4 (4)
#define IBEACON_DATA_INDEX20 (20)
#define IBEACON_DATA_INDEX21 (21)
#define IBEACON_DATA_INDEX22 (22)
#define IBEACON_DATA_INDEX23 (23)
#define IBEACON_TX_POWER_INDEX (24)
#define IBEACON_DATA_COMPANY_ID_INDEX0 (0)
#define IBEACON_DATA_COMPANY_ID_INDEX1 (1)
#define IBEACON_DATA_TYPE_INDEX0 (0)
#define IBEACON_DATA_TYPE_INDEX1 (1)
#define IBEACON_ADV_DATA0 (0)
#define IBEACON_DATA_INDEX0 (0)
#define IBEACON_DATA_INDEX1 (1)
/******************************************************************************
* Structures
******************************************************************************/
/* Structure to hold advertisement element data */
typedef struct
{
uint8_t data[BEACON_ADV_DATA_MAX]; /* Advertisement data */
uint8_t len; /* Advertisement length */
wiced_bt_ble_advert_type_t advert_type; /* Advertisement data type */
}beacon_ble_advert_elem_t;
/* Structure to hold eddystone URL parameters */
typedef struct __attribute__((packed, aligned(1)))
{
uint8_t tx_power; /* ADV Tx Power */
uint8_t urlscheme; /* URL Scheme */
uint8_t encoded_url[EDDYSTONE_URL_VALUE_MAX_LEN]; /* URL */
}eddystone_url_t;
/* Structure to hold eddystone UID parameters */
typedef struct __attribute__((packed, aligned(1)))
{
uint8_t eddystone_ranging_data; /* Calibrated TX power */
uint8_t eddystone_namespace[EDDYSTONE_UID_NAMESPACE_LEN]; /* UID namespace */
uint8_t eddystone_instance[EDDYSTONE_UID_INSTANCE_ID_LEN]; /* Instance */
}eddystone_uid_t;
/****************************************************************************
* FUNCTION DECLARATIONS
***************************************************************************/
void eddystone_set_data_for_url (eddystone_url_t url_data,
uint8_t adv_data[BEACON_ADV_DATA_MAX],
uint8_t *adv_len);
void eddystone_set_data_common (beacon_ble_advert_elem_t *eddystone_adv_elem,
uint8_t frame_type, uint8_t frame_len);
void beacon_set_adv_data (beacon_ble_advert_elem_t *beacon_adv_elem,
uint8_t num_elem,
uint8_t adv_data[BEACON_ADV_DATA_MAX],
uint8_t *adv_len);
void ibeacon_set_adv_data (uint8_t ibeacon_uuid[LEN_UUID_128],
uint16_t ibeacon_major_number,
uint16_t ibeacon_minor_number,
uint8_t tx_power_lcl,
uint8_t adv_data[BEACON_ADV_DATA_MAX],
uint8_t *adv_len);
void beacon_bt_set_adv_data (beacon_ble_advert_elem_t *beacon_adv_elem,
uint8_t num_elem,
uint8_t adv_data[BEACON_ADV_DATA_MAX],
uint8_t *adv_len);
#endif /* __BEACON_UTILS_H__ */
/* [] END OF FILE */