You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ze...@apache.org on 2020/04/26 16:34:11 UTC
[incubator-streampipes-extensions] branch dev updated: Add
description and icon to speed calculator
This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
The following commit(s) were added to refs/heads/dev by this push:
new dc29746 Add description and icon to speed calculator
dc29746 is described below
commit dc29746c5bdb3e1018854b294a2045eb40ced6b3
Author: Philipp Zehnder <ze...@fzi.de>
AuthorDate: Sun Apr 26 18:24:45 2020 +0200
Add description and icon to speed calculator
---
.../processor/speed/SpeedCalculatorController.java | 2 +-
.../documentation.md | 18 +++++++++++-------
.../icon.png | Bin 0 -> 14632 bytes
.../strings.en | 8 ++++----
4 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/streampipes-processors-geo-jvm/src/main/java/org/apache/streampipes/processors/geo/jvm/processor/speed/SpeedCalculatorController.java b/streampipes-processors-geo-jvm/src/main/java/org/apache/streampipes/processors/geo/jvm/processor/speed/SpeedCalculatorController.java
index a9170d4..8896a62 100644
--- a/streampipes-processors-geo-jvm/src/main/java/org/apache/streampipes/processors/geo/jvm/processor/speed/SpeedCalculatorController.java
+++ b/streampipes-processors-geo-jvm/src/main/java/org/apache/streampipes/processors/geo/jvm/processor/speed/SpeedCalculatorController.java
@@ -50,7 +50,7 @@ public class SpeedCalculatorController extends StandaloneEventProcessingDeclarer
return ProcessingElementBuilder.create("org.apache.streampipes.processors.geo.jvm.processor" +
".speed")
.category(DataProcessorType.ALGORITHM)
- .withAssets(Assets.DOCUMENTATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
.withLocales(Locales.EN)
.requiredStream(StreamRequirementsBuilder
.create()
diff --git a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/documentation.md b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/documentation.md
index 605501f..dbb4b65 100644
--- a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/documentation.md
+++ b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/documentation.md
@@ -22,24 +22,28 @@
## Description
-Calculates the speed (in km/h) based on two latitude/longitude pairs. The distance of the two location pairs can be
- configured.
+Calculates the speed (in km/h) based on latitude/longitude values in a data stream. Therefore it uses the GPS and timestamps values of consecutive events.
+It calculates the distance between two points (events) and how much time has passed. Based on those values the speed is calculated.
***
## Required input
-Requires a data stream that provides latitude and longitude values.
+Requires a data stream that provides latitude and longitude values as well as a timestamp.
***
## Configuration
-Describe the configuration parameters here
+### Timestamp field
-### 1st parameter
+### Latitude field
+### Longitude field
-### 2nd parameter
+### Count window
+Describes the number of stored events, used for the calculation.
+E.g. a value of 5 means that thhe current event and the event (t-5) are used for the speed calculation.
-## Output
\ No newline at end of file
+## Output
+Appends the calculated speed in km/h.
\ No newline at end of file
diff --git a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/icon.png b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/icon.png
new file mode 100644
index 0000000..7254648
Binary files /dev/null and b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/icon.png differ
diff --git a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/strings.en b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/strings.en
index a695358..0cf2ad9 100644
--- a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/strings.en
+++ b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.speed/strings.en
@@ -2,13 +2,13 @@ org.apache.streampipes.processors.geo.jvm.processor.speed.title=Speed Calculator
org.apache.streampipes.processors.geo.jvm.processor.speed.description=Calculates the speed of two latlng pairs in kilometers per hour
timestamp-key.title=Timestamp field
-timestamp-key.description=
+timestamp-key.description=Used to calculate the time between events
latitude-key.title=Latitude field
-latitude-key.description=
+latitude-key.description=Used to calculate the distance between events
longitude-key.title=Longitude field
-longitude-key.description=
+longitude-key.description=Used to calculate the distance between events
count-window-key.title=Count window
-count-window-key.description=
\ No newline at end of file
+count-window-key.description=Describes the number of stored events, used for the calculation
\ No newline at end of file