pull/61/head
Pieter Robyns 2017-08-29 20:18:53 +02:00
rodzic 51925d4483
commit d3ee3a3e6b
8 zmienionych plików z 163 dodań i 1710 usunięć

Wyświetl plik

@ -17,6 +17,17 @@
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
########################################################################
# gr-lora specific options
########################################################################
option(HAS_MONGODB "Support for storing data to MongoDB" OFF)
option(DEBUG "Print debug output" OFF)
if(DEBUG)
message("-- Enabling debug mode")
add_definitions(-DDEBUG)
endif(DEBUG)
########################################################################
# Project setup
########################################################################
@ -41,6 +52,8 @@ if(CMAKE_COMPILER_IS_GNUCXX AND NOT WIN32)
#http://gcc.gnu.org/wiki/Visibility
add_definitions(-fvisibility=hidden)
add_definitions(-std=c++11)
add_definitions(-Wall)
add_definitions(-Wextra)
endif()
########################################################################
@ -183,8 +196,3 @@ endif(NOT CMAKE_MODULES_DIR)
install(FILES cmake/Modules/loraConfig.cmake
DESTINATION ${CMAKE_MODULES_DIR}/lora
)
########################################################################
# gr-lora specific options
########################################################################
option(HAS_MONGODB "Support for storing data to MongoDB" OFF)

Wyświetl plik

@ -1,4 +1,4 @@
-------- Test Results on 2017-08-29 14:10:48 ---------
-------- Test Results on 2017-08-29 20:03:58 ---------
Test serie 0: [u'01 23 45 67 89 ab cd ef'] * 10
Test 1 :: cr4-5 bw125 sf7 crc1 pwr1 :: passed 10 out of 10 (100.00%)
Test 2 :: cr4-5 bw125 sf8 crc1 pwr1 :: passed 10 out of 10 (100.00%)

Wyświetl plik

