UIManager.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */

#ifndef ACSDK_SAMPLE_INTERACTIONMANAGER_UIMANAGER_H_
#define ACSDK_SAMPLE_INTERACTIONMANAGER_UIMANAGER_H_

#include <string>
#include <memory>
#include <unordered_map>
#include <vector>

#include <acsdkSampleApplicationInterfaces/UIStateAggregatorInterface.h>
#include <acsdkSampleApplicationInterfaces/UIAuthNotifierInterface.h>
#include <acsdkSampleApplicationInterfaces/UIManagerInterface.h>
#include <AVSCommon/SDKInterfaces/AuthObserverInterface.h>
#include <AVSCommon/SDKInterfaces/CapabilitiesDelegateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/DialogUXStateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/LocaleAssetsManagerInterface.h>
#include <AVSCommon/SDKInterfaces/SingleSettingObserverInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerManagerObserverInterface.h>
#include <AVSCommon/Utils/DeviceInfo.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <Settings/DeviceSettingsManager.h>
#include <Settings/SettingCallbacks.h>
#include <Settings/SpeechConfirmationSettingType.h>
#include <Settings/WakeWordConfirmationSettingType.h>
#include <acsdkAlertsInterfaces/AlertObserverInterface.h>
#include <acsdkBluetoothInterfaces/BluetoothDeviceObserverInterface.h>
#include <acsdkNotificationsInterfaces/NotificationsObserverInterface.h>

