cs_CommandHandler.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: May 18, 2016
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <ble/cs_Nordic.h>
#include <ble/cs_Stack.h>
#include <cfg/cs_Boards.h>
#include <common/cs_Types.h>
#include <protocol/cs_CommandTypes.h>
 
class CommandHandler : EventListener {
public:
    static CommandHandler& getInstance() {
        static CommandHandler instance;
        return instance;
    }
 
    void init(const boards_config_t* board);
 
    void handleCommand(
            uint8_t protocolVersion,
            const CommandHandlerTypes type,
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
 
    // Handle events as EventListener
    void handleEvent(event_t& event);
 
private:
    CommandHandler();
 
    app_timer_t _resetTimerData;
    app_timer_id_t _resetTimerId;
 
    const boards_config_t* _boardConfig;
 
    struct {
        // Control command type we are waiting for. Set to CTRL_CMD_NONE for none.
        CommandHandlerTypes type = CTRL_CMD_NONE;
 
        // Source of the command.
        cmd_source_with_counter_t source;
 
        // Number of ticks until timeout.
        uint16_t timeoutCountdown;
    } _awaitingCommandResult;
 
    static const uint32_t ASYNC_COMMAND_TIMEOUT_MS = 10000;
 
    EncryptionAccessLevel getRequiredAccessLevel(const CommandHandlerTypes type);
    bool allowedAsMeshCommand(const CommandHandlerTypes type);
 
    /*
     * Same as handleCommand, allows us to check the result code.
     */
    void _handleCommand(
            uint8_t protocolVersion,
            const CommandHandlerTypes type,
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
 
    void resolveAsyncCommand(cs_async_result_t* result);
 
    void handleCmdNop(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGotoDfu(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetBootloaderVersion(
            cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetUicrData(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdReset(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdFactoryReset(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetMacAddress(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetHardwareVersion(
            cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetFirmwareVersion(
            cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdSetSunTime(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetTime(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdIncreaseTx(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdValidateSetup(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdDisconnect(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdResetErrors(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdPwm(
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
    void handleCmdSwitch(
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
    void handleCmdRelay(
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
    void handleCmdMultiSwitch(
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accessLevel,
            cs_result_t& result);
    void handleCmdMeshCommand(
            uint8_t protocol,
            cs_data_t commandData,
            const cmd_source_with_counter_t source,
            const EncryptionAccessLevel accesss_resulLevel,
            cs_result_t& result);
    void handleCmdAllowDimming(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdLockSwitch(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdSetup(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdUartMsg(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdHubData(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdStateGet(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdStateSet(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdRegisterTrackedDevice(
            cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdTrackedDeviceHeartbeat(
            cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdGetUptime(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdMicroappUpload(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
    void handleCmdMicroappMessage(cs_data_t commandData, const EncryptionAccessLevel accessLevel, cs_result_t& result);
 
    void dispatchEventForCommand(
            CS_TYPE type, cs_data_t commandData, const cmd_source_with_counter_t& source, cs_result_t& result);
 
    void resetDelayed(uint8_t opCode, uint16_t delayMs = 2000);
};