Add processor documentation and CLI support #2108
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2108 +/- ##
=======================================
Coverage 79.76% 79.77%
=======================================
Files 633 633
Lines 48026 48025 -1
Branches 754 754
=======================================
Hits 38310 38310
+ Misses 9633 9632 -1
Partials 83 83
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| To create a Ruby processor simply replace `--python` with `--ruby`. This creates a processor called `slope_processor.py` at `targets/GSE/lib/slope_processor.py`. The code which is generated looks like the following: | ||
|
|
||
| ```python |
There was a problem hiding this comment.
Should this be Ruby to match the rest of our docs?
There was a problem hiding this comment.
I think the majority of our users are going to be Python going forward so I'm slowing switching the docs over to Python as the primary example.
|
|
||
| Processors execute code every time a packet is received to calculate values that can be retrieved by a [ProcessorConversion](/docs/configuration/conversions#processor_conversion). Processors are applied using the [PROCESSOR](/docs/configuration/telemetry#processor) keyword and generate values unique to the processor. | ||
|
|
||
| If you only want to perform a single calculation to modify a single telemetry value you probably want to use a [Conversion](/docs/configuration/conversions). Processors are used when you're deriving a number of values from a single telemetry item. |
There was a problem hiding this comment.
I would say from a single packet, not from a single item.
|
|
||
| ### Instantiate Processor | ||
|
|
||
| Now that we have implemented the processor logic we need to create the processor by adding it to a telemetry packet with the line `PROCESSOR slope_conversion.rb` in the [telemetry](/docs/configuration/telemetry) definition file. We also need a [ProcessorConversion](/docs/configuration/conversions#processor_conversion) to pull the calculated values out of the processor and into a [derived](/docs/configuration/telemetry#derived-items) telemetry item. This could look something like this: |
There was a problem hiding this comment.
Confusing switch to ruby. Probably need to provide examples for both languages.
There was a problem hiding this comment.
Accidental switch to Ruby ... this matches the Conversion documentation
|
No description provided.