From ff142ae2a1715e23a1ab7b84cc8cee8caffd22f5 Mon Sep 17 00:00:00 2001
From: su530201 <olivier.kaufmann@umons.ac.be>
Date: Sun, 20 Nov 2022 22:38:38 +0100
Subject: [PATCH] Improves doc
---
doc/source/Ohmpi.rst | 2 +-
doc/source/Ohmpi_V2023/V2023_step_02.rst | 2 +-
doc/source/V2023.rst | 4 ++--
ohmpi.py | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/source/Ohmpi.rst b/doc/source/Ohmpi.rst
index 9a579123..3bfb3dc2 100644
--- a/doc/source/Ohmpi.rst
+++ b/doc/source/Ohmpi.rst
@@ -16,7 +16,7 @@ OhmPi project
| Rémi CLEMENT, Vivien DUBOIS, Nicolas Forquet, INRAE, REVERSAAL, Villeurbanne, France
| Yannick FARGIER, GERS-RRO, Univ Gustave Eiffel, IFSTTAR, Lyon, France
| Hélène GUYARD, IGE Grenoble, Université Grenoble Alpes, Grenoble, France
-| Olivier KAUFMANN, Arnaud WATELET, Université de Mons, Mons, Belgium
+| Olivier KAUFMANN, Arnaud WATLET, Université de Mons, Mons, Belgium
| Guillaume BLANCHY, ILVO, Merelbeke, Belgium|
diff --git a/doc/source/Ohmpi_V2023/V2023_step_02.rst b/doc/source/Ohmpi_V2023/V2023_step_02.rst
index 48a50e64..f853b077 100644
--- a/doc/source/Ohmpi_V2023/V2023_step_02.rst
+++ b/doc/source/Ohmpi_V2023/V2023_step_02.rst
@@ -159,7 +159,7 @@ which allows to realize precise current measurement around a shunt resistor. The
.. warning::
- In this version, We used a shunt resistor of 2 ohms, which limits the current measurement to 48 mA. If the current is higher than this value, you just have to decrease the value of the shunt resistor.Change the shunt value in the code.
+ In this version, we used a shunt resistor of 2 ohms, which limits the current measurement to 48 mA. If the current is higher than this value, you just have to decrease the value of the shunt resistor. Don't forget to change the shunt value in the config.py file (value associated to key 'R_shunt' in the OHMPI_CONFIG dict).
diff --git a/doc/source/V2023.rst b/doc/source/V2023.rst
index 860f2a5a..c5887e83 100644
--- a/doc/source/V2023.rst
+++ b/doc/source/V2023.rst
@@ -103,9 +103,9 @@ Loggers
Loggers have been introduced in this release. They use the excellent logging python package.
Specific handlers have been implemented for running with ohmpi.py (one for logging to an mqtt broker (see `MQTT interface`_ for more details) and one for creating zipped rotated logs on disk.
-Two loggers have been defined. The first one is dedicated to log operations execution. It is named exec_logger. The second one is dedicated to acquisition data. A third one is planned to log state of health data (SOH) in a future version.
+Two loggers have been defined. The first one is dedicated to log operations execution. It is named exec_logger. The second one, named data_logger, is dedicated to log data. A third one is planned to log the state of health (SOH) of the system in a future version.
-In the default version, logs are written to the console (print-like), stored locally in files (a zip is created after some time i.e. every day and/or when the size of the log exceeds a maximum size) and sent to an MQTT broker. Different logging levels may be defined for the different logs and handlers in the `Configuration file`_.
+By default, logs are written to the console (print-like), stored locally in files (a zip is created after some time i.e. every day and/or when the size of the log exceeds a maximum size) and sent to an MQTT broker. Different logging levels may be defined for the different logs and handlers in the `Configuration file`_.
Advanced users may write new handlers and edit the `setup_loggers.py` file to customize the logging mechanisms to their needs.
diff --git a/ohmpi.py b/ohmpi.py
index 6c008c9e..284d64c6 100644
--- a/ohmpi.py
+++ b/ohmpi.py
@@ -6,7 +6,7 @@ Hardware: Licensed under CERN-OHL-S v2 or any later version
Software: Licensed under the GNU General Public License v3.0
Ohmpi.py is a program to control a low-cost and open hardware resistivity meter OhmPi that has been developed by
Rémi CLEMENT (INRAE), Vivien DUBOIS (INRAE), Hélène GUYARD (IGE), Nicolas FORQUET (INRAE), Yannick FARGIER (IFSTTAR)
-Olivier KAUFMANN (UMONS), Arnaud WATELET (UMONS) and Guillaume BLANCHY (FNRS/ULiege).
+Olivier KAUFMANN (UMONS), Arnaud WATLET (UMONS) and Guillaume BLANCHY (FNRS/ULiege).
"""
import os
--
GitLab