namespace alexaClientSDK {
namespace sampleApplications {
namespace common {

class UIManager
        : public avsCommon::sdkInterfaces::DialogUXStateObserverInterface
        , public avsCommon::sdkInterfaces::AuthObserverInterface
        , public avsCommon::sdkInterfaces::CapabilitiesDelegateObserverInterface
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
        , public avsCommon::sdkInterfaces::SingleSettingObserverInterface
        , public avsCommon::sdkInterfaces::SpeakerManagerObserverInterface
        , public acsdkNotificationsInterfaces::NotificationsObserverInterface
        , public acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface
        , public acsdkSampleApplicationInterfaces::UIManagerInterface {
public:
    using DeviceAttributes = acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface::DeviceAttributes;

    static std::shared_ptr<UIManager> create(
        const std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>& localeAssetsManager,
        const std::shared_ptr<avsCommon::utils::DeviceInfo>& deviceInfo);

    void onDialogUXStateChanged(DialogUXState state) override;

    void onConnectionStatusChanged(const Status status, const ChangedReason reason) override;

    void onSettingChanged(const std::string& key, const std::string& value) override;

    void onSpeakerSettingsChanged(
        const avsCommon::sdkInterfaces::SpeakerManagerObserverInterface::Source& source,
        const avsCommon::sdkInterfaces::ChannelVolumeInterface::Type& type,
        const avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings& settings) override;

    void onSetIndicator(avsCommon::avs::IndicatorState state) override;
    void onNotificationReceived() override{};

    void printMessage(const std::string& message) override;

    void onAuthStateChange(
        avsCommon::sdkInterfaces::AuthObserverInterface::State newState,
        avsCommon::sdkInterfaces::AuthObserverInterface::Error newError) override;

    void onCapabilitiesStateChange(
        avsCommon::sdkInterfaces::CapabilitiesDelegateObserverInterface::State newState,
        avsCommon::sdkInterfaces::CapabilitiesDelegateObserverInterface::Error newError,
        const std::vector<avsCommon::sdkInterfaces::endpoints::EndpointIdentifier>& addedOrUpdatedEndpoints,
        const std::vector<avsCommon::sdkInterfaces::endpoints::EndpointIdentifier>& deletedEndpoints) override;

    void onActiveDeviceConnected(const DeviceAttributes& deviceAttributes) override;
    void onActiveDeviceDisconnected(const DeviceAttributes& deviceAttributes) override;

    void printWelcomeScreen();

    void printHelpScreen();

    void printLimitedHelp();

    void printAudioInjectionHeader();

    void printSettingsScreen();

    void printEndpointModificationScreen();

    void printEndpointModificationError(const std::string& message);

    void printEndpointControllerScreen();

    void printLocaleScreen();

    void printPowerControllerScreen();

    void printToggleControllerScreen();

    void printModeControllerScreen();

    void printRangeControllerScreen();

    void printSpeakerControlScreen();

    void printFirmwareVersionControlScreen();

    void printVolumeControlScreen();

#ifdef ENABLE_PCC

    void printPhoneControlScreen();

    void printCallerIdScreen();

    void printCallIdScreen();
#endif

#ifdef ENABLE_MCC

    void printMeetingControlScreen();

    void printSessionIdScreen();

    void printCalendarItemsScreen();
#endif

#ifdef ENABLE_COMMS

    void printCommsControlScreen();

    void printDtmfScreen();

    void printDtmfErrorScreen();

    void printMuteCallScreen();

    void printUnmuteCallScreen();
#endif

    void printErrorScreen();

    void microphoneOff();

    /*
     * Prints the state that Alexa is currenty in.
     */
    void microphoneOn();

    void printResetWarning();

    void printResetConfirmation();

    void printReauthorizeConfirmation();

    void printCommsNotSupported();

    bool configureSettingsNotifications(std::shared_ptr<settings::DeviceSettingsManager> settingsManager);

    void printAlarmVolumeRampScreen();

    void printWakeWordConfirmationScreen();

    void printSpeechConfirmationScreen();

    void printTimeZoneScreen();

    void printNetworkInfoScreen();

    void printNetworkInfoConnectionTypePrompt();
    void printNetworkInfoESSIDPrompt();
    void printNetworkInfoBSSIDPrompt();
    void printNetworkInfoIpPrompt();
    void printNetworkInfoSubnetPrompt();
    void printNetworkInfoMacPrompt();
    void printNetworkInfoDHCPPrompt();
    void printNetworkInfoStaticIpPrompt();

    void printDoNotDisturbScreen();

    void printDiagnosticsScreen();

    void printDevicePropertiesScreen();

    void printAllDeviceProperties(const std::unordered_map<std::string, std::string>& deviceProperties);

    void printDeviceProtocolTracerScreen();

    void printProtocolTrace(const std::string& protocolTrace);

    void printProtocolTraceFlag(bool enabled);

    void printAudioInjectionScreen();

    void printAudioInjectionFailureMessage();

    void setUIAuthNotifier(std::shared_ptr<acsdkSampleApplicationInterfaces::UIAuthNotifierInterface> uiAuthNotifier);

    void setUIStateAggregator(
        std::shared_ptr<acsdkSampleApplicationInterfaces::UIStateAggregatorInterface> uiStateAggregator);

private:
    UIManager(
        const std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>& localeAssetsManager,
        const std::shared_ptr<avsCommon::utils::DeviceInfo>& deviceInfo);

    void printState();

    void onBooleanSettingNotification(
        const std::string& name,
        bool enable,
        settings::SettingNotifications notification);

    void onStringSettingNotification(const std::string& name, bool enable, settings::SettingNotifications notification);

    template <typename SettingType>
    void onSettingNotification(const std::string& name, SettingType value, settings::SettingNotifications notification);

    void setFailureStatus(const std::string& status);

    DialogUXState m_dialogState;

    avsCommon::sdkInterfaces::AuthObserverInterface::State m_authState;

    avsCommon::sdkInterfaces::ConnectionStatusObserverInterface::Status m_connectionStatus;

    std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> m_localeAssetsManager;

    avsCommon::utils::threading::Executor m_executor;

    // String that holds a failure status message to be displayed when we are in limited mode.
    std::string m_failureStatus;

    // Object that manages settings notifications.
    std::shared_ptr<settings::SettingCallbacks<settings::DeviceSettingsManager>> m_callbacks;

    // The @c EndpointIdentifier of the default endpoint.
    avsCommon::sdkInterfaces::endpoints::EndpointIdentifier m_defaultEndpointId;

    std::shared_ptr<acsdkSampleApplicationInterfaces::UIStateAggregatorInterface> m_uiStateAggregator;

    std::shared_ptr<acsdkSampleApplicationInterfaces::UIAuthNotifierInterface> m_uiAuthNotifier;
};

}  // namespace common
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ACSDK_SAMPLE_INTERACTIONMANAGER_UIMANAGER_H_