eive-obsw/bsp_q7s/devices/startracker/StrImageLoader.h

215 lines
8.7 KiB
C
Raw Normal View History

2021-11-30 16:01:02 +01:00
#ifndef BSP_Q7S_DEVICES_STRIMAGELOADER_H_
#define BSP_Q7S_DEVICES_STRIMAGELOADER_H_
#include <string>
#include "ArcsecDatalinkLayer.h"
2021-11-30 16:01:02 +01:00
#include "fsfw/osal/linux/BinarySemaphore.h"
#include "bsp_q7s/memory/SdCardManager.h"
2021-12-02 08:05:33 +01:00
#include "fsfw/returnvalues/HasReturnvaluesIF.h"
2021-12-06 19:36:21 +01:00
#include "fsfw/objectmanager/SystemObject.h"
#include "fsfw/tasks/ExecutableObjectIF.h"
2021-12-10 10:07:23 +01:00
#include "fsfw_hal/linux/uart/UartComIF.h"
2021-12-06 19:36:21 +01:00
#include "fsfw/devicehandlers/CookieIF.h"
extern "C" {
#include "thirdparty/arcsec_star_tracker/common/generated/tmtcstructs.h"
#include "thirdparty/arcsec_star_tracker/client/generated/actionreq.h"
}
2021-11-30 16:01:02 +01:00
/**
* @brief An object of this class runs in a separate task and is responsible for uploading and
* downloading images to/from the star tracker. This is required because uploading and
* downloading via the star tracker handler takes a lot of time because each upload or
* download packet can transport a maximum of 1024 bytes.
*/
2021-12-02 08:05:33 +01:00
class StrImageLoader: public SystemObject, public ExecutableObjectIF, public HasReturnvaluesIF {
2021-11-30 16:01:02 +01:00
public:
2021-12-02 08:05:33 +01:00
static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::STR_IMAGE_LOADER;
2021-12-10 10:07:23 +01:00
//! [EXPORT] : [COMMENT] Image upload failed
static const Event IMAGE_UPLOAD_FAILED = MAKE_EVENT(0, severity::LOW);
//! [EXPORT] : [COMMENT] Image download failed
static const Event IMAGE_DOWNLOAD_FAILED = MAKE_EVENT(1, severity::LOW);
2021-12-02 08:05:33 +01:00
//! [EXPORT] : [COMMENT] Uploading image to star tracker was successful
2021-12-10 10:07:23 +01:00
static const Event IMAGE_UPLOAD_SUCCESSFUL = MAKE_EVENT(2, severity::LOW);
//! [EXPORT] : [COMMENT] Image download was successful
static const Event IMAGE_DOWNLOAD_SUCCESSFUL = MAKE_EVENT(3, severity::LOW);
2021-12-02 08:05:33 +01:00
//! [EXPORT] : [COMMENT] Failed to read communication interface reply data
//!P1: Return code of failed communication interface read call
2021-12-09 15:02:58 +01:00
//!P1: Upload/download position for which the read call failed
static const Event IMG_LOADER_READING_REPLY_FAILED = MAKE_EVENT(4, severity::LOW);
2021-12-02 08:05:33 +01:00
//! [EXPORT] : [COMMENT] Unexpected stop of decoding sequence
//!P1: Return code of failed communication interface read call
2021-12-09 15:02:58 +01:00
//!P1: Upload/download position for which the read call failed
static const Event IMG_LOADER_COM_ERROR = MAKE_EVENT(5, severity::LOW);
2021-12-06 19:36:21 +01:00
//! [EXPORT] : [COMMENT] Star tracker did not send replies (maybe device is powered off)
2021-12-09 15:02:58 +01:00
//!P1: Position of upload or download packet for which no reply was sent
static const Event IMG_LOADER_NO_REPLY = MAKE_EVENT(6, severity::LOW);
2021-12-06 19:36:21 +01:00
//! [EXPORT] : [COMMENT] Received reply with invalid type ID
static const Event INVALID_TYPE_ID = MAKE_EVENT(7, severity::LOW);
//! [EXPORT] : [COMMENT] Status field in reply signals error
static const Event STATUS_ERROR = MAKE_EVENT(8, severity::LOW);
//! [EXPORT] : [COMMENT] Error during decoding of received reply occurred
//P1: Return value of decoding function
2021-12-09 15:02:58 +01:00
//P2: Position of upload/download packet for which reply decoding failed
static const Event IMG_LOADER_DEC_ERROR = MAKE_EVENT(9, severity::LOW);
//! [EXPORT] : [COMMENT] Position mismatch
//! P1: The expected position and thus the position for which the image upload/download failed
2021-12-10 10:07:23 +01:00
static const Event POSITION_MISMATCH = MAKE_EVENT(10, severity::LOW);
//! [EXPORT] : [COMMENT] Try to upload image but specified image does not exist
static const Event IMAGE_FILE_NOT_EXISTS = MAKE_EVENT(11, severity::LOW);
//! [EXPORT] : [COMMENT] Sending packet (download or upload) to star tracker failed
//!P1: Return code of communication interface sendMessage function
//!P2: Position of upload/download packet for which the transmission failed
static const Event IMG_LOADER_SENDING_PACKET_FAILED = MAKE_EVENT(12, severity::LOW);
//! [EXPORT] : [COMMENT] Communication interface requesting reply failed
//!P1: Return code of failed request
//!P1: Upload/download position for which the request failed
static const Event IMG_LOADER_REQUESTING_MSG_FAILED = MAKE_EVENT(13, severity::LOW);
2021-11-30 16:01:02 +01:00
StrImageLoader(object_id_t objectId);
virtual ~StrImageLoader();
2021-12-06 19:36:21 +01:00
ReturnValue_t initialize() override;
2021-11-30 16:01:02 +01:00
ReturnValue_t performOperation(uint8_t operationCode = 0) override;
2021-12-10 10:07:23 +01:00
ReturnValue_t setComIF(DeviceCommunicationIF* communicationInterface_);
2021-11-30 16:01:02 +01:00
void setComCookie(CookieIF* comCookie_);
2021-12-02 08:05:33 +01:00
/**
* @brief Starts sequence to upload image to star tracker
*
* @param image Name including absolute path if to image to upload. Must be previously
* transferred to the OBC with the CFDP protocoll.
*/
2021-12-11 11:56:47 +01:00
ReturnValue_t startImageUpload(std::string uploadImage_);
2021-12-02 08:05:33 +01:00
2021-12-06 19:36:21 +01:00
/**
* @brief Calling this function initiates the download of an image from the star tracker.
2021-12-11 11:56:47 +01:00
*
* @param Name of the image which will be created
2021-12-06 19:36:21 +01:00
*/
2021-12-11 11:56:47 +01:00
ReturnValue_t startImageDownload(std::string downloadPath_);
2021-12-06 19:36:21 +01:00
2021-12-10 10:07:23 +01:00
/**
* @brief Can be used to interrupt a running upload or download process.
*/
void stopProcess();
2021-12-11 11:56:47 +01:00
/**
* @brief Changes the dafault name of downloaded images
*/
void setDownloadImageName(std::string image);
2021-11-30 16:01:02 +01:00
private:
static const uint8_t INTERFACE_ID = CLASS_ID::STR_IMG_LOADER;
//! [EXPORT] : [COMMENT] SD card specified in path string not mounted
static const ReturnValue_t SD_NOT_MOUNTED = MAKE_RETURN_CODE(0xA0);
//! [EXPORT] : [COMMENT] Specified file does not exist on filesystem
static const ReturnValue_t FILE_NOT_EXISTS = MAKE_RETURN_CODE(0xA1);
2021-12-11 11:56:47 +01:00
//! [EXPORT] : [COMMENT] Specified path does not exist
static const ReturnValue_t PATH_NOT_EXISTS = MAKE_RETURN_CODE(0xA2);
//! [EXPORT] : [COMMENT] Failed to create download file
static const ReturnValue_t FILE_CREATION_FAILED = MAKE_RETURN_CODE(0xA3);
2021-11-30 16:01:02 +01:00
2021-12-02 08:05:33 +01:00
// Size of one image part which can be sent per action request
static const size_t SIZE_IMAGE_PART = 1024;
2021-12-09 15:02:58 +01:00
static const uint32_t LAST_POSITION = 4095;
2021-12-06 19:36:21 +01:00
static const uint32_t MAX_POLLS = 10000;
2021-12-09 15:02:58 +01:00
static const uint8_t POS_OFFSET = 2;
static const uint8_t DATA_OFFSET = 5;
static const size_t IMAGE_DATA_SIZE = 1024;
2021-12-10 10:07:23 +01:00
static const size_t CONFIG_MAX_DOWNLOAD_RETRIES = 3;
2021-12-09 15:02:58 +01:00
2021-11-30 16:01:02 +01:00
enum class InternalState {
IDLE,
UPLOAD_IMAGE,
DOWNLOAD_IMAGE
};
InternalState internalState = InternalState::IDLE;
2021-12-02 08:05:33 +01:00
ArcsecDatalinkLayer datalinkLayer;
2021-11-30 16:01:02 +01:00
BinarySemaphore semaphore;
2021-12-09 15:02:58 +01:00
// Name including absolute path of image to upload
2021-11-30 16:01:02 +01:00
std::string uploadImage;
2021-12-11 11:56:47 +01:00
// Path where the downloaded image will be stored
std::string downloadPath;
// Default name of downloaded image, can be changed via command
std::string downloadImage = "image";
2021-11-30 16:01:02 +01:00
SdCardManager* sdcMan = nullptr;
2021-12-06 19:36:21 +01:00
uint8_t commandBuffer[StarTracker::MAX_FRAME_SIZE];
2021-12-10 10:07:23 +01:00
bool terminate = false;
2021-11-30 16:01:02 +01:00
/**
2021-12-10 10:07:23 +01:00
* UART communication object responsible for low level access of star tracker
2021-11-30 16:01:02 +01:00
* Must be set by star tracker handler
*/
2021-12-10 10:07:23 +01:00
UartComIF* uartComIF = nullptr;
2021-12-02 08:05:33 +01:00
// Communication cookie. Must be set by the star tracker handler
CookieIF* comCookie = nullptr;
2021-12-06 19:36:21 +01:00
// Queue id of raw data receiver
MessageQueueId_t rawDataReceiver = MessageQueueIF::NO_QUEUE;
2021-12-02 08:05:33 +01:00
/**
* @brief Performs image uploading
*/
2021-12-06 19:36:21 +01:00
ReturnValue_t performImageUpload();
/**
2021-12-14 19:24:31 +01:00
* @brief Performs download of last taken image from the star tracker.
*
* @details Download is split over multiple packets transporting each a maximum of 1024 bytes.
* In case the download of one position fails, the same packet will be again
* requested. If the download of the packet fails CONFIG_MAX_DOWNLOAD_RETRIES times,
* the download will be stopped.
2021-12-09 15:02:58 +01:00
*/
ReturnValue_t performImageDownload();
/**
* @brief Sends packet to the star tracker and reads reply by using the communication
* interface
2021-12-06 19:36:21 +01:00
*
2021-12-09 15:02:58 +01:00
* @return RETURN_OK if successful, otherwise RETURN_FAILED
*/
ReturnValue_t sendAndRead(size_t size, uint32_t position);
/**
* @brief Checks the reply header (type id and status fields)
2021-12-06 19:36:21 +01:00
*
2021-12-09 15:02:58 +01:00
* @return RETURN_OK if reply confirms success of packet transfer, otherwise REUTRN_FAILED
2021-12-06 19:36:21 +01:00
*/
2021-12-09 15:02:58 +01:00
ReturnValue_t checkReply();
2021-12-06 19:36:21 +01:00
/**
2021-12-09 15:02:58 +01:00
* @brief Checks the position field in a star tracker reply.
*
* @param expectedPosition Value of expected position
2021-12-06 19:36:21 +01:00
*
2021-12-09 15:02:58 +01:00
* @return RETURN_OK if received position matches expected position, otherwise RETURN_FAILED
2021-12-06 19:36:21 +01:00
*/
2021-12-09 15:02:58 +01:00
ReturnValue_t checkReplyPosition(uint32_t expectedPosition);
2021-12-11 11:56:47 +01:00
/**
* @brief Checks if a path points to an sd card and whether the SD card is monuted.
*
* @return SD_NOT_MOUNTED id SD card is not mounted, otherwise RETURN_OK
*/
ReturnValue_t checkPath(std::string name);
2021-11-30 16:01:02 +01:00
};
#endif /* BSP_Q7S_DEVICES_STRIMAGELOADER_H_ */