Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kcech committed May 7, 2019
1 parent dcef01c commit 7006070
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 13 deletions.
Binary file modified docs/_static/images/catalog_and_maps/sensor_detail.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 41 additions & 11 deletions docs/catalog_and_maps.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -944,8 +944,8 @@ respectively).

.. _details-3:

Details
^^^^^^^
Details Tab
^^^^^^^^^^^

The detail page of a sensor is structured into four tabs:

Expand Down Expand Up @@ -993,9 +993,18 @@ The main properties of the *Details* tab are the following:
| | | from a list of |
| | | available types |
+-----------------------+-----------------------+-----------------------+
| Data type | Type of data | Mandatory. Numeric, |
| | published by the | text or boolean |
| | sensor | |
| Data type | Type of data | Mandatory. Possible |
| | published by the | values are: |
| | sensor | - Audio Link |
| | | - Boolean |
| | | - File link |
| | | - Image link |
| | | - JSON |
| | | - Link |
| | | - Numerical |
| | | - Text |
| | | - Video Link |
| | | |
+-----------------------+-----------------------+-----------------------+
| Unit | Measurement unit | |
+-----------------------+-----------------------+-----------------------+
Expand Down Expand Up @@ -1036,11 +1045,22 @@ The main properties of the *Details* tab are the following:
| | | mongoDB. No default |
| | | value. |
+-----------------------+-----------------------+-----------------------+
| TTL (min) | Time of expitation of | This value can be |
| | the sensor in minutes | configured only |
| | | from the catalog, |
| | | Only admin should |
| | | control this value. |
| | | The default value is |
| | | redis.expire.data.seco|
| | | nds from the plantform|
| | | server jedis-config.pr|
| | | operties. |
+-----------------------+-----------------------+-----------------------+

.. _technical-details-1:

Technical details
^^^^^^^^^^^^^^^^^
Technical details tab
^^^^^^^^^^^^^^^^^^^^^

As noted above, this tab displays a set of properties related to the
technical details of the sensor ( such as the *manufacturer*, the
Expand All @@ -1051,14 +1071,24 @@ described in the component section) as shown in the following picture:

.. _additional-information-1:

Additional information
^^^^^^^^^^^^^^^^^^^^^^

Visual configuration tab
^^^^^^^^^^^^^^^^^^^^^^^^

The only configurable option in this tab is "Chart values number".
This integer indicates how many measures will be show in the observation chart of the sensor.




Additional information tab
^^^^^^^^^^^^^^^^^^^^^^^^^^

As mentioned early, the meaning of this tab is the same as described for
the components.

Latest data
'''''''''''
Latest data tab
'''''''''''''''

This tab, as shown in the following picture:

Expand Down
2 changes: 0 additions & 2 deletions docs/extensions.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,6 @@ The Kafka agent publishes Sentilo events to Kafka.
+--------------------------+----------------+-----------------------------------------------------------------------------------------------------+
| kafka.bootstrap.servers | localhost:9092 | Comma-separated list of Kafka brokers |
+--------------------------+----------------+-----------------------------------------------------------------------------------------------------+
| kafka.topic.prefix | sentilo | |
+--------------------------+----------------+-----------------------------------------------------------------------------------------------------+
| zookeeper.nodes | localhost:2181 | Comma-separated list of Zookeeper nodes |
+--------------------------+----------------+-----------------------------------------------------------------------------------------------------+
| batch.workers.size | 10 | Number of worker threads |
Expand Down

0 comments on commit 7006070

Please sign in to comment.