ChannelChangeCommand.cpp

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright (C) 2023-2024 Thomas Basler and others
 */

/*
Derives from CommandAbstract. Special command to set frequency channel on HMS/HMT inverters.

Command structure:
* ID: fixed identifier and everytime 0x56
* CH: Channel to which the inverter will be switched to

00   01 02 03 04   05 06 07 08   09   10   11   12   13   14   15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
-----------------------------------------------------------------------------------------------------------------
56   71 60 35 46   80 12 23 04   02   15   21   00   14   00   -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- (860 MHz band)
56   71 60 35 46   80 12 23 04   03   17   3c   00   14   00   -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- (900 MHz band)
^^   ^^^^^^^^^^^   ^^^^^^^^^^^   ^^   ^^   ^^   ^^   ^^   ^^
ID   Target Addr   Source Addr   ?    ?    ?    CH   ?    CRC8
*/
#include "ChannelChangeCommand.h"

ChannelChangeCommand::ChannelChangeCommand(InverterAbstract* inv, const uint64_t router_address, const uint8_t channel)
    : CommandAbstract(inv, router_address)
{
    _payload[0] = 0x56;
    _payload[13] = 0x14;
    _payload_size = 14;

    setCountryMode(CountryModeId_t::MODE_EU);
    setChannel(channel);
    setTimeout(10);
}

String ChannelChangeCommand::getCommandName() const
{
    return "ChannelChangeCommand";
}

void ChannelChangeCommand::setChannel(const uint8_t channel)
{
    _payload[12] = channel;
}

uint8_t ChannelChangeCommand::getChannel() const
{
    return _payload[12];
}

void ChannelChangeCommand::setCountryMode(const CountryModeId_t mode)
{
    switch (mode) {
    case CountryModeId_t::MODE_US:
        _payload[9] = 0x03;
        _payload[10] = 0x17;
        _payload[11] = 0x3c;
        break;
    case CountryModeId_t::MODE_BR:
        _payload[9] = 0x03;
        _payload[10] = 0x17;
        _payload[11] = 0x3c;
        break;
    default:
        _payload[9] = 0x02;
        _payload[10] = 0x15;
        _payload[11] = 0x21;
        break;
    }
}

bool ChannelChangeCommand::handleResponse(const fragment_t fragment[], const uint8_t max_fragment_id)
{
    return true;
}

uint8_t ChannelChangeCommand::getMaxResendCount() const
{
    // This command will never retrieve an answer. Repeat anyway to allow FrequencyManager to send it on a few different frequencies.
    return MAX_RESEND_COUNT;
}