kiss - vlizBE/dcafs GitHub Wiki

Quick Reference

Glossary

Modules

Collect

  • streams or ss connect to TCP, UDP and serial devices
  • email send and receive emails
  • telnet user interface to send commands and view data
  • transserver or ts TCP server that can receive data or act as a telnet session
  • mqtt connect to MQTT brokers
  • gpio interact with GPIO pins
  • spi interact with a SPI bus/device
  • i2c interact with a i²C bus/device

Alter & Forward

  • filterforward or ff filter data out based on rules
  • EditorForward or ef alter data based on edit operations
  • MathForward or mf apply mathematical operations on received data

Store

  • DatabaseManager or dbm connect with sql database servers and SQLite
  • FileCollector of fc receives data and stores it in a file
  • generics or gens receive delimited data and stores it in memory
  • valmap or vm variant of generics that is geared toward multiple different messages in data
  • DoubleVal or dv store a single double value in memory
  • FlagVal or fv store a single bit/boolean in memory
  • text store a piece of text
  • MathCollector or mc store a collection of double values to calculate avg/stdev etc
  • waypoints or wps store a geographical position and the possible travels

Other

  • taskmanager or tm script actions and interactions with the other modules
  • pathforward of pf combine instances of modules in a single structure to mimic the data path