Automodule

docs/build/html/_sources/code.rst.txt

@@ -16,7 +16,7 @@ En premier lieu, le programme essaie de détecter s'il y a des problèmes d'init
 D'abord, il détecte si Python peut bel et bien initialiser la fenêtre et, ensuite, si il peut initialiser l'objet `PiCamera`_.
 S'il ne peut pas, il lèves deux types d'erreurs et propose des solutions exposées :ref:`exceptionsmodules:ici`.
 
-L'instance `app` de la classe :ref:`gui:PiCameraGUI` est crée avec `win` comme `root` et `camera` comme objet `PiCamera`. Le programme exécute ensuite la ligne::
+L'instance `app` de la classe :ref:`gui` est crée avec `win` comme `root` et `camera` comme objet `PiCamera`. Le programme exécute ensuite la ligne::
 
 	win.mainloop()
 
@@ -37,7 +37,8 @@ PiCameraGUI.py
 
 Ce fichier contient la classe `PiCameraGUI` qui s'occupe de la création de l'interface ainsi que des fonctionnalités du programme.
 
-.. automodule:: PiCameraGUI.PiCameraGUI
+.. currentmodule:: ../../PiCameraGUI
+.. automodule:: PiCameraGUI
 
 
 .. _layout:

docs/build/html/_sources/index.rst.txt

@@ -41,10 +41,10 @@ Liens
 
 .. _content:
 
-Welcome to PiCamera GUI's documentation!
-=========================================
+Bienvenue sur la documentation de PiCamera GUI!
+===============================================
 
-Contents:
+Table des matières:
 
 .. toctree::
    :maxdepth: 2
@@ -56,6 +56,7 @@ Contents:
    code
    calltipwindow
    exceptionsmodules
+   bibliography
    rights
 
 

docs/build/html/_sources/userguide.rst.txt

@@ -4,6 +4,119 @@
 Guide de l'utilisateur
 ======================
 
+À l'initialisation du logiciel, l'aperçu en temps réel devrait apparaître. Vous avez alors plusieurs fonctionnalités à votre disposition.
+
+.. note:: 
+
+	Le prévisionnement est un `Overlay`_, ce qui signifie qu'il est généré «par-dessus» l'écran.
+	C'est pour cela qu'en déplaçant la fenêtre, il ne suit pas immédiatement la position de la fenêtre. Son ajustement est fait de manière à ce que sa position s'adapte lorsque le programme
+	détecte un mouvement de la fenêtre principale (`root`) et la fonction est seulement appelée lorsque le déplacement du `root` est complété.
+	On ne peut pas prendre de capture d'écran du prévisionnement puisque c'est un `Overlay`. C'est comme s'il était par-dessus la capture. Pour plus d'informations, consultez la `page`_
+	du module PiCamera sur l'aperçu et l'`Overlay`.
+
+.. _Overlay: https://en.wikipedia.org/wiki/Overlay_(programming)
+.. _page: https://picamera.readthedocs.io/en/release-1.10/api_camera.html#picamera.camera.PiCamera.start_preview
+
+
+.. _quickstart:
+
+Démarrage rapide
+================
+
+Si vous avez téléchargé le dossier au complet, vous remarquerez deux dossiers dans le répertoire principal: **Captures** et **Vidéo**. Ce sont les dossiers dans lesquels
+seront enregistrées vos photos et vidéos prises avec l'application. Si vous souhaitez enregistrer vos captures dans un autre répertoire vous pouvez commencer par ouvrir le 
+menu **Fichier** et choisir de nouveaux répertoires. Pour plus d'options, consultez la section :ref:`save`.
+
+Vous pouvez maintenant prendre des photos en appuyant sur la barre espace ou sur le bouton avec l'icône d'un appareil photo dans le menu *Commandes* sous l'aperçu. 
+Remarquez la barre d'état en bas à droite: elle indique si vous pouvez prendre une photo et ensuite dans quel répertoire la capture est enregistrée.
+
+Pour prendre des vidéos, appuyez sur le bouton avec l'icône d'un caméscope. Un rond rouge vous indiquera que vous êtes en train de filmer. Pour finir l'enregistrement, 
+appuyez à nouveau sur le bouton. La barre d'état vous dira dans quel répertoire la vidéo est enregistrée.
+
+.. note::
+
+	Le format des fichiers vidéo est .h264 par défaut et le programme filme à 24 fps. Si vous voulez lire les vidéos, 
+	allez dans le répertoire dans lequel se trouve le fichier et exécutez la commande suivante 
+	dans l'invite de commande::
+		
+		omxplayer --fps 24 file_name.h264
+	
+	Omxplayer est le lecteur vidéo du Raspberry Pi.
+
+
+.. _zoom:
+
+Zoomer
+======
+
+Vous pouvez zoomer dans l'image à l'aide de la glissoire **Zoom**. Après avoir choisi le zoom désiré, vous pouvez vous déplacer avec les deux autres glissoires **X** et **Y**. 
+Celles-ci vous feront déplacer horizontalement et verticalement respectivement. Pour la glissoire **X**, une valeur 0 indique que vous vous trouvez complètement à gauche de 
+l'image et une valeur de 100, complètement à droite. Pour la glissoire **Y**, 0 indique que vous vous trouvez complètement en haut de 
+l'image et une valeur de 100, complètement en bas.    
+
+
+.. note::
+
+	Il y a une sécurité qui limite le zoom maximal dans le code. À un certain point, la caméra zoome sur seulement quelques pixels et cela fait planter l'application. 
+	Si vous devez absolument zoomer plus que ce que le programme propose, vous pouvez changer la valeur 1.05 à la ligne 780 du fichier **PiCameraGUI.py** dans la fonction 
+	set_previewScale par 1.00. Cela vous permettera de zoomer jusqu'aux limites de la PiCamera, mais c'est déconseillé. Vous êtes conseillez de remettre ce paramètre à 1.05 par la suite.
+
+Pour réinitialiser le zoom de l'image comme elle était à l'ouverture du programme, appuyez sur le bouton **Réinitialiser** sous la glissoire **Y**. 
+Ça fait la même chose que de remettre les
+trois glissoires à 0.
+
+.. _image:
+
+Paramètres de l'image
+=====================
+
+
+
+.. _resolution:
+
+Changer la résolution
+=====================
+
+
+
+.. _text:
+
+Afficher un texte
+=================
+
+
+
+.. _save:
+
+Modifier l'endroit de la sauvegarde
+===================================
+
+
+.. _other:
+
+Autres fonctionnalités
+======================
+
+
+* Changer le nombre de prise de photo en séquence
+
+
+
+* Changer le temps de la capture vidéo
+
+
+
+* Revirements et rotation
+
+
+* Tout réinitialiser
+
+
+
+
+
+
+
 Ce `package`_ sert à afficher un label en survolant un objet Tkinter.
 
 Par exemple, pour attacher un ToolTip au Label "self.modeLabel", il suffit d'appeler la fonction "createToolTip" à partir du fichier CallTipWindow.py 
