Commit 4caa5b1a authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates doc software

Showing with 4 additions and 3 deletions
+4 -3
......@@ -3,7 +3,7 @@ Getting started
Step 1: Set up the Raspberry Pi
===============================
First, install an operating system on the Raspberry Pi by following the official `instructions`_.
First, install an operating system on the Raspberry Pi by following the official instructions`_.
.. _instructions : https://www.raspberrypi.com/documentation/computers/getting-started.html#install-an-operating-system
Then connect to the Raspberry Pi either via ssh or using an external monitor.
......
.. _config:
Configuration
*************
......
......@@ -2,10 +2,10 @@ 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 `IoT-interface`_ for more details) and one for creating zipped rotated logs on disk).
Specific handlers have been implemented for running with ohmpi.py (one for logging to an mqtt broker (see :ref:`IoT-interfaces` 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, 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.
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`_.
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 :ref:`config`.
Advanced users may write new handlers and edit the `setup_loggers.py` file to customize the logging mechanisms to their needs.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment