OVMS3-idf/components/protocomm/include/transports/protocomm_ble.h
Amey Inamdar 9428375368 Protocomm : Added support for choice of transport - WiFi (SoftAP+HTTPD), BLE, Console (development friendly transport)
Co-Authored-By: Amey Inamdar <amey@espressif.com>
Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-10-02 19:07:28 +05:30

92 lines
3 KiB
C

// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#include <protocomm.h>
/**
* BLE device name cannot be larger than this value
*/
#define MAX_BLE_DEVNAME_LEN 13
/**
* @brief This structure maps handler required by protocomm layer to
* UUIDs which are used to uniquely identify BLE characteristics
* from a smartphone or a similar client device.
*/
typedef struct name_uuid {
/**
* Name of the handler, which is passed to protocomm layer
*/
char *name;
/**
* UUID to be assigned to the BLE characteristic which is
* mapped to the handler
*/
uint16_t uuid;
} protocomm_ble_name_uuid_t;
/**
* @brief Config parameters for protocomm BLE service
*/
typedef struct {
/**
* BLE device name being broadcast at the time of provisioning
*/
char device_name[MAX_BLE_DEVNAME_LEN];
uint8_t service_uuid[16]; /*!< SSID of the provisioning service */
ssize_t nu_lookup_count; /*!< Number of entries in the Name-UUID lookup table */
/**
* Pointer to the Name-UUID lookup table
*/
protocomm_ble_name_uuid_t *nu_lookup;
} protocomm_ble_config_t;
/**
* @brief Start Bluetooth Low Energy based transport layer for provisioning
*
* Initialize and start required BLE service for provisioning. This includes
* the initialization for characteristics/service for BLE.
*
* @param[in] pc Protocomm instance pointer obtained from protocomm_new()
* @param[in] config Pointer to config structure for initialising BLE
*
* @return
* - ESP_OK : if successful
* - ESP_FAIL : Simple BLE start error
* - ESP_ERR_NO_MEM : Error allocating memory for internal resources
* - ESP_ERR_INVALID_STATE : Error in ble config
* - ESP_ERR_INVALID_ARG : Null arguments
*/
esp_err_t protocomm_ble_start(protocomm_t *pc, const protocomm_ble_config_t *config);
/**
* @brief Stop Bluetooth Low Energy based transport layer for provisioning
*
* Stops service/task responsible for BLE based interactions for provisioning
*
* @note You might want to optionally reclaim memory from Bluetooth.
* Refer to the documentation of `esp_bt_mem_release` in that case.
*
* @param[in] pc Same protocomm instance that was passed to protocomm_ble_start()
*
* @return
* - ESP_OK : For success or appropriate error code
* - ESP_FAIL : Simple BLE stop error
* - ESP_ERR_INVALID_ARG : Null / incorrect protocomm instance
*/
esp_err_t protocomm_ble_stop(protocomm_t *pc);