@@ -20,4 +133,3 @@ et de mettre le widget parent en premier argument et le texte à afficher en deu
 
 Note: L'auteur du programme PiCamera GUI ne détient pas les droits sur ce package et la license ne s'applique pas sur celui-ci. Les droits de ce package reviennent à Michael Foord.
 
-.. _package: http://www.voidspace.org.uk/python/weblog/arch_d7_2006_07_01.shtml#e387

docs/build/html/code.html

@@ -90,7 +90,8 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1"><a class="reference internal" href="rights.html">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rights.html">7. Droits d’auteurs</a></li>
 </ul>
 
 
@@ -163,7 +164,7 @@
 <p>En premier lieu, le programme essaie de détecter s’il y a des problèmes d’initialisation.
 D’abord, il détecte si Python peut bel et bien initialiser la fenêtre et, ensuite, si il peut initialiser l’objet <a class="reference external" href="https://picamera.readthedocs.io/en/release-1.10/index.html">PiCamera</a>.
 S’il ne peut pas, il lèves deux types d’erreurs et propose des solutions exposées <span class="xref std std-ref">exceptionsmodules:ici</span>.</p>
-<p>L’instance <cite>app</cite> de la classe <span class="xref std std-ref">gui:PiCameraGUI</span> est crée avec <cite>win</cite> comme <cite>root</cite> et <cite>camera</cite> comme objet <cite>PiCamera</cite>. Le programme exécute ensuite la ligne:</p>
+<p>L’instance <cite>app</cite> de la classe <a class="reference internal" href="#gui"><span class="std std-ref">PiCameraGUI.py</span></a> est crée avec <cite>win</cite> comme <cite>root</cite> et <cite>camera</cite> comme objet <cite>PiCamera</cite>. Le programme exécute ensuite la ligne:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">win</span><span class="o">.</span><span class="n">mainloop</span><span class="p">()</span>
 </pre></div>
 </div>

docs/build/html/genindex.html

@@ -84,7 +84,8 @@
 <li class="toctree-l1"><a class="reference internal" href="code.html">3. Notes sur le code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1"><a class="reference internal" href="rights.html">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rights.html">7. Droits d’auteurs</a></li>
 </ul>
 
 

docs/build/html/index.html

@@ -84,7 +84,8 @@
 <li class="toctree-l1"><a class="reference internal" href="code.html">3. Notes sur le code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1"><a class="reference internal" href="rights.html">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rights.html">7. Droits d’auteurs</a></li>
 </ul>
 
 