@ -68,7 +68,6 @@ namespace gr {
void channelizer_impl::apply_cfo(float cfo) {
d_cfo += cfo;
//std::cout << d_freq_offset + d_cfo << std::endl;
d_xlating_fir_filter->set_center_freq(d_freq_offset + d_cfo);
}

Wyświetl plik

@ -29,12 +29,9 @@
#define CLAMP_VAL 0.7e6f //1000000.0f //0.7f
#undef NDEBUG /// Debug printing
//#define NDEBUG /// No debug printing
//#define DBGR_CHRONO /// Measure execution time
#ifdef NDEBUG
#ifndef DEBUG
#define DBGR_PAUSE(MSG)
#define DBGR_QUICK_TO_FILE(FILEPATH, APPEND, DATA, SIZE, FORMAT)
#define DBGR_WRITE_SIGNAL(IDEAL_SIG_FP, SAMPLE_SIG_FP, WINDOW, OFFSET, MIN, MAX, FULL, PAUSE, MSG)

Wyświetl plik

@ -31,13 +31,6 @@
#include "tables.h"
#include "utilities.h"
//#define NO_TMP_WRITES 1 /// Debug output file write
//#define CFO_CORRECT 1 /// Correct shift fft estimation
//#undef NDEBUG /// Debug printing
//#define NDEBUG /// No debug printing
#include "dbugr.hpp"
namespace gr {
@ -54,42 +47,34 @@ namespace gr {
decoder_impl::decoder_impl(float samp_rate, uint8_t sf)
: gr::sync_block("decoder",
gr::io_signature::make(1, -1, sizeof(gr_complex)),
gr::io_signature::make(0, 2, sizeof(float))) {
gr::io_signature::make(0, 0, 0)) {
// Radio config
this->d_state = gr::lora::DecoderState::DETECT;
if (sf < 6 || sf > 13) {
//throw std::invalid_argument("[LoRa Decoder] ERROR : Spreading factor should be between 6 and 12 (inclusive)!\n Other values are currently not supported.");
std::cerr << "[LoRa Decoder] ERROR : Spreading factor should be between 6 and 12 (inclusive)!" << std::endl
<< " Other values are currently not supported." << std::endl;
exit(1);
}
// Set whitening sequence
this->d_whitening_sequence = gr::lora::prng_payload;
if (sf == 6) {
std::cerr << "[LoRa Decoder] WARNING : Spreading factor wrapped around to 12 due to incompatibility in hardware!" << std::endl;
sf = 12;
}
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug_samples.open("/tmp/grlora_debug", std::ios::out | std::ios::binary);
this->d_debug.open("/tmp/grlora_debug_txt", std::ios::out);
#endif
#ifndef NDEBUG
d_dbg.attach();
#endif
this->d_bw = 125000u;
this->d_cr = 4;
this->d_samples_per_second = samp_rate;
this->d_corr_decim_factor = (uint32_t)(samp_rate / this->d_bw); // samples_per_symbol / corr_decim_factor = correlation window. Also serves as preamble decimation factor
this->d_payload_symbols = 0;
this->d_cfo_estimation = 0.0f;
this->d_dt = 1.0f / this->d_samples_per_second;
this->d_sf = sf; // Only affects PHY send
this->d_sf = sf;
this->d_bits_per_second = (double)this->d_sf * (double)(1u + this->d_cr) / (1u << this->d_sf) * this->d_bw;
this->d_symbols_per_second = (double)this->d_bw / (1u << this->d_sf);
this->d_period = 1.0f / (double)this->d_symbols_per_second;
@ -97,57 +82,37 @@ namespace gr {
this->d_samples_per_symbol = (uint32_t)(this->d_samples_per_second / this->d_symbols_per_second);
this->d_delay_after_sync = this->d_samples_per_symbol / 4u;
this->d_number_of_bins = (uint32_t)(1u << this->d_sf);
this->d_number_of_bins_hdr = this->d_number_of_bins / 4u;
this->d_decim_factor = this->d_samples_per_symbol / this->d_number_of_bins;
this->d_energy_threshold = 0.01f;
this->d_whitening_sequence = gr::lora::prng_payload;
this->d_fine_sync = 0;
this->set_output_multiple(2 * this->d_samples_per_symbol);
// Some preparations
std::cout << "Bits per symbol: \t" << this->d_bits_per_symbol << std::endl;
std::cout << "Bins per symbol: \t" << this->d_number_of_bins << std::endl;
std::cout << "Header bins per symbol: " << this->d_number_of_bins_hdr << std::endl;
std::cout << "Samples per symbol: \t" << this->d_samples_per_symbol << std::endl;
std::cout << "Decimation: \t\t" << this->d_decim_factor << std::endl;
//std::cout << "Magnitude threshold:\t" << this->d_energy_threshold << std::endl;
// Locally generated chirps
this->build_ideal_chirps();
this->set_output_multiple(2 * this->d_samples_per_symbol);
// FFT decoding preparations
this->d_fft.resize(this->d_samples_per_symbol);
this->d_mult_hf.resize(this->d_samples_per_symbol);
this->d_tmp.resize(this->d_number_of_bins);
this->d_q = fft_create_plan(this->d_samples_per_symbol, &this->d_mult_hf[0], &this->d_fft[0], LIQUID_FFT_FORWARD, 0);
this->d_qr = fft_create_plan(this->d_number_of_bins, &this->d_tmp[0], &this->d_mult_hf[0], LIQUID_FFT_BACKWARD, 0);
// Decimation filter
const int delay = 2;
const int decim_filter_size = (2 * this->d_decim_factor * delay + 1);
float g[decim_filter_size];
float d_decim_h[decim_filter_size]; ///< The reversed decimation filter for LiquidDSP.
liquid_firdes_rrcos(this->d_decim_factor, delay, 0.5f, 0.3f, g); // Filter for interpolating
for (uint32_t i = 0u; i < decim_filter_size; i++) // Reverse it to get decimation filter
d_decim_h[i] = g[decim_filter_size - i - 1u];
this->d_decim = firdecim_crcf_create(this->d_decim_factor, d_decim_h, decim_filter_size);
// Register gnuradio ports
this->message_port_register_out(pmt::mp("frames"));
this->message_port_register_out(pmt::mp("control"));
// Whitening empty file
// DBGR_QUICK_TO_FILE("/tmp/whitening_out", false, g, -1, "");
d_fine_sync = 0;
}
/**
* Our virtual destructor.
*/
decoder_impl::~decoder_impl() {
#ifndef NDEBUG
#ifdef DEBUG
if (this->d_debug_samples.is_open())
this->d_debug_samples.close();
@ -157,7 +122,6 @@ namespace gr {
fft_destroy_plan(this->d_q);
fft_destroy_plan(this->d_qr);
firdecim_crcf_destroy(this->d_decim);
}
void decoder_impl::build_ideal_chirps(void) {
@ -165,10 +129,8 @@ namespace gr {
this->d_upchirp.resize(this->d_samples_per_symbol);
this->d_downchirp_ifreq.resize(this->d_samples_per_symbol);
this->d_upchirp_ifreq.resize(this->d_samples_per_symbol);
gr_complex tmp[this->d_samples_per_symbol*3];
this->d_upchirp_ifreq_v.resize(this->d_samples_per_symbol*3);
this->d_upchirp_stored.resize(this->d_samples_per_symbol*3);
this->d_downchirp_stored.resize(this->d_samples_per_symbol);
gr_complex tmp[this->d_samples_per_symbol*3];
const double T = -0.5 * this->d_bw * this->d_symbols_per_second;
const double f0 = (this->d_bw / 2.0);
@ -184,14 +146,14 @@ namespace gr {
this->d_upchirp[i] = cmx * gr_expj(pre_dir * t * (f0 + T * t) * -1.0f);
}
// Store instant. frequency
// Store instantaneous frequency
this->instantaneous_frequency(&this->d_downchirp[0], &this->d_downchirp_ifreq[0], this->d_samples_per_symbol);
this->instantaneous_frequency(&this->d_upchirp[0], &this->d_upchirp_ifreq[0], this->d_samples_per_symbol);
samples_to_file("/tmp/downchirp", &this->d_downchirp[0], this->d_downchirp.size(), sizeof(gr_complex));
samples_to_file("/tmp/upchirp", &this->d_upchirp[0], this->d_upchirp.size(), sizeof(gr_complex));
// Values
// Upchirp sequence
memcpy(tmp, &d_upchirp[0], sizeof(gr_complex) * this->d_samples_per_symbol);
memcpy(tmp+this->d_samples_per_symbol, &d_upchirp[0], sizeof(gr_complex) * this->d_samples_per_symbol);
memcpy(tmp+this->d_samples_per_symbol*2, &d_upchirp[0], sizeof(gr_complex) * this->d_samples_per_symbol);
@ -213,7 +175,7 @@ namespace gr {
}
void decoder_impl::samples_to_file(const std::string path, const gr_complex *v, const uint32_t length, const uint32_t elem_size) {
#ifndef NO_TMP_WRITES
#ifdef DEBUG
std::ofstream out_file;
out_file.open(path.c_str(), std::ios::out | std::ios::binary);
@ -232,7 +194,7 @@ namespace gr {
}
void decoder_impl::samples_debug(const gr_complex *v, const uint32_t length) {
#ifndef NDEBUG
#ifdef DEBUG
gr_complex start_indicator(0.0f, 32.0f);
this->d_debug_samples.write(reinterpret_cast<const char *>(&start_indicator), sizeof(gr_complex));
@ -245,26 +207,6 @@ namespace gr {
#endif
}
/**
* Currently unused.
*/
bool decoder_impl::calc_energy_threshold(const gr_complex *samples, const uint32_t window_size, const float threshold) {
float result = 0.0f;
for (uint32_t i = 0u; i < window_size; i++) {
const float magn = std::abs(samples[i]);
result += magn * magn;
}
result /= (float)window_size;
#ifndef NDEBUG
this->d_debug << "T: " << result << "\n";
#endif
return result > threshold;
}
inline void decoder_impl::instantaneous_frequency(const gr_complex *in_samples, float *out_ifreq, const uint32_t window) {
if (window < 2u) {
std::cerr << "[LoRa Decoder] WARNING : window size < 2 !" << std::endl;
@ -287,9 +229,6 @@ namespace gr {
out_ifreq[window - 1] = out_ifreq[window - 2];
}
/**
* Currently unused.
*/
inline void decoder_impl::instantaneous_phase(const gr_complex *in_samples, float *out_iphase, const uint32_t window) {
out_iphase[0] = std::arg(in_samples[0]);
@ -315,9 +254,6 @@ namespace gr {
return abs(result);
}
/**
* Currently unused.
*/
float decoder_impl::cross_correlate(const gr_complex *samples_1, const gr_complex *samples_2, const uint32_t window) {
float result = 0.0f;
@ -330,10 +266,6 @@ namespace gr {
return result;
}
/**
* Calculate normalized cross correlation of real values.
* See https://en.wikipedia.org/wiki/Cross-correlation#Normalized_cross-correlation.
*/
float decoder_impl::cross_correlate_ifreq(const float *samples_ifreq, const std::vector<float>& ideal_chirp, const uint32_t to_idx) {
float result = 0.0f;
@ -353,7 +285,6 @@ namespace gr {
void decoder_impl::fine_sync(const gr_complex* in_samples, uint32_t bin_idx, int32_t search_space) {
int32_t shift_ref = (bin_idx+1) * this->d_decim_factor;
//shift_ref = std::max(shift_ref + (int32_t)(this->d_decim_factor / 2), 0);
float samples_ifreq[d_samples_per_symbol];
float max_correlation = 0.0f;
int32_t lag = 0;
@ -361,7 +292,7 @@ namespace gr {
this->instantaneous_frequency(in_samples, samples_ifreq, d_samples_per_symbol);
for(int32_t i = -search_space+1; i < search_space; i++) {
//float c = cross_correlate_fast(in_samples, &d_upchirp_stored[shift_ref+i+d_samples_per_symbol], d_samples_per_symbol);
//float c = cross_correlate_fast(in_samples, &d_upchirp_v[shift_ref+i+d_samples_per_symbol], d_samples_per_symbol);
float c = cross_correlate_ifreq_fast(samples_ifreq, &d_upchirp_ifreq_v[shift_ref+i+d_samples_per_symbol], d_samples_per_symbol);
if(c > max_correlation) {
max_correlation = c;
@ -369,11 +300,11 @@ namespace gr {
}
}
#ifndef NDEBUG
#ifdef DEBUG
//d_debug << "FINE: " << -lag << std::endl;
#endif
d_fine_sync = -lag;
this->d_fine_sync = -lag;
//if(abs(d_fine_sync) >= d_decim_factor / 2)
// d_fine_sync = 0;
@ -411,7 +342,14 @@ namespace gr {
return this->cross_correlate_ifreq(samples_ifreq, this->d_downchirp_ifreq, window - 1u);
}
float decoder_impl::sliding_norm_cross_correlate_upchirp(const float *samples_ifreq, const uint32_t window, int32_t *index) {
float decoder_impl::detect_upchirp(const gr_complex *samples, const uint32_t window, int32_t *index) {
float samples_ifreq[window*2];
this->instantaneous_frequency(samples, samples_ifreq, window*2);
return this->sliding_norm_cross_correlate_upchirp(samples_ifreq, window, index);
}
float decoder_impl::sliding_norm_cross_correlate_upchirp(const float *samples_ifreq, const uint32_t window, int32_t *index) {
float max_correlation = 0;
// Cross correlate
@ -424,33 +362,9 @@ namespace gr {
}
}
// Signal from local_max_idx vs shifted with *index
//DBGR_WRITE_SIGNAL(this->d_upchirp_ifreq, (samples_ifreq + local_max_idx), len, (*index - local_max_idx), 0u, window, false, true, Printed graphs in sliding_norm_cross_correlate_upchirp);
return max_correlation;
}
/**
* Slide the given chirp perfectly on top of the ideal upchirp (phase shift).
* Currently unused.
*/
int32_t decoder_impl::slide_phase_shift_upchirp_perfect(const float* samples_ifreq, const uint32_t window) {
/// Perfect shift to ideal frequency
const uint32_t t_low = window / 4u,
t_mid = window / 2u;
// Average before compare
const uint32_t coeff = 20u;
float avg = std::accumulate(&samples_ifreq[t_mid] - coeff / 2u, &samples_ifreq[t_mid] + coeff / 2u, 0.0f) / coeff;
uint32_t idx = std::lower_bound( this->d_upchirp_ifreq.begin() + t_low,
this->d_upchirp_ifreq.begin() + t_mid,
avg)
- this->d_upchirp_ifreq.begin();
return (idx <= t_low || idx >= t_mid) ? -1 : t_mid - idx;
}
float decoder_impl::stddev(const float *values, const uint32_t len, const float mean) {
float variance = 0.0f;
@ -463,13 +377,6 @@ namespace gr {
return std::sqrt(variance);
}
float decoder_impl::detect_upchirp(const gr_complex *samples, const uint32_t window, int32_t *index) {
float samples_ifreq[window*2];
this->instantaneous_frequency(samples, samples_ifreq, window*2);
return this->sliding_norm_cross_correlate_upchirp(samples_ifreq, window, index);
}
/**
* Currently unstable due to center frequency offset.
*/
@ -485,22 +392,15 @@ namespace gr {
samples_to_file("/tmp/mult", &this->d_mult_hf[0], this->d_samples_per_symbol, sizeof(gr_complex));
// Perform decimation
//for (uint32_t i = 0u; i < this->d_number_of_bins; i++) {
// firdecim_crcf_execute(this->d_decim, &mult_hf[this->d_decim_factor * i], &this->d_mult[i]);
//}
//samples_to_file("/tmp/resampled", &this->d_mult[0], this->d_number_of_bins, sizeof(gr_complex));
// Perform FFT
fft_execute(this->d_q);
// Decimate. Note: assumes fft size is multiple of decimation factor and number of bins is even
// This decimation should be identical to numpy's approach
const uint32_t N = this->d_number_of_bins;
memcpy(&this->d_tmp[0], &this->d_fft[0], (N + 1u) / 2u * sizeof(gr_complex));
memcpy(&this->d_tmp[ (N + 1u) / 2u ], &this->d_fft[this->d_samples_per_symbol - (N / 2u)], N / 2u * sizeof(gr_complex));
this->d_tmp[N / 2u] += this->d_fft[N / 2u];
// Note that you have to kill the grc before checking the plots!
// Get magnitude
for (uint32_t i = 0u; i < this->d_number_of_bins; i++) {
@ -509,14 +409,14 @@ namespace gr {
samples_to_file("/tmp/fft", &this->d_tmp[0], this->d_number_of_bins, sizeof(gr_complex));
fft_execute(this->d_qr); // debug
fft_execute(this->d_qr); // For debugging
samples_to_file("/tmp/resampled", &this->d_mult_hf[0], this->d_number_of_bins, sizeof(gr_complex));
// Return argmax here
return (std::max_element(fft_mag, fft_mag + this->d_number_of_bins) - fft_mag);
}
uint32_t decoder_impl::max_frequency_gradient_idx(const gr_complex *samples, const bool is_header) {
uint32_t decoder_impl::max_frequency_gradient_idx(const gr_complex *samples) {
float samples_ifreq[this->d_samples_per_symbol];
float samples_ifreq_avg[this->d_number_of_bins];
@ -546,26 +446,25 @@ namespace gr {
}
bool decoder_impl::demodulate(const gr_complex *samples, const bool is_header) {
// DBGR_TIME_MEASUREMENT_TO_FILE("SFxx_method");
// DBGR_TIME_MEASUREMENT_TO_FILE("SFxx_method");
// DBGR_START_TIME_MEASUREMENT(false, "only");
// DBGR_START_TIME_MEASUREMENT(false, "only");
uint32_t bin_idx = this->max_frequency_gradient_idx(samples, is_header);
uint32_t bin_idx = this->max_frequency_gradient_idx(samples);
//uint32_t bin_idx = this->get_shift_fft(samples);
fine_sync(samples, bin_idx, std::max(d_decim_factor / 4u, 2u));
// DBGR_INTERMEDIATE_TIME_MEASUREMENT();
// DBGR_INTERMEDIATE_TIME_MEASUREMENT();
// Header has additional redundancy
if (is_header || d_sf > 10) {
bin_idx /= 4u;
//bin_idx = std::max(bin_idx - 2u, 0u) / 4u;
}
// Decode (actually gray encode) the bin to get the symbol value
const uint32_t word = bin_idx ^ (bin_idx >> 1u);
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << gr::lora::to_bin(word, is_header ? this->d_sf - 2u : this->d_sf) << " " << bin_idx << std::endl;
#endif
this->d_words.push_back(word);
@ -583,7 +482,7 @@ namespace gr {
/**
* Correct the interleaving by extracting each column of bits after rotating to the left.
* <BR>(The words were interleaved diagonally, by rotating we make them straight into columns.)
* <br/>(The words were interleaved diagonally, by rotating we make them straight into columns.)
*/
void decoder_impl::deinterleave(const uint32_t ppm) {
const uint32_t bits_per_word = this->d_words.size();
@ -594,6 +493,7 @@ namespace gr {
if (bits_per_word > 8u) {
// Not sure if this can ever occur. It would imply coding rate high than 4/8 e.g. 4/9.
std::cerr << "[LoRa Decoder] WARNING : Deinterleaver: More than 8 bits per word. uint8_t will not be sufficient!\nBytes need to be stored in intermediate array and then packed into words_deinterleaved!" << std::endl;
exit(1);
}
for (uint32_t i = 0u; i < bits_per_word; i++) {
@ -604,7 +504,7 @@ namespace gr {
}
}
#ifndef NDEBUG
#ifdef DEBUG
print_vector(this->d_debug, words_deinterleaved, "D", sizeof(uint8_t) * 8u);
//print_interleave_matrix(this->d_debug, this->d_words, ppm);
#endif
@ -619,14 +519,15 @@ namespace gr {
void decoder_impl::decode(uint8_t *out_data, const bool is_header) {
static const uint8_t shuffle_pattern[] = {5, 0, 1, 2, 4, 3, 6, 7};
if (!is_header)
this->values_to_file("/tmp/before_deshuffle", &this->d_demodulated[0], this->d_demodulated.size(), 8);
// For determining shuffle pattern
//if (!is_header)
// this->values_to_file("/tmp/before_deshuffle", &this->d_demodulated[0], this->d_demodulated.size(), 8);
this->deshuffle(shuffle_pattern, is_header);
// For determining whitening sequence
if (!is_header)
this->values_to_file("/tmp/after_deshuffle", &this->d_words_deshuffled[0], this->d_words_deshuffled.size(), 8);
//if (!is_header)
// this->values_to_file("/tmp/after_deshuffle", &this->d_words_deshuffled[0], this->d_words_deshuffled.size(), 8);
this->dewhiten(is_header ? gr::lora::prng_header : this->d_whitening_sequence);
this->hamming_decode(out_data);
@ -666,7 +567,7 @@ namespace gr {
this->d_words_deshuffled.push_back(result);
}
#ifndef NDEBUG
#ifdef DEBUG
//print_vector(d_debug, d_words_deshuffled, "S", sizeof(uint8_t)*8);
print_vector_raw(this->d_debug, this->d_words_deshuffled, sizeof(uint8_t) * 8u);
this->d_debug << std::endl;
@ -683,22 +584,12 @@ namespace gr {
void decoder_impl::dewhiten(const uint8_t *prng) {
const uint32_t len = this->d_words_deshuffled.size();
// Whitening out
// if (prng != gr::lora::prng_header)
// DBGR_QUICK_TO_FILE("/tmp/whitening_out", true, this->d_words_deshuffled, len, "0x%02X,");
for (uint32_t i = 0u; i < len; i++) {
uint8_t xor_b = this->d_words_deshuffled[i] ^ prng[i];
// TODO: reverse bit order is performed here,
// but is probably due to mistake in whitening or interleaving
/*xor_b = (xor_b & 0xF0) >> 4 | (xor_b & 0x0F) << 4;
xor_b = (xor_b & 0xCC) >> 2 | (xor_b & 0x33) << 2;
xor_b = (xor_b & 0xAA) >> 1 | (xor_b & 0x55) << 1;*/
this->d_words_dewhitened.push_back(xor_b);
}
#ifndef NDEBUG
#ifdef DEBUG
print_vector(this->d_debug, this->d_words_dewhitened, "W", sizeof(uint8_t) * 8);
#endif
@ -740,21 +631,15 @@ namespace gr {
}
/**
* Currently unused.
* Old method to determine CFO. Currently unused.
*/
void decoder_impl::determine_cfo(const gr_complex *samples) {
float instantaneous_phase[this->d_samples_per_symbol];
// float instantaneous_freq [this->d_samples_per_symbol];
const float div = (float) this->d_samples_per_second / (2.0f * M_PI);
// Determine instant phase
this->instantaneous_phase(samples, instantaneous_phase, this->d_samples_per_symbol);
// Determine instant freq
// for (unsigned int i = 1; i < this->d_samples_per_symbol; i++) {
// instantaneous_freq[i - 1] = (float)((instantaneous_phase[i] - instantaneous_phase[i - 1]) * div);
// }
float sum = 0.0f;
for (uint32_t i = 1u; i < this->d_samples_per_symbol; i++) {
@ -762,10 +647,11 @@ namespace gr {
}
this->d_cfo_estimation = sum / (float)(this->d_samples_per_symbol - 1u);
/*d_cfo_estimation = (*std::max_element(instantaneous_freq, instantaneous_freq+d_samples_per_symbol-1) + *std::min_element(instantaneous_freq, instantaneous_freq+d_samples_per_symbol-1)) / 2;*/
}
/**
* New method to determine CFO.
*/
float decoder_impl::experimental_determine_cfo(const gr_complex *samples, uint32_t window) {
gr_complex mult[window];
float mult_ifreq[window];
@ -776,49 +662,6 @@ namespace gr {
return mult_ifreq[256] / (2.0 * M_PI) * d_samples_per_second;
}
/**
* Currently unused.
*/
void decoder_impl::correct_cfo(gr_complex *samples, const uint32_t num_samples) {
const float mul = 2.0f * M_PI * -this->d_cfo_estimation * this->d_dt;
for (uint32_t i = 0u; i < num_samples; i++) {
samples[i] *= gr_expj(mul * i);
}
}
/**
* Currently unused.
*/
int decoder_impl::find_preamble_start(const gr_complex *samples) {
for (uint32_t i = 0u; i < this->d_samples_per_symbol; i++) {
if (!this->get_shift_fft(&samples[i]))
return i;
}
return -1;
}
/**
* Look for a signal with an absolute value above `this->d_energy_threshold`.
*/
int decoder_impl::find_preamble_start_fast(const gr_complex *samples) {
const uint32_t decimation = this->d_corr_decim_factor * 4u;
const uint32_t decim_size = this->d_samples_per_symbol / decimation;
// Absolute value
for (uint32_t i = 1u; i < decimation - 1u; i++) {
if ( std::abs(samples[ i * decim_size]) > this->d_energy_threshold
&& std::abs(samples[(i - 1u) * decim_size]) < std::abs(samples[i * decim_size])
&& std::abs(samples[(i + 1u) * decim_size]) > std::abs(samples[i * decim_size])
) {
return i * decim_size;
}
}
return -1;
}
uint8_t decoder_impl::lookup_cr(const uint8_t bytevalue) {
switch (bytevalue & 0x0f) {
case 0x09: return 4;
@ -829,15 +672,6 @@ namespace gr {
}
}
void decoder_impl::msg_raw_chirp_debug(const gr_complex *raw_samples, const uint32_t num_samples) {
pmt::pmt_t chirp_blob = pmt::make_blob(raw_samples, sizeof(gr_complex) * num_samples);
//message_port_pub(pmt::mp("debug"), chirp_blob);
}
void decoder_impl::msg_lora_frame(const uint8_t *frame_bytes, const uint32_t frame_len) {
// ?? No implementation
}
int decoder_impl::work(int noutput_items,
gr_vector_const_void_star& input_items,
gr_vector_void_star& output_items) {
@ -845,20 +679,19 @@ namespace gr {
(void) output_items;
const gr_complex *input = (gr_complex *) input_items[0];
const gr_complex *raw_input = (gr_complex *) input_items[1];
d_fine_sync = 0;
// float *out = (float *)output_items[0];
//const gr_complex *raw_input = (gr_complex *) input_items[1]; // Input bypassed by low pass filter
// DBGR_TIME_MEASUREMENT_TO_FILE("SF7_fft_idx");
d_fine_sync = 0; // Always reset fine sync
// DBGR_START_TIME_MEASUREMENT(false, gr::lora::DecoderStateToString(this->d_state));
// DBGR_TIME_MEASUREMENT_TO_FILE("SF7_fft_idx");
// DBGR_START_TIME_MEASUREMENT(false, gr::lora::DecoderStateToString(this->d_state));
switch (this->d_state) {
case gr::lora::DecoderState::DETECT: {
float correlation = detect_preamble_autocorr(input, d_samples_per_symbol);
if (correlation >= 0.90f) {
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << "Ca: " << correlation << std::endl;
#endif
this->d_corr_fails = 0u;
@ -873,16 +706,13 @@ namespace gr {
case gr::lora::DecoderState::SYNC: {
int i = 0;
float correlation = detect_upchirp(input, d_samples_per_symbol, &i);
detect_upchirp(input, d_samples_per_symbol, &i);
//float cfo = experimental_determine_cfo(&input[i], d_samples_per_symbol);
//pmt::pmt_t kv = pmt::cons(pmt::intern(std::string("cfo")), pmt::from_double(cfo));
//this->message_port_pub(pmt::mp("control"), kv);
this->samples_to_file("/tmp/detect", &input[i], this->d_samples_per_symbol, sizeof(gr_complex));
memcpy(&d_upchirp_stored[0], input+i, sizeof(gr_complex) * this->d_samples_per_symbol);
memcpy(&d_upchirp_stored[d_samples_per_symbol], input+i, sizeof(gr_complex) * this->d_samples_per_symbol);
memcpy(&d_upchirp_stored[d_samples_per_symbol*2], input+i, sizeof(gr_complex) * this->d_samples_per_symbol);
this->consume_each(i);
this->d_state = gr::lora::DecoderState::FIND_SFD;
@ -892,24 +722,20 @@ namespace gr {
case gr::lora::DecoderState::FIND_SFD: {
const float c = this->detect_downchirp(input, this->d_samples_per_symbol);
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << "Cd: " << c << std::endl;
#endif
if (c > 0.96f) {
memcpy(&d_downchirp_stored[0], input, sizeof(gr_complex) * this->d_samples_per_symbol);
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << "SYNC: " << c << std::endl;
#endif
// Debug stuff
this->samples_to_file("/tmp/sync", input, this->d_samples_per_symbol, sizeof(gr_complex));
d_dbg.analyze_samples(false, false);
//printf("---------------------- SYNC! with %f\n", c);
this->d_state = gr::lora::DecoderState::PAUSE;
} else {
if(c < -0.97) {
if(c < -0.97f) {
fine_sync(input, d_number_of_bins-1, d_decim_factor * 4);
} else {
this->d_corr_fails++;
@ -917,7 +743,7 @@ namespace gr {
if (this->d_corr_fails > 4u) {
this->d_state = gr::lora::DecoderState::DETECT;
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << "Lost sync" << std::endl;
#endif
}
@ -929,7 +755,6 @@ namespace gr {
case gr::lora::DecoderState::PAUSE: {
this->d_state = gr::lora::DecoderState::DECODE_HEADER;
//samples_debug(input, d_samples_per_symbol + d_delay_after_sync);
this->consume_each(this->d_samples_per_symbol + this->d_delay_after_sync);
break;
}
@ -944,27 +769,25 @@ namespace gr {
this->decode(decoded, true);
this->nibble_reverse(decoded, 1u); // TODO: Why? Endianess?
this->nibble_reverse(decoded, 1u); // TODO: Why? Endianness?
this->d_payload_length = decoded[0];
this->d_cr = this->lookup_cr(decoded[1]);
// Calculate number of payload symbols needed
uint8_t redundancy = (d_sf > 10 ? 2 : 0);
const int symbols_per_block = this->d_cr + 4u;
const float bits_needed = float(this->d_payload_length) * 8.0f + 16.0f;
const float symbols_needed = bits_needed * (symbols_per_block / 4.0f) / float(this->d_sf - redundancy);
const int blocks_needed = (int)std::ceil(symbols_needed / symbols_per_block);
this->d_payload_symbols = blocks_needed * symbols_per_block;
#ifndef NDEBUG
#ifdef DEBUG
this->d_debug << "LEN: " << this->d_payload_length << " (" << this->d_payload_symbols << " symbols)" << std::endl;
#endif
this->d_state = gr::lora::DecoderState::DECODE_PAYLOAD;
}
this->msg_raw_chirp_debug(raw_input, this->d_samples_per_symbol);
//samples_debug(input, d_samples_per_symbol);
this->consume_each((int32_t)this->d_samples_per_symbol+d_fine_sync);
break;
}
@ -991,13 +814,11 @@ namespace gr {
this->d_state = gr::lora::DecoderState::DETECT;
this->d_data.clear();
// DBGR_STOP_TIME_MEASUREMENT(true);
// DBGR_PAUSE();
// DBGR_STOP_TIME_MEASUREMENT(true);
// DBGR_PAUSE();
}
}
this->msg_raw_chirp_debug(raw_input, this->d_samples_per_symbol);
//samples_debug(input, d_samples_per_symbol);
this->consume_each((int32_t)this->d_samples_per_symbol+d_fine_sync);
break;
@ -1014,7 +835,7 @@ namespace gr {
}
}
// DBGR_INTERMEDIATE_TIME_MEASUREMENT();
// DBGR_INTERMEDIATE_TIME_MEASUREMENT();
// Tell runtime system how many output items we produced.
return 0;

Wyświetl plik

@ -29,8 +29,6 @@
#include <lora/debugger.h>
#include <volk/volk.h>
#define DECIMATOR_FILTER_SIZE (2*8*1 + 1) // 2*decim_factor*delay+1
namespace gr {
namespace lora {
@ -53,16 +51,16 @@ namespace gr {
* \param s
* The state to return to string.
*/
static std::string DecoderStateToString(DecoderState s) {
static std::string DecoderStateLUT[] = { "DETECT", "SYNC", "PAUSE", "DECODE_HEADER", "DECODE_PAYLOAD", "STOP" };
/*static std::string state_to_string(DecoderState s) {
static std::string DecoderStateLUT[] = { "DETECT", "SYNC", "FIND_SFD", "PAUSE", "DECODE_HEADER", "DECODE_PAYLOAD", "STOP" };
return DecoderStateLUT[ (size_t)s ];
}
}*/
/**
* \brief **LoRa Decoder**
* <BR>The main class for the LoRa decoder.
* <br/>The main class for the LoRa decoder.
* Contains all variables and methods necessary for succesfully decoding LoRa PHY.
* <BR>Only the sample rate and spreading factor are needed.
* <br/>Only the sample rate and spreading factor are needed.
* The other settings, like packet length and coding rate, are extracted from the (explicit) HDR.
*/
class decoder_impl : public decoder {
@ -75,10 +73,7 @@ namespace gr {
std::vector<gr_complex> d_upchirp; ///< The complex ideal upchirp.
std::vector<float> d_upchirp_ifreq; ///< The instantaneous frequency of the ideal upchirp.
std::vector<float> d_upchirp_ifreq_v; ///< The instantaneous frequency of the ideal upchirp.
std::vector<gr_complex> d_upchirp_stored; ///< The complex stored upchirp.
std::vector<gr_complex> d_downchirp_stored; ///< The complex stored upchirp.
std::vector<gr_complex> d_fft; ///< Vector containing the FFT resuls.
std::vector<gr_complex> d_mult_hf; ///< Vector containing the FFT decimation.
@ -114,30 +109,35 @@ namespace gr {
fftplan d_q; ///< The LiquidDSP::FFT_Plan.
fftplan d_qr; ///< The LiquidDSP::FFT_Plan in reverse.
uint32_t d_corr_decim_factor; ///< The decimation factor used in finding the preamble start.
uint32_t d_decim_factor; ///< The amount of samples (data points) in each bin.
firdecim_crcf d_decim = nullptr; ///< The LiquidDSP FIR decimation filter used to decimate the FFT imput.
uint32_t d_decim_factor; ///< The number of samples (data points) in each bin.
float d_cfo_estimation; ///< An estimation for the current Center Frequency Offset.
double d_dt; ///< Indicates how fast the frequency changes in a symbol (chirp).
float cross_correlate_ifreq_fast(const float *samples_ifreq, const float *ideal_chirp, const uint32_t window);
float cross_correlate_fast(const gr_complex* samples, const gr_complex* ideal_chirp, const uint32_t window);
void fine_sync(const gr_complex* in_samples, uint32_t bin_idx, int32_t search_space);
int32_t d_fine_sync;
float detect_preamble_autocorr(const gr_complex *samples, uint32_t window);
float experimental_determine_cfo(const gr_complex *samples, uint32_t window);
/**
* \brief Calculates the average energy from the given samples and returns whether its higher than the given threshold.
*
* \param samples
* The samples to calculate and compare the energy to.
* \param window_size
* The length of the samples array.
* \param threshold
* The threshold to compare to.
* \brief TODO
*/
bool calc_energy_threshold(const gr_complex *samples, const uint32_t window_size, const float threshold);
float cross_correlate_ifreq_fast(const float *samples_ifreq, const float *ideal_chirp, const uint32_t window);
/**
* \brief TODO
*/
float cross_correlate_fast(const gr_complex* samples, const gr_complex* ideal_chirp, const uint32_t window);
/**
* \brief TODO
*/
void fine_sync(const gr_complex* in_samples, uint32_t bin_idx, int32_t search_space);
/**
* \brief Schmidl-Cox autocorrelation approach for approximately detecting the preamble.
*/
float detect_preamble_autocorr(const gr_complex *samples, uint32_t window);
/**
* \brief TODO
*/
float experimental_determine_cfo(const gr_complex *samples, uint32_t window);
/**
* \brief Generate the ideal up- and downchirps.
@ -207,7 +207,7 @@ namespace gr {
/**
* \brief Base method to start upchirp detection by calling `sliding_norm_cross_correlate_upchirp`.
* <BR>Sets up the instantaneous frequency of the given complex symbol.
* <br/>Sets up the instantaneous frequency of the given complex symbol.
*
* \param samples
* The complex array of samples to detect an upchirp in.
@ -232,7 +232,8 @@ namespace gr {
float cross_correlate(const gr_complex *samples_1, const gr_complex *samples_2, const uint32_t window);
/**
* \brief Returns the correlation coefficient when correlating the given symbols in the given range.
* \brief Returns the correlation coefficient of a real signal.
* See https://en.wikipedia.org/wiki/Cross-correlation#Normalized_cross-correlation.
*
* \param samples_ifreq
* The instantaneous frequency of the symbol to correlate with.
@ -243,16 +244,6 @@ namespace gr {
*/
float cross_correlate_ifreq(const float *samples_ifreq, const std::vector<float>& ideal_chirp, const uint32_t to_idx);
/**
* \brief Returns the index to shift the given symbol so that it overlaps the ideal upchirp.
*
* \param samples_ifreq
* The instantaneous frequency of the symbol to analyse.
* \param window
* Length of said symbol.
*/
int32_t slide_phase_shift_upchirp_perfect(const float* samples_ifreq, const uint32_t window);
/**
* \brief Returns the index of the bin containing the frequency change by using FFT.
*
@ -269,41 +260,13 @@ namespace gr {
*/
void determine_cfo(const gr_complex *samples);
/**
* \brief Correct the center frequency offset in the given symbol.
*
* \param samples
* The complex symbol to analyse.
* \param num_samples
* Length of said symbol.
*/
void correct_cfo(gr_complex *samples, const uint32_t num_samples);
/**
* \brief Find a valid signal that identifies the start of the preamble.
*
* \param samples
* The complex symbol to analyse.
*/
int find_preamble_start(const gr_complex *samples);
/**
* \brief Skip through the given symbol to find a signal.
*
* \param samples
* The complex symbol to analyse.
*/
int find_preamble_start_fast(const gr_complex *samples);
/**
* \brief Returns the index of the bin containing the frequency change.
*
* \param samples
* The complex symbol to analyse.
* \param is_header
* Whether the given symbol is part of a HDR.
* The complex symbol to analyze.
*/
uint32_t max_frequency_gradient_idx(const gr_complex *samples, const bool is_header = false);
uint32_t max_frequency_gradient_idx(const gr_complex *samples);
/**
* \brief Demodulate the given symbol and return true if all expected symbols have been parsed.
@ -325,11 +288,11 @@ namespace gr {
/**
* \brief The process of decoding the demodulated words to get the actual payload.
* <BR>1. Deshuffle the words
* <BR>2. Dewhiten the words
* <BR>3. Hamming decoding
* <BR><BR>The result is printed to the standard outputstream
* <BR>and passed as a `blob` to the `frames` output in GRC, for further use.
* <br/>1. Deshuffle the words
* <br/>2. Dewhiten the words
* <br/>3. Hamming decoding
* <br/><br/>The result is printed to the standard outputstream
* <br/>and passed as a `blob` to the `frames` output in GRC, for further use.
*
* \param out_data
* An array to store the decoded payload words.
@ -358,8 +321,8 @@ namespace gr {
/**
* \brief Use Hamming to decode the dewhitened words.
* <BR>- CR 4 or 3: Hamming(8,4) or Hamming(7,4) with parity correction
* <BR>- CR 2 or 1: Extract data only (can only find parity errors, not correct them)
* <br/>- CR 4 or 3: Hamming(8,4) or Hamming(7,4) with parity correction
* <br/>- CR 2 or 1: Extract data only (can only find parity errors, not correct them)
*
* \param out_data
* The result after decoding the words.
@ -368,7 +331,7 @@ namespace gr {
/**
* \brief Reverse the nibbles for each byte in the given array.
* <BR>`MSB LSB` nibbles --> `LSB MSB`
* <br/>`MSB LSB` nibbles --> `LSB MSB`
*
* \param out_data
* The array of bytes to reverse the nibbles in.
@ -379,7 +342,7 @@ namespace gr {
/**
* \brief Return the standard deviation for the given array.
* <BR>Used for cross correlating.
* <br/>Used for cross correlating.
*
* \param values
* The array to calculate the standard deviation for.
@ -421,28 +384,9 @@ namespace gr {
* The LSB nibble to decode.
*/
uint8_t lookup_cr(const uint8_t bytevalue);
/**
* \brief Output a complex array to the GRC `"debug"` port.
*
* \param raw_samples
* The complex array to output.
* \param num_samples
* Size of said complex array.
*/
void msg_raw_chirp_debug(const gr_complex *raw_samples, const uint32_t num_samples);
/**
* \brief Unimplemented
*
* \param frame_bytes
* \param frame_len
*/
void msg_lora_frame(const uint8_t *frame_bytes, const uint32_t frame_len);
public:
/**
* \brief Default ctor.
* \brief Default constructor.
*
* \param samp_rate
* The sample rate of the input signal given to `work` later.
@ -452,7 +396,7 @@ namespace gr {
decoder_impl(float samp_rate, uint8_t sf);
/**
* Default dtor.
* Default destructor.
*/
~decoder_impl();
@ -473,7 +417,7 @@ namespace gr {
/**
* \brief Set th current spreading factor.
* <BR>**Currently not supported, restart GNU Radio with different settings instead.**
* <br/>**Currently not supported, restart GNU Radio with different settings instead.**
* \param sf
* The new spreading factor.
*/
@ -481,7 +425,7 @@ namespace gr {
/**
* \brief Set the current sample rate.
* <BR>**Currently not supported, restart GNU Radio with different settings instead.**
* <br/>**Currently not supported, restart GNU Radio with different settings instead.**
*
* \param samp_rate
* The new sample rate.
@ -490,8 +434,8 @@ namespace gr {
/**
* \brief Set the absolute threshold to distinguish signal from noise.
* <BR>Should be around 0.01f (default) for normal environments,
* <BR>or as low as 0.001f for the very noise-resistant USRP.
* <br/>Should be around 0.01f (default) for normal environments,
* <br/>or as low as 0.001f for the very noise-resistant USRP.
*
* \param threshold
* The new threshold value.

Wyświetl plik

@ -1,678 +1,21 @@
/* -*- c++ -*- */
/* GNU GENERAL PUBLIC LICENSE
* Version 3, 29 June 2007
*
* Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
* Everyone is permitted to copy and distribute verbatim copies
* of this license document, but changing it is not allowed.
*
* Preamble
*
* The GNU General Public License is a free, copyleft license for
* software and other kinds of works.
*
* The licenses for most software and other practical works are designed
* to take away your freedom to share and change the works. By contrast,
* the GNU General Public License is intended to guarantee your freedom to
* share and change all versions of a program--to make sure it remains free
* software for all its users. We, the Free Software Foundation, use the
* GNU General Public License for most of our software; it applies also to
* any other work released this way by its authors. You can apply it to
* your programs, too.
*
* When we speak of free software, we are referring to freedom, not
* price. Our General Public Licenses are designed to make sure that you
* have the freedom to distribute copies of free software (and charge for
* them if you wish), that you receive source code or can get it if you
* want it, that you can change the software or use pieces of it in new
* free programs, and that you know you can do these things.
*
* To protect your rights, we need to prevent others from denying you
* these rights or asking you to surrender the rights. Therefore, you have
* certain responsibilities if you distribute copies of the software, or if
* you modify it: responsibilities to respect the freedom of others.
*
* For example, if you distribute copies of such a program, whether
* gratis or for a fee, you must pass on to the recipients the same
* freedoms that you received. You must make sure that they, too, receive
* or can get the source code. And you must show them these terms so they
* know their rights.
*
* Developers that use the GNU GPL protect your rights with two steps:
* (1) assert copyright on the software, and (2) offer you this License
* giving you legal permission to copy, distribute and/or modify it.
*
* For the developers' and authors' protection, the GPL clearly explains
* that there is no warranty for this free software. For both users' and
* authors' sake, the GPL requires that modified versions be marked as
* changed, so that their problems will not be attributed erroneously to
* authors of previous versions.
*
* Some devices are designed to deny users access to install or run
* modified versions of the software inside them, although the manufacturer
* can do so. This is fundamentally incompatible with the aim of
* protecting users' freedom to change the software. The systematic
* pattern of such abuse occurs in the area of products for individuals to
* use, which is precisely where it is most unacceptable. Therefore, we
* have designed this version of the GPL to prohibit the practice for those
* products. If such problems arise substantially in other domains, we
* stand ready to extend this provision to those domains in future versions
* of the GPL, as needed to protect the freedom of users.
*
* Finally, every program is threatened constantly by software patents.
* States should not allow patents to restrict development and use of
* software on general-purpose computers, but in those that do, we wish to
* avoid the special danger that patents applied to a free program could
* make it effectively proprietary. To prevent this, the GPL assures that
* patents cannot be used to render the program non-free.
*
* The precise terms and conditions for copying, distribution and
* modification follow.
*
* TERMS AND CONDITIONS
*
* 0. Definitions.
*
* "This License" refers to version 3 of the GNU General Public License.
*
* "Copyright" also means copyright-like laws that apply to other kinds of
* works, such as semiconductor masks.
*
* "The Program" refers to any copyrightable work licensed under this
* License. Each licensee is addressed as "you". "Licensees" and
* "recipients" may be individuals or organizations.
*
* To "modify" a work means to copy from or adapt all or part of the work
* in a fashion requiring copyright permission, other than the making of an
* exact copy. The resulting work is called a "modified version" of the
* earlier work or a work "based on" the earlier work.
*
* A "covered work" means either the unmodified Program or a work based
* on the Program.
*
* To "propagate" a work means to do anything with it that, without
* permission, would make you directly or secondarily liable for
* infringement under applicable copyright law, except executing it on a
* computer or modifying a private copy. Propagation includes copying,
* distribution (with or without modification), making available to the
* public, and in some countries other activities as well.
*
* To "convey" a work means any kind of propagation that enables other
* parties to make or receive copies. Mere interaction with a user through
* a computer network, with no transfer of a copy, is not conveying.
*
* An interactive user interface displays "Appropriate Legal Notices"
* to the extent that it includes a convenient and prominently visible
* feature that (1) displays an appropriate copyright notice, and (2)
* tells the user that there is no warranty for the work (except to the
* extent that warranties are provided), that licensees may convey the
* work under this License, and how to view a copy of this License. If
* the interface presents a list of user commands or options, such as a
* menu, a prominent item in the list meets this criterion.
*
* 1. Source Code.
*
* The "source code" for a work means the preferred form of the work
* for making modifications to it. "Object code" means any non-source
* form of a work.
*
* A "Standard Interface" means an interface that either is an official
* standard defined by a recognized standards body, or, in the case of
* interfaces specified for a particular programming language, one that
* is widely used among developers working in that language.
*
* The "System Libraries" of an executable work include anything, other
* than the work as a whole, that (a) is included in the normal form of
* packaging a Major Component, but which is not part of that Major
* Component, and (b) serves only to enable use of the work with that
* Major Component, or to implement a Standard Interface for which an
* implementation is available to the public in source code form. A
* "Major Component", in this context, means a major essential component
* (kernel, window system, and so on) of the specific operating system
* (if any) on which the executable work runs, or a compiler used to
* produce the work, or an object code interpreter used to run it.
*
* The "Corresponding Source" for a work in object code form means all
* the source code needed to generate, install, and (for an executable
* work) run the object code and to modify the work, including scripts to
* control those activities. However, it does not include the work's
* System Libraries, or general-purpose tools or generally available free
* programs which are used unmodified in performing those activities but
* which are not part of the work. For example, Corresponding Source
* includes interface definition files associated with source files for
* the work, and the source code for shared libraries and dynamically
* linked subprograms that the work is specifically designed to require,
* such as by intimate data communication or control flow between those
* subprograms and other parts of the work.
*
* The Corresponding Source need not include anything that users
* can regenerate automatically from other parts of the Corresponding
* Source.
*
* The Corresponding Source for a work in source code form is that
* same work.
*
* 2. Basic Permissions.
*
* All rights granted under this License are granted for the term of
* copyright on the Program, and are irrevocable provided the stated
* conditions are met. This License explicitly affirms your unlimited
* permission to run the unmodified Program. The output from running a
* covered work is covered by this License only if the output, given its
* content, constitutes a covered work. This License acknowledges your
* rights of fair use or other equivalent, as provided by copyright law.
*
* You may make, run and propagate covered works that you do not
* convey, without conditions so long as your license otherwise remains
* in force. You may convey covered works to others for the sole purpose
* of having them make modifications exclusively for you, or provide you
* with facilities for running those works, provided that you comply with
* the terms of this License in conveying all material for which you do
* not control copyright. Those thus making or running the covered works
* for you must do so exclusively on your behalf, under your direction
* and control, on terms that prohibit them from making any copies of
* your copyrighted material outside their relationship with you.
*
* Conveying under any other circumstances is permitted solely under
* the conditions stated below. Sublicensing is not allowed; section 10
* makes it unnecessary.
*
* 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
*
* No covered work shall be deemed part of an effective technological
* measure under any applicable law fulfilling obligations under article
* 11 of the WIPO copyright treaty adopted on 20 December 1996, or
* similar laws prohibiting or restricting circumvention of such
* measures.
*
* When you convey a covered work, you waive any legal power to forbid
* circumvention of technological measures to the extent such circumvention
* is effected by exercising rights under this License with respect to
* the covered work, and you disclaim any intention to limit operation or
* modification of the work as a means of enforcing, against the work's
* users, your or third parties' legal rights to forbid circumvention of
* technological measures.
*
* 4. Conveying Verbatim Copies.
*
* You may convey verbatim copies of the Program's source code as you
* receive it, in any medium, provided that you conspicuously and
* appropriately publish on each copy an appropriate copyright notice;
* keep intact all notices stating that this License and any
* non-permissive terms added in accord with section 7 apply to the code;
* keep intact all notices of the absence of any warranty; and give all
* recipients a copy of this License along with the Program.
*
* You may charge any price or no price for each copy that you convey,
* and you may offer support or warranty protection for a fee.
*
* 5. Conveying Modified Source Versions.
*
* You may convey a work based on the Program, or the modifications to
* produce it from the Program, in the form of source code under the
* terms of section 4, provided that you also meet all of these conditions:
*
* a) The work must carry prominent notices stating that you modified
* it, and giving a relevant date.
*
* b) The work must carry prominent notices stating that it is
* released under this License and any conditions added under section
* 7. This requirement modifies the requirement in section 4 to
* "keep intact all notices".
*
* c) You must license the entire work, as a whole, under this
* License to anyone who comes into possession of a copy. This
* License will therefore apply, along with any applicable section 7
* additional terms, to the whole of the work, and all its parts,
* regardless of how they are packaged. This License gives no
* permission to license the work in any other way, but it does not
* invalidate such permission if you have separately received it.
*
* d) If the work has interactive user interfaces, each must display
* Appropriate Legal Notices; however, if the Program has interactive
* interfaces that do not display Appropriate Legal Notices, your
* work need not make them do so.
*
* A compilation of a covered work with other separate and independent
* works, which are not by their nature extensions of the covered work,
* and which are not combined with it such as to form a larger program,
* in or on a volume of a storage or distribution medium, is called an
* "aggregate" if the compilation and its resulting copyright are not
* used to limit the access or legal rights of the compilation's users
* beyond what the individual works permit. Inclusion of a covered work
* in an aggregate does not cause this License to apply to the other
* parts of the aggregate.
*
* 6. Conveying Non-Source Forms.
*
* You may convey a covered work in object code form under the terms
* of sections 4 and 5, provided that you also convey the
* machine-readable Corresponding Source under the terms of this License,
* in one of these ways:
*
* a) Convey the object code in, or embodied in, a physical product
* (including a physical distribution medium), accompanied by the
* Corresponding Source fixed on a durable physical medium
* customarily used for software interchange.
*
* b) Convey the object code in, or embodied in, a physical product
* (including a physical distribution medium), accompanied by a
* written offer, valid for at least three years and valid for as
* long as you offer spare parts or customer support for that product
* model, to give anyone who possesses the object code either (1) a
* copy of the Corresponding Source for all the software in the
* product that is covered by this License, on a durable physical
* medium customarily used for software interchange, for a price no
* more than your reasonable cost of physically performing this
* conveying of source, or (2) access to copy the
* Corresponding Source from a network server at no charge.
*
* c) Convey individual copies of the object code with a copy of the
* written offer to provide the Corresponding Source. This
* alternative is allowed only occasionally and noncommercially, and
* only if you received the object code with such an offer, in accord
* with subsection 6b.
*
* d) Convey the object code by offering access from a designated
* place (gratis or for a charge), and offer equivalent access to the
* Corresponding Source in the same way through the same place at no
* further charge. You need not require recipients to copy the
* Corresponding Source along with the object code. If the place to
* copy the object code is a network server, the Corresponding Source
* may be on a different server (operated by you or a third party)
* that supports equivalent copying facilities, provided you maintain
* clear directions next to the object code saying where to find the
* Corresponding Source. Regardless of what server hosts the
* Corresponding Source, you remain obligated to ensure that it is
* available for as long as needed to satisfy these requirements.
*
* e) Convey the object code using peer-to-peer transmission, provided
* you inform other peers where the object code and Corresponding
* Source of the work are being offered to the general public at no
* charge under subsection 6d.
*
* A separable portion of the object code, whose source code is excluded
* from the Corresponding Source as a System Library, need not be
* included in conveying the object code work.
*
* A "User Product" is either (1) a "consumer product", which means any
* tangible personal property which is normally used for personal, family,
* or household purposes, or (2) anything designed or sold for incorporation
* into a dwelling. In determining whether a product is a consumer product,
* doubtful cases shall be resolved in favor of coverage. For a particular
* product received by a particular user, "normally used" refers to a
* typical or common use of that class of product, regardless of the status
* of the particular user or of the way in which the particular user
* actually uses, or expects or is expected to use, the product. A product
* is a consumer product regardless of whether the product has substantial
* commercial, industrial or non-consumer uses, unless such uses represent
* the only significant mode of use of the product.
*
* "Installation Information" for a User Product means any methods,
* procedures, authorization keys, or other information required to install
* and execute modified versions of a covered work in that User Product from
* a modified version of its Corresponding Source. The information must
* suffice to ensure that the continued functioning of the modified object
* code is in no case prevented or interfered with solely because
* modification has been made.
*
* If you convey an object code work under this section in, or with, or
* specifically for use in, a User Product, and the conveying occurs as
* part of a transaction in which the right of possession and use of the
* User Product is transferred to the recipient in perpetuity or for a
* fixed term (regardless of how the transaction is characterized), the
* Corresponding Source conveyed under this section must be accompanied
* by the Installation Information. But this requirement does not apply
* if neither you nor any third party retains the ability to install
* modified object code on the User Product (for example, the work has
* been installed in ROM).
*
* The requirement to provide Installation Information does not include a
* requirement to continue to provide support service, warranty, or updates
* for a work that has been modified or installed by the recipient, or for
* the User Product in which it has been modified or installed. Access to a
* network may be denied when the modification itself materially and
* adversely affects the operation of the network or violates the rules and
* protocols for communication across the network.
*
* Corresponding Source conveyed, and Installation Information provided,
* in accord with this section must be in a format that is publicly
* documented (and with an implementation available to the public in
* source code form), and must require no special password or key for
* unpacking, reading or copying.
*
* 7. Additional Terms.
*
* "Additional permissions" are terms that supplement the terms of this
* License by making exceptions from one or more of its conditions.
* Additional permissions that are applicable to the entire Program shall
* be treated as though they were included in this License, to the extent
* that they are valid under applicable law. If additional permissions
* apply only to part of the Program, that part may be used separately
* under those permissions, but the entire Program remains governed by
* this License without regard to the additional permissions.
*
* When you convey a copy of a covered work, you may at your option
* remove any additional permissions from that copy, or from any part of
* it. (Additional permissions may be written to require their own
* removal in certain cases when you modify the work.) You may place
* additional permissions on material, added by you to a covered work,
* for which you have or can give appropriate copyright permission.
*
* Notwithstanding any other provision of this License, for material you
* add to a covered work, you may (if authorized by the copyright holders of
* that material) supplement the terms of this License with terms:
*
* a) Disclaiming warranty or limiting liability differently from the
* terms of sections 15 and 16 of this License; or
*
* b) Requiring preservation of specified reasonable legal notices or
* author attributions in that material or in the Appropriate Legal
* Notices displayed by works containing it; or
*
* c) Prohibiting misrepresentation of the origin of that material, or
* requiring that modified versions of such material be marked in
* reasonable ways as different from the original version; or
*
* d) Limiting the use for publicity purposes of names of licensors or
* authors of the material; or
*
* e) Declining to grant rights under trademark law for use of some
* trade names, trademarks, or service marks; or
*
* f) Requiring indemnification of licensors and authors of that
* material by anyone who conveys the material (or modified versions of
* it) with contractual assumptions of liability to the recipient, for
* any liability that these contractual assumptions directly impose on
* those licensors and authors.
*
* All other non-permissive additional terms are considered "further
* restrictions" within the meaning of section 10. If the Program as you
* received it, or any part of it, contains a notice stating that it is
* governed by this License along with a term that is a further
* restriction, you may remove that term. If a license document contains
* a further restriction but permits relicensing or conveying under this
* License, you may add to a covered work material governed by the terms
* of that license document, provided that the further restriction does
* not survive such relicensing or conveying.
*
* If you add terms to a covered work in accord with this section, you
* must place, in the relevant source files, a statement of the
* additional terms that apply to those files, or a notice indicating
* where to find the applicable terms.
*
* Additional terms, permissive or non-permissive, may be stated in the
* form of a separately written license, or stated as exceptions;
* the above requirements apply either way.
*
* 8. Termination.
*
* You may not propagate or modify a covered work except as expressly
* provided under this License. Any attempt otherwise to propagate or
* modify it is void, and will automatically terminate your rights under
* this License (including any patent licenses granted under the third
* paragraph of section 11).
*
* However, if you cease all violation of this License, then your
* license from a particular copyright holder is reinstated (a)
* provisionally, unless and until the copyright holder explicitly and
* finally terminates your license, and (b) permanently, if the copyright
* holder fails to notify you of the violation by some reasonable means
* prior to 60 days after the cessation.
*
* Moreover, your license from a particular copyright holder is
* reinstated permanently if the copyright holder notifies you of the
* violation by some reasonable means, this is the first time you have
* received notice of violation of this License (for any work) from that
* copyright holder, and you cure the violation prior to 30 days after
* your receipt of the notice.
*
* Termination of your rights under this section does not terminate the
* licenses of parties who have received copies or rights from you under
* this License. If your rights have been terminated and not permanently
* reinstated, you do not qualify to receive new licenses for the same
* material under section 10.
*
* 9. Acceptance Not Required for Having Copies.
*
* You are not required to accept this License in order to receive or
* run a copy of the Program. Ancillary propagation of a covered work
* occurring solely as a consequence of using peer-to-peer transmission
* to receive a copy likewise does not require acceptance. However,
* nothing other than this License grants you permission to propagate or
* modify any covered work. These actions infringe copyright if you do
* not accept this License. Therefore, by modifying or propagating a
* covered work, you indicate your acceptance of this License to do so.
*
* 10. Automatic Licensing of Downstream Recipients.
*
* Each time you convey a covered work, the recipient automatically
* receives a license from the original licensors, to run, modify and
* propagate that work, subject to this License. You are not responsible
* for enforcing compliance by third parties with this License.
*
* An "entity transaction" is a transaction transferring control of an
* organization, or substantially all assets of one, or subdividing an
* organization, or merging organizations. If propagation of a covered
* work results from an entity transaction, each party to that
* transaction who receives a copy of the work also receives whatever
* licenses to the work the party's predecessor in interest had or could
* give under the previous paragraph, plus a right to possession of the
* Corresponding Source of the work from the predecessor in interest, if
* the predecessor has it or can get it with reasonable efforts.
*
* You may not impose any further restrictions on the exercise of the
* rights granted or affirmed under this License. For example, you may
* not impose a license fee, royalty, or other charge for exercise of
* rights granted under this License, and you may not initiate litigation
* (including a cross-claim or counterclaim in a lawsuit) alleging that
* any patent claim is infringed by making, using, selling, offering for
* sale, or importing the Program or any portion of it.
*
* 11. Patents.
*
* A "contributor" is a copyright holder who authorizes use under this
* License of the Program or a work on which the Program is based. The
* work thus licensed is called the contributor's "contributor version".
*
* A contributor's "essential patent claims" are all patent claims
* owned or controlled by the contributor, whether already acquired or
* hereafter acquired, that would be infringed by some manner, permitted
* by this License, of making, using, or selling its contributor version,
* but do not include claims that would be infringed only as a
* consequence of further modification of the contributor version. For
* purposes of this definition, "control" includes the right to grant
* patent sublicenses in a manner consistent with the requirements of
* this License.
*
* Each contributor grants you a non-exclusive, worldwide, royalty-free
* patent license under the contributor's essential patent claims, to
* make, use, sell, offer for sale, import and otherwise run, modify and
* propagate the contents of its contributor version.
*
* In the following three paragraphs, a "patent license" is any express
* agreement or commitment, however denominated, not to enforce a patent
* (such as an express permission to practice a patent or covenant not to
* sue for patent infringement). To "grant" such a patent license to a
* party means to make such an agreement or commitment not to enforce a
* patent against the party.
*
* If you convey a covered work, knowingly relying on a patent license,
* and the Corresponding Source of the work is not available for anyone
* to copy, free of charge and under the terms of this License, through a
* publicly available network server or other readily accessible means,
* then you must either (1) cause the Corresponding Source to be so
* available, or (2) arrange to deprive yourself of the benefit of the
* patent license for this particular work, or (3) arrange, in a manner
* consistent with the requirements of this License, to extend the patent
* license to downstream recipients. "Knowingly relying" means you have
* actual knowledge that, but for the patent license, your conveying the
* covered work in a country, or your recipient's use of the covered work
* in a country, would infringe one or more identifiable patents in that
* country that you have reason to believe are valid.
*
* If, pursuant to or in connection with a single transaction or
* arrangement, you convey, or propagate by procuring conveyance of, a
* covered work, and grant a patent license to some of the parties
* receiving the covered work authorizing them to use, propagate, modify
* or convey a specific copy of the covered work, then the patent license
* you grant is automatically extended to all recipients of the covered
* work and works based on it.
*
* A patent license is "discriminatory" if it does not include within
* the scope of its coverage, prohibits the exercise of, or is
* conditioned on the non-exercise of one or more of the rights that are
* specifically granted under this License. You may not convey a covered
* work if you are a party to an arrangement with a third party that is
* in the business of distributing software, under which you make payment
* to the third party based on the extent of your activity of conveying
* the work, and under which the third party grants, to any of the
* parties who would receive the covered work from you, a discriminatory
* patent license (a) in connection with copies of the covered work
* conveyed by you (or copies made from those copies), or (b) primarily
* for and in connection with specific products or compilations that
* contain the covered work, unless you entered into that arrangement,
* or that patent license was granted, prior to 28 March 2007.
*
* Nothing in this License shall be construed as excluding or limiting
* any implied license or other defenses to infringement that may
* otherwise be available to you under applicable patent law.
*
* 12. No Surrender of Others' Freedom.
*
* If conditions are imposed on you (whether by court order, agreement or
* otherwise) that contradict the conditions of this License, they do not
* excuse you from the conditions of this License. If you cannot convey a
* covered work so as to satisfy simultaneously your obligations under this
* License and any other pertinent obligations, then as a consequence you may
* not convey it at all. For example, if you agree to terms that obligate you
* to collect a royalty for further conveying from those to whom you convey
* the Program, the only way you could satisfy both those terms and this
* License would be to refrain entirely from conveying the Program.
*
* 13. Use with the GNU Affero General Public License.
*
* Notwithstanding any other provision of this License, you have
* permission to link or combine any covered work with a work licensed
* under version 3 of the GNU Affero General Public License into a single
* combined work, and to convey the resulting work. The terms of this
* License will continue to apply to the part which is the covered work,
* but the special requirements of the GNU Affero General Public License,
* section 13, concerning interaction through a network will apply to the
* combination as such.
*
* 14. Revised Versions of this License.
*
* The Free Software Foundation may publish revised and/or new versions of
* the GNU General Public License from time to time. Such new versions will
* be similar in spirit to the present version, but may differ in detail to
* address new problems or concerns.
*
* Each version is given a distinguishing version number. If the
* Program specifies that a certain numbered version of the GNU General
* Public License "or any later version" applies to it, you have the
* option of following the terms and conditions either of that numbered
* version or of any later version published by the Free Software
* Foundation. If the Program does not specify a version number of the
* GNU General Public License, you may choose any version ever published
* by the Free Software Foundation.
*
* If the Program specifies that a proxy can decide which future
* versions of the GNU General Public License can be used, that proxy's
* public statement of acceptance of a version permanently authorizes you
* to choose that version for the Program.
*
* Later license versions may give you additional or different
* permissions. However, no additional obligations are imposed on any
* author or copyright holder as a result of your choosing to follow a
* later version.
*
* 15. Disclaimer of Warranty.
*
* THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
* APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
* HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
* OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
* IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
* ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
*
* 16. Limitation of Liability.
*
* IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
* WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
* THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
* GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
* USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
* DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
* PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
* EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGES.
*
* 17. Interpretation of Sections 15 and 16.
*
* If the disclaimer of warranty and limitation of liability provided
* above cannot be given local legal effect according to their terms,
* reviewing courts shall apply local law that most closely approximates
* an absolute waiver of all civil liability in connection with the
* Program, unless a warranty or assumption of liability accompanies a
* copy of the Program in return for a fee.
*
* END OF TERMS AND CONDITIONS
*
* How to Apply These Terms to Your New Programs
*
* If you develop a new program, and you want it to be of the greatest
* possible use to the public, the best way to achieve this is to make it
* free software which everyone can redistribute and change under these terms.
*
* To do so, attach the following notices to the program. It is safest
* to attach them to the start of each source file to most effectively
* state the exclusion of warranty; and each file should have at least
* the "copyright" line and a pointer to where the full notice is found.
*
* {one line to give the program's name and a brief idea of what it does.}
* Copyright (C) {year} {name of author}
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Also add information on how to contact you by electronic and paper mail.
*
* If the program does terminal interaction, make it output a short
* notice like this when it starts in an interactive mode:
*
* {project} Copyright (C) {year} {fullname}
* This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
* This is free software, and you are welcome to redistribute it
* under certain conditions; type `show c' for details.
*
* The hypothetical commands `show w' and `show c' should show the appropriate
* parts of the General Public License. Of course, your program's commands
* might be different; for a GUI interface, you would use an "about box".
*
* You should also get your employer (if you work as a programmer) or school,
* if any, to sign a "copyright disclaimer" for the program, if necessary.
* For more information on this, and how to apply and follow the GNU GPL, see
* <http://www.gnu.org/licenses/>.
*
* The GNU General Public License does not permit incorporating your program
* into proprietary programs. If your program is a subroutine library, you
* may consider it more useful to permit linking proprietary applications with
* the library. If this is what you want to do, use the GNU Lesser General
* Public License instead of this License. But first, please read
* <http://www.gnu.org/philosophy/why-not-lgpl.html>.
/*
* Copyright 2017 Pieter Robyns, William Thenaers.
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifdef HAVE_CONFIG_H
@ -682,8 +25,6 @@
#include <gnuradio/io_signature.h>
#include "message_socket_sink_impl.h"
#define NDEBUG /// Debug printing
namespace gr {
namespace lora {
@ -743,7 +84,7 @@ namespace gr {
uint8_t *data = (uint8_t*) pmt::blob_data(msg);
size_t size = pmt::blob_length(msg);
#ifndef NDEBUG
#ifdef DEBUG
printf("Received message:\n\t");
for (size_t i = 0; i < size; ++i)
@ -755,7 +96,7 @@ namespace gr {
if (sendto(this->_socket, data, size, 0,
(const struct sockaddr*) this->_sock_addr,
sizeof(*this->_sock_addr))
!= size) {
!= (ssize_t)size) {
perror("[message_socket_sink] Mismatch in number of bytes sent");
exit(EXIT_FAILURE);
}

Wyświetl plik

@ -1,678 +1,21 @@
/* -*- c++ -*- */
/* GNU GENERAL PUBLIC LICENSE
* Version 3, 29 June 2007
*
* Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
* Everyone is permitted to copy and distribute verbatim copies
* of this license document, but changing it is not allowed.
*
* Preamble
*
* The GNU General Public License is a free, copyleft license for
* software and other kinds of works.
*
* The licenses for most software and other practical works are designed
* to take away your freedom to share and change the works. By contrast,
* the GNU General Public License is intended to guarantee your freedom to
* share and change all versions of a program--to make sure it remains free
* software for all its users. We, the Free Software Foundation, use the
* GNU General Public License for most of our software; it applies also to
* any other work released this way by its authors. You can apply it to
* your programs, too.
*
* When we speak of free software, we are referring to freedom, not
* price. Our General Public Licenses are designed to make sure that you
* have the freedom to distribute copies of free software (and charge for
* them if you wish), that you receive source code or can get it if you
* want it, that you can change the software or use pieces of it in new
* free programs, and that you know you can do these things.
*
* To protect your rights, we need to prevent others from denying you
* these rights or asking you to surrender the rights. Therefore, you have
* certain responsibilities if you distribute copies of the software, or if
* you modify it: responsibilities to respect the freedom of others.
*
* For example, if you distribute copies of such a program, whether
* gratis or for a fee, you must pass on to the recipients the same
* freedoms that you received. You must make sure that they, too, receive
* or can get the source code. And you must show them these terms so they
* know their rights.
*
* Developers that use the GNU GPL protect your rights with two steps:
* (1) assert copyright on the software, and (2) offer you this License
* giving you legal permission to copy, distribute and/or modify it.
*
* For the developers' and authors' protection, the GPL clearly explains
* that there is no warranty for this free software. For both users' and
* authors' sake, the GPL requires that modified versions be marked as
* changed, so that their problems will not be attributed erroneously to
* authors of previous versions.
*
* Some devices are designed to deny users access to install or run
* modified versions of the software inside them, although the manufacturer
* can do so. This is fundamentally incompatible with the aim of
* protecting users' freedom to change the software. The systematic
* pattern of such abuse occurs in the area of products for individuals to
* use, which is precisely where it is most unacceptable. Therefore, we
* have designed this version of the GPL to prohibit the practice for those
* products. If such problems arise substantially in other domains, we
* stand ready to extend this provision to those domains in future versions
* of the GPL, as needed to protect the freedom of users.
*
* Finally, every program is threatened constantly by software patents.
* States should not allow patents to restrict development and use of
* software on general-purpose computers, but in those that do, we wish to
* avoid the special danger that patents applied to a free program could
* make it effectively proprietary. To prevent this, the GPL assures that
* patents cannot be used to render the program non-free.
*
* The precise terms and conditions for copying, distribution and
* modification follow.
*
* TERMS AND CONDITIONS
*
* 0. Definitions.
*
* "This License" refers to version 3 of the GNU General Public License.
*
* "Copyright" also means copyright-like laws that apply to other kinds of
* works, such as semiconductor masks.
*
* "The Program" refers to any copyrightable work licensed under this
* License. Each licensee is addressed as "you". "Licensees" and
* "recipients" may be individuals or organizations.
*
* To "modify" a work means to copy from or adapt all or part of the work
* in a fashion requiring copyright permission, other than the making of an
* exact copy. The resulting work is called a "modified version" of the
* earlier work or a work "based on" the earlier work.
*
* A "covered work" means either the unmodified Program or a work based
* on the Program.
*
* To "propagate" a work means to do anything with it that, without
* permission, would make you directly or secondarily liable for
* infringement under applicable copyright law, except executing it on a
* computer or modifying a private copy. Propagation includes copying,
* distribution (with or without modification), making available to the
* public, and in some countries other activities as well.
*
* To "convey" a work means any kind of propagation that enables other
* parties to make or receive copies. Mere interaction with a user through
* a computer network, with no transfer of a copy, is not conveying.
*
* An interactive user interface displays "Appropriate Legal Notices"
* to the extent that it includes a convenient and prominently visible
* feature that (1) displays an appropriate copyright notice, and (2)
* tells the user that there is no warranty for the work (except to the
* extent that warranties are provided), that licensees may convey the
* work under this License, and how to view a copy of this License. If
* the interface presents a list of user commands or options, such as a
* menu, a prominent item in the list meets this criterion.
*
* 1. Source Code.
*
* The "source code" for a work means the preferred form of the work
* for making modifications to it. "Object code" means any non-source
* form of a work.
*
* A "Standard Interface" means an interface that either is an official
* standard defined by a recognized standards body, or, in the case of
* interfaces specified for a particular programming language, one that
* is widely used among developers working in that language.
*
* The "System Libraries" of an executable work include anything, other
* than the work as a whole, that (a) is included in the normal form of
* packaging a Major Component, but which is not part of that Major
* Component, and (b) serves only to enable use of the work with that
* Major Component, or to implement a Standard Interface for which an
* implementation is available to the public in source code form. A
* "Major Component", in this context, means a major essential component
* (kernel, window system, and so on) of the specific operating system
* (if any) on which the executable work runs, or a compiler used to
* produce the work, or an object code interpreter used to run it.
*
* The "Corresponding Source" for a work in object code form means all
* the source code needed to generate, install, and (for an executable
* work) run the object code and to modify the work, including scripts to
* control those activities. However, it does not include the work's
* System Libraries, or general-purpose tools or generally available free
* programs which are used unmodified in performing those activities but
* which are not part of the work. For example, Corresponding Source
* includes interface definition files associated with source files for
* the work, and the source code for shared libraries and dynamically
* linked subprograms that the work is specifically designed to require,
* such as by intimate data communication or control flow between those
* subprograms and other parts of the work.
*
* The Corresponding Source need not include anything that users
* can regenerate automatically from other parts of the Corresponding
* Source.
*
* The Corresponding Source for a work in source code form is that
* same work.
*
* 2. Basic Permissions.
*
* All rights granted under this License are granted for the term of
* copyright on the Program, and are irrevocable provided the stated
* conditions are met. This License explicitly affirms your unlimited
* permission to run the unmodified Program. The output from running a
* covered work is covered by this License only if the output, given its
* content, constitutes a covered work. This License acknowledges your
* rights of fair use or other equivalent, as provided by copyright law.
*
* You may make, run and propagate covered works that you do not
* convey, without conditions so long as your license otherwise remains
* in force. You may convey covered works to others for the sole purpose
* of having them make modifications exclusively for you, or provide you
* with facilities for running those works, provided that you comply with
* the terms of this License in conveying all material for which you do
* not control copyright. Those thus making or running the covered works
* for you must do so exclusively on your behalf, under your direction
* and control, on terms that prohibit them from making any copies of
* your copyrighted material outside their relationship with you.
*
* Conveying under any other circumstances is permitted solely under
* the conditions stated below. Sublicensing is not allowed; section 10
* makes it unnecessary.
*
* 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
*
* No covered work shall be deemed part of an effective technological
* measure under any applicable law fulfilling obligations under article
* 11 of the WIPO copyright treaty adopted on 20 December 1996, or
* similar laws prohibiting or restricting circumvention of such
* measures.
*
* When you convey a covered work, you waive any legal power to forbid
* circumvention of technological measures to the extent such circumvention
* is effected by exercising rights under this License with respect to
* the covered work, and you disclaim any intention to limit operation or
* modification of the work as a means of enforcing, against the work's
* users, your or third parties' legal rights to forbid circumvention of
* technological measures.
*
* 4. Conveying Verbatim Copies.
*
* You may convey verbatim copies of the Program's source code as you
* receive it, in any medium, provided that you conspicuously and
* appropriately publish on each copy an appropriate copyright notice;
* keep intact all notices stating that this License and any
* non-permissive terms added in accord with section 7 apply to the code;
* keep intact all notices of the absence of any warranty; and give all
* recipients a copy of this License along with the Program.
*
* You may charge any price or no price for each copy that you convey,
* and you may offer support or warranty protection for a fee.
*
* 5. Conveying Modified Source Versions.
*
* You may convey a work based on the Program, or the modifications to
* produce it from the Program, in the form of source code under the
* terms of section 4, provided that you also meet all of these conditions:
*
* a) The work must carry prominent notices stating that you modified
* it, and giving a relevant date.
*
* b) The work must carry prominent notices stating that it is
* released under this License and any conditions added under section
* 7. This requirement modifies the requirement in section 4 to
* "keep intact all notices".
*
* c) You must license the entire work, as a whole, under this
* License to anyone who comes into possession of a copy. This
* License will therefore apply, along with any applicable section 7
* additional terms, to the whole of the work, and all its parts,
* regardless of how they are packaged. This License gives no
* permission to license the work in any other way, but it does not
* invalidate such permission if you have separately received it.
*
* d) If the work has interactive user interfaces, each must display
* Appropriate Legal Notices; however, if the Program has interactive
* interfaces that do not display Appropriate Legal Notices, your
* work need not make them do so.
*
* A compilation of a covered work with other separate and independent
* works, which are not by their nature extensions of the covered work,
* and which are not combined with it such as to form a larger program,
* in or on a volume of a storage or distribution medium, is called an
* "aggregate" if the compilation and its resulting copyright are not
* used to limit the access or legal rights of the compilation's users
* beyond what the individual works permit. Inclusion of a covered work
* in an aggregate does not cause this License to apply to the other
* parts of the aggregate.
*
* 6. Conveying Non-Source Forms.
*
* You may convey a covered work in object code form under the terms
* of sections 4 and 5, provided that you also convey the
* machine-readable Corresponding Source under the terms of this License,
* in one of these ways:
*
* a) Convey the object code in, or embodied in, a physical product
* (including a physical distribution medium), accompanied by the
* Corresponding Source fixed on a durable physical medium
* customarily used for software interchange.
*
* b) Convey the object code in, or embodied in, a physical product
* (including a physical distribution medium), accompanied by a
* written offer, valid for at least three years and valid for as
* long as you offer spare parts or customer support for that product
* model, to give anyone who possesses the object code either (1) a
* copy of the Corresponding Source for all the software in the
* product that is covered by this License, on a durable physical
* medium customarily used for software interchange, for a price no
* more than your reasonable cost of physically performing this
* conveying of source, or (2) access to copy the
* Corresponding Source from a network server at no charge.
*
* c) Convey individual copies of the object code with a copy of the
* written offer to provide the Corresponding Source. This
* alternative is allowed only occasionally and noncommercially, and
* only if you received the object code with such an offer, in accord
* with subsection 6b.
*
* d) Convey the object code by offering access from a designated
* place (gratis or for a charge), and offer equivalent access to the
* Corresponding Source in the same way through the same place at no
* further charge. You need not require recipients to copy the
* Corresponding Source along with the object code. If the place to
* copy the object code is a network server, the Corresponding Source
* may be on a different server (operated by you or a third party)
* that supports equivalent copying facilities, provided you maintain
* clear directions next to the object code saying where to find the
* Corresponding Source. Regardless of what server hosts the
* Corresponding Source, you remain obligated to ensure that it is
* available for as long as needed to satisfy these requirements.
*
* e) Convey the object code using peer-to-peer transmission, provided
* you inform other peers where the object code and Corresponding
* Source of the work are being offered to the general public at no
* charge under subsection 6d.
*
* A separable portion of the object code, whose source code is excluded
* from the Corresponding Source as a System Library, need not be
* included in conveying the object code work.
*
* A "User Product" is either (1) a "consumer product", which means any
* tangible personal property which is normally used for personal, family,
* or household purposes, or (2) anything designed or sold for incorporation
* into a dwelling. In determining whether a product is a consumer product,
* doubtful cases shall be resolved in favor of coverage. For a particular
* product received by a particular user, "normally used" refers to a
* typical or common use of that class of product, regardless of the status
* of the particular user or of the way in which the particular user
* actually uses, or expects or is expected to use, the product. A product
* is a consumer product regardless of whether the product has substantial
* commercial, industrial or non-consumer uses, unless such uses represent
* the only significant mode of use of the product.
*
* "Installation Information" for a User Product means any methods,
* procedures, authorization keys, or other information required to install
* and execute modified versions of a covered work in that User Product from
* a modified version of its Corresponding Source. The information must
* suffice to ensure that the continued functioning of the modified object
* code is in no case prevented or interfered with solely because
* modification has been made.
*
* If you convey an object code work under this section in, or with, or
* specifically for use in, a User Product, and the conveying occurs as
* part of a transaction in which the right of possession and use of the
* User Product is transferred to the recipient in perpetuity or for a
* fixed term (regardless of how the transaction is characterized), the
* Corresponding Source conveyed under this section must be accompanied
* by the Installation Information. But this requirement does not apply
* if neither you nor any third party retains the ability to install
* modified object code on the User Product (for example, the work has
* been installed in ROM).
*
* The requirement to provide Installation Information does not include a
* requirement to continue to provide support service, warranty, or updates
* for a work that has been modified or installed by the recipient, or for
* the User Product in which it has been modified or installed. Access to a
* network may be denied when the modification itself materially and
* adversely affects the operation of the network or violates the rules and
* protocols for communication across the network.
*
* Corresponding Source conveyed, and Installation Information provided,
* in accord with this section must be in a format that is publicly
* documented (and with an implementation available to the public in
* source code form), and must require no special password or key for
* unpacking, reading or copying.
*
* 7. Additional Terms.
*
* "Additional permissions" are terms that supplement the terms of this
* License by making exceptions from one or more of its conditions.
* Additional permissions that are applicable to the entire Program shall
* be treated as though they were included in this License, to the extent
* that they are valid under applicable law. If additional permissions
* apply only to part of the Program, that part may be used separately
* under those permissions, but the entire Program remains governed by
* this License without regard to the additional permissions.
*
* When you convey a copy of a covered work, you may at your option
* remove any additional permissions from that copy, or from any part of
* it. (Additional permissions may be written to require their own
* removal in certain cases when you modify the work.) You may place
* additional permissions on material, added by you to a covered work,
* for which you have or can give appropriate copyright permission.
*
* Notwithstanding any other provision of this License, for material you
* add to a covered work, you may (if authorized by the copyright holders of
* that material) supplement the terms of this License with terms:
*
* a) Disclaiming warranty or limiting liability differently from the
* terms of sections 15 and 16 of this License; or
*
* b) Requiring preservation of specified reasonable legal notices or
* author attributions in that material or in the Appropriate Legal
* Notices displayed by works containing it; or
*
* c) Prohibiting misrepresentation of the origin of that material, or
* requiring that modified versions of such material be marked in
* reasonable ways as different from the original version; or
*
* d) Limiting the use for publicity purposes of names of licensors or
* authors of the material; or
*
* e) Declining to grant rights under trademark law for use of some
* trade names, trademarks, or service marks; or
*
* f) Requiring indemnification of licensors and authors of that
* material by anyone who conveys the material (or modified versions of
* it) with contractual assumptions of liability to the recipient, for
* any liability that these contractual assumptions directly impose on
* those licensors and authors.
*
* All other non-permissive additional terms are considered "further
* restrictions" within the meaning of section 10. If the Program as you
* received it, or any part of it, contains a notice stating that it is
* governed by this License along with a term that is a further
* restriction, you may remove that term. If a license document contains
* a further restriction but permits relicensing or conveying under this
* License, you may add to a covered work material governed by the terms
* of that license document, provided that the further restriction does
* not survive such relicensing or conveying.
*
* If you add terms to a covered work in accord with this section, you
* must place, in the relevant source files, a statement of the
* additional terms that apply to those files, or a notice indicating
* where to find the applicable terms.
*
* Additional terms, permissive or non-permissive, may be stated in the
* form of a separately written license, or stated as exceptions;
* the above requirements apply either way.
*
* 8. Termination.
*
* You may not propagate or modify a covered work except as expressly
* provided under this License. Any attempt otherwise to propagate or
* modify it is void, and will automatically terminate your rights under
* this License (including any patent licenses granted under the third
* paragraph of section 11).
*
* However, if you cease all violation of this License, then your
* license from a particular copyright holder is reinstated (a)
* provisionally, unless and until the copyright holder explicitly and
* finally terminates your license, and (b) permanently, if the copyright
* holder fails to notify you of the violation by some reasonable means
* prior to 60 days after the cessation.
*
* Moreover, your license from a particular copyright holder is
* reinstated permanently if the copyright holder notifies you of the
* violation by some reasonable means, this is the first time you have
* received notice of violation of this License (for any work) from that
* copyright holder, and you cure the violation prior to 30 days after
* your receipt of the notice.
*
* Termination of your rights under this section does not terminate the
* licenses of parties who have received copies or rights from you under
* this License. If your rights have been terminated and not permanently
* reinstated, you do not qualify to receive new licenses for the same
* material under section 10.
*
* 9. Acceptance Not Required for Having Copies.
*
* You are not required to accept this License in order to receive or
* run a copy of the Program. Ancillary propagation of a covered work
* occurring solely as a consequence of using peer-to-peer transmission
* to receive a copy likewise does not require acceptance. However,
* nothing other than this License grants you permission to propagate or
* modify any covered work. These actions infringe copyright if you do
* not accept this License. Therefore, by modifying or propagating a
* covered work, you indicate your acceptance of this License to do so.
*
* 10. Automatic Licensing of Downstream Recipients.
*
* Each time you convey a covered work, the recipient automatically
* receives a license from the original licensors, to run, modify and
* propagate that work, subject to this License. You are not responsible
* for enforcing compliance by third parties with this License.
*
* An "entity transaction" is a transaction transferring control of an
* organization, or substantially all assets of one, or subdividing an
* organization, or merging organizations. If propagation of a covered
* work results from an entity transaction, each party to that
* transaction who receives a copy of the work also receives whatever
* licenses to the work the party's predecessor in interest had or could
* give under the previous paragraph, plus a right to possession of the
* Corresponding Source of the work from the predecessor in interest, if
* the predecessor has it or can get it with reasonable efforts.
*
* You may not impose any further restrictions on the exercise of the
* rights granted or affirmed under this License. For example, you may
* not impose a license fee, royalty, or other charge for exercise of
* rights granted under this License, and you may not initiate litigation
* (including a cross-claim or counterclaim in a lawsuit) alleging that
* any patent claim is infringed by making, using, selling, offering for
* sale, or importing the Program or any portion of it.
*
* 11. Patents.
*
* A "contributor" is a copyright holder who authorizes use under this
* License of the Program or a work on which the Program is based. The
* work thus licensed is called the contributor's "contributor version".
*
* A contributor's "essential patent claims" are all patent claims
* owned or controlled by the contributor, whether already acquired or
* hereafter acquired, that would be infringed by some manner, permitted
* by this License, of making, using, or selling its contributor version,
* but do not include claims that would be infringed only as a
* consequence of further modification of the contributor version. For
* purposes of this definition, "control" includes the right to grant
* patent sublicenses in a manner consistent with the requirements of
* this License.
*
* Each contributor grants you a non-exclusive, worldwide, royalty-free
* patent license under the contributor's essential patent claims, to
* make, use, sell, offer for sale, import and otherwise run, modify and
* propagate the contents of its contributor version.
*
* In the following three paragraphs, a "patent license" is any express
* agreement or commitment, however denominated, not to enforce a patent
* (such as an express permission to practice a patent or covenant not to
* sue for patent infringement). To "grant" such a patent license to a
* party means to make such an agreement or commitment not to enforce a
* patent against the party.
*
* If you convey a covered work, knowingly relying on a patent license,
* and the Corresponding Source of the work is not available for anyone
* to copy, free of charge and under the terms of this License, through a
* publicly available network server or other readily accessible means,
* then you must either (1) cause the Corresponding Source to be so
* available, or (2) arrange to deprive yourself of the benefit of the
* patent license for this particular work, or (3) arrange, in a manner
* consistent with the requirements of this License, to extend the patent
* license to downstream recipients. "Knowingly relying" means you have
* actual knowledge that, but for the patent license, your conveying the
* covered work in a country, or your recipient's use of the covered work
* in a country, would infringe one or more identifiable patents in that
* country that you have reason to believe are valid.
*
* If, pursuant to or in connection with a single transaction or
* arrangement, you convey, or propagate by procuring conveyance of, a
* covered work, and grant a patent license to some of the parties
* receiving the covered work authorizing them to use, propagate, modify
* or convey a specific copy of the covered work, then the patent license
* you grant is automatically extended to all recipients of the covered
* work and works based on it.
*
* A patent license is "discriminatory" if it does not include within
* the scope of its coverage, prohibits the exercise of, or is
* conditioned on the non-exercise of one or more of the rights that are
* specifically granted under this License. You may not convey a covered
* work if you are a party to an arrangement with a third party that is
* in the business of distributing software, under which you make payment
* to the third party based on the extent of your activity of conveying
* the work, and under which the third party grants, to any of the
* parties who would receive the covered work from you, a discriminatory
* patent license (a) in connection with copies of the covered work
* conveyed by you (or copies made from those copies), or (b) primarily
* for and in connection with specific products or compilations that
* contain the covered work, unless you entered into that arrangement,
* or that patent license was granted, prior to 28 March 2007.
*
* Nothing in this License shall be construed as excluding or limiting
* any implied license or other defenses to infringement that may
* otherwise be available to you under applicable patent law.
*
* 12. No Surrender of Others' Freedom.
*
* If conditions are imposed on you (whether by court order, agreement or
* otherwise) that contradict the conditions of this License, they do not
* excuse you from the conditions of this License. If you cannot convey a
* covered work so as to satisfy simultaneously your obligations under this
* License and any other pertinent obligations, then as a consequence you may
* not convey it at all. For example, if you agree to terms that obligate you
* to collect a royalty for further conveying from those to whom you convey
* the Program, the only way you could satisfy both those terms and this
* License would be to refrain entirely from conveying the Program.
*
* 13. Use with the GNU Affero General Public License.
*
* Notwithstanding any other provision of this License, you have
* permission to link or combine any covered work with a work licensed
* under version 3 of the GNU Affero General Public License into a single
* combined work, and to convey the resulting work. The terms of this
* License will continue to apply to the part which is the covered work,
* but the special requirements of the GNU Affero General Public License,
* section 13, concerning interaction through a network will apply to the
* combination as such.
*
* 14. Revised Versions of this License.
*
* The Free Software Foundation may publish revised and/or new versions of
* the GNU General Public License from time to time. Such new versions will
* be similar in spirit to the present version, but may differ in detail to
* address new problems or concerns.
*
* Each version is given a distinguishing version number. If the
* Program specifies that a certain numbered version of the GNU General
* Public License "or any later version" applies to it, you have the
* option of following the terms and conditions either of that numbered
* version or of any later version published by the Free Software
* Foundation. If the Program does not specify a version number of the
* GNU General Public License, you may choose any version ever published
* by the Free Software Foundation.
*
* If the Program specifies that a proxy can decide which future
* versions of the GNU General Public License can be used, that proxy's
* public statement of acceptance of a version permanently authorizes you
* to choose that version for the Program.
*
* Later license versions may give you additional or different
* permissions. However, no additional obligations are imposed on any
* author or copyright holder as a result of your choosing to follow a
* later version.
*
* 15. Disclaimer of Warranty.
*
* THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
* APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
* HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
* OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
* IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
* ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
*
* 16. Limitation of Liability.
*
* IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
* WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
* THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
* GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
* USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
* DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
* PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
* EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGES.
*
* 17. Interpretation of Sections 15 and 16.
*
* If the disclaimer of warranty and limitation of liability provided
* above cannot be given local legal effect according to their terms,
* reviewing courts shall apply local law that most closely approximates
* an absolute waiver of all civil liability in connection with the
* Program, unless a warranty or assumption of liability accompanies a
* copy of the Program in return for a fee.
*
* END OF TERMS AND CONDITIONS
*
* How to Apply These Terms to Your New Programs
*
* If you develop a new program, and you want it to be of the greatest
* possible use to the public, the best way to achieve this is to make it
* free software which everyone can redistribute and change under these terms.
*
* To do so, attach the following notices to the program. It is safest
* to attach them to the start of each source file to most effectively
* state the exclusion of warranty; and each file should have at least
* the "copyright" line and a pointer to where the full notice is found.
*
* {one line to give the program's name and a brief idea of what it does.}
* Copyright (C) {year} {name of author}
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Also add information on how to contact you by electronic and paper mail.
*
* If the program does terminal interaction, make it output a short
* notice like this when it starts in an interactive mode:
*
* {project} Copyright (C) {year} {fullname}
* This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
* This is free software, and you are welcome to redistribute it
* under certain conditions; type `show c' for details.
*
* The hypothetical commands `show w' and `show c' should show the appropriate
* parts of the General Public License. Of course, your program's commands
* might be different; for a GUI interface, you would use an "about box".
*
* You should also get your employer (if you work as a programmer) or school,
* if any, to sign a "copyright disclaimer" for the program, if necessary.
* For more information on this, and how to apply and follow the GNU GPL, see
* <http://www.gnu.org/licenses/>.
*
* The GNU General Public License does not permit incorporating your program
* into proprietary programs. If your program is a subroutine library, you
* may consider it more useful to permit linking proprietary applications with
* the library. If this is what you want to do, use the GNU Lesser General
* Public License instead of this License. But first, please read
* <http://www.gnu.org/philosophy/why-not-lgpl.html>.
/*
* Copyright 2017 Pieter Robyns, William Thenaers.
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_LORA_MESSAGE_SOCKET_SINK_IMPL_H