summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2023-07-16 17:38:04 +0200
committerLoic Guegan <manzerbredes@mailbox.org>2023-07-16 17:38:04 +0200
commita3bb6ee6d7e10e5e6438255e60052c14173f3d61 (patch)
treef1380ba5172a207f077e200c9adac80b8ead8d11 /README.md
parentf1bbb2449f0ecbdb1ebe29e08d1aa041b8bf0f61 (diff)
Minor changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 11 insertions, 13 deletions
diff --git a/README.md b/README.md
index 63be914..794fa29 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,26 @@
## ina260-zmq-publisher
-A ZeroMQ-based power monitoring publisher for the ina260 chip. This repository provides:
-
+A ZeroMQ-based power monitoring publisher for the ina260 chip.\
+This repository provides:
- `logger`: that collects power measurements from the ina260 using the dedicated driver
-- `publisher`: that continuously publish using the ZeroMQ pub/sub communication pattern
-- `subscriber`: a client that collect the measurements from the publishers (broker, frontend etc...)
+- `publisher`: that continuously publish the logger's data using the ZeroMQ pub/sub communication pattern
+- `subscriber`: a program that collects the measurements published by the publishers (used to create a broker, frontend etc...)
*Note: Nothing is stored locally! Everything that is published by the publishers is either received by the subscriber or lost.*
### Compilation
-The only dependency is [ZeroMQ](https://zeromq.org/). After installing the ZeroMQ library, the following will generate all the executables:
-
- $ make
+The only dependency is [ZeroMQ](https://zeromq.org/). After installing the ZeroMQ library, running `$ make` will generate all the executables.
### Deployment
1. Update `config.mk` according to your needs \*\***IMPORTANT**\*\*
-2. On the nodes equiped with the ina260 chips run `make publish`
+2. On the nodes equiped with the ina260 chips and its driver, run `make publish`
3. On the node that collect the measurements (broker, frontend etc..) run `make subscribe`
### Notes
- Message format used in ZeroMQ exchanges:
- 1: <ZMQ_TOKEN>
- 2: <KEY>
- 3: <CLIENT>
- 4: <INTERVAL>
- 5-n:<CSV-DATA>
+ L1: &lt;ZMQ_TOKEN>\
+ L2: &lt;KEY>\
+ L3: &lt;CLIENT>\
+ L4: &lt;INTERVAL>\
+ L5-n: &lt;CSV-DATA> \ No newline at end of file