initial commit

usecase.md

@@ -0,0 +1,43 @@
+# RMon Use Case
+
+## Main Goal
+
+The goal is to have a fast data plotter / monitor for a distributed control system accessible only remotely via multiple ssh jumps
+
+- The UI will run locally on the operator pc on a modern Linux
+- The Data will be accessed remotely
+- The operator can choose to record some of the data for history review
+
+## Use case
+
+- The data are acquired at different frequency from a distributed system in a private network
+- The access to the data are different, some examples include:
+  - CSV file
+  - UDP streams
+  - Specific software (e.g. EPICS)
+  - ...
+- Timestamp could be different for each case, e.g.:
+  - for CSV could be as string %Y.%m.%d %H:%M:%S
+  - for UDP a u64
+  - etc
+- Some signal are accessed in a push mode (e.g. udp) and some in pull (e.g. CSV) mode
+- Each signal could have the following info:
+  - Scale, offset
+  - Unit
+  - Label
+  - Sampling period
+- Data could be stored, two option:
+  - continuos storage (from user start to user stop, data are kept if not explicitly required)
+  - loop storage (only last N:M hours, N:M specified from user)
+- The user will access the signals from a UI on his local machine (mostly linux, but windows also possible)
+- The user UI should be a portable executable with limit dynamic dependencies
+- In the UI the user can:
+  - have multiple plots
+  - have multiple cursors
+  - make measurements and maths on the signals
+  - hide/show signals
+  - explore the list/tree of available signals and get info on them
+  - request to store siganls
+  - request historical data
+  - drag and drop to add signals
+  - signal plot style can be personalised