|
|
|
|
# CycleTimeReport
|
|
|
|
|
|
|
|
|
|
A development and debugging aid, this plugin will measure average mainloop times
|
|
|
|
|
(in microseconds) and print it to `Serial` periodically. While not the most
|
|
|
|
|
reliable way to measure the speed of processing, it gives a reasonable
|
|
|
|
|
indication nevertheless.
|
|
|
|
|
|
|
|
|
|
## Using the plugin
|
|
|
|
|
|
|
|
|
|
The plugin comes with reasonable defaults (see below), and can be used out of
|
|
|
|
|
the box, without any further configuration:
|
|
|
|
|
|
|
|
|
|
```c++
|
|
|
|
|
#include <Kaleidoscope.h>
|
|
|
|
|
#include <Kaleidoscope-CycleTimeReport.h>
|
|
|
|
|
|
|
|
|
|
KALEIDOSCOPE_INIT_PLUGINS(CycleTimeReport);
|
|
|
|
|
|
|
|
|
|
void setup (void) {
|
Redesign how the hardware objects are defined
Instead of having to define `HARDWARE_IMPLEMENTATION` to the class name of the
device, and define `KeyboardHardware` from within the plugin, let all devices
set `kaleidoscope::Device` to their own class via a typedef. Furthermore,
instead of `KeyboardHardware`, use `Kaleidoscope.device()` instead. This makes
device plugins a little bit simpler, and our naming more consistent.
Because some parts of the firmware need to access the device object before the
`Kaleidoscope` object is available, we can't make it a member of that. For this
reason, the device object is `kaleidoscope_internal::device`, and
`Kaleidoscope.device()` wraps it. In general, the wrapper should be used. But if
access to the device is required before `Kaleidoscope` is available, then that's
also available.
The `Kaleidoscope` object grew a few more wrappers: `storage()` and
`serialPort()`, so that one doesn't need to use `Kaleidoscope.device()`
directly, but can use the wrappers, which are noticably shorter to write.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
5 years ago
|
|
|
Kaleidoscope.serialPort().begin(9600);
|
|
|
|
|
Kaleidoscope.setup ();
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Plugin methods
|
|
|
|
|
|
|
|
|
|
The plugin provides a single object, `CycleTimeReport`, with the following
|
|
|
|
|
property. All times are in milliseconds.
|
|
|
|
|
|
|
|
|
|
### `.average_loop_time`
|
|
|
|
|
|
|
|
|
|
> A read-only by contract value, the average time of main loop lengths between
|
|
|
|
|
> two reports.
|
|
|
|
|
|
|
|
|
|
## Overrideable methods
|
|
|
|
|
|
|
|
|
|
### `cycleTimeReport()`
|
|
|
|
|
|
|
|
|
|
> Reports the average loop time. By default, it does so over `Serial`, every
|
|
|
|
|
> time when the report period is up.
|
|
|
|
|
>
|
|
|
|
|
> It can be overridden, to change how the report looks, or to make the report
|
|
|
|
|
> toggleable, among other things.
|
|
|
|
|
>
|
|
|
|
|
> It takes no arguments, and returns nothing, but has access to
|
|
|
|
|
> `CycleTimeReport.average_loop_time` above.
|
|
|
|
|
|
|
|
|
|
## Further reading
|
|
|
|
|
|
|
|
|
|
Starting from the [example][plugin:example] is the recommended way of getting
|
|
|
|
|
started with the plugin.
|
|
|
|
|
|
|
|
|
|
[plugin:example]: ../../examples/Features/CycleTimeReport/CycleTimeReport.ino
|
