diff --git a/doxygen/html/CLI_8cpp_source.html b/doxygen/html/CLI_8cpp_source.html deleted file mode 100644 index 7819f10..0000000 --- a/doxygen/html/CLI_8cpp_source.html +++ /dev/null @@ -1,242 +0,0 @@ - - -
- - - - -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
CDevice | |
CMeaning | Holds the parsed packet as a collection of MeaningElements |
CMeaningElement | Chunks of parsed packet. Either a pulse, a gap or a block of decoded data |
COOKwiz | The static functions in the OOKwiz class provide the main controls for OOKwiz' functionality. Prefix them with OOKwiz:: to use them from your own code |
CpulseBin | Struct that holds information about a 'bin' in a Pulsetrain, a range of timings that are lumped together when converting RawTimings to a Pulsetrain |
CPulsetrain | Instances of Pulsetrain represent packets in a normalized way, meaning all intervals of similar length are made equal |
CRadio | |
CRawTimings | RawTimings instances store the time in µs of each interval |
CSettings |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for Device, including all inherited members.
-add(const char *name, Device *pointer) (defined in Device) | Device | static |
len (defined in Device) | Device | static |
list(String separator=", ") (defined in Device) | Device | static |
name (defined in Device) | Device | |
new_packet(RawTimings &raw, Pulsetrain &train, Meaning &meaning) (defined in Device) | Device | static |
pointer (defined in Device) | Device | |
receive(const RawTimings &raw, const Pulsetrain &train, const Meaning &meaning) (defined in Device) | Device | virtual |
setup() (defined in Device) | Device | static |
store (defined in Device) | Device | static |
transmit(const String &plugin_name, const String &toTransmit) (defined in Device) | Device | static |
transmit(const String &toTransmit) (defined in Device) | Device | virtual |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
-Public Member Functions | |
-virtual bool | receive (const RawTimings &raw, const Pulsetrain &train, const Meaning &meaning) |
-virtual bool | transmit (const String &toTransmit) |
-Static Public Member Functions | |
-static bool | setup () |
-static bool | add (const char *name, Device *pointer) |
-static String | list (String separator=", ") |
-static bool | new_packet (RawTimings &raw, Pulsetrain &train, Meaning &meaning) |
-static bool | transmit (const String &plugin_name, const String &toTransmit) |
-Static Public Attributes | |
-struct { | |
- Device * pointer | |
- char name [MAX_DEVICE_NAME_LEN] | |
} | store [MAX_DEVICES] |
-static int | len = 0 |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for Meaning, including all inherited members.
-addGap(uint16_t pulse_time) | Meaning | |
addPPM(int space, int mark, int filler, int bits, uint8_t *tmp_data) | Meaning | |
addPulse(uint16_t pulse_time) | Meaning | |
addPWM(int space, int mark, int bits, uint8_t *tmp_data) | Meaning | |
elements | Meaning | |
fromPulsetrain(Pulsetrain &train) | Meaning | |
fromString(String in) | Meaning | |
gap | Meaning | |
maybe(String str) | Meaning | static |
operator bool() | Meaning | |
parsePPM(const Pulsetrain &train, int from, int to, int space, int mark, int filler) | Meaning | |
parsePWM(const Pulsetrain &train, int from, int to, int space, int mark) | Meaning | |
repeats | Meaning | |
suspected_incomplete | Meaning | |
toString() | Meaning | |
zap() | Meaning |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
Holds the parsed packet as a collection of MeaningElements. - More...
- -#include <Meaning.h>
-Public Member Functions | |
- | operator bool () |
If you try to evaluate the instance as a bool, for instance in if (myMeaning) ... , it will be true if this holds Meaning elements. | |
-void | zap () |
empty out all Meaning elements | |
bool | fromPulsetrain (Pulsetrain &train) |
Convert Pulsetrain to Meaning. More... | |
bool | addPulse (uint16_t pulse_time) |
Adds a "pulse" Meaning element. More... | |
bool | addGap (uint16_t pulse_time) |
Adds a "gap"" Meaning element. More... | |
bool | addPWM (int space, int mark, int bits, uint8_t *tmp_data) |
Adds a new meaning element with the specified PWM-encoded data. More... | |
bool | addPPM (int space, int mark, int filler, int bits, uint8_t *tmp_data) |
Adds a new meaning element with the specified PPM-encoded data. More... | |
String | toString () |
Get the String representation, which looks like pulse(5906) + pwm(timing 190/575, 24 bits 0x1772A4) More... | |
bool | fromString (String in) |
Read a String representation like above, and store in this instance. More... | |
int | parsePWM (const Pulsetrain &train, int from, int to, int space, int mark) |
Decode PWM data with specified timings from given range in Pulsetrain to a new Meaning element. Normally called by fromPulsetrain , but can be used from user code also. More... | |
int | parsePPM (const Pulsetrain &train, int from, int to, int space, int mark, int filler) |
Decode PPM data with specified timings from given range in Pulsetrain to a new Meaning element. Normally called by fromPulsetrain , but can be used from user code also. More... | |
-Static Public Member Functions | |
static bool | maybe (String str) |
See if String might be a representation of Maening. No guarantees until you try to convert it, but silent. More... | |
-Public Attributes | |
-std::vector< MeaningElement > | elements |
The MeaningElement structs that make up the parsed packet. | |
-bool | suspected_incomplete = false |
Set when there were no repetitions and the number of bits detected is not divisible by 4. | |
-uint16_t | repeats = 0 |
Number of repeats of the signal. | |
-uint16_t | gap = 0 |
Shortest time between two repetitions. | |
Holds the parsed packet as a collection of MeaningElements.
- - -
-
|
- -static | -
See if String might be a representation of Maening. No guarantees until you try to convert it, but silent.
-str | String that we are curious about |
true
if it might be a Meaning String, false
if not. Definition at line 14 of file Meaning.cpp.
- -bool Meaning::fromPulsetrain | -( | -Pulsetrain & | -train | ) | -- |
Convert Pulsetrain to Meaning.
-train | Pulsetrain we want to convert |
true
if there was data found, false
otherwise. Definition at line 37 of file Meaning.cpp.
- -bool Meaning::addPulse | -( | -uint16_t | -pulse_time | ) | -- |
Adds a "pulse" Meaning element.
-pulse_time | time in µs |
true
Definition at line 384 of file Meaning.cpp.
- -bool Meaning::addGap | -( | -uint16_t | -gap_time | ) | -- |
Adds a "gap"" Meaning element.
-gap_time | time in µs |
true
Definition at line 395 of file Meaning.cpp.
- -bool Meaning::addPWM | -( | -int | -space, | -
- | - | int | -mark, | -
- | - | int | -bits, | -
- | - | uint8_t * | -tmp_data | -
- | ) | -- |
Adds a new meaning element with the specified PWM-encoded data.
-space | time in µs |
mark | time in µs |
bits | Length of data at tmp_data IN BITS, not bytes |
tmp_data | pointer to uint8_t array with the data |
true
Definition at line 431 of file Meaning.cpp.
- -bool Meaning::addPPM | -( | -int | -space, | -
- | - | int | -mark, | -
- | - | int | -filler, | -
- | - | int | -bits, | -
- | - | uint8_t * | -tmp_data | -
- | ) | -- |
Adds a new meaning element with the specified PPM-encoded data.
-space | time in µs |
mark | time in µs |
filler | time in µs |
bits | Length of data at tmp_data IN BITS, not bytes |
tmp_data | pointer to uint8_t array with the data |
true
Definition at line 410 of file Meaning.cpp.
- -String Meaning::toString | -( | -) | -- |
Get the String representation, which looks like pulse(5906) + pwm(timing 190/575, 24 bits 0x1772A4)
Definition at line 234 of file Meaning.cpp.
- -bool Meaning::fromString | -( | -String | -in | ) | -- |
Read a String representation like above, and store in this instance.
-true
if it worked, false
(with error message) if it didn't. Definition at line 273 of file Meaning.cpp.
- -int Meaning::parsePWM | -( | -const Pulsetrain & | -train, | -
- | - | int | -from, | -
- | - | int | -to, | -
- | - | int | -space, | -
- | - | int | -mark | -
- | ) | -- |
Decode PWM data with specified timings from given range in Pulsetrain to a new Meaning element. Normally called by fromPulsetrain
, but can be used from user code also.
train | Pulsetrain we're reading from |
from | start at this interval |
to | end before this interval |
space | bin number (NOT time in µs) for space (first if bit 0) |
mark | bin number (NOT time in µs) for mark (first if bit 1) |
Definition at line 135 of file Meaning.cpp.
- -int Meaning::parsePPM | -( | -const Pulsetrain & | -train, | -
- | - | int | -from, | -
- | - | int | -to, | -
- | - | int | -space, | -
- | - | int | -mark, | -
- | - | int | -filler | -
- | ) | -- |
Decode PPM data with specified timings from given range in Pulsetrain to a new Meaning element. Normally called by fromPulsetrain
, but can be used from user code also.
train | Pulsetrain we're reading from |
from | start at this interval |
to | end before this interval |
space | bin number (NOT time in µs) for space (first if bit 0) |
mark | bin number (NOT time in µs) for mark (first if bit 1) |
filler | bin number for delineator interval between the mark and space intervals |
Definition at line 184 of file Meaning.cpp.
- -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for OOKwiz, including all inherited members.
-loop() | OOKwiz | static |
onReceive(void(*callback_function)(RawTimings, Pulsetrain, Meaning)) | OOKwiz | static |
receive() | OOKwiz | static |
setup(bool skip_saved_defaults=false) | OOKwiz | static |
simulate(String &str) | OOKwiz | static |
simulate(RawTimings &raw) | OOKwiz | static |
simulate(Pulsetrain &train) | OOKwiz | static |
simulate(Meaning &meaning) | OOKwiz | static |
standby() | OOKwiz | static |
transmit(String &str) | OOKwiz | static |
transmit(RawTimings &raw) | OOKwiz | static |
transmit(Pulsetrain &train) | OOKwiz | static |
transmit(Meaning &meaning) | OOKwiz | static |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
The static functions in the OOKwiz class provide the main controls for OOKwiz' functionality. Prefix them with OOKwiz::
to use them from your own code.
- More...
#include <OOKwiz.h>
-Static Public Member Functions | |
static bool | setup (bool skip_saved_defaults=false) |
Starts OOKwiz. Loads settings, initializes the radio and starts receiving if it finds the appropriate settings. More... | |
static bool | loop () |
To be called from your own loop() function. More... | |
static bool | receive () |
Tell OOKwiz to start receiving and processing packets. More... | |
static bool | onReceive (void(*callback_function)(RawTimings, Pulsetrain, Meaning)) |
Use this to supply your own function that will be called every time a packet is received. More... | |
static bool | standby () |
Sets radio standby mode, turning off reception. More... | |
static bool | simulate (String &str) |
Pretends this string representation of a RawTimings , Pulsetrain or Meaning instance was just received by the radio. More... | |
static bool | simulate (RawTimings &raw) |
Pretends this RawTimings instance was just received by the radio. More... | |
static bool | simulate (Pulsetrain &train) |
Pretends this Pulsetrain instance was just received by the radio. More... | |
static bool | simulate (Meaning &meaning) |
Pretends this Meaning instance was just received by the radio. More... | |
static bool | transmit (String &str) |
Transmits this string representation of a RawTimings , Pulsetrain or Meaning instance. More... | |
static bool | transmit (RawTimings &raw) |
Transmits this RawTimings instance. More... | |
static bool | transmit (Pulsetrain &train) |
Transmits this Pulsetrain instance. More... | |
static bool | transmit (Meaning &meaning) |
Transmits this Meaning instance. More... | |
The static functions in the OOKwiz class provide the main controls for OOKwiz' functionality. Prefix them with OOKwiz::
to use them from your own code.
Example use of functions from the OOKwiz class
-
|
- -static | -
Starts OOKwiz. Loads settings, initializes the radio and starts receiving if it finds the appropriate settings.
-If you set the GPIO pin for a button on your ESP32 in 'pin_rescue' and press it during boot, OOKwiz will not initialize SPI and the radio, possibly breaking an endless boot loop. Set 'rescue_active_high' if the button connects to VCC instead of GND.
-Normally, OOKwiz will start up in receive mode. If you set 'start_in_standby', it will start in standby mode instead.
skip_saved_defaults | The settings in the SPIFFS file 'defaults' are not read when this is true, leaving only the factory defaults from config.cpp. - |
Definition at line 42 of file OOKwiz.cpp.
- -
-
|
- -static | -
To be called from your own loop()
function.
Does the high-level processing of packets as soon as they are received and processed by the ISR functions. Handles the serial port output of each packet as well as calling the user's own callback function and the various device plugins.
true
Definition at line 129 of file OOKwiz.cpp.
- -
-
|
- -static | -
Tell OOKwiz to start receiving and processing packets.
-OOKwiz starts in receive mode normally, so you would only need to call this if your code has turned off reception (with standby()
) or if you configured OOKwiz to not start in receive mode by setting start_in_standby
.
true
if receive mode could be activated, false
if not. Definition at line 375 of file OOKwiz.cpp.
- -
-
|
- -static | -
Use this to supply your own function that will be called every time a packet is received.
-The callback_function parameter has to be the function name of a function that takes the three packet representations as arguments and does not return anything. Here's an example sketch:
-Make sure your own function is defined exactly as like this, even if you don't need all the parameters. You may change the names of the function and the parameters, but nothing else.
callback_function | The name of your own function, without parenthesis () after it. |
true
Definition at line 363 of file OOKwiz.cpp.
- -
-
|
- -static | -
Sets radio standby mode, turning off reception.
-receive()
, turns off reception. Definition at line 582 of file OOKwiz.cpp.
- -
-
|
- -static | -
Pretends this string representation of a RawTimings
, Pulsetrain
or Meaning
instance was just received by the radio.
str | The string representation of what needs to be simulated |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 399 of file OOKwiz.cpp.
- -
-
|
- -static | -
Pretends this RawTimings
instance was just received by the radio.
raw | the instance to be simulated |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 425 of file OOKwiz.cpp.
- -
-
|
- -static | -
Pretends this Pulsetrain
instance was just received by the radio.
train | the instance to be simulated |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 435 of file OOKwiz.cpp.
- -
-
|
- -static | -
Pretends this Meaning
instance was just received by the radio.
meaning | the instance to be simulated |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 446 of file OOKwiz.cpp.
- -
-
|
- -static | -
Transmits this string representation of a RawTimings
, Pulsetrain
or Meaning
instance.
str | The string representation of what needs to be simulated |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 457 of file OOKwiz.cpp.
- -
-
|
- -static | -
Transmits this RawTimings
instance.
raw | the instance to be transmitted |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 482 of file OOKwiz.cpp.
- -
-
|
- -static | -
Transmits this Pulsetrain
instance.
train | the instance to be transmitted |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 525 of file OOKwiz.cpp.
- -
-
|
- -static | -
Transmits this Meaning
instance.
meaning | the instance to be transmitted |
true
if it worked, false
if not. Will show error message telling you why it didn't work in latter case. Definition at line 572 of file OOKwiz.cpp.
- -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for Pulsetrain, including all inherited members.
-binList() | Pulsetrain | |
bins | Pulsetrain | |
duration | Pulsetrain | |
first_at | Pulsetrain | |
fromMeaning(const Meaning &meaning) (defined in Pulsetrain) | Pulsetrain | |
fromRawTimings(const RawTimings &raw) | Pulsetrain | |
fromString(String in) | Pulsetrain | |
gap | Pulsetrain | |
last_at | Pulsetrain | |
maybe(String str) | Pulsetrain | static |
operator bool() | Pulsetrain | |
repeats | Pulsetrain | |
sameAs(const Pulsetrain &other_train) | Pulsetrain | |
summary() const | Pulsetrain | |
toString() const | Pulsetrain | |
transitions | Pulsetrain | |
visualizer() | Pulsetrain | |
visualizer(int base) | Pulsetrain | |
zap() | Pulsetrain |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
Instances of Pulsetrain represent packets in a normalized way, meaning all intervals of similar length are made equal. - More...
- -#include <Pulsetrain.h>
-Public Member Functions | |
-IRAM_ATTR | operator bool () |
If you try to evaluate the instance as a bool (e.g. if (myPulsetrain) ... ) this will be true if there's transitions stored. | |
-void IRAM_ATTR | zap () |
empty out all information about the stored pulses | |
bool IRAM_ATTR | sameAs (const Pulsetrain &other_train) |
Compare to other Pulsetrains to see if same packet. Ignores minor timing differences. Used internally by ISR processing to see if packet is a repeat. More... | |
bool IRAM_ATTR | fromRawTimings (const RawTimings &raw) |
Convert RawTimings to Pulsetrain. More... | |
-bool | fromMeaning (const Meaning &meaning) |
String | summary () const |
Summary String a la 25 pulses over 24287 µs, repeated 6 times with gaps of 132 µs More... | |
bool | fromString (String in) |
Read a String representation like above, and store in this instance. More... | |
String | toString () const |
Get the String representation, which looks like 2010101100110101001101010010110011001100101100101,190,575,5906*6@132 More... | |
String | binList () |
Get information about the bins in this Pulsetrain, such as lowest, average and highest interval as well as number of pulses in each bin. More... | |
String | visualizer () |
Returns the viasualizer (the blocky time-graph) for the pulses in this Pulsetrain instance. More... | |
String | visualizer (int base) |
The visualizer like above, with base taken from visualizer_pixel setting. More... | |
-Static Public Member Functions | |
static bool | maybe (String str) |
See if String might be a representation of Pulsetrain. No guarantees until you try to convert it, but silent. More... | |
-Public Attributes | |
-std::vector< pulseBin > | bins |
std::vector with the bins, each a PulseBin struct | |
-std::vector< uint8_t > | transitions |
std::vector with the transitions, each merely the pulsebin that transition is in | |
-uint32_t | duration = 0 |
Total duration of this Pulsetrain in µs. | |
-int64_t | first_at = 0 |
First seen at this time, in system microseconds. | |
-int64_t | last_at = 0 |
Last seen at this time, in system microseconds. | |
-uint16_t | repeats = 0 |
Number of repetitions detected before either another packet came or repeat_timeout µs elapsed. | |
-uint16_t | gap = 0 |
Smallest gap between repeated transmissions. | |
Instances of Pulsetrain represent packets in a normalized way, meaning all intervals of similar length are made equal.
- -Definition at line 24 of file Pulsetrain.h.
-
-
|
- -static | -
See if String might be a representation of Pulsetrain. No guarantees until you try to convert it, but silent.
-str | String that we are curious about |
true
if it might be a Pulsetrain String, false
if not. Definition at line 15 of file Pulsetrain.cpp.
- -bool IRAM_ATTR Pulsetrain::sameAs | -( | -const Pulsetrain & | -other_train | ) | -- |
Compare to other Pulsetrains to see if same packet. Ignores minor timing differences. Used internally by ISR processing to see if packet is a repeat.
-other_train | Pulsetrain we're comparing this one to |
true
if same, false
if not Definition at line 45 of file Pulsetrain.cpp.
- -bool IRAM_ATTR Pulsetrain::fromRawTimings | -( | -const RawTimings & | -raw | ) | -- |
Convert RawTimings to Pulsetrain.
-raw | the RawTimings instance to convert from |
true
Definition at line 168 of file Pulsetrain.cpp.
- -String Pulsetrain::summary | -( | -) | -const | -
Summary String a la 25 pulses over 24287 µs, repeated 6 times with gaps of 132 µs
Definition at line 156 of file Pulsetrain.cpp.
- -bool Pulsetrain::fromString | -( | -String | -in | ) | -- |
Read a String representation like above, and store in this instance.
-true
if it worked, false
(with error message) if it didn't. Definition at line 87 of file Pulsetrain.cpp.
- -String Pulsetrain::toString | -( | -) | -const | -
Get the String representation, which looks like 2010101100110101001101010010110011001100101100101,190,575,5906*6@132
Definition at line 67 of file Pulsetrain.cpp.
- -String Pulsetrain::binList | -( | -) | -- |
Get information about the bins in this Pulsetrain, such as lowest, average and highest interval as well as number of pulses in each bin.
-Definition at line 212 of file Pulsetrain.cpp.
- -String Pulsetrain::visualizer | -( | -) | -- |
Returns the viasualizer (the blocky time-graph) for the pulses in this Pulsetrain instance.
-base | µs per (half-character) block. Every interval gets at least one block so all pulses are guaranteed visible |
Definition at line 224 of file Pulsetrain.cpp.
- -String Pulsetrain::visualizer | -( | -int | -base | ) | -- |
The visualizer like above, with base taken from visualizer_pixel
setting.
Definition at line 232 of file Pulsetrain.cpp.
- -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for Radio, including all inherited members.
-add(const char *name, Radio *pointer) (defined in Radio) | Radio | static |
bandwidth (defined in Radio) | Radio | |
bitrate (defined in Radio) | Radio | |
current (defined in Radio) | Radio | static |
frequency (defined in Radio) | Radio | |
init() (defined in Radio) | Radio | virtual |
len (defined in Radio) | Radio | static |
list(String separator=", ") (defined in Radio) | Radio | static |
name (defined in Radio) | Radio | |
name() (defined in Radio) | Radio | |
pin_cs (defined in Radio) | Radio | |
pin_rx (defined in Radio) | Radio | static |
pin_tx (defined in Radio) | Radio | static |
pointer (defined in Radio) | Radio | |
radio_init() (defined in Radio) | Radio | static |
radio_rx() (defined in Radio) | Radio | static |
radio_standby() (defined in Radio) | Radio | static |
radio_tx() (defined in Radio) | Radio | static |
radiolibInit() (defined in Radio) | Radio | |
radioLibModule (defined in Radio) | Radio | |
rx() (defined in Radio) | Radio | virtual |
select(const String &name) (defined in Radio) | Radio | static |
setup() (defined in Radio) | Radio | static |
showRadiolibResult(const int result, const char *action) (defined in Radio) | Radio | |
spi (defined in Radio) | Radio | |
standby() (defined in Radio) | Radio | virtual |
store (defined in Radio) | Radio | static |
threshold_level (defined in Radio) | Radio | |
threshold_type_average (defined in Radio) | Radio | |
threshold_type_fixed (defined in Radio) | Radio | |
threshold_type_int (defined in Radio) | Radio | |
threshold_type_peak (defined in Radio) | Radio | |
thresholdSetup(const int fixed, const int average, const int peak) (defined in Radio) | Radio | |
tx() (defined in Radio) | Radio | virtual |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
-Static Public Member Functions | |
-static bool | add (const char *name, Radio *pointer) |
-static bool | setup () |
-static bool | select (const String &name) |
-static String | list (String separator=", ") |
-static bool | radio_init () |
-static bool | radio_rx () |
-static bool | radio_tx () |
-static bool | radio_standby () |
-Public Attributes | |
-Module * | radioLibModule |
-SPIClass * | spi |
-int | pin_cs |
-float | frequency |
-float | bandwidth |
-float | bitrate |
-int | threshold_type_fixed |
-int | threshold_type_peak |
-int | threshold_type_average |
-int | threshold_type_int |
-int | threshold_level |
-Radio * | pointer |
-char | name [MAX_RADIO_NAME_LEN] |
-Static Public Attributes | |
-struct { | |
- Radio * pointer | |
- char name [MAX_RADIO_NAME_LEN] | |
} | store [MAX_RADIOS] |
-static Radio * | current = nullptr |
-static int | len = 0 |
-static int | pin_rx |
-static int | pin_tx |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for RawTimings, including all inherited members.
-fromPulsetrain(Pulsetrain &train) | RawTimings | |
fromString(const String &in) | RawTimings | |
intervals | RawTimings | |
maybe(String str) | RawTimings | static |
operator bool() | RawTimings | |
toString() | RawTimings | |
visualizer() | RawTimings | |
visualizer(int base) | RawTimings | |
zap() | RawTimings |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
RawTimings instances store the time in µs of each interval. - More...
- -#include <RawTimings.h>
-Public Member Functions | |
- | operator bool () |
If you try to evaluate the instance as a bool, for instance in if (myRawTimings) ... , it will be true if there's intervals stored. | |
-void | zap () |
empty out the stored intervals | |
String | toString () |
Get the String representation, which is a comma-separated list of intervals. More... | |
bool | fromString (const String &in) |
Read a String representation, which is a comma-separated list of intervals, and store in this instance. More... | |
bool | fromPulsetrain (Pulsetrain &train) |
Convert Pulsetrain into RawTimings. Loses stats about bins as well as information about repeats. More... | |
String | visualizer () |
The visualizer like above, with base taken from visualizer_pixel setting. More... | |
String | visualizer (int base) |
Returns the viasualizer (the blocky time-graph) for the pulses in this RawTimings instance. More... | |
-Static Public Member Functions | |
static bool | maybe (String str) |
Static method to see if String might be a representation of RawTimings. No guarantees until you try to convert it, but silent. More... | |
-Public Attributes | |
-std::vector< uint16_t > | intervals |
std::vector of uint16_t times in µs for each interval | |
RawTimings instances store the time in µs of each interval.
- -Definition at line 11 of file RawTimings.h.
-
-
|
- -static | -
Static method to see if String might be a representation of RawTimings. No guarantees until you try to convert it, but silent.
-str | String that we are curious about |
true
if it might be a RawTimings String, false
if not. Static, so not called on any particular RawTimings instance but instead like: Definition at line 19 of file RawTimings.cpp.
- -String RawTimings::toString | -( | -) | -- |
Get the String representation, which is a comma-separated list of intervals.
-Definition at line 48 of file RawTimings.cpp.
- -bool RawTimings::fromString | -( | -const String & | -in | ) | -- |
Read a String representation, which is a comma-separated list of intervals, and store in this instance.
-true
if it worked, false
(with error message) if it didn't. Definition at line 61 of file RawTimings.cpp.
- -bool RawTimings::fromPulsetrain | -( | -Pulsetrain & | -train | ) | -- |
Convert Pulsetrain into RawTimings. Loses stats about bins as well as information about repeats.
-train | the Puksetrain you want to convert from |
true
Definition at line 88 of file RawTimings.cpp.
- -String RawTimings::visualizer | -( | -) | -- |
The visualizer like above, with base taken from visualizer_pixel
setting.
Definition at line 129 of file RawTimings.cpp.
- -String RawTimings::visualizer | -( | -int | -base | ) | -- |
Returns the viasualizer (the blocky time-graph) for the pulses in this RawTimings instance.
-base | µs per (half-character) block. Every interval gets at least one block so all pulses are guaranteed visible |
Definition at line 98 of file RawTimings.cpp.
- -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
This is the complete list of members for Settings, including all inherited members.
-fileExists(String filename) | Settings | static |
fromList(String in) | Settings | static |
get(const String &name, String &value) | Settings | static |
get(const String &name, float &value) | Settings | static |
get(const String &name, int &value) | Settings | static |
get(const String &name, long &value) | Settings | static |
getFloat(const String &name, const float dflt=-1) | Settings | static |
getInt(const String &name, const long dflt=-1) | Settings | static |
getLong(const String &name, const long dflt=-1) | Settings | static |
getString(const String &name, const String dflt="") | Settings | static |
isSet(const String &name) | Settings | static |
list() | Settings | static |
load(const String filename) | Settings | static |
ls() | Settings | static |
rm(const String filename) | Settings | static |
save(const String filename) | Settings | static |
set(const String &name, const String &value="") | Settings | static |
set(const String &name, const T &value="") (defined in Settings) | Settings | inlinestatic |
Settings() (defined in Settings) | Settings | |
unset(const String &name) | Settings | static |
validName(const String &name) | Settings | static |
zap() | Settings | static |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
-Static Public Member Functions | |
static bool | set (const String &name, const String &value="") |
Set a value. More... | |
-template<typename T > | |
static bool | set (const String &name, const T &value="") |
static bool | unset (const String &name) |
Removes key with given name from memory. More... | |
static bool | get (const String &name, String &value) |
Get a value from memory as String. More... | |
static bool | get (const String &name, float &value) |
Get a value from memory as float. More... | |
static bool | get (const String &name, int &value) |
Get a value from memory as int. More... | |
static bool | get (const String &name, long &value) |
Get a value from memory as long. More... | |
static String | getString (const String &name, const String dflt="") |
Get a value from memory as String with default. More... | |
static int | getInt (const String &name, const long dflt=-1) |
Get a value from memory as int with default. More... | |
static long | getLong (const String &name, const long dflt=-1) |
Get a value from memory as long with default. More... | |
static float | getFloat (const String &name, const float dflt=-1) |
Get a value from memory as float with default. More... | |
-static bool | validName (const String &name) |
true if name is a valid name for a setting. | |
static String | list () |
List of values in memory. More... | |
static bool | fromList (String in) |
Stores all settings from a String into memory. More... | |
static bool | save (const String filename) |
Save settings to file in SPIFFS. More... | |
static bool | load (const String filename) |
Load settings from file in SPIFFS. More... | |
static bool | ls () |
Shows all files in the location SPIFFS_PREFIX in SPIFFS. More... | |
static bool | rm (const String filename) |
Deletes file from SPIFFS. More... | |
static bool | fileExists (String filename) |
See if given file exists in SPIFFS. More... | |
-static void | zap () |
Deletes all settings from memory. | |
static bool | isSet (const String &name) |
Find out if a key with given name exists in memory. More... | |
Definition at line 31 of file Settings.h.
-
-
|
- -static | -
Set a value.
-name | name of the key to be set |
value | value to be set as an Arduino String |
Definition at line 186 of file Settings.cpp.
- -
-
|
- -static | -
Removes key with given name from memory.
-name | name of key |
true
if removed, false
if name not valid or key not set. Definition at line 197 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as String.
-name | name of the key |
value | String variable that will hold the value on return |
true
if value found, false
if not Definition at line 209 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as float.
-name | name of the key |
value | float variable that will hold the value on return |
true
if value found, false
if not Definition at line 221 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as int.
-name | name of the key |
value | int variable that will hold the value on return |
true
if value found, false
if not Definition at line 235 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as long.
-name | name of the key |
value | long variable that will hold the value on return |
true
if value found, false
if not Definition at line 249 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as String with default.
-name | name of the key |
dflt | [optional] Default returned if key not found in memory or "" if no default specified. |
Definition at line 263 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as int with default.
-name | name of the key |
dflt | [optional] Default returned if key not found in memory or -1 if no default specified. |
Definition at line 274 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as long with default.
-name | name of the key |
dflt | [optional] Default returned if key not found in memory or -1 if no default specified. |
Definition at line 285 of file Settings.cpp.
- -
-
|
- -static | -
Get a value from memory as float with default.
-name | name of the key |
dflt | [optional] Default returned if key not found in memory or -1 if no default specified. |
Definition at line 296 of file Settings.cpp.
- -
-
|
- -static | -
List of values in memory.
-Definition at line 157 of file Settings.cpp.
- -
-
|
- -static | -
Stores all settings from a String into memory.
-in | String that contains name=value<lf>name=value<lf>... |
true
if it worked, displays error and returns false
if not. Definition at line 122 of file Settings.cpp.
- -
-
|
- -static | -
Save settings to file in SPIFFS.
-filename | The actual filename in SPIFFS will have SPIFFS_PREFIX from config.h preprended |
true
if it worked, displays error and returns false
if not. Definition at line 18 of file Settings.cpp.
- -
-
|
- -static | -
Load settings from file in SPIFFS.
-filename | The actual filename in SPIFFS will have SPIFFS_PREFIX from config.h preprended |
true
if it worked, displays error and returns false
if not. Definition at line 44 of file Settings.cpp.
- -
-
|
- -static | -
Shows all files in the location SPIFFS_PREFIX in SPIFFS.
-true
if it worked, displays error and returns false
if not. Definition at line 68 of file Settings.cpp.
- -
-
|
- -static | -
Deletes file from SPIFFS.
-filename | The actual filename in SPIFFS will have SPIFFS_PREFIX from config.h preprended |
true
if it worked, displays error and returns false
if not. Definition at line 85 of file Settings.cpp.
- -
-
|
- -static | -
See if given file exists in SPIFFS.
-filename | The actual filename in SPIFFS will have SPIFFS_PREFIX from config.h preprended |
true
if file exists, false
if not. Definition at line 102 of file Settings.cpp.
- -
-
|
- -static | -
Find out if a key with given name exists in memory.
-name | Setting name |
true
if that name is set Definition at line 178 of file Settings.cpp.
- -
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
▼ src | |
CLI.cpp | |
CLI.h | |
config.cpp | |
config.h | |
Device.cpp | |
Device.h | |
Meaning.cpp | |
Meaning.h | |
OOKwiz.cpp | |
OOKwiz.h | |
Pulsetrain.cpp | |
Pulsetrain.h | |
Radio.cpp | |
Radio.h | |
RawTimings.cpp | |
RawTimings.h | |
serial_output.c | |
serial_output.h | |
Settings.cpp | |
Settings.h | |
tools.cpp | |
tools.h |
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-
- OOKwiz
-
- on/off-keying for ESP32 and a variety of supported radio modules
- |
-