alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e52cf5c821'
${ noResults }
Kaleidoscope/plugins/Kaleidoscope-CycleTimeReport/README.md

52 lines
1.4 KiB
Raw Normal View History Unescape

Remove the "Kaleidoscope-" prefix from the titles of plugin docs
5 years ago
# CycleTimeReport
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
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);
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
void setup () {
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);
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Kaleidoscope.setup ();
}
```
## Plugin methods
The plugin provides a single object, `CycleTimeReport`, with the following
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
methods:
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
### `.setReportInterval(interval)`
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
> Sets the length of time between reports to `interval` milliseconds. The
> default is `1000`, so it will report once per second.
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
### `.report(mean_cycle_time)`
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
> Reports the average (mean) cycle time since the previous report. This method
> is called automatically, once per report interval (see above). By default, it
> does so over `Serial`.
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
>
> It can be overridden, to change how the report looks, or to make the report
> toggleable, among other things.
>
Rewrite CycleTimeReport plugin The plugin was both more complex and less accurate than it could have been. For simplicity, it used a weighted average, with each cycle getting twice the weight of the previous one. As a result, the reported average really only took into account the last three or four cycles. On a keyboard with LEDs, some cycles take much longer than others because of relatively rare updates, so this could lead to misleading results, with the "average" cycle time usually being reported as lower than it really should have been, and occasionally much higher. This new version computes an evenly-weighted mean cycle time for each interval, and runs more efficiently, by dividing the total elapsed time by the number of cycles that has passed since the last report, rather than computing the time for each individual cycle. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
2 years ago
> It takes no arguments, and returns nothing.
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/CycleTimeReport.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
## Further reading
Starting from the [example][plugin:example] is the recommended way of getting
started with the plugin.
first pass at getting our examples into readthedocs
4 years ago
[plugin:example]: /examples/Features/CycleTimeReport/CycleTimeReport.ino