rts_frame_builder.h

Go to the documentation of this file.

#ifndef RTS_FRAME_BUILDER_H
#define RTS_FRAME_BUILDER_H
 
#include <stdint.h>
 
#include "rts_frame.h"
#include "rts_timings.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct rts_frame_builder {
    // Timings to use for generating pulses
    struct rts_timings *timings;
 
    // The timing tolerance to use when processing pulses. Defaults to
    // `timings->symbol / 2` when calling rts_frame_builder_init
    uint16_t tolerance;
 
    // User provided frame callback
    void (*callback)(struct rts_frame *frame, uint8_t count, uint32_t duration,
                     void *user_data);
 
    // Additional user data to supply whenever callback is called
    void *callback_user_data;
 
    //
    // Internal frame assembly state
    //
 
    // Frame builder state
    uint8_t mode;
 
    // The frame currently being assembled
    uint8_t bytes[RTS_FRAME_BYTES];
 
    // The number of bits we've assembled so far
    uint8_t bits;
 
    // Are we half way through receiving a bit
    bool mid_bit : 1;
 
    // Keep track of previous manchester symbol
    bool prev_symbol : 1;
 
    // Check if this is the first data pulse
    uint8_t first_data_pulse;
 
    // The number of preamble pulses received while assembling this frame
    uint8_t preambles;
 
    // The last complete frame we assembled, used to detect repeat frames
    uint8_t last_bytes[RTS_FRAME_BYTES];
 
    // How many times have we seen this frame repeated
    uint8_t frame_repeat_count;
 
    // When did we first see this frame
    uint32_t frame_first_seen;
};
 
void rts_frame_builder_init(struct rts_frame_builder *builder,
                            struct rts_timings *timings);
 
void rts_frame_builder_handle_pulse(struct rts_frame_builder *builder,
                                    bool state, uint32_t micros);
 
void rts_frame_builder_set_callback(struct rts_frame_builder *builder,
                                    void (*callback)(struct rts_frame *frame,
                                                     uint8_t count,
                                                     uint32_t duration,
                                                     void *user_data),
                                    void *user_data);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // RTS_FRAME_BUILDER_H