Skip to content
Snippets Groups Projects
Commit 6e84aabb authored by jkerdreu's avatar jkerdreu
Browse files

Update redmine url


git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7@3210 b32b6428-25c9-4566-ad07-03861ab6144f
parent f57c62ae
Branches
No related tags found
No related merge requests found
......@@ -621,7 +621,7 @@ a { text-decoration: none; }
<section id="requirements">
<h2><span class="sectnum">1 </span>Requirements</h2>
<p>To install xAAL for Python, you need Python-3 (version 3.8 or above). And limited stack exists
for Python-2, you can find more informations <a class="reference external" href="https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/py2-backport">here</a>.</p>
for Python-2, you can find more informations <a class="reference external" href="https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/py2-backport">here</a>.</p>
<section id="un-x-like">
<h3><span class="sectnum">1.1 </span>Un*x like</h3>
<p>Install the following packages:</p>
......@@ -632,9 +632,9 @@ for Python-2, you can find more informations <a class="reference external" href=
<li><p>libsodium-dev</p></li>
</ul>
<p>For Debian / Ubuntu users:</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>apt-get<span class="whitespace"> </span>install<span class="whitespace"> </span>subversion<span class="whitespace"> </span>python3-dev<span class="whitespace"> </span>libsodium-dev<span class="whitespace"> </span>python3-setuptools<span class="whitespace"> </span>gcc<span class="whitespace">
</span><span class="comment single"># recommended
</span>$<span class="whitespace"> </span>apt-get<span class="whitespace"> </span>install<span class="whitespace"> </span>python3-venv<span class="whitespace"> </span>python3-pip</code></pre>
<pre class="code bash literal-block"><code>$ apt-get install subversion python3-dev libsodium-dev python3-setuptools gcc
<span class="comment single"># recommended
</span>$ apt-get install python3-venv python3-pip</code></pre>
</section>
<section id="windows">
<h3><span class="sectnum">1.2 </span>Windows</h3>
......@@ -661,32 +661,32 @@ are just renamed with an exe extension (ie: xaal-dumper.exe)</p>
you have to install things from SVN or archive.</p>
<p>You can use virtualenv (recommended).</p>
<p>First build a virtualenv :</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>python3<span class="whitespace"> </span>-m<span class="whitespace"> </span>venv<span class="whitespace"> </span>xaal_env</code></pre>
<pre class="code bash literal-block"><code>$ python3 -m venv xaal_env</code></pre>
<p>Everytime, you want to use the binding, you must source the activate script.</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span><span class="name builtin">source</span><span class="whitespace"> </span>xaal_env/bin/activate</code></pre>
<pre class="code bash literal-block"><code>$ <span class="name builtin">source</span> xaal_env/bin/activate</code></pre>
<p>Download sources from SVN:</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>svn<span class="whitespace"> </span>checkout<span class="whitespace"> </span>https://redmine.telecom-bretagne.eu/svn/xaal/code/Python/trunk/<span class="whitespace"> </span>xaal_svn</code></pre>
<pre class="code bash literal-block"><code>$ svn checkout https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7/ xaal_svn</code></pre>
<p>First, install the xaal.lib package:</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span><span class="name builtin">cd</span><span class="whitespace"> </span>xaal_svn/libs/lib/<span class="whitespace">
</span>$<span class="whitespace"> </span>pip<span class="whitespace"> </span>install<span class="whitespace"> </span>.</code></pre>
<pre class="code bash literal-block"><code>$ <span class="name builtin">cd</span> xaal_svn/libs/lib/
$ pip install .</code></pre>
<p>Install the monitor lib (needed by Dashboard, REST API..)</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span><span class="name builtin">cd</span><span class="whitespace"> </span>xaal_svn/libs/monitor/<span class="whitespace">
</span>$<span class="whitespace"> </span>pip<span class="whitespace"> </span>install<span class="whitespace"> </span>-e<span class="whitespace"> </span>.</code></pre>
<pre class="code bash literal-block"><code>$ <span class="name builtin">cd</span> xaal_svn/libs/monitor/
$ pip install -e .</code></pre>
<p>Install the schemas (needed by some devices)</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span><span class="name builtin">cd</span><span class="whitespace"> </span>xaal_svn/libs/schemas/<span class="whitespace">
</span>$<span class="whitespace"> </span>pip<span class="whitespace"> </span>install<span class="whitespace"> </span>-e<span class="whitespace"> </span>.</code></pre>
<pre class="code bash literal-block"><code>$ <span class="name builtin">cd</span> xaal_svn/libs/schemas/
$ pip install -e .</code></pre>
<p>Install the tools</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span><span class="name builtin">cd</span><span class="whitespace"> </span>xaal_svn/apps/tools<span class="whitespace">
</span>$<span class="whitespace"> </span>pip<span class="whitespace"> </span>install<span class="whitespace"> </span>-e<span class="whitespace"> </span>.</code></pre>
<pre class="code bash literal-block"><code>$ <span class="name builtin">cd</span> xaal_svn/apps/tools
$ pip install -e .</code></pre>
<dl class="simple">
<dt>You can remove the <em>-e</em> in pip install command , but modification in source files</dt>
<dd><p>won't be applied, you have to re-install it. Right now, <em>-e</em> is the best option.</p>
</dd>
</dl>
<p>Create the configuration file in your home directory:</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>mkdir<span class="whitespace"> </span>~/.xaal/<span class="whitespace">
</span>$<span class="whitespace"> </span>cp<span class="whitespace"> </span>xaal_svn/libs/lib/xaal.ini.sample<span class="whitespace"> </span>~/.xaal/xaal.ini<span class="whitespace">
</span>$<span class="whitespace"> </span>xaal-keygen</code></pre>
<pre class="code bash literal-block"><code>$ mkdir ~/.xaal/
$ cp xaal_svn/libs/lib/xaal.ini.sample ~/.xaal/xaal.ini
$ xaal-keygen</code></pre>
<p>xaal-keygen will compute an key for a given passphrase. Edit the xaal.ini
file according to your needs.</p>
</section>
......@@ -704,32 +704,32 @@ container. The Dockerfile use the automatic installation script.</p>
<section id="tests">
<h2><span class="sectnum">3 </span>Tests</h2>
<p>First, you can launch a message dumper with this tools</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>xaal-dumper<span class="whitespace">
</span>$<span class="whitespace"> </span>or<span class="whitespace"> </span>xaal-tail</code></pre>
<pre class="code bash literal-block"><code>$ xaal-dumper
$ or xaal-tail</code></pre>
<p>To start an fake lamp:</p>
<pre class="code bash literal-block"><code>$<span class="whitespace"> </span>python<span class="whitespace"> </span>-m<span class="whitespace"> </span>xaal.dummy.lamp</code></pre>
<pre class="code bash literal-block"><code>$ python -m xaal.dummy.lamp</code></pre>
<p>To check devices, you can use:</p>
<pre class="code bash literal-block"><code><span class="comment single"># search alive devices
</span>$<span class="whitespace"> </span>xaal-isalive<span class="whitespace">
</span>$ xaal-isalive
</span><span class="comment single"># search lamp.basic devices
</span>$<span class="whitespace"> </span>xaal-isalive<span class="whitespace"> </span>-t<span class="whitespace"> </span>lamp.basic<span class="whitespace">
<span class="comment single"># search lamp.basic devices
</span>$ xaal-isalive -t lamp.basic
</span><span class="comment single"># search any kind of lamp
</span>$<span class="whitespace"> </span>xaal-isalive<span class="whitespace"> </span>-t<span class="whitespace"> </span>lamp.any<span class="whitespace">
<span class="comment single"># search any kind of lamp
</span>$ xaal-isalive -t lamp.any
</span><span class="comment single"># display description / attribute
</span>$<span class="whitespace"> </span>xaal-info<span class="whitespace"> </span>xxxxxxxxxxxxxx<span class="whitespace"> </span>&lt;-<span class="whitespace"> </span>uuid<span class="whitespace">
<span class="comment single"># display description / attribute
</span>$ xaal-info xxxxxxxxxxxxxx &lt;- uuid
</span><span class="comment single"># display description / attribute for all devices
</span>$<span class="whitespace"> </span>xaal-walker<span class="whitespace">
<span class="comment single"># display description / attribute for all devices
</span>$ xaal-walker
</span><span class="comment single"># same but only for lamp devices
</span>$<span class="whitespace"> </span>xaal-walker<span class="whitespace"> </span>-t<span class="whitespace"> </span>lamp.any</code></pre>
<span class="comment single"># same but only for lamp devices
</span>$ xaal-walker -t lamp.any</code></pre>
<p>To turn on/off the lamp</p>
<pre class="code bash literal-block"><code><span class="comment single"># turn on the lamp
</span>$<span class="whitespace"> </span>xaal-send<span class="whitespace"> </span>-d<span class="whitespace"> </span>xxxxxxxxxxxxxx<span class="whitespace"> </span>-r<span class="whitespace"> </span>turn_off<span class="whitespace">
</span>$<span class="whitespace"> </span>xaal-send<span class="whitespace"> </span>-d<span class="whitespace"> </span>xxxxxxxxxxxxxx<span class="whitespace"> </span>-r<span class="whitespace"> </span>turn_on</code></pre>
</span>$ xaal-send -d xxxxxxxxxxxxxx -r turn_off
$ xaal-send -d xxxxxxxxxxxxxx -r turn_on</code></pre>
</section>
<section id="informations">
<h2><span class="sectnum">4 </span>Informations</h2>
......@@ -739,17 +739,17 @@ container. The Dockerfile use the automatic installation script.</p>
or <em>xaal.zwave</em>. By convention, you can run everything just by calling the namespace
module.</p>
<pre class="code bash literal-block"><code><span class="comment single"># to run the meta data sever:
</span>$<span class="whitespace"> </span>python<span class="whitespace"> </span>-m<span class="whitespace"> </span>xaal.metadb<span class="whitespace">
</span>$ python -m xaal.metadb
</span><span class="comment single"># to run the dashboard (web interface)
</span>$<span class="whitespace"> </span>python<span class="whitespace"> </span>-m<span class="whitespace"> </span>xaal.dashboard<span class="whitespace">
<span class="comment single"># to run the dashboard (web interface)
</span>$ python -m xaal.dashboard
</span><span class="comment single"># to run the Open Weather Map gateway
</span>$<span class="whitespace"> </span>python<span class="whitespace"> </span>-m<span class="whitespace"> </span>xaal.owm</code></pre>
<span class="comment single"># to run the Open Weather Map gateway
</span>$ python -m xaal.owm</code></pre>
<p>To reduce memory footprint, you can use the <em>xaal-pkgrun</em> command. This tool will
register every package on a single Python interpreter.</p>
<pre class="code bash literal-block"><code><span class="comment single"># to run aqara and owm gateways:
</span>$<span class="whitespace"> </span>xaal-pkgrun<span class="whitespace"> </span>aqara<span class="whitespace"> </span>owm</code></pre>
</span>$ xaal-pkgrun aqara owm</code></pre>
</section>
<section id="links">
<h3><span class="sectnum">4.2 </span>Links</h3>
......
......@@ -8,7 +8,7 @@ Requirements
.. sectnum::
To install xAAL for Python, you need Python-3 (version 3.8 or above). And limited stack exists
for Python-2, you can find more informations `here <https://redmine.telecom-bretagne.eu/projects/xaal/repository/show/code/Python/branches/py2-backport>`_.
for Python-2, you can find more informations `here <https://redmine.imt-atlantique.fr/projects/xaal/repository/xaal/show/code/Python/branches/py2-backport>`_.
Un*x like
~~~~~~~~~
......@@ -77,7 +77,7 @@ Download sources from SVN:
.. code-block:: bash
$ svn checkout https://redmine.telecom-bretagne.eu/svn/xaal/code/Python/trunk/ xaal_svn
$ svn checkout https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7/ xaal_svn
First, install the xaal.lib package:
......@@ -238,5 +238,3 @@ FAQ
big packages (like PyYAML) take around 0.5 sec on a Raspy. This is way too
much for a simple command-line tools like xaal-info for example.
We want to provide a better user experience.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment