Commit 0cbda050 authored by remi.clement's avatar remi.clement
Browse files

update documentation

Showing with 84 additions and 6 deletions
+84 -6
No preview for this file type
No preview for this file type
No preview for this file type
sphinx/build/html/_images/measurement_board-2.jpg

205 KB

sphinx/build/html/_images/measurement_board.jpg

466 KB

......@@ -2,8 +2,6 @@
Premiere page
*************
.. image:: logo_ohmpi.JPG
......
......@@ -2,6 +2,12 @@
OhmPi V 1.01
**************
The philosophy of Ohmpi
******************************************
The philosophy of Ohmpi V1.01 is to offer a multi electrode resistivity meter, from a set of commercially available electronic cards it is a resistivity meter limited to 32 electrodes only. It is limited to low-current injection, but suitable for small laboratory experiments and small field time monitoring
OS installation on a Raspberry Pi
******************************************
......@@ -25,3 +31,24 @@ The measurement board must be printed using the PCB file (Source file repository
* Step no. 5: addition of both the ADS115 directly onto the header (pins must be plugged according to the figure) and the LM358N operational amplifiers (pay attention to the direction).
1-Kohm and 1.5-Kohm resistors apply to the divider bridge. If, for example, you prefer using a weaker or stronger power supply, it would be possible to adjust the divider bridge value by simply modifying these resistors. Once all the components have been soldered together, the measurement board can be connected to the Raspberry Pi and the battery terminal, according to Figure 9. Between the battery and the TX+ terminal of the measurement board, remember to place a fuse holder with a 1.5-A fuse for safety purposes.
.. figure:: measurement_board.jpg
:width: 800px
:align: center
:height: 400px
:alt: alternate text
:figclass: align-center
Measurement circuit board assembly: a) printed circuit board, b) adding the 1-Kohm resistors ± 1%, c)adding the 1.5-Kohm resistors ± 1%, d) adding the black female 1 x 10 header and the 7-blue screw terminal block(2 pin, 3.5-mm pitch), e) adding the 50-ohm reference resistor ± 0.1%, and f) adding the ADS1115 and the LM358N low-power dual operational amplifiers
.. figure:: measurement_board-2.jpg
:width: 800px
:align: center
:height: 700px
:alt: alternate text
:figclass: align-center
Measurement board installation with Raspberry Pi
Current injection
******************
\ No newline at end of file
......@@ -157,8 +157,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="page1.html">OhmPi V 1.01</a><ul>
<li class="toctree-l2"><a class="reference internal" href="page1.html#the-philosophy-of-ohmpi">The philosophy of Ohmpi</a></li>
<li class="toctree-l2"><a class="reference internal" href="page1.html#os-installation-on-a-raspberry-pi">OS installation on a Raspberry Pi</a></li>
<li class="toctree-l2"><a class="reference internal" href="page1.html#construction-of-the-measurement-board-and-connection-to-the-raspberry">Construction of the measurement board and connection to the Raspberry</a></li>
<li class="toctree-l2"><a class="reference internal" href="page1.html#current-injection">Current injection</a></li>
</ul>
</li>
</ul>
......
......@@ -84,8 +84,10 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="page0.html"><strong>Introduction to OhmPi</strong></a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">OhmPi V 1.01</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#the-philosophy-of-ohmpi">The philosophy of Ohmpi</a></li>
<li class="toctree-l2"><a class="reference internal" href="#os-installation-on-a-raspberry-pi">OS installation on a Raspberry Pi</a></li>
<li class="toctree-l2"><a class="reference internal" href="#construction-of-the-measurement-board-and-connection-to-the-raspberry">Construction of the measurement board and connection to the Raspberry</a></li>
<li class="toctree-l2"><a class="reference internal" href="#current-injection">Current injection</a></li>
</ul>
</li>
</ul>
......@@ -155,6 +157,10 @@
<div class="section" id="ohmpi-v-1-01">
<h1>OhmPi V 1.01<a class="headerlink" href="#ohmpi-v-1-01" title="Permalink to this headline"></a></h1>
<div class="section" id="the-philosophy-of-ohmpi">
<h2>The philosophy of Ohmpi<a class="headerlink" href="#the-philosophy-of-ohmpi" title="Permalink to this headline"></a></h2>
<p>The philosophy of Ohmpi V1.01 is to offer a multi electrode resistivity meter, from a set of commercially available electronic cards it is a resistivity meter limited to 32 electrodes only. It is limited to low-current injection, but suitable for small laboratory experiments and small field time monitoring</p>
</div>
<div class="section" id="os-installation-on-a-raspberry-pi">
<h2>OS installation on a Raspberry Pi<a class="headerlink" href="#os-installation-on-a-raspberry-pi" title="Permalink to this headline"></a></h2>
<p>The first step is to start up the Raspberry Pi board, including installation of an OS (operating system).
......@@ -175,6 +181,17 @@ Raspbian GUI settings menu. Failure to carry out this task may cause damage to t
<li><p>Step no. 5: addition of both the ADS115 directly onto the header (pins must be plugged according to the figure) and the LM358N operational amplifiers (pay attention to the direction).</p></li>
</ul>
<p>1-Kohm and 1.5-Kohm resistors apply to the divider bridge. If, for example, you prefer using a weaker or stronger power supply, it would be possible to adjust the divider bridge value by simply modifying these resistors. Once all the components have been soldered together, the measurement board can be connected to the Raspberry Pi and the battery terminal, according to Figure 9. Between the battery and the TX+ terminal of the measurement board, remember to place a fuse holder with a 1.5-A fuse for safety purposes.</p>
<div class="align-center figure" id="id1">
<a class="reference internal image-reference" href="_images/measurement_board.jpg"><img alt="alternate text" src="_images/measurement_board.jpg" style="width: 800px; height: 400px;" /></a>
<p class="caption"><span class="caption-text">Measurement circuit board assembly: a) printed circuit board, b) adding the 1-Kohm resistors ± 1%, c)adding the 1.5-Kohm resistors ± 1%, d) adding the black female 1 x 10 header and the 7-blue screw terminal block(2 pin, 3.5-mm pitch), e) adding the 50-ohm reference resistor ± 0.1%, and f) adding the ADS1115 and the LM358N low-power dual operational amplifiers</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</div>
<div class="align-center figure" id="id2">
<a class="reference internal image-reference" href="_images/measurement_board-2.jpg"><img alt="alternate text" src="_images/measurement_board-2.jpg" style="width: 800px; height: 700px;" /></a>
<p class="caption"><span class="caption-text">Measurement board installation with Raspberry Pi</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="current-injection">
<h2>Current injection<a class="headerlink" href="#current-injection" title="Permalink to this headline"></a></h2>
</div>
</div>
......
Search.setIndex({docnames:["index","page0","page1"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","page0.rst","page1.rst"],objects:{},objnames:{},objtypes:{},terms:{"cr\u00e9er":[],"d\u00e9mo":[],"esp\u00e8r":[],"function":1,"pr\u00e9sent":[],"pr\u00e9sentat":[],"premi\u00e8r":[],For:2,The:2,accord:2,accuraci:2,addit:2,adjust:2,ads115:2,all:2,allow:1,amplifi:2,appli:2,articl:1,associ:1,attent:2,author:2,automat:1,basic:1,batteri:2,been:2,below:2,between:2,black:2,block:2,blue:2,board:0,both:2,bridg:2,c_1:[],c_2:[],call:1,can:2,card:2,carri:2,caus:2,ceci:[],cela:[],commun:1,complet:2,compon:2,connect:0,construct:0,consult:[],content:0,cos:[],cost:1,current:1,damag:2,deactiv:2,demo:[],describ:2,develop:1,direct:2,directli:2,divid:2,doc:[],document:[],dure:2,electrod:1,est:[],everyon:1,exampl:2,experi:1,failur:2,featur:[],femal:2,fig:[],figur:2,file:2,first:2,flexibl:1,follow:2,fonctionn:[],formul:[],fulli:1,fuse:2,get:1,gpio:2,gui:2,hardwar:1,hardwareresist:[],has:2,have:2,header:2,help:2,holder:2,http:2,illustr:2,imag:[],implement:[],includ:2,index:0,inform:[],inject:1,instal:0,instruct:2,introduct:0,introduir:[],invit:[],involv:1,kohm:2,latest:2,lien:[],lm358n:2,low:1,mai:2,maxdepth:[],measur:[0,1],menu:2,meter:1,meterfeatur:1,modifi:2,modul:0,multiplex:1,must:2,noob:2,notr:[],officiel:[],ohm:2,ohmpi:[],onc:2,onto:2,open:1,oper:2,option:2,org:2,out:2,page0:[],page1:[],page:[],pai:2,parl:[],pcb:2,perform:1,peu:[],philosophi:1,pin:2,place:2,plu:[],plug:2,possibl:2,pour:[],power:2,prefer:2,present:1,print:2,project:1,provid:1,purpos:2,que:[],raspberri:0,raspberrypi:2,raspbian:2,recommend:2,refer:2,relai:2,rememb:2,remot:2,repositori:2,resist:1,resistor:2,robust:1,safeti:2,scale:1,scientif:1,screw:2,search:[],second:[],set:2,setup:2,shield:2,simpl:2,simpli:2,site:[],small:1,solder:2,sourc:[1,2],sphinx:[],stabl:2,start:2,step:2,stronger:2,sum_:[],suppli:2,sur:[],surfac:1,system:2,task:2,termin:2,text:[],thi:[1,2],toctre:[],togeth:2,tool:1,use:2,using:2,valu:2,version:2,via:2,vise:[],voici:[],vou:[],weaker:2,websit:2,welcom:1,well:2,willing:1,wire:2,would:2,www:2,x_n:[],you:2},titles:["OHMPI: Open source and open hardware resitivity-meter","<strong>Introduction to OhmPi</strong>","OhmPi V 1.01"],titleterms:{bienvenu:[],board:2,cett:[],connect:2,construct:2,document:[],formul:[],hardwar:0,imag:[],implement:[],indic:0,instal:2,introduct:1,lien:[],measur:2,meter:0,ohmpi:[0,1,2],open:0,page:[],raspberri:2,resit:0,second:[],sourc:0,sur:[],tabl:0,text:[],welcom:[]}})
\ No newline at end of file
Search.setIndex({docnames:["index","page0","page1"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","page0.rst","page1.rst"],objects:{},objnames:{},objtypes:{},terms:{"cr\u00e9er":[],"d\u00e9mo":[],"esp\u00e8r":[],"function":1,"pr\u00e9sent":[],"pr\u00e9sentat":[],"premi\u00e8r":[],For:2,The:0,accord:2,accuraci:2,adding:2,addit:2,adjust:2,ads1115:2,ads115:2,all:2,allow:1,amplifi:2,appli:2,articl:1,assembl:2,associ:1,attent:2,author:2,automat:1,avail:2,basic:1,batteri:2,been:2,below:2,between:2,black:2,block:2,blue:2,board:0,both:2,bridg:2,c_1:[],c_2:[],call:1,can:2,caption:[],card:2,carri:2,caus:2,ceci:[],cela:[],circuit:2,commerci:2,commun:1,complet:2,compon:2,connect:0,construct:0,consult:[],content:0,cos:[],cost:1,current:[0,1],damag:2,deactiv:2,demo:[],describ:2,develop:1,direct:2,directli:2,divid:2,doc:[],document:[],dual:2,dure:2,electrod:[1,2],electron:2,est:[],everyon:1,exampl:2,experi:[1,2],failur:2,featur:[],femal:2,field:2,fig:[],figur:2,file:2,first:2,flexibl:1,follow:2,fonctionn:[],formul:[],from:2,fulli:1,fuse:2,get:1,gpio:2,gui:2,hardwar:1,hardwareresist:[],has:2,have:2,header:2,help:2,holder:2,http:2,illustr:2,imag:[],implement:[],includ:2,index:0,inform:[],inject:[0,1],instal:0,instruct:2,introduct:0,introduir:[],invit:[],involv:1,kohm:2,laboratori:2,latest:2,lien:[],like:[],limit:2,lm358n:2,low:[1,2],mai:2,maxdepth:[],measur:[0,1],menu:2,meter:[1,2],meterfeatur:1,modifi:2,modul:0,monitor:2,multi:2,multiplex:1,must:2,noob:2,notr:[],offer:2,officiel:[],ohm:2,ohmpi:[],onc:2,onli:2,onto:2,open:1,oper:2,option:2,org:2,out:2,page0:[],page1:[],page:[],pai:2,parl:[],pcb:2,perform:1,peu:[],philosophi:[0,1],pin:2,pitch:2,place:2,plu:[],plug:2,possibl:2,pour:[],power:2,prefer:2,present:1,print:2,project:1,provid:1,purpos:2,que:[],raspberri:0,raspberrypi:2,raspbian:2,recommend:2,refer:2,relai:2,rememb:2,remot:2,repositori:2,resist:[1,2],resistor:2,robust:1,safeti:2,scale:1,scientif:1,screw:2,search:[],second:[],set:2,setup:2,shield:2,simpl:2,simpli:2,site:[],small:[1,2],solder:2,sourc:[1,2],sphinx:[],stabl:2,start:2,step:2,stronger:2,suitabl:2,sum_:[],suppli:2,sur:[],surfac:1,system:2,task:2,termin:2,text:[],thi:[1,2],time:2,toctre:[],togeth:2,tool:1,use:2,using:2,valu:2,version:2,via:2,vise:[],voici:[],vou:[],weaker:2,websit:2,welcom:1,well:2,willing:1,wire:2,would:2,www:2,x_n:[],you:2},titles:["OHMPI: Open source and open hardware resitivity-meter","<strong>Introduction to OhmPi</strong>","OhmPi V 1.01"],titleterms:{The:2,bienvenu:[],board:2,cett:[],connect:2,construct:2,current:2,document:[],formul:[],hardwar:0,imag:[],implement:[],indic:0,inject:2,instal:2,introduct:1,lien:[],measur:2,meter:0,ohmpi:[0,1,2],open:0,page:[],philosophi:2,raspberri:2,resit:0,second:[],sourc:0,sur:[],tabl:0,text:[],welcom:[]}})
\ No newline at end of file
# -*- coding: utf-8 -*-
"""
Created on Mon Jul 13 21:48:00 2020
@author: remi.clement
"""
import shutil
sphinx/source/measurement_board-2.jpg

205 KB

sphinx/source/measurement_board.jpg

466 KB

......@@ -2,8 +2,6 @@
Premiere page
*************
.. image:: logo_ohmpi.JPG
......
**************
OhmPi V 1.01
OhmPi V 1.01 (limited to 32 electrodes)
**************
The philosophy of Ohmpi
******************************************
The philosophy of Ohmpi V1.01 is to offer a multi electrode resistivity meter, from a set of commercially available electronic cards it is a resistivity meter limited to 32 electrodes only. It is limited to low-current injection, but suitable for small laboratory experiments and small field time monitoring
OS installation on a Raspberry Pi
******************************************
......@@ -25,3 +31,24 @@ The measurement board must be printed using the PCB file (Source file repository
* Step no. 5: addition of both the ADS115 directly onto the header (pins must be plugged according to the figure) and the LM358N operational amplifiers (pay attention to the direction).
1-Kohm and 1.5-Kohm resistors apply to the divider bridge. If, for example, you prefer using a weaker or stronger power supply, it would be possible to adjust the divider bridge value by simply modifying these resistors. Once all the components have been soldered together, the measurement board can be connected to the Raspberry Pi and the battery terminal, according to Figure 9. Between the battery and the TX+ terminal of the measurement board, remember to place a fuse holder with a 1.5-A fuse for safety purposes.
.. figure:: measurement_board.jpg
:width: 800px
:align: center
:height: 400px
:alt: alternate text
:figclass: align-center
Measurement circuit board assembly: a) printed circuit board, b) adding the 1-Kohm resistors ± 1%, c)adding the 1.5-Kohm resistors ± 1%, d) adding the black female 1 x 10 header and the 7-blue screw terminal block(2 pin, 3.5-mm pitch), e) adding the 50-ohm reference resistor ± 0.1%, and f) adding the ADS1115 and the LM358N low-power dual operational amplifiers
.. figure:: measurement_board-2.jpg
:width: 800px
:align: center
:height: 700px
:alt: alternate text
:figclass: align-center
Measurement board installation with Raspberry Pi
Current injection
******************
\ No newline at end of file
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