Loading...
Searching...
No Matches
infrared_signal.h
Go to the documentation of this file.
1
9#pragma once
10
11#include "infrared_error_code.h"
13#include <infrared.h>
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
23
32typedef struct {
33 size_t timings_size;
34 uint32_t* timings;
35 uint32_t frequency;
36 float duty_cycle;
38
45
52
59bool infrared_signal_is_raw(const InfraredSignal* signal);
60
68
79
95 InfraredSignal* signal,
96 const uint32_t* timings,
97 size_t timings_size,
98 uint32_t frequency,
99 float duty_cycle);
100
110
123
133
146InfraredErrorCode
148
158InfraredErrorCode infrared_signal_read_name(FlipperFormat* ff, FuriString* name);
159
169InfraredErrorCode infrared_signal_read_body(InfraredSignal* signal, FlipperFormat* ff);
170
183 InfraredSignal* signal,
184 FlipperFormat* ff,
185 const char* name);
186
199 InfraredSignal* signal,
200 FlipperFormat* ff,
201 size_t index);
202
214InfraredErrorCode
215 infrared_signal_save(const InfraredSignal* signal, FlipperFormat* ff, const char* name);
216
224void infrared_signal_transmit(const InfraredSignal* signal);
225
226#ifdef __cplusplus
227}
228#endif
Flipper File Format helper library.
InfraredSignal * infrared_signal_alloc(void)
Create a new InfraredSignal instance.
Definition infrared_signal.c:277
const InfraredMessage * infrared_signal_get_message(const InfraredSignal *signal)
Get the parsed signal held by an InfraredSignal instance.
Definition infrared_signal.c:341
InfraredErrorCode infrared_signal_save(const InfraredSignal *signal, FlipperFormat *ff, const char *name)
Save a signal contained in an InfraredSignal instance to a FlipperFormat file.
Definition infrared_signal.c:347
InfraredErrorCode infrared_signal_read(InfraredSignal *signal, FlipperFormat *ff, FuriString *name)
Read a signal and its name from a FlipperFormat file into an InfraredSignal instance.
Definition infrared_signal.c:363
void infrared_signal_set_message(InfraredSignal *signal, const InfraredMessage *message)
Set an InfraredInstance to hold a parsed signal.
Definition infrared_signal.c:334
InfraredErrorCode infrared_signal_search_by_name_and_read(InfraredSignal *signal, FlipperFormat *ff, const char *name)
Read a signal with a particular name from a FlipperFormat file into an InfraredSignal instance.
Definition infrared_signal.c:382
void infrared_signal_transmit(const InfraredSignal *signal)
Transmit a signal contained in an InfraredSignal instance.
Definition infrared_signal.c:430
InfraredErrorCode infrared_signal_search_by_index_and_read(InfraredSignal *signal, FlipperFormat *ff, size_t index)
Read a signal with a particular index from a FlipperFormat file into an InfraredSignal instance.
Definition infrared_signal.c:403
bool infrared_signal_is_valid(const InfraredSignal *signal)
Test whether an InfraredSignal instance holds any signal.
Definition infrared_signal.c:295
void infrared_signal_set_raw_signal(InfraredSignal *signal, const uint32_t *timings, size_t timings_size, uint32_t frequency, float duty_cycle)
Set an InfraredInstance to hold a raw signal.
Definition infrared_signal.c:311
bool infrared_signal_is_raw(const InfraredSignal *signal)
Test whether an InfraredSignal instance holds a raw signal.
Definition infrared_signal.c:291
InfraredErrorCode infrared_signal_read_body(InfraredSignal *signal, FlipperFormat *ff)
Read a signal from a FlipperFormat file.
Definition infrared_signal.c:250
void infrared_signal_free(InfraredSignal *signal)
Delete an InfraredSignal instance.
Definition infrared_signal.c:286
const InfraredRawSignal * infrared_signal_get_raw_signal(const InfraredSignal *signal)
Get the raw signal held by an InfraredSignal instance.
Definition infrared_signal.c:329
InfraredErrorCode infrared_signal_read_name(FlipperFormat *ff, FuriString *name)
Read a signal name from a FlipperFormat file.
Definition infrared_signal.c:376
void infrared_signal_set_signal(InfraredSignal *signal, const InfraredSignal *other)
Set an InfraredInstance to hold the signal from another one.
Definition infrared_signal.c:300
Definition flipper_format.c:17
Definition string.c:4
Definition infrared.h:42
Raw signal type definition.
Definition infrared_signal.h:32
uint32_t frequency
Carrier frequency of the signal.
Definition infrared_signal.h:35
uint32_t * timings
Pointer to an array of timings describing the signal.
Definition infrared_signal.h:34
float duty_cycle
Duty cycle of the signal.
Definition infrared_signal.h:36
size_t timings_size
Number of elements in the timings array.
Definition infrared_signal.h:33
Definition infrared_signal.c:29