@@ -174,9 +175,9 @@ <h2>Liens<a class="headerlink" href="#liens" title="Permalink to this headline">
 <li>Ce code est licencé sous la <a class="reference external" href="https://opensource.org/licenses/BSD-3-Clause">Licence BSD</a></li>
 </ul>
 </div>
-<div class="section" id="welcome-to-picamera-gui-s-documentation">
-<span id="content"></span><h2>Welcome to PiCamera GUI’s documentation!<a class="headerlink" href="#welcome-to-picamera-gui-s-documentation" title="Permalink to this headline">¶</a></h2>
-<p>Contents:</p>
+<div class="section" id="bienvenue-sur-la-documentation-de-picamera-gui">
+<span id="content"></span><h2>Bienvenue sur la documentation de PiCamera GUI!<a class="headerlink" href="#bienvenue-sur-la-documentation-de-picamera-gui" title="Permalink to this headline">¶</a></h2>
+<p>Table des matières:</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="install.html">1. Installation</a><ul>
@@ -185,7 +186,16 @@ <h2>Liens<a class="headerlink" href="#liens" title="Permalink to this headline">
 <li class="toctree-l2"><a class="reference internal" href="install.html#ouvrir-l-application">1.3. Ouvrir l’application</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="userguide.html">2. Guide de l’utilisateur</a></li>
+<li class="toctree-l1"><a class="reference internal" href="userguide.html">2. Guide de l’utilisateur</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#demarrage-rapide">2.1. Démarrage rapide</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#zoomer">2.2. Zoomer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#parametres-de-l-image">2.3. Paramètres de l’image</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#changer-la-resolution">2.4. Changer la résolution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#afficher-un-texte">2.5. Afficher un texte</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#modifier-l-endroit-de-la-sauvegarde">2.6. Modifier l’endroit de la sauvegarde</a></li>
+<li class="toctree-l2"><a class="reference internal" href="userguide.html#autres-fonctionnalites">2.7. Autres fonctionnalités</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="code.html">3. Notes sur le code</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="code.html#main-py">3.1. Main.py</a></li>
 <li class="toctree-l2"><a class="reference internal" href="code.html#picameragui-py">3.2. PiCameraGUI.py</a></li>
@@ -194,7 +204,8 @@ <h2>Liens<a class="headerlink" href="#liens" title="Permalink to this headline">
 </li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1"><a class="reference internal" href="rights.html">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rights.html">7. Droits d’auteurs</a></li>
 </ul>
 </div>
 </div>

docs/build/html/rights.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>6. Droits d’auteurs &mdash; PiCameraGUI 1.0 documentation</title>
+  <title>7. Droits d’auteurs &mdash; PiCameraGUI 1.0 documentation</title>
 
 
 
@@ -29,7 +29,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="5. Modules d’exception" href="exceptionsmodules.html" /> 
+    <link rel="prev" title="6. Bibliographie" href="bibliography.html" /> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -84,7 +84,8 @@
 <li class="toctree-l1"><a class="reference internal" href="code.html">3. Notes sur le code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">7. Droits d’auteurs</a></li>
 </ul>
 
 
@@ -130,7 +131,7 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
-      <li>6. Droits d’auteurs</li>
+      <li>7. Droits d’auteurs</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -150,7 +151,7 @@
            <div itemprop="articleBody">
 
   <div class="section" id="droits-d-auteurs">
-<span id="rights"></span><h1>6. Droits d’auteurs<a class="headerlink" href="#droits-d-auteurs" title="Permalink to this headline">¶</a></h1>
+<span id="rights"></span><h1>7. Droits d’auteurs<a class="headerlink" href="#droits-d-auteurs" title="Permalink to this headline">¶</a></h1>
 <p>Copyright (c) 2018, Jérémy Talbot-Pâquet
 All rights reserved.</p>
 <p>Redistribution and use in source and binary forms, with or without
@@ -189,7 +190,7 @@
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
 
-        <a href="exceptionsmodules.html" class="btn btn-neutral" title="5. Modules d’exception" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="bibliography.html" class="btn btn-neutral" title="6. Bibliographie" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

docs/build/html/search.html

@@ -83,7 +83,8 @@
 <li class="toctree-l1"><a class="reference internal" href="code.html">3. Notes sur le code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="calltipwindow.html">4. Call Tip Window</a></li>
 <li class="toctree-l1"><a class="reference internal" href="exceptionsmodules.html">5. Modules d’exception</a></li>
-<li class="toctree-l1"><a class="reference internal" href="rights.html">6. Droits d’auteurs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bibliography.html">6. Bibliographie</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rights.html">7. Droits d’auteurs</a></li>
 </ul>