diff --git a/include/utils/sequencer.h b/include/utils/sequencer.h new file mode 100644 index 0000000..5e3fff9 --- /dev/null +++ b/include/utils/sequencer.h @@ -0,0 +1,359 @@ +/*! + * \file utils/sequencer.h + * \brief + * A terminal-like device communication automation tool + * + * \copyright Copyright (C) 2021 Christos Choutouridis + * + *
License
+ * The MIT License (MIT) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + *
+ */ + +#ifndef TBX_UTILS_SEQUENCER_H_ +#define TBX_UTILS_SEQUENCER_H_ + + +#include +#include +#include +#include +#include + +namespace tbx { + +/*! + * \class sequencer_t + * \brief + * A CRTP base class to provide the sequencer functionality. + * + * Sequencer can automate communication with a terminal-like device such as AT-command modems etc... + * It can operate based on a script array and handle the outgoing commands and incoming responses. + * The user can create matching rules on received data and hook handlers and actions on them. + * + * The derived class (implementation) has to provide: + * 1) size_t get(Data_t* data); + * This function return 0 or a number of Data_t items. The data points to buffer for the input data. + * 2) size_t put(const Data_t* data, size_t n); + * This function sends to implementation the data pointed by \c data witch have size \c n. + * 3) clock_t clock(); + * This function return a number to be used as time. The units of this function may be arbitrary but they + * match the units in \c record_t::timeout field. + * + * \tparam Impl_t The type of derived class + * \tparam Data_t The char-like stream item type. Usually \c char + * \tparam N The size of the sequence buffer to temporary store each line from get(). + */ +template +class sequencer_t { + _CRTP_IMPL(Impl_t); + + using str_view_t = std::basic_string_view; + + //! \name Public types + //! @{ + public: + //! \enum status_t + //! \brief The sequencer run status + enum class status_t { + OK, ERROR + }; + + + //! \enum action_t + //! \brief Possible response actions for the sequencer + enum class action_t { + NO, NEXT, GOTO, EXIT_OK, EXIT_ERROR + }; + + //! \enum control_t + //! \brief The control type of the script entry. + enum class control_t { + NOP, //!< No command, dont send or expect anything, used for delays + SEND, //!< Send data to implementation + EXPECT //!< Expects data from implementation + }; + + //! \enum match_t + //! \brief Token match types + enum class match_t { + NO, STARTS_WITH, ENDS_WITH, CONTAINS, nSTARTS_WITH, nENDS_WITH, nCONTAINS + }; + + /*! + * Match handler function pointer type. + * Expects a pointer to buffer and a size and returns status + */ + using handler_ft = status_t (*) (const Data_t*, size_t); + + /*! + * \struct block_t + * \brief + * The script line block. + * + * Each script "line" contains up to 2 blocks for matching functionality. Each block + * has a token and a matching type. If the response matches the token, the sequencer calls + * the handler and perform the action. + */ + struct block_t { + std::basic_string_view + token; //!< The token for the match + match_t match_type; //!< The matching type functionality + handler_ft handler; //!< The handler to called if the match is successful. + action_t action; //!< The action to be performer if the match is successful + size_t idx; //!< The index for the action_t::GOTO action. Otherwise can be left 0. + }; + + /*! + * \struct record_t + * \brief + * Describes the sequencer's script record entry (line). + * + * Each line consist from a control, 2 blocks and a timeout. The control says if we send or receive data. + * The blocks contain the data and the matching information. And the timeout guards the entire line. + * + * The user can create arrays as the example bellow to act as a script. + * \code + * const std::array script = {{ + * / * 0 * / {Seq::control_t::NOP, {"", Seq::match_t::NO, nullptr, Seq::action_t::GOTO, 1}, 1000}, //delay 1000 clocks + * / * 1 * / {Seq::control_t::SEND, {"ATE0\r\n", Seq::match_t::NO, nullptr, Seq::action_t::NEXT, 0}, 1000}, + * / * 2 * / {Seq::control_t::EXPECT, {{ + * {"OK\r\n", Seq::match_t::ENDS_WITH, nullptr, Seq::action_t::NEXT, 0}, + * {"ERROR", Seq::match_t::CONTAINS, nullptr, Seq::action_t::EXIT_ERROR, 0} }}, + * 1000 + * }, + * // ... + * }}; + * \endcode + */ + struct record_t { + control_t control; //!< The type of the entry + std::array block; //!< The matching block + clock_t timeout; //!< Timeout in CPU time + }; + //! @} + + + + //! \name Constructor / Destructor + //!@{ + protected: + ~sequencer_t () = default; //!< \brief Allow destructor from derived only + sequencer_t () = default; //!< \brief A default constructor from derived only + sequencer_t(const sequencer_t&) = delete; //!< No copies + sequencer_t& operator= (const sequencer_t&) = delete; //!< No copy assignments + //!@} + + //! \name Sequencer interface requirements for implementer + //! @{ + private: + size_t get_ (Data_t* data) { return impl().get (data); } + size_t put_ (const Data_t* data, size_t n) { return impl().put (data, n); } + clock_t clock_ () { return impl().clock(); } + //! @} + + //! \name Private functionality + //! @{ + private: + /*! + * \brief + * Check if the \c stream starts with the \c prefix + * \param stream The stream in witch we search + * \param prefix What we search + * \return True on success, false otherwise + */ + bool starts_with_ (const str_view_t stream, const str_view_t prefix) { + return (stream.rfind(prefix, 0) != str_view_t::npos); + } + + /*! + * \brief + * Check if the \c stream ends with the \c postfix + * \param stream The stream in witch we search + * \param postfix What we search + * \return True on success, false otherwise + */ + bool ends_with_ (const str_view_t stream, const str_view_t postfix) { + return ( + stream.compare( + stream.size() - postfix.size(), + postfix.size(), + postfix) == 0 + ); + } + + /*! + * \brief + * Check if the \c haystack contains the \c needle + * \param haystack The stream in witch we search + * \param needle What we search + * \return True on success, false otherwise + */ + bool contains_ (const str_view_t haystack, const str_view_t needle) { + return (haystack.find(needle) != str_view_t::npos); + } + /*! + * \brief + * Return the new sequencer's step value. + * + * Step is index to the sequencer's script array. + * + * \param current_idx The current step value + * \param action The advancing type + * \param go_idx The new value of the step in the case of GOTO type + * \return The new sequencer's step value + */ + size_t step_ (size_t current_idx, action_t action, size_t go_idx =0) { + switch (action) { + default: + case action_t::NO: return current_idx; + case action_t::NEXT: return ++current_idx; + case action_t::GOTO: return go_idx; + case action_t::EXIT_OK: + case action_t::EXIT_ERROR: + return 0; + } + } + /*! + * \brief + * Checks if the \c needle matches the \c haystack. + * + * \param type The type of matching functionality + * \param haystack The stream in witch we search + * \param needle The stream we search + * \return True on match + */ + bool match_(match_t type, const str_view_t haystack, const str_view_t needle) { + switch (type) { + default: + case match_t::NO: return true; + case match_t::STARTS_WITH: return starts_with_(haystack, needle); + case match_t::ENDS_WITH: return ends_with_(haystack, needle); + case match_t::CONTAINS: return contains_(haystack, needle); + case match_t::nSTARTS_WITH: return !starts_with_(haystack, needle); + case match_t::nENDS_WITH: return !ends_with_(haystack, needle); + case match_t::nCONTAINS: return !contains_(haystack, needle); + } + } + //! @} + + + public: + /*! + * \brief + * Run the script array + * + * The main sequencer functionality. It starts with the first entry of the array. + * - If the entry is \c NOP it executes the action after the timeout. + * \c token and \c handler are discarded. + * - If the entry is \c SEND it uses the first block's token to send and executes the action after that. + * \c timeout is discarded. + * - If the entry is \c EXCEPTS it continuously try to receive data using implementation's get until one + * of the blocks match. + * On match: + * - Calls the handler if there is one + * - Executes the action + * - Skips the next block if there is one + * If there is no match on timeout it return status_t::EXIT_ERROR + * + * \tparam Steps The number of steps of the script + * \param script Reference to script to run + * \return The status of entire operation as described above + */ + template + status_t run (const std::array& script) { + Data_t buffer[N]; + size_t resp_size; + + clock_t mark = clock_(); + for (size_t step =0, p_step =0 ; step < Steps ; ) { + const record_t& it = script[step]; + + if (step != p_step) { + p_step = step; + mark = clock_(); + } + switch (it.control) { + default: + case control_t::NOP: + if ((clock_() - mark) >= it.timeout) { + switch (it.block[0].action) { + case action_t::EXIT_OK: return status_t::OK; + case action_t::EXIT_ERROR: return status_t::ERROR; + default: + step = step_(step, it.block[0].action, it.block[0].idx); + break; + } + } + break; + + case control_t::SEND: + put_(it.block[0].token.data(), it.block[0].token.size()); + switch (it.block[0].action) { + case action_t::EXIT_OK: return status_t::OK; + case action_t::EXIT_ERROR: return status_t::ERROR; + default: + step = step_(step, it.block[0].action, it.block[0].idx); + break; + } + break; + + case control_t::EXPECT: + resp_size = get_(buffer); + if (resp_size) { + for (auto& block : it.block) { + if (match_(block.match_type, buffer, block.token)) { + if (block.handler != nullptr) + block.handler(buffer, resp_size); + switch (block.action) { + case action_t::EXIT_OK: return status_t::OK; + case action_t::EXIT_ERROR: return status_t::ERROR; + default: + step = step_(step, block.action, block.idx); + break; + } + break; + } + } + } + if ((clock_() - mark) >= it.timeout) + return status_t::ERROR; + break; + } // switch (it.control) + } + return status_t::OK; + } +}; + +/*! + * An "empty" block for convenience. + */ +template +constexpr typename sequencer_t::block_t Sequencer_null_block = { + "", + sequencer_t::match_t::NO, + nullptr, + sequencer_t::action_t::NO, + 0 +}; + +} +#endif /* TBX_UTILS_SEQUENCER_H_ */ diff --git a/test/tests/sequencer.cpp b/test/tests/sequencer.cpp new file mode 100644 index 0000000..3b11451 --- /dev/null +++ b/test/tests/sequencer.cpp @@ -0,0 +1,123 @@ +/*! + * \file sequencer.cpp + * + * \copyright Copyright (C) 2020 Christos Choutouridis + * + *
License
+ * The MIT License (MIT) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + *
+ * + */ +#include +#include + + +namespace test_sequencer { + using namespace tbx; + + // Sequencer implementer mock + class Seq : public sequencer_t { + const char *msg_[10] = { + "", "", "", "\r\nOK\r\n", + "", "", "+CCLK = \"21/08/26-12:16:30+12\"\r\nOK\r\n" + "", "", "\r\nERROR\r\n" + }; + public: + size_t get(char* data) { + static int msg =0; + size_t len = strlen(msg_[msg]); + strcpy(data, msg_[msg++]); + if (msg >= 10) msg =0; + return len; + } + size_t put (const char* data, size_t n) { + (void)*data; + return n; + } + clock_t clock() { static clock_t t=0; return ++t; } + + static status_t my_handler (const char* data, size_t size) { + (void)*data; + (void)size; + return Seq::status_t::OK; + } + }; + + /* + * Test sequencer.run() + */ + TEST(Tsequencer, run_delay) { + Seq s; + const std::array script = {{ + /* 0 */{Seq::control_t::NOP, {"", Seq::match_t::NO, nullptr, Seq::action_t::EXIT_OK, 0}, 1000} + }}; + EXPECT_EQ ((int)Seq::status_t::OK, (int)s.run(script)); + } + + TEST(Tsequencer, run_dummy_output) { + Seq s; + const std::array script = {{ + /* 0 */{Seq::control_t::SEND, {"", Seq::match_t::NO, nullptr, Seq::action_t::NEXT, 0}, 1000}, + /* 1 */{Seq::control_t::SEND, {"", Seq::match_t::NO, nullptr, Seq::action_t::EXIT_OK, 0}, 1000} + }}; + EXPECT_EQ ((int)Seq::status_t::OK, (int)s.run(script)); + } + + TEST(Tsequencer, run_exits) { + Seq s; + const std::array script1 = {{ + /* 0 */{Seq::control_t::SEND, {"", Seq::match_t::NO, nullptr, Seq::action_t::EXIT_OK, 0}, 1000}, + }}; + EXPECT_EQ ((int)Seq::status_t::OK, (int)s.run(script1)); + + const std::array script2 = {{ + /* 0 */{Seq::control_t::SEND, {"", Seq::match_t::NO, nullptr, Seq::action_t::EXIT_ERROR, 0}, 1000}, + }}; + EXPECT_EQ ((int)Seq::status_t::ERROR, (int)s.run(script2)); + } + + TEST(Tsequencer, run_sequence) { + Seq s; + const std::array script = {{ + /* 0 */{Seq::control_t::NOP, {"", Seq::match_t::NO, nullptr, Seq::action_t::GOTO, 1}, 1000}, + /* 1 */{Seq::control_t::SEND, {"ATE0\r\n", Seq::match_t::NO, nullptr, Seq::action_t::NEXT, 0}, 1000}, + /* 2 */{Seq::control_t::EXPECT, {{ + {"OK\r\n", Seq::match_t::ENDS_WITH, nullptr, Seq::action_t::NEXT, 0}, + {"ERROR", Seq::match_t::CONTAINS, nullptr, Seq::action_t::EXIT_ERROR, 0} }}, + 1000 + }, + /* 3 */{Seq::control_t::SEND, {"AT+CCLK?", Seq::match_t::NO, nullptr, Seq::action_t::NEXT, 0}, 1000}, + /* 4 */{Seq::control_t::EXPECT, {{ + {"OK\r\n", Seq::match_t::ENDS_WITH, Seq::my_handler, Seq::action_t::NEXT, 0}, + {"ERROR", Seq::match_t::CONTAINS, nullptr, Seq::action_t::EXIT_ERROR, 0} }}, + 1000 + }, + /* 5 */{Seq::control_t::SEND, {"AT+CT?", Seq::match_t::NO, nullptr, Seq::action_t::NEXT, 0}, 1000}, + /* 6 */{Seq::control_t::EXPECT, {{ + {"OK\r\n", Seq::match_t::ENDS_WITH, nullptr, Seq::action_t::NEXT, 0}, + {"ERROR", Seq::match_t::CONTAINS, nullptr, Seq::action_t::EXIT_ERROR, 0} }}, + 1000 + }, + /* 7 */{Seq::control_t::SEND, {"AT+POWD=0", Seq::match_t::NO, nullptr, Seq::action_t::EXIT_OK, 0}, 1000} + }}; + EXPECT_EQ ((int)Seq::status_t::ERROR, (int)s.run(script)); + } +}