CCSDSPack
C++ Library for CCSDS Space Packet manipulation. i.e. generation, extraction, analisys and more
Loading...
Searching...
No Matches
exec_encoder.cpp
Go to the documentation of this file.
1
6#include <unordered_map>
7#include <string>
8#include <vector>
9#include <iostream>
10#include <chrono>
11#include <sstream>
12#include "CCSDSPack.h"
13#include "exec_utils.h"
14
15
16void printHelp() {
17 // ascii art generated on https://www.asciiart.eu/text-to-ascii-art
18 // with ANSI SHADOW Font, with 80 and Block frame
19 std::cout << std::endl <<
20 "▐▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▌\n"
21 "▐ ██████╗ ██████╗███████╗██████╗ ███████╗ ▌\n"
22 "▐ ██╔════╝██╔════╝██╔════╝██╔══██╗██╔════╝ ▌\n"
23 "▐ ██║ ██║ ███████╗██║ ██║███████╗ ▌\n"
24 "▐ ██║ ██║ ╚════██║██║ ██║╚════██║ █▀█░█▀█░█▀▀░█░█░ ▌\n"
25 "▐ ╚██████╗╚██████╗███████║██████╔╝███████║ █▀▀░█▀█░█░░░█▀▄░ ▌\n"
26 "▐ ╚═════╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝ ▀░░░▀░▀░▀▀▀░▀░▀░ ▌\n"
27 "▐ ███████╗███╗ ██╗ ██████╗ ██████╗ ██████╗ ███████╗██████╗ ▌\n"
28 "▐ ██╔════╝████╗ ██║██╔════╝██╔═══██╗██╔══██╗██╔════╝██╔══██╗ ▌\n"
29 "▐ █████╗ ██╔██╗ ██║██║ ██║ ██║██║ ██║█████╗ ██████╔╝ ▌\n"
30 "▐ ██╔══╝ ██║╚██╗██║██║ ██║ ██║██║ ██║██╔══╝ ██╔══██╗ ▌\n"
31 "▐ ███████╗██║ ╚████║╚██████╗╚██████╔╝██████╔╝███████╗██║ ██║ ▌\n"
32 "▐ ╚══════╝╚═╝ ╚═══╝ ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝ ▌\n"
33 "▐▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▌\n"
34 << std::endl;
35 std::cout << "Usage: ccsds_encoder [OPTIONS] - take a file and packets it into ccsds packets and saves it to a binary file." << std::endl;
36 std::cout << "Mandatory parameters:" << std::endl;
37 std::cout << " -i or --input <filename> : input file to be encoded" << std::endl;;
38 std::cout << " -o or --output <filename> : Generated output file" << std::endl;;
39 std::cout << " -c or --config <filename> : Configuration file" << std::endl;
40 std::cout << std::endl;
41 std::cout << "Optionals:" << std::endl;
42 std::cout << " -h or --help : Show this help and message" << std::endl;
43 std::cout << " -v or --verbose : Show generated packets information" << std::endl;
44 std::cout << std::endl;
45 std::cout << "Note : the template CCSDS packet is defined in the configuration file" << std::endl;
46 std::cout << " This should follow the guide lines provided in the link below." << std::endl;
47 std::cout << std::endl;
48 std::cout << "For further information please visit: https://github.com/ExoSpaceLabs/CCSDSPack" << std::endl;
49}
50
51int main(const int argc, char* argv[]) {
52 std::string appName = "ccsds_encoder";
53
54 std::unordered_map<std::string, std::string> allowed;
55 allowed.insert({"h", "help"});
56 allowed.insert({"v", "verbose"});
57 allowed.insert({"i", "input"});
58 allowed.insert({"o", "output"});
59 allowed.insert({"c", "config"});
60
61 const std::set<std::string> booleanArgs{"verbose", "help"};
62
63 std::unordered_map<std::string, std::string> args;
64 args.insert({"verbose", "false"});
65 args.insert({"help", "false"});
66
67 const auto start = std::chrono::high_resolution_clock::now();
68 if (const auto res = parseArguments(argc, argv, allowed, args, booleanArgs); !res.has_value()) {
69 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
70 return res.error().code();
71 }
72 // std::cout << "Parsed args:\n";
73 //for (const auto& [k, v] : args) {
74 // std::cout << " " << k << ": " << v << '\n';
75 //}
76 if (args["help"] == "true") {
77 printHelp();
78 return 0;
79 }
80 bool verbose{args["verbose"] == "true"};
81
82 if (args.find("input") == args.end()) {
83 std::cerr << "[ Error " << ARG_PARSE_ERROR << " ]: " << "Input file must be specified" << std::endl;
84 printHelp();
85 return ARG_PARSE_ERROR;
86 }
87
88 if (!fileExists(args["input"])) {
89 std::cerr << "[ Error " << ARG_PARSE_ERROR << " ]: " << "Input \"" << args["input"] << "\" does not exist" << std::endl;
90 return ARG_PARSE_ERROR;
91 }
92 const std::string input{args["input"]};
93 const std::string output{args["output"]};
94
95 if (output.empty()) {
96 std::cerr << "[ Error " << ARG_PARSE_ERROR << " ]: " << "Output file must be specified" << std::endl;
97 printHelp();
98 return ARG_PARSE_ERROR;
99 }
100
101 if (args.find("config") == args.end()) {
102 std::cerr << "[ Error " << ARG_PARSE_ERROR << " ]: " << "Config file must be specified" << std::endl;
103 printHelp();
104 return ARG_PARSE_ERROR;
105 }
106
107 if (!fileExists(args["config"])) {
108 std::cerr << "[ Error " << ARG_PARSE_ERROR << " ]: " << "Config \"" << args["config"] << "\" does not exist" << std::endl;
109 return ARG_PARSE_ERROR;
110 }
111 const std::string configFile{args["config"]};
112
113 // prepare template packet
114 customConsole(appName,"reading CCSDS configuration file: " + configFile);
115 Config cfg;
116 {
117 if (auto res = cfg.load(configFile); !res.has_value()) {
118 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
119 return res.error().code();
120 }
121 }
122
123 CCSDS::Manager manager;
124
125 if (cfg.isKey("data_field_size")) {
126 std::uint16_t dataFieldSize;
127 ASSIGN_OR_PRINT(dataFieldSize, cfg.get<int>("data_field_size"));
128 manager.setDataFieldSize(dataFieldSize);
129 }
130
131 if (cfg.isKey("sync_pattern_enable")) {
132 bool syncPatternEnable;
133 ASSIGN_OR_PRINT(syncPatternEnable, cfg.get<bool>("sync_pattern_enable"));
134 manager.setSyncPatternEnable(syncPatternEnable);
135 if (syncPatternEnable && cfg.isKey("sync_pattern")) {
136 std::uint32_t syncPattern;
137 ASSIGN_OR_PRINT(syncPattern, cfg.get<int>("sync_pattern"));
138 manager.setSyncPattern(syncPattern);
139 }
140 }
141
142 customConsole(appName,"creating CCSDS template packet");
143
144 if (const auto res = manager.loadTemplateConfig(cfg);!res.has_value()) {
145 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
146 return res.error().code();
147 }
148
149 std::vector<std::uint8_t> inputBytes;
150 customConsole(appName,"reading data from " + input);
151
152 if (const auto res = readBinaryFile(input); !res.has_value()) {
153 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
154 return res.error().code();
155 }else {
156 inputBytes = res.value();
157 if (manager.getTemplate().getPrimaryHeader().getSequenceFlags() == CCSDS::UNSEGMENTED && inputBytes.size() > manager.getDataFieldSize()){
158 std::cerr << "[ Error " << INVALID_INPUT_DATA << " ]: "<< "Input data is too big for unsegmented packets, data "
159 << inputBytes.size() << " must be less than defined data packet length of " << manager.getDataFieldSize() << std::endl ;
160 return INVALID_INPUT_DATA;
161 }
162 }
163
164 customConsole(appName, "generating CCSDS packets using input data");
165 if (const auto res = manager.setApplicationData(inputBytes); !res.has_value()) {
166 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
167 return res.error().code();
168 }
169 if (verbose) customConsole(appName,"printing data to screen:");
170 if (verbose) printPackets(manager);
171
172 customConsole(appName,"serializing CCSDS packets");
173 auto packets = manager.getPacketsBuffer();
174 customConsole(appName,"writing data to " + output);
175 if (const auto res = writeBinaryFile(packets, output); !res.has_value()) {
176 std::cerr << "[ Error " << res.error().code() << " ]: "<< res.error().message() << std::endl ;
177 return res.error().code();
178 }
179
180 const auto end = std::chrono::high_resolution_clock::now();
181 const auto duration = std::chrono::duration_cast<std::chrono::microseconds>(end - start);
182 customConsole(appName,"execution time: " + std::to_string(duration.count()) + " [us]");
183 customConsole(appName,"[ Exit code 0 ]");
184 return 0;
185}
#define ASSIGN_OR_PRINT(var, result)
Macro to assign a result value or print an error message.
bool fileExists(const std::string &fileName)
filesystem check fore file existence prepared for both windows and linux.
CCSDS::ResultBuffer readBinaryFile(const std::string &filename)
Read a specified binary file and return its contents as a buffer.
CCSDS::ResultBool writeBinaryFile(const std::vector< std::uint8_t > &data, const std::string &filename)
This function takes in a buffer of data and a file name.
void printPackets(CCSDS::Manager &manager)
Prints to console a series of CCSDS Packets contained in the manager.
std::uint8_t getSequenceFlags() const
2 bits
Definition CCSDSHeader.h:88
Manages CCSDS packets and their templates.
void setSyncPatternEnable(bool enable)
enable sync pattern utilization both in serialization, deserialization, read and write.
std::uint16_t getDataFieldSize() const
retrieves the set data field size (this includes the secondary header if present)
void setSyncPattern(std::uint32_t syncPattern)
set sync pattern that should indicate the start of a CCSDS packet.
Packet getTemplate()
Retrieves the packet template.
ResultBool loadTemplateConfig(const Config &cfg)
Loads a template packet from a configuration object.
std::vector< std::uint8_t > getPacketsBuffer() const
Retrieves a buffer containing all the stored packets sequentially.
void setDataFieldSize(std::uint16_t size)
Sets the size of the data field.
ResultBool setApplicationData(const std::vector< std::uint8_t > &data)
Sets the application data for the packet.
Header & getPrimaryHeader()
returns the CCSDS packet's Primary Header.
bool has_value() const
Checks if the result contains a valid value.
Parses and stores config values from custom file format.
Definition CCSDSConfig.h:11
bool isKey(const std::string &key) const
CCSDS::ResultBool load(const std::string &filename)
Load config file.
CCSDS::Result< T > get(const std::string &key) const
Get value by key and type.
Definition CCSDSConfig.h:20
void printHelp()
This is the source file that holds the execution logic of ccsds_encoder binary file.
int main(const int argc, char *argv[])
void customConsole(const std::string &appName, const std::string &message, const std::string &logLevel="INFO")
Prints log to console adding various information about.
CCSDS::ResultBool parseArguments(int argc, char *argv[], std::unordered_map< std::string, std::string > &allowedMap, std::unordered_map< std::string, std::string > &outArgs, const std::set< std::string > &booleanArgs)
Parses the input arguments with defined values returns an unordered map with given keys and input val...
@ ARG_PARSE_ERROR
Error Parsing argument.
Definition exec_utils.h:12
@ INVALID_INPUT_DATA
Definition exec_utils.h:14
@ UNSEGMENTED
11 Complete packet in a single frame.
Definition CCSDSHeader.h:23