GNU Radio's SATNOGS Package
ieee802_15_4_encoder.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2020, Libre Space Foundation <http://libre.space>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATNOGS_IEEE802_15_4_ENCODER_H
22 #define INCLUDED_SATNOGS_IEEE802_15_4_ENCODER_H
23 
24 #include <satnogs/api.h>
25 #include <satnogs/crc.h>
26 #include <satnogs/whitening.h>
27 #include <satnogs/encoder.h>
28 
29 namespace gr {
30 namespace satnogs {
31 
32 /*!
33  * \brief An IEEE802.15.4 frame encoder with some extended parameterization
34  */
36 public:
37  static encoder::encoder_sptr
38  make(uint8_t preamble, size_t preamble_len,
39  const std::vector<uint8_t> &sync_word, crc::crc_t crc,
40  whitening::whitening_sptr scrambler,
41  bool var_len = true);
42 
43  ieee802_15_4_encoder(uint8_t preamble, size_t preamble_len,
44  const std::vector<uint8_t> &sync_word, crc::crc_t crc,
45  whitening::whitening_sptr scrambler,
46  bool var_len);
48 
49  pmt::pmt_t
50  encode(pmt::pmt_t msg);
51 private:
52  const size_t d_max_frame_len;
53  const size_t d_preamle_len;
54  const crc::crc_t d_crc;
55  whitening::whitening_sptr d_scrambler;
56  const bool d_var_len;
57  uint8_t *d_buffer;
58  uint8_t *d_payload;
59 };
60 
61 } // namespace satnogs
62 } // namespace gr
63 
64 #endif /* INCLUDED_SATNOGS_IEEE802_15_4_ENCODER_H */
65 
Abstract class defining the API of the SatNOGS Encoders.
Definition: encoder.h:43
An IEEE802.15.4 frame encoder with some extended parameterization.
Definition: ieee802_15_4_encoder.h:35
Definition: amsat_duv_decoder.h:29
enum gr::satnogs::crc::crc_type crc_t
Definition: crc.h:33
#define SATNOGS_API
Definition: api.h:30