Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kcech committed May 9, 2019
1 parent 82175ce commit a442494
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/_themes/sentilo_sphinx_rtd_theme/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
</div>

{%- if show_sphinx %}
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a modified <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
{%- endif %}

{%- block extrafooter %} {% endblock %}
Expand Down
9 changes: 4 additions & 5 deletions docs/catalog_and_maps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ number of sensors registered, current requests per second, max daily
average and max average requests per second, ….. These values are
automatically updated every 30 seconds.

.. image:: _static/images/catalog_and_maps/stats_170_001.jpg
.. image:: _static/images/catalog_and_maps/stats_001.jpg

It also shows a time-series graph which displays the platform activity
(such as observations, orders and alarms) for the last 100 minutes. This
graph is automatically updated every 5 minutes.

.. image:: _static/images/catalog_and_maps/stats_170_002.jpg
.. image:: _static/images/catalog_and_maps/stats_002.jpg

Navigate the last data chart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -256,13 +256,12 @@ The organization is the entity that describes the Sentilo instance.
Detail
^^^^^^

By default, this organization is created and it identifier is
By default, this organization is created and its identifier is
**sentilo**.

.. image:: _static/images/catalog_and_maps/Organitzation_detail.png

We can access to the parameter edition form, where we can edit the
organization name and several contact details.
We can also edit the organization's name other contact details, except the.

Config params
^^^^^^^^^^^^^
Expand Down
28 changes: 14 additions & 14 deletions docs/tutorials.rst → docs/clients.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Tutorials
=========
Clients
=======

Contents:

.. toctree::
:maxdepth: 1

tutorials/java_client
tutorials/raspberrypi_client
tutorials/arduino_client
clients/java_client
clients/raspberrypi_client
clients/arduino_client

On this page you will find several tutorials about how to connect to
Sentilo using various existing platforms and languages.
Expand Down Expand Up @@ -39,21 +39,21 @@ Sentilo using various existing platforms and languages.
| Platform |
+-----------------------------------+

.. _Java Client: ./tutorials/java_client.html
.. _RaspberryPi Client: ./tutorials/raspberrypi_client.html
.. _Arduino Client: ./tutorials/arduino_client.html
.. _Java Client: ./clients/java_client.html
.. _RaspberryPi Client: ./clients/raspberrypi_client.html
.. _Arduino Client: ./clients/arduino_client.html

.. |java_logo.jpg| image:: _static/images/tutorials/java_logo.jpg
.. |java_logo.jpg| image:: _static/images/clients/java_logo.jpg
:width: 202px
:height: 113px
:target: tutorials/java_client.html
:target: clients/java_client.html

.. |raspberrypi.jpeg| image:: _static/images/tutorials/raspberrypi.jpeg
.. |raspberrypi.jpeg| image:: _static/images/clients/raspberrypi.jpeg
:width: 215px
:height: 122px
:target: ./tutorials/raspberrypi_client.html
:target: ./clients/raspberrypi_client.html

.. |arduino-mega-2560-r3.jpg| image:: _static/images/tutorials/arduino-mega-2560-r3.jpg
.. |arduino-mega-2560-r3.jpg| image:: _static/images/clients/arduino-mega-2560-r3.jpg
:width: 216px
:height: 157px
:target: ./tutorials/arduino_client.html
:target: ./clients/arduino_client.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Arduino Client
==============

.. figure:: ../_static/images/tutorials/arduino-mega-2560-r3.jpg
.. figure:: ../_static/images/clients/arduino-mega-2560-r3.jpg
:alt: Arduino

The **SentiloClient Library** for Arduino offers a basic C++ library
Expand Down Expand Up @@ -796,4 +796,4 @@ As you can see, the type is generic and the data type is text, because
this is the best way to publish any data without any format problem.


.. |arduino_sensors_board.png| image:: ../_static/images/tutorials/arduino_sensors_board.png
.. |arduino_sensors_board.png| image:: ../_static/images/clients/arduino_sensors_board.png
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Java Client
===========

.. figure:: ../_static/images/tutorials/java_logo.jpg
.. figure:: ../_static/images/clients/java_logo.jpg
:alt: Java

The Sentilo Java Client is a library developed for working with webapps
Expand All @@ -25,12 +25,12 @@ Software
You’ll need some software packages, as you’re developing in Java
environment:

- Java SE 1.6
- Java SE 1.8
- Eclipse IDE or STS Spring IDE
- The **Sentilo Client Java Library**, which you can download and
install it as a *Maven dependency* into your project (please, see the
**pom file** in the project form more information)
- Tomcat 7
- Tomcat 7+
- Some other Maven dependencies(you can see them in the **pom file** of
the example project):

Expand Down Expand Up @@ -409,4 +409,4 @@ As you can see, there’s a button named *Send observations*. You can use
to re-send observations and reload the page. Every page reload send the
observatios to the Sentilo Platform Client.

.. |java_sample_4.jpg| image:: ../_static/images/tutorials/java_sample_4.jpg
.. |java_sample_4.jpg| image:: ../_static/images/clients/java_sample_4.jpg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RaspberryPi Client
==================

.. figure:: ../_static/images/tutorials/raspberrypi.jpeg
.. figure:: ../_static/images/clients/raspberrypi.jpeg
:alt: RaspberryPi

The **SentiloClientNodej** is a library written in javascript that
Expand Down Expand Up @@ -816,4 +816,4 @@ properties, as you need:
For our purpose, we only have DEBUG, INFO and ERROR logs. Try tu use
**true** or **false** for each one.

.. |raspi3.png| image:: ../_static/images/tutorials/raspi3.png
.. |raspi3.png| image:: ../_static/images/clients/raspi3.png
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Contents:
monitorization
catalog_and_maps
multitenant
tutorials
clients
technical_faq
platform_testing
use_a_virtual_machine

0 comments on commit a442494

Please sign in to comment.