From 831c3999b48613c61e15094bf0581cb38e1c3467 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Sat, 15 Jul 2023 19:31:17 +0200 Subject: Minor changes --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 30147ea..656b625 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,22 @@ A ZeroMQ-based power monitoring publisher for the ina260 chip. This repository provides: - `logger`: that collects (as fast as possible) power measurements from the ina260 using the dedicated driver -- `publisher`: that continuously publish through the pub/sub communication pattern of ZeroMQ -- `client`: a sub client example that you can use for testing +- `publisher`: that continuously publish using the ZeroMQ pub/sub communication pattern +- `subscriber`: a client that collect the measurements from the publishers (broker, frontend etc...) *Note: Nothing is stored locally! Everything that is published by the publisher is either receive by a subscriber or lost.* ### Compilation -The only dependency is [ZeroMQ](https://zeromq.org/). -First, you need to setup the environment by editing `config.mk` according to your needs. Then, executing `make` is sufficient to generate *logger*, *publisher* and *client*. +The only dependency is [ZeroMQ](https://zeromq.org/). After installing the ZeroMQ library, the following will generate all the executables: -### Execution -Running `make start` will start the *logger* and *publisher* according to the settings you provided in `config.mk`. + $ make -Then, to access to the power measurements, simply execute the client on a machine where the publisher is reachable with `./client`. \ No newline at end of file +### Deployment +1. Update `config.mk` according to you needs +2. On the nodes equiped with the ina260 chips: + + $ make publish + +3. One the node that collect the measurements (broker, frontend etc..): + + $ make subscribe \ No newline at end of file -- cgit v1.2.3