eive-obsw/mission/devices/SyrlinksHkHandler.cpp

653 lines
26 KiB
C++
Raw Normal View History

2021-03-22 13:09:06 +01:00
#include <fsfw/datapool/PoolReadGuard.h>
2022-01-17 15:58:27 +01:00
#include <fsfw/globalfunctions/CRC.h>
#include <mission/devices/SyrlinksHkHandler.h>
2021-05-17 16:37:29 +02:00
2022-01-17 15:58:27 +01:00
#include "OBSWConfig.h"
2021-02-17 15:54:48 +01:00
2022-03-30 09:19:30 +02:00
SyrlinksHkHandler::SyrlinksHkHandler(object_id_t objectId, object_id_t comIF, CookieIF* comCookie,
2022-04-28 15:29:57 +02:00
power::Switch_t powerSwitch, FailureIsolationBase* customFdir)
: DeviceHandlerBase(objectId, comIF, comCookie, customFdir),
2022-03-30 09:19:30 +02:00
rxDataset(this),
txDataset(this),
temperatureSet(this),
2022-04-01 14:15:42 +02:00
powerSwitch(powerSwitch) {
2022-04-05 08:38:36 +02:00
if (comCookie == nullptr) {
sif::warning << "SyrlinksHkHandler: Invalid com cookie" << std::endl;
2022-01-17 15:58:27 +01:00
}
2021-02-17 15:54:48 +01:00
}
2022-01-17 15:58:27 +01:00
SyrlinksHkHandler::~SyrlinksHkHandler() {}
2021-02-17 15:54:48 +01:00
2022-01-17 15:58:27 +01:00
void SyrlinksHkHandler::doStartUp() {
2022-04-04 14:58:35 +02:00
switch (startupState) {
case StartupState::OFF: {
startupState = StartupState::ENABLE_TEMPERATURE_PROTECTION;
break;
}
case StartupState::DONE: {
setMode(_MODE_TO_ON);
break;
}
default:
break;
}
2021-02-17 15:54:48 +01:00
}
2022-01-17 15:58:27 +01:00
void SyrlinksHkHandler::doShutDown() { setMode(_MODE_POWER_DOWN); }
ReturnValue_t SyrlinksHkHandler::buildNormalDeviceCommand(DeviceCommandId_t* id) {
switch (nextCommand) {
case (syrlinks::READ_RX_STATUS_REGISTERS):
*id = syrlinks::READ_RX_STATUS_REGISTERS;
nextCommand = syrlinks::READ_TX_STATUS;
2022-01-17 15:58:27 +01:00
break;
case (syrlinks::READ_TX_STATUS):
*id = syrlinks::READ_TX_STATUS;
nextCommand = syrlinks::READ_TX_WAVEFORM;
2022-01-17 15:58:27 +01:00
break;
case (syrlinks::READ_TX_WAVEFORM):
*id = syrlinks::READ_TX_WAVEFORM;
nextCommand = syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE;
2022-01-17 15:58:27 +01:00
break;
case (syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE):
*id = syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE;
nextCommand = syrlinks::READ_TX_AGC_VALUE_LOW_BYTE;
2022-01-17 15:58:27 +01:00
break;
case (syrlinks::READ_TX_AGC_VALUE_LOW_BYTE):
*id = syrlinks::READ_TX_AGC_VALUE_LOW_BYTE;
nextCommand = syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE;
break;
case (syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE):
*id = syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE;
nextCommand = syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE;
break;
case (syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE):
*id = syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE;
nextCommand = syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE;
break;
case (syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE):
*id = syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE;
nextCommand = syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE;
break;
case (syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE):
*id = syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE;
nextCommand = syrlinks::READ_RX_STATUS_REGISTERS;
2022-01-17 15:58:27 +01:00
break;
2021-03-01 12:23:39 +01:00
default:
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::buildNormalDeviceCommand: rememberCommandId has invalid"
<< "command id" << std::endl;
break;
}
2022-04-05 08:38:36 +02:00
return buildCommandFromCommand(*id, nullptr, 0);
2021-02-17 15:54:48 +01:00
}
2022-01-17 15:58:27 +01:00
ReturnValue_t SyrlinksHkHandler::buildTransitionDeviceCommand(DeviceCommandId_t* id) {
switch (startupState) {
case StartupState::ENABLE_TEMPERATURE_PROTECTION: {
*id = syrlinks::WRITE_LCL_CONFIG;
2022-04-05 08:38:36 +02:00
return buildCommandFromCommand(*id, nullptr, 0);
}
default:
break;
}
return NOTHING_TO_SEND;
2021-02-17 15:54:48 +01:00
}
2022-01-17 15:58:27 +01:00
ReturnValue_t SyrlinksHkHandler::buildCommandFromCommand(DeviceCommandId_t deviceCommand,
const uint8_t* commandData,
size_t commandDataLen) {
switch (deviceCommand) {
case (syrlinks::RESET_UNIT): {
2022-04-04 14:58:35 +02:00
prepareCommand(resetCommand, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::SET_TX_MODE_STANDBY): {
2022-04-04 14:58:35 +02:00
prepareCommand(setTxModeStandby, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::SET_TX_MODE_MODULATION): {
2022-04-04 14:58:35 +02:00
prepareCommand(setTxModeModulation, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::SET_TX_MODE_CW): {
2022-04-04 14:58:35 +02:00
prepareCommand(setTxModeCw, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::WRITE_LCL_CONFIG): {
2022-04-04 14:58:35 +02:00
prepareCommand(writeLclConfig, deviceCommand);
2022-03-30 11:25:03 +02:00
return RETURN_OK;
}
case (syrlinks::READ_RX_STATUS_REGISTERS): {
2022-04-04 14:58:35 +02:00
prepareCommand(readRxStatusRegCommand, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::READ_LCL_CONFIG): {
2022-04-04 14:58:35 +02:00
prepareCommand(readLclConfig, deviceCommand);
2022-03-30 16:29:58 +02:00
return RETURN_OK;
}
case (syrlinks::READ_TX_STATUS): {
2022-04-04 14:58:35 +02:00
prepareCommand(readTxStatus, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::READ_TX_WAVEFORM): {
2022-04-04 14:58:35 +02:00
prepareCommand(readTxWaveform, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE): {
2022-04-04 14:58:35 +02:00
prepareCommand(readTxAgcValueHighByte, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
case (syrlinks::READ_TX_AGC_VALUE_LOW_BYTE): {
2022-04-04 14:58:35 +02:00
prepareCommand(readTxAgcValueLowByte, deviceCommand);
2022-01-17 15:58:27 +01:00
return RETURN_OK;
}
2022-04-04 14:58:35 +02:00
case (syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE): {
prepareCommand(tempPowerAmpBoardHighByte, deviceCommand);
2022-03-31 09:11:01 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE): {
prepareCommand(tempPowerAmpBoardLowByte, deviceCommand);
2022-03-31 09:11:01 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE): {
prepareCommand(tempBasebandBoardHighByte, deviceCommand);
2022-03-31 09:11:01 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE): {
prepareCommand(tempBasebandBoardLowByte, deviceCommand);
2022-03-31 09:11:01 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::CONFIG_BPSK): {
prepareCommand(configBPSK, deviceCommand);
2022-04-01 14:15:42 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::CONFIG_OQPSK): {
prepareCommand(configOQPSK, deviceCommand);
2022-04-01 14:15:42 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::ENABLE_DEBUG): {
2022-04-26 10:37:25 +02:00
debugMode = true;
2022-04-05 08:38:36 +02:00
rawPacketLen = 0;
2022-04-01 14:15:42 +02:00
return RETURN_OK;
2022-04-04 14:58:35 +02:00
}
case (syrlinks::DISABLE_DEBUG): {
2022-04-26 10:37:25 +02:00
debugMode = false;
2022-04-05 08:38:36 +02:00
rawPacketLen = 0;
2022-04-04 14:58:35 +02:00
return RETURN_OK;
}
2022-01-17 15:58:27 +01:00
default:
return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
}
return HasReturnvaluesIF::RETURN_FAILED;
2021-02-17 15:54:48 +01:00
}
2021-02-19 11:02:27 +01:00
void SyrlinksHkHandler::fillCommandAndReplyMap() {
this->insertInCommandAndReplyMap(syrlinks::RESET_UNIT, 1, nullptr, syrlinks::ACK_SIZE, false,
true, syrlinks::ACK_REPLY);
this->insertInCommandAndReplyMap(syrlinks::SET_TX_MODE_STANDBY, 1, nullptr, syrlinks::ACK_SIZE,
false, true, syrlinks::ACK_REPLY);
this->insertInCommandAndReplyMap(syrlinks::SET_TX_MODE_MODULATION, 1, nullptr, syrlinks::ACK_SIZE,
false, true, syrlinks::ACK_REPLY);
this->insertInCommandAndReplyMap(syrlinks::SET_TX_MODE_CW, 1, nullptr, syrlinks::ACK_SIZE, false,
true, syrlinks::ACK_REPLY);
this->insertInCommandAndReplyMap(syrlinks::WRITE_LCL_CONFIG, 1, nullptr, syrlinks::ACK_SIZE,
false, true, syrlinks::ACK_REPLY);
2022-04-07 09:57:52 +02:00
this->insertInCommandAndReplyMap(syrlinks::CONFIG_BPSK, 1, nullptr, syrlinks::ACK_SIZE, false,
true, syrlinks::ACK_REPLY);
this->insertInCommandAndReplyMap(syrlinks::CONFIG_OQPSK, 1, nullptr, syrlinks::ACK_SIZE, false,
true, syrlinks::ACK_REPLY);
2022-04-04 14:58:35 +02:00
this->insertInCommandMap(syrlinks::ENABLE_DEBUG);
this->insertInCommandMap(syrlinks::DISABLE_DEBUG);
this->insertInCommandAndReplyMap(syrlinks::READ_LCL_CONFIG, 1, nullptr,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::READ_TX_STATUS, 1, &txDataset,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::READ_TX_WAVEFORM, 1, &txDataset,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE, 1, &txDataset,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::READ_TX_AGC_VALUE_LOW_BYTE, 1, &txDataset,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE, 1, nullptr,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE, 1, nullptr,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE, 1, nullptr,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE, 1, nullptr,
syrlinks::READ_ONE_REGISTER_REPLY_SIE);
this->insertInCommandAndReplyMap(syrlinks::READ_RX_STATUS_REGISTERS, 1, &rxDataset,
syrlinks::RX_STATUS_REGISTERS_REPLY_SIZE);
2021-02-17 15:54:48 +01:00
}
2022-01-17 15:58:27 +01:00
ReturnValue_t SyrlinksHkHandler::scanForReply(const uint8_t* start, size_t remainingSize,
DeviceCommandId_t* foundId, size_t* foundLen) {
ReturnValue_t result = RETURN_OK;
if (*start != '<') {
sif::warning << "SyrlinksHkHandler::scanForReply: Missing start frame character" << std::endl;
2022-01-17 15:58:27 +01:00
return MISSING_START_FRAME_CHARACTER;
}
switch (*(start + 1)) {
case ('A'):
*foundLen = syrlinks::ACK_SIZE;
*foundId = syrlinks::ACK_REPLY;
2022-01-17 15:58:27 +01:00
break;
case ('E'):
*foundLen = syrlinks::RX_STATUS_REGISTERS_REPLY_SIZE;
*foundId = syrlinks::READ_RX_STATUS_REGISTERS;
2022-01-17 15:58:27 +01:00
break;
case ('R'):
*foundId = rememberCommandId;
*foundLen = syrlinks::READ_ONE_REGISTER_REPLY_SIE;
2022-01-17 15:58:27 +01:00
break;
default:
sif::warning << "SyrlinksHkHandler::scanForReply: Unknown reply identifier" << std::endl;
2022-01-17 15:58:27 +01:00
result = IGNORE_REPLY_DATA;
break;
}
2021-02-22 09:24:42 +01:00
2022-01-17 15:58:27 +01:00
return result;
2021-02-17 15:54:48 +01:00
}
2022-03-30 09:19:30 +02:00
ReturnValue_t SyrlinksHkHandler::getSwitches(const uint8_t** switches, uint8_t* numberOfSwitches) {
if (powerSwitch == power::NO_SWITCH) {
return DeviceHandlerBase::NO_SWITCH;
}
*numberOfSwitches = 1;
*switches = &powerSwitch;
return RETURN_OK;
}
2022-01-17 15:58:27 +01:00
ReturnValue_t SyrlinksHkHandler::interpretDeviceReply(DeviceCommandId_t id, const uint8_t* packet) {
ReturnValue_t result;
2021-02-17 15:54:48 +01:00
2022-01-17 15:58:27 +01:00
switch (id) {
case (syrlinks::ACK_REPLY): {
result = verifyReply(packet, syrlinks::ACK_SIZE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Acknowledgment reply has "
2022-04-04 14:58:35 +02:00
"invalid crc"
<< std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
result = handleAckReply(packet);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
return result;
}
break;
}
case (syrlinks::READ_RX_STATUS_REGISTERS): {
result = verifyReply(packet, syrlinks::RX_STATUS_REGISTERS_REPLY_SIZE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read rx status registers reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
parseRxStatusRegistersReply(packet);
break;
}
case (syrlinks::READ_LCL_CONFIG): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-03-30 16:29:58 +02:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read config lcl reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-03-30 16:29:58 +02:00
return CRC_FAILURE;
}
parseLclConfigReply(packet);
break;
}
case (syrlinks::READ_TX_STATUS): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read tx status reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
parseTxStatusReply(packet);
break;
}
case (syrlinks::READ_TX_WAVEFORM): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read tx waveform reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
parseTxWaveformReply(packet);
break;
}
case (syrlinks::READ_TX_AGC_VALUE_HIGH_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read tx AGC high byte reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
parseAgcHighByte(packet);
break;
}
case (syrlinks::READ_TX_AGC_VALUE_LOW_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-01-17 15:58:27 +01:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read tx AGC low byte reply "
2022-04-04 14:58:35 +02:00
<< "has invalid crc" << std::endl;
2022-01-17 15:58:27 +01:00
return CRC_FAILURE;
}
parseAgcLowByte(packet);
break;
}
case (syrlinks::TEMP_BASEBAND_BOARD_HIGH_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-03-31 09:11:01 +02:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read temperature baseband board "
2022-04-04 14:58:35 +02:00
<< "high byte reply has invalid crc" << std::endl;
2022-03-31 09:11:01 +02:00
return CRC_FAILURE;
}
rawTempBasebandBoard = convertHexStringToUint8(reinterpret_cast<const char*>(
packet + syrlinks::MESSAGE_HEADER_SIZE))
2022-03-31 09:11:01 +02:00
<< 8;
break;
}
case (syrlinks::TEMP_BASEBAND_BOARD_LOW_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-03-31 09:11:01 +02:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read temperature baseband board"
2022-04-04 14:58:35 +02:00
" low byte reply has invalid crc"
<< std::endl;
2022-03-31 09:11:01 +02:00
return CRC_FAILURE;
}
rawTempBasebandBoard |= convertHexStringToUint8(
reinterpret_cast<const char*>(packet + syrlinks::MESSAGE_HEADER_SIZE));
2022-03-31 09:11:01 +02:00
tempBasebandBoard = calcTempVal(rawTempBasebandBoard);
PoolReadGuard rg(&temperatureSet);
2022-06-03 18:03:25 +02:00
temperatureSet.temperatureBasebandBoard = tempBasebandBoard;
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-04 14:58:35 +02:00
sif::info << "Syrlinks temperature baseband board: " << tempBasebandBoard << " °C"
<< std::endl;
}
2022-03-31 09:11:01 +02:00
break;
}
case (syrlinks::TEMP_POWER_AMPLIFIER_HIGH_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-03-31 09:11:01 +02:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read temperature power amplifier "
2022-04-04 14:58:35 +02:00
<< "board high byte reply has invalid crc" << std::endl;
2022-03-31 09:11:01 +02:00
return CRC_FAILURE;
}
rawTempPowerAmplifier = 0;
rawTempPowerAmplifier = convertHexStringToUint8(reinterpret_cast<const char*>(
packet + syrlinks::MESSAGE_HEADER_SIZE))
<< 8;
2022-03-31 09:11:01 +02:00
break;
}
case (syrlinks::TEMP_POWER_AMPLIFIER_LOW_BYTE): {
result = verifyReply(packet, syrlinks::READ_ONE_REGISTER_REPLY_SIE);
2022-03-31 09:11:01 +02:00
if (result != RETURN_OK) {
sif::warning << "SyrlinksHkHandler::interpretDeviceReply: Read temperature power amplifier"
2022-04-04 14:58:35 +02:00
<< " board low byte reply has invalid crc" << std::endl;
2022-03-31 09:11:01 +02:00
return CRC_FAILURE;
}
rawTempPowerAmplifier |= convertHexStringToUint8(
reinterpret_cast<const char*>(packet + syrlinks::MESSAGE_HEADER_SIZE));
tempPowerAmplifier = calcTempVal(rawTempPowerAmplifier);
PoolReadGuard rg(&temperatureSet);
temperatureSet.temperaturePowerAmplifier = tempPowerAmplifier;
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-04 14:58:35 +02:00
sif::info << "Syrlinks temperature power amplifier board: " << tempPowerAmplifier << " °C"
<< std::endl;
}
2022-03-31 09:11:01 +02:00
break;
}
2022-01-17 15:58:27 +01:00
default: {
sif::debug << "SyrlinksHkHandler::interpretDeviceReply: Unknown device reply id" << std::endl;
return DeviceHandlerIF::UNKNOWN_DEVICE_REPLY;
}
}
return RETURN_OK;
}
2021-03-01 12:23:39 +01:00
LocalPoolDataSetBase* SyrlinksHkHandler::getDataSetHandle(sid_t sid) {
2022-01-17 15:58:27 +01:00
if (sid == rxDataset.getSid()) {
return &rxDataset;
} else if (sid == txDataset.getSid()) {
return &txDataset;
} else if (sid == temperatureSet.getSid()) {
return &temperatureSet;
2022-01-17 15:58:27 +01:00
} else {
sif::warning << "SyrlinksHkHandler::getDataSetHandle: Invalid sid" << std::endl;
2022-01-17 15:58:27 +01:00
return nullptr;
}
2021-02-27 11:07:42 +01:00
}
std::string SyrlinksHkHandler::convertUint16ToHexString(uint16_t intValue) {
2022-01-17 15:58:27 +01:00
std::stringstream stream;
stream << std::setfill('0') << std::setw(4) << std::hex << std::uppercase << intValue;
return stream.str();
}
2021-02-25 18:15:57 +01:00
uint8_t SyrlinksHkHandler::convertHexStringToUint8(const char* twoChars) {
2022-01-17 15:58:27 +01:00
uint32_t value;
std::string hexString(twoChars, 2);
std::stringstream stream;
stream << std::hex << hexString;
stream >> value;
return static_cast<uint8_t>(value);
2021-02-25 15:53:28 +01:00
}
2021-02-25 18:15:57 +01:00
uint16_t SyrlinksHkHandler::convertHexStringToUint16(const char* fourChars) {
2022-01-17 15:58:27 +01:00
uint16_t value = 0;
value = convertHexStringToUint8(fourChars) << 8 | convertHexStringToUint8(fourChars + 2);
return value;
2021-02-25 18:15:57 +01:00
}
2021-02-25 15:53:28 +01:00
2022-01-17 15:58:27 +01:00
uint32_t SyrlinksHkHandler::convertHexStringToUint32(const char* characters,
uint8_t numberOfChars) {
uint32_t value = 0;
2021-02-25 18:15:57 +01:00
2022-01-17 15:58:27 +01:00
switch (numberOfChars) {
2021-02-25 18:15:57 +01:00
case 6:
2022-01-17 15:58:27 +01:00
value = convertHexStringToUint8(characters) << 16 |
convertHexStringToUint8(characters + 2) << 8 |
convertHexStringToUint8(characters + 4);
return value;
2021-02-25 18:15:57 +01:00
case 8:
2022-01-17 15:58:27 +01:00
value = convertHexStringToUint8(characters) << 24 |
convertHexStringToUint8(characters + 2) << 16 |
convertHexStringToUint8(characters + 4) << 8 |
convertHexStringToUint8(characters + 4);
return value;
2021-02-25 18:15:57 +01:00
default:
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::convertHexStringToUint32: Invalid number of characters. "
<< "Must be either 6 or 8" << std::endl;
return 0;
}
2021-02-25 15:53:28 +01:00
}
2021-02-22 09:24:42 +01:00
ReturnValue_t SyrlinksHkHandler::parseReplyStatus(const char* status) {
2022-01-17 15:58:27 +01:00
switch (*status) {
case '0':
2022-01-17 15:58:27 +01:00
return RETURN_OK;
case '1':
2022-04-07 09:57:52 +02:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Uart framing or parity error"
<< std::endl;
2022-01-17 15:58:27 +01:00
return UART_FRAMIN_OR_PARITY_ERROR_ACK;
case '2':
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Bad character detected" << std::endl;
return BAD_CHARACTER_ACK;
case '3':
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Bad parameter value (unexpected value "
<< "detected" << std::endl;
return BAD_PARAMETER_VALUE_ACK;
case '4':
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Bad end of frame" << std::endl;
return BAD_END_OF_FRAME_ACK;
case '5':
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Unknown command id or attempt to access"
<< " a protected register" << std::endl;
return UNKNOWN_COMMAND_ID_ACK;
case '6':
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Bad CRC" << std::endl;
return BAD_CRC_ACK;
default:
2022-01-17 15:58:27 +01:00
sif::debug << "SyrlinksHkHandler::parseReplyStatus: Status reply contains an invalid "
<< "status id" << std::endl;
return RETURN_FAILED;
}
}
2021-02-22 09:24:42 +01:00
ReturnValue_t SyrlinksHkHandler::verifyReply(const uint8_t* packet, uint8_t size) {
2022-01-17 15:58:27 +01:00
int result = 0;
/* Calculate crc from received packet */
uint16_t crc =
CRC::crc16ccitt(packet, size - syrlinks::SIZE_CRC_AND_TERMINATION, CRC_INITIAL_VALUE);
2022-01-17 15:58:27 +01:00
std::string recalculatedCrc = convertUint16ToHexString(crc);
const char* startOfCrc =
reinterpret_cast<const char*>(packet + size - syrlinks::SIZE_CRC_AND_TERMINATION);
2022-01-17 15:58:27 +01:00
const char* endOfCrc = reinterpret_cast<const char*>(packet + size - 1);
std::string replyCrc(startOfCrc, endOfCrc);
result = recalculatedCrc.compare(replyCrc);
if (result != 0) {
return RETURN_FAILED;
}
return RETURN_OK;
}
2021-02-22 09:24:42 +01:00
void SyrlinksHkHandler::parseRxStatusRegistersReply(const uint8_t* packet) {
2022-01-17 15:58:27 +01:00
PoolReadGuard readHelper(&rxDataset);
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-01-17 15:58:27 +01:00
rxDataset.rxStatus = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
offset += 2;
rxDataset.rxSensitivity =
convertHexStringToUint32(reinterpret_cast<const char*>(packet + offset), 6);
offset += 6;
rxDataset.rxFrequencyShift =
convertHexStringToUint32(reinterpret_cast<const char*>(packet + offset), 6);
offset += 6;
rxDataset.rxIqPower = convertHexStringToUint16(reinterpret_cast<const char*>(packet + offset));
offset += 4;
rxDataset.rxAgcValue = convertHexStringToUint16(reinterpret_cast<const char*>(packet + offset));
offset += 4;
offset += 2; // reserved register
rxDataset.rxDemodEb = convertHexStringToUint32(reinterpret_cast<const char*>(packet + offset), 6);
offset += 6;
rxDataset.rxDemodN0 = convertHexStringToUint32(reinterpret_cast<const char*>(packet + offset), 6);
offset += 6;
rxDataset.rxDataRate = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2021-02-25 18:15:57 +01:00
2022-04-26 10:37:25 +02:00
if (debugMode) {
#if OBSW_VERBOSE_LEVEL >= 1
2022-04-07 09:57:52 +02:00
sif::info << "Syrlinks RX Status: 0x" << std::hex << (unsigned int)rxDataset.rxStatus.value
<< std::endl;
sif::info << "Syrlinks RX Sensitivity: " << std::dec << rxDataset.rxSensitivity << std::endl;
sif::info << "Syrlinks RX Frequency Shift: " << rxDataset.rxFrequencyShift << std::endl;
sif::info << "Syrlinks RX IQ Power: " << rxDataset.rxIqPower << std::endl;
sif::info << "Syrlinks RX AGC Value: " << rxDataset.rxAgcValue << std::endl;
sif::info << "Syrlinks RX Demod Eb: " << rxDataset.rxDemodEb << std::endl;
sif::info << "Syrlinks RX Demod N0: " << rxDataset.rxDemodN0 << std::endl;
sif::info << "Syrlinks RX Datarate: " << (unsigned int)rxDataset.rxDataRate.value << std::endl;
2021-02-25 18:15:57 +01:00
#endif
2022-04-26 10:37:25 +02:00
}
2021-02-22 09:24:42 +01:00
}
2022-03-30 16:29:58 +02:00
void SyrlinksHkHandler::parseLclConfigReply(const uint8_t* packet) {
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-03-30 16:29:58 +02:00
uint8_t lclConfig = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-07 09:57:52 +02:00
sif::info << "SyrlinksHkHandler::parseRxStatusRegistersReply: Lcl config: "
<< static_cast<unsigned int>(lclConfig) << std::endl;
2022-04-05 08:38:36 +02:00
}
2022-03-30 16:29:58 +02:00
}
2021-02-22 09:24:42 +01:00
void SyrlinksHkHandler::parseTxStatusReply(const uint8_t* packet) {
2022-01-17 15:58:27 +01:00
PoolReadGuard readHelper(&txDataset);
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-01-17 15:58:27 +01:00
txDataset.txStatus = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-07 09:57:52 +02:00
sif::info << "Syrlinks TX Status: 0x" << std::hex << (unsigned int)txDataset.txStatus.value
<< std::endl;
2022-04-05 08:38:36 +02:00
}
2021-02-27 11:07:42 +01:00
}
void SyrlinksHkHandler::parseTxWaveformReply(const uint8_t* packet) {
2022-01-17 15:58:27 +01:00
PoolReadGuard readHelper(&txDataset);
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-01-17 15:58:27 +01:00
txDataset.txWaveform = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-07 09:57:52 +02:00
sif::info << "Syrlinks TX Waveform: 0x" << std::hex << (unsigned int)txDataset.txWaveform.value
<< std::endl;
2022-04-05 08:38:36 +02:00
}
2021-02-27 11:07:42 +01:00
}
2021-03-01 12:23:39 +01:00
void SyrlinksHkHandler::parseAgcLowByte(const uint8_t* packet) {
2022-01-17 15:58:27 +01:00
PoolReadGuard readHelper(&txDataset);
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-01-17 15:58:27 +01:00
txDataset.txAgcValue = agcValueHighByte << 8 |
convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2022-04-26 10:37:25 +02:00
if (debugMode) {
2022-04-07 09:57:52 +02:00
sif::info << "Syrlinks TX AGC Value: " << txDataset.txAgcValue << std::endl;
2022-04-05 08:38:36 +02:00
}
2021-02-22 09:24:42 +01:00
}
2021-03-01 12:23:39 +01:00
void SyrlinksHkHandler::parseAgcHighByte(const uint8_t* packet) {
2022-01-17 15:58:27 +01:00
PoolReadGuard readHelper(&txDataset);
uint16_t offset = syrlinks::MESSAGE_HEADER_SIZE;
2022-01-17 15:58:27 +01:00
agcValueHighByte = convertHexStringToUint8(reinterpret_cast<const char*>(packet + offset));
2021-03-01 12:23:39 +01:00
}
2022-01-17 15:58:27 +01:00
void SyrlinksHkHandler::setNormalDatapoolEntriesInvalid() {}
2021-02-17 15:54:48 +01:00
2022-04-05 08:38:36 +02:00
uint32_t SyrlinksHkHandler::getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) { return 500; }
2021-02-17 15:54:48 +01:00
ReturnValue_t SyrlinksHkHandler::initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
2022-01-17 15:58:27 +01:00
LocalDataPoolManager& poolManager) {
localDataPoolMap.emplace(syrlinks::RX_STATUS, new PoolEntry<uint8_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_SENSITIVITY, new PoolEntry<uint32_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_FREQUENCY_SHIFT, new PoolEntry<uint32_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_IQ_POWER, new PoolEntry<uint16_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_AGC_VALUE, new PoolEntry<uint16_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_DEMOD_EB, new PoolEntry<uint32_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_DEMOD_N0, new PoolEntry<uint32_t>({0}));
localDataPoolMap.emplace(syrlinks::RX_DATA_RATE, new PoolEntry<uint8_t>({0}));
localDataPoolMap.emplace(syrlinks::TX_STATUS, new PoolEntry<uint8_t>({0}));
localDataPoolMap.emplace(syrlinks::TX_WAVEFORM, new PoolEntry<uint8_t>({0}));
localDataPoolMap.emplace(syrlinks::TX_AGC_VALUE, new PoolEntry<uint16_t>({0}));
2022-04-01 14:15:42 +02:00
localDataPoolMap.emplace(syrlinks::TEMP_BASEBAND_BOARD, new PoolEntry<uint16_t>({0}));
localDataPoolMap.emplace(syrlinks::TEMP_POWER_AMPLIFIER, new PoolEntry<uint16_t>({0}));
2022-01-17 15:58:27 +01:00
poolManager.subscribeForPeriodicPacket(txDataset.getSid(), false, 5.0, true);
poolManager.subscribeForPeriodicPacket(rxDataset.getSid(), false, 5.0, true);
poolManager.subscribeForPeriodicPacket(temperatureSet.getSid(), false, 10.0, false);
2022-01-17 15:58:27 +01:00
return HasReturnvaluesIF::RETURN_OK;
2021-02-22 09:24:42 +01:00
}
2022-01-17 15:58:27 +01:00
void SyrlinksHkHandler::setModeNormal() { mode = MODE_NORMAL; }
2022-03-31 09:11:01 +02:00
float SyrlinksHkHandler::calcTempVal(uint16_t raw) { return 0.126984 * raw - 67.87; }
ReturnValue_t SyrlinksHkHandler::handleAckReply(const uint8_t* packet) {
ReturnValue_t result =
parseReplyStatus(reinterpret_cast<const char*>(packet + syrlinks::MESSAGE_HEADER_SIZE));
if (rememberCommandId == syrlinks::WRITE_LCL_CONFIG and result != RETURN_OK) {
startupState = StartupState::OFF;
} else if (rememberCommandId == syrlinks::WRITE_LCL_CONFIG and result == RETURN_OK) {
startupState = StartupState::DONE;
}
return result;
}
2022-04-04 14:58:35 +02:00
void SyrlinksHkHandler::prepareCommand(std::string command, DeviceCommandId_t commandId) {
2022-04-05 08:38:36 +02:00
command.copy(reinterpret_cast<char*>(commandBuffer), command.size(), 0);
2022-04-04 14:58:35 +02:00
rawPacketLen = command.size();
rememberCommandId = commandId;
rawPacket = commandBuffer;
}
2022-04-26 10:37:25 +02:00
void SyrlinksHkHandler::setDebugMode(bool enable) { this->debugMode = enable; }