Skip to content

Commit

Permalink
Custom profile documentation added.
Browse files Browse the repository at this point in the history
  • Loading branch information
glaslos committed Apr 24, 2013
1 parent 6ebe44a commit 0ad5bd0
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ Contents:
.. toctree::
:maxdepth: 2

development/index
installation/index
usage
development/index


Indices and tables
Expand Down
50 changes: 50 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Using Conpot
============

Creating custom profiles
------------------------

Conpot comes with a ``default.xml`` profile in the templates directory.

Modbus template
~~~~~~~~~~~~~~~

The ``<slave />`` section allows you to define the slaves. Every slave definition is separated into ``<blocks />``.

An binary output block has the type ``COILS``, binary input blocks ``DISCRETE_INPUTS``. You define the starting address
and size. ``ANALOG_INPUTS`` hold data in byte size.

In the ``<values />`` section you take the starting address and fill the field with values. The content is evaluated so
you can easily fill it with random values.

::

<block name="a">
<!-- COILS/DISCRETE_OUTPUTS aka. binary output, power on/power off
Here we map modbus addresses 1 to 127 to S7-200 PLC Addresses Q0.0 to Q15.7 -->
<type>COILS</type>
<starting_address>1</starting_address>
<size>128</size>
<values>
<value>
<address>1</address>
<!-- Will be parsed with eval() -->
<content>[random.randint(0,1) for b in range(0,128)]</content>
</value>
</values>
</block>

``HOLDING_REGISTERS`` can be considered as temporary data storage. You define them with the starting address and their
size. Holding registers don't have any initial value.

SNMP template
~~~~~~~~~~~~~

In the ``<snmp />`` section you define a management information base (MIB). MIBs consist of a ``<symbol>`` with a name
attribute, and its ``<value>``.

::

<symbol name="sysDescr">
<value>Siemens, SIMATIC, S7-200</value>
</symbol>

0 comments on commit 0ad5bd0

Please sign in to comment.