Commit 231e2d47 authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates doc software

Showing with 5 additions and 4 deletions
+5 -4
...@@ -3,12 +3,12 @@ Getting started ...@@ -3,12 +3,12 @@ Getting started
Step 1: Set up the Raspberry Pi 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 .. _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. Then connect to the Raspberry Pi either via ssh or using an external monitor.
For all questions related to Raspberry Pi operations, please refer to the official documentation_. For all questions related to Raspberry Pi operations, please refer to the official d`ocumentation`_.
.. _documentation: https://www.raspberrypi.com/documentation/ .. _documentation: https://www.raspberrypi.com/documentation/
Step 2: Clone the OhmPi project Step 2: Clone the OhmPi project
......
...@@ -101,6 +101,7 @@ To access the Python API, make sure that the PYTHONPATH has been correctly confi ...@@ -101,6 +101,7 @@ To access the Python API, make sure that the PYTHONPATH has been correctly confi
For detailed usage, please see the Python API or look at the examples. For detailed usage, please see the Python API or look at the examples.
.. _IoT-interface:
IoT interface IoT interface
============= =============
......
...@@ -2,7 +2,7 @@ Loggers ...@@ -2,7 +2,7 @@ Loggers
******* *******
Loggers have been introduced in this release. They use the excellent logging python package. 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). 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).
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. 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.
......
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