mirror of
https://github.com/google/pebble
synced 2026-10-17 00:34:11 +02:00
93 lines
3.4 KiB
C
93 lines
3.4 KiB
C
/*
|
|
* Copyright 2024 Google LLC
|
|
*
|
|
* 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 "applib/bluetooth/ble_client.h"
|
|
|
|
//! @file ancs.h Module implementing an ANCS client.
|
|
//! See http://bit.ly/ancs-spec for Apple's documentation of ANCS
|
|
|
|
typedef enum {
|
|
ANCSClientStateIdle = 0,
|
|
ANCSClientStateRequestedNotification,
|
|
ANCSClientStateReassemblingNotification,
|
|
ANCSClientStatePerformingAction,
|
|
ANCSClientStateRequestedApp,
|
|
ANCSClientStateAliveCheck,
|
|
ANCSClientStateRetrying,
|
|
} ANCSClientState;
|
|
|
|
//! Enum indexing the ANCS characteristics
|
|
//! @note The order is actually important for ancs.c's implementation. Don't shuffle!
|
|
typedef enum {
|
|
// Subscribe-able:
|
|
ANCSCharacteristicNotification = 0, //<! Notification Source
|
|
ANCSCharacteristicData = 1, //<! Data Source
|
|
|
|
// Writable:
|
|
ANCSCharacteristicControl = 2, //<! Control Point
|
|
NumANCSCharacteristic,
|
|
|
|
ANCSCharacteristicInvalid = NumANCSCharacteristic,
|
|
} ANCSCharacteristic;
|
|
|
|
//! Creates the ANCS client.
|
|
//! Must only be called from KernelMain!
|
|
void ancs_create(void);
|
|
|
|
//! Updates the BLECharacteristic references, in case new ones have been obtained after a
|
|
//! re-discovery of the remote services.
|
|
//! @param characteristics Matrix of characteristics references of the ANCS service(s)
|
|
//! @note This module only uses the first service instance, any others will be ignored.
|
|
//! Must only be called from KernelMain!
|
|
void ancs_handle_service_discovered(BLECharacteristic *characteristics);
|
|
|
|
void ancs_invalidate_all_references(void);
|
|
|
|
void ancs_handle_service_removed(BLECharacteristic *characteristics, uint8_t num_characteristics);
|
|
|
|
//! @param characteristic The characteristic for which to test whether the ANCS module handles
|
|
//! reads/writes/notifications for it.
|
|
//! @return True whether the ANCS module handles reads/writes/etc for it, false if not
|
|
bool ancs_can_handle_characteristic(BLECharacteristic characteristic);
|
|
|
|
//! Handles GATT write responses
|
|
//! @see BLEClientWriteHandler
|
|
//! Must only be called from KernelMain!
|
|
void ancs_handle_write_response(BLECharacteristic characteristic, BLEGATTError error);
|
|
|
|
//! Handles GATT subscriptions
|
|
//! @see BLEClientSubscribeHandler
|
|
//! Must only be called from KernelMain!
|
|
void ancs_handle_subscribe(BLECharacteristic characteristic,
|
|
BLESubscription subscription_type, BLEGATTError error);
|
|
|
|
//! Handles GATT notifications
|
|
//! Must only be called from KernelMain!
|
|
void ancs_handle_read_or_notification(BLECharacteristic characteristic, const uint8_t *value,
|
|
size_t value_length, BLEGATTError error);
|
|
|
|
//! Destroys the ANCS client.
|
|
//! Must only be called from KernelMain!
|
|
void ancs_destroy(void);
|
|
|
|
//! This function is safe to call from any task.
|
|
void ancs_perform_action(uint32_t notification_uid, uint8_t action_id);
|
|
|
|
//! Called by kernel_le_client/dis/dis.c
|
|
void ancs_handle_ios9_or_newer_detected(void);
|