Open RTS
Full implementation of the Somfy RTS protocol
rts_pulse_source.h
Go to the documentation of this file.
1#ifndef RTS_PULSE_SOURCE_H
2#define RTS_PULSE_SOURCE_H
3
4#include <stdbool.h>
5#include <stdint.h>
6
7#include "rts_frame_builder.h"
8
9#ifdef __cplusplus
10extern "C" {
11#endif
12
35struct rts_pulse_source {
36 struct rts_frame_builder *frame_builder;
37
38 void (*enable)(struct rts_pulse_source *pulse_source);
39 void (*disable)(struct rts_pulse_source *pulse_source);
40 void (*update)(struct rts_pulse_source *pulse_source);
41 void (*close)(struct rts_pulse_source *pulse_source);
42
43 bool last_state;
44 uint64_t last_updated;
45
46 union {
47 void *user_data_ptr;
48 int user_data_int;
49 };
50};
51
59void rts_pulse_source_enable(struct rts_pulse_source *pulse_source);
60
68void rts_pulse_source_disable(struct rts_pulse_source *pulse_source);
69
77void rts_pulse_source_update(struct rts_pulse_source *pulse_source);
78
87void rts_pulse_source_attach(struct rts_pulse_source *pulse_source,
88 struct rts_frame_builder *frame_builder);
89
98void rts_pulse_source_close(struct rts_pulse_source *pulse_source);
99
104#ifdef __cplusplus
105} // extern "C"
106#endif
107
108#endif // RTS_PULSE_SOURCE_H
rts_pulse_source::rts_pulse_source_update
void rts_pulse_source_update(struct rts_pulse_source *pulse_source)
Check for new pulse data, should be called every loop()
Definition: rts_pulse_source.c:31
rts_pulse_source::rts_pulse_source_disable
void rts_pulse_source_disable(struct rts_pulse_source *pulse_source)
Disable the pulse source.
Definition: rts_pulse_source.c:21
rts_pulse_source::rts_pulse_source_enable
void rts_pulse_source_enable(struct rts_pulse_source *pulse_source)
Enable the pulse source.
Definition: rts_pulse_source.c:11
rts_pulse_source::rts_pulse_source_close
void rts_pulse_source_close(struct rts_pulse_source *pulse_source)
Close and free any resources allocated via a previous call to rts_pulse_source_init_*()
Definition: rts_pulse_source.c:41
rts_pulse_source::rts_pulse_source_attach
void rts_pulse_source_attach(struct rts_pulse_source *pulse_source, struct rts_frame_builder *frame_builder)
Attach an observer.
Definition: rts_pulse_source.c:5
rts_frame_builder.h
rts_frame_builder
Assembles pulses received via rts_frame_builder_handle_pulse, into a complete rts_frame,...
Definition: rts_frame_builder.h:36
rts_pulse_source
Provides an interface for a source of RTS pulses, eg a GPIO or radio.
Definition: rts_pulse_source.h:35