Выключение

Операция выключения программно отключает устройство. Эта операция полезна, когда вам нужно отключить устройство удаленно или как часть контролируемой последовательности выключения.

Предварительные условия

Перед выполнением выключения убедитесь, что:

• Устройство подключено и находится в стабильном состоянии
• Все несохраненные данные сохранены
• Пользователь понимает, что устройство отключится после выключения

Реализация с помощью AI

Разработка с AI

Реализуйте этот сценарий с AI

Используйте официальный навык «Выключение AIBuds» и адаптируйте сценарий к приложению.

Прочитайте и выполните инструкции https://docs-aibuds.github.io/ru/skills/implement-aibuds-power-off. Используйте этот навык, чтобы реализовать «Выключение AIBuds» в данном iOS-проекте и проверить результат.

Открыть официальный навык↗

Ссылка на API

Framework

AIBuds.xcframework

Import

В файлах, где вы хотите использовать SDK, импортируйте основной заголовок:

Swift

Swift

import AIBuds

Objective-C

Objective-C

#import <AIBuds/AIBuds.h>
#import <AIBuds/AIBuds-Swift.h>

Протокол

Метод powerOff определен в следующем протоколе. Протокол наследуется от базового протокола API устройства.

Swift

Swift

/// Defines common device operations including power off
protocol DeviceCommonAPI: DeviceAPI {
    /// Power off the device
    /// - Parameters:
    ///   - completion: Completion callback that returns the operation result
    ///     - success: `true` if the operation was successful; otherwise `false`.
    ///     - error: An `NSError` object that describes the error that occurred, or `nil` if the operation was successful.
    func powerOff(_ completion: AIBudsCompletionHandler?)
}

Objective-C

Objective-C

/// Defines common device operations including power off
@protocol AIBudsDeviceCommonAPI <AIBudsDeviceAPI>
/// Power off the device
/// - Parameters:
///   - completion: Completion callback that returns the operation result
///     - success: `true` if the operation was successful; otherwise `false`.
///     - error: An `NSError` object that describes the error that occurred, or `nil` if the
///     operation was successful.
- (void)powerOffWithCompletion:(AIBudsCompletionHandler)completion;
@end

Метод экземпляра

Выключает устройство из приложения.

iOS 13.0+

Swift

Swift

/// Power off the device
/// - Parameters:
///   - completion: Completion callback that returns the operation result
///     - success: `true` if the operation was successful; otherwise `false`.
///     - error: An `NSError` object that describes the error that occurred, or `nil` if the operation was successful.
func powerOff(_ completion: AIBudsCompletionHandler?)

Objective-C

Objective-C

/// Power off the device
/// - Parameters:
///   - completion: Completion callback that returns the operation result
///     - success: `true` if the operation was successful; otherwise `false`.
///     - error: An `NSError` object that describes the error that occurred, or `nil` if the
///     operation was successful.
- (void)powerOffWithCompletion:(AIBudsCompletionHandler)completion;

Параметры

Параметр	Тип	Описание
completion	AIBudsCompletionHandler?	Необязательный callback, вызываемый после завершения операции.

Параметры callback:

Имя	Тип	Описание
success	Bool	true, если операция выполнена успешно; иначе false.
error	NSError?	Сведения об ошибке при сбое; при успехе — nil.

Возвращаемое значение

Метод не возвращает значение напрямую. Результат передается через callback завершения.

Примеры использования

Swift

Swift

import AIBuds

class DeviceManager {

    /// The connected device
    weak var device: DeviceConvertible?

    /// Powers off the connected device
    func powerOffDevice() {
        // Ensure the device supports power off protocol
        guard let device = device as? DeviceCommonAPI else {
            print("Device does not support power off")
            return
        }

        // Execute power off with completion handler
        device.powerOff { [weak self] success, error in
            // Handle failure case
            if !success {
                let errorMessage = {
                    if let error = error {
                        return "\(error)"
                    }
                    return "Unknown error"
                }()
                print("Power off failed: \(errorMessage)")
                return
            }
            // Handle success case
            print("Power off command sent successfully")
        }
    }
}

Objective-C

Objective-C

#import <AIBuds/AIBuds.h>

@interface DeviceManager ()

/// The connected device
@property(weak, nonatomic) id<AIBudsDeviceConvertible> device;

@end

@implementation DeviceManager

- (void)powerOffDevice {
    __weak typeof(self) weakSelf = self;

    id<AIBudsDeviceCommonAPI> device = (id<AIBudsDeviceCommonAPI>)self.device;
    // Ensure the device supports power off protocol
    if ([device conformsToProtocol:@protocol(AIBudsDeviceCommonAPI)]) {
        // Execute power off with completion handler
        [device powerOffWithCompletion:^(BOOL success, NSError *_Nullable error) {
            // Handle failure case
            if (!success) {
                NSLog(@"Power off failed: %@", error);
                return;
            }
            // Handle success case
            NSLog(@"Power off command sent successfully");
        }];
    }
}

@end

Обработка ошибок

Обработчик завершения может вернуть следующие ошибки:

Домен ошибок: AIBudsSDK.ErrorDomain

Swift

Код ошибки	Описание	Что делать
.deviceNotConnected	Устройство не подключено	Проверьте сопряжение и подключение
.bleCommandExecFailedDueToTimeout	Истекло время ожидания операции	Повторите операцию
.deviceBusy	Устройство занято другой операцией	Дождитесь завершения текущей операции
.deviceNotSupport	Устройство не поддерживает выключение	Проверьте возможности перед вызовом

Objective-C

Код ошибки	Описание	Что делать
AIBudsSdkErrorCodeDeviceNotConnected	Устройство не подключено	Проверьте сопряжение и подключение
AIBudsSdkErrorCodeBleCommandExecFailedDueToTimeout	Истекло время ожидания операции	Повторите операцию
AIBudsSdkErrorCodeDeviceBusy	Устройство занято другой операцией	Дождитесь завершения текущей операции
AIBudsSdkErrorCodeDeviceNotSupport	Устройство не поддерживает выключение	Проверьте возможности перед вызовом

Рекомендации

1. Запросите подтверждение: перед выключением покажите диалог подтверждения, поскольку устройство отключится от приложения.

2. Обновляйте интерфейс в главном потоке: при изменении UI из callback используйте DispatchQueue.main.async.

3. Используйте слабую ссылку: добавьте [weak self] в callback, чтобы избежать цикла удержания.

4. Проверьте поддержку протокола: перед вызовом убедитесь, что устройство поддерживает DeviceCommonAPI.

5. Обработайте отключение: после успешного выключения корректно обновите состояние подключения в приложении.

Примечания

• После выполнения команды выключения устройство отключится от приложения
• Пользователь сможет включить устройство вручную
• Все выполняющиеся операции будут прерваны
• Выключение может занять несколько секунд