doc/about.rst
author Edouard Tisserant <edouard@beremiz.fr>
Mon, 15 Jul 2024 09:40:11 +0200
changeset 3988 150599d9073f
parent 3942 ac6408084c60
permissions -rw-r--r--
MQTT: WIP, subscibed topics have no "Retained" attribute.

Allow subscribed and published data models to be different, by removing "Retained" column.
3942
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     1
About this document
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     2
============================
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     3
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     4
..
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     5
    TODO: take content from https://hg.beremiz.org/beremiz_docs/
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     6
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     7
Who Should Read This Document
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     8
----------------------------------------------
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
     9
If you are new to the Beremiz IDE and want to get started with it or upgrading from
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    10
previous versions then You should read this document.
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    11
In order to properly understand this document, it is necessary to understand at least basics of the
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    12
PLC and HMIs.
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    13
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    14
Terminology
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    15
--------------------------------------------------
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    16
Throughout this manual, various phrases are used. Here is a description of some of them.
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    17
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    18
PLC
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    19
^^^^
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    20
This means programmable logical controllers
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    21
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    22
HMI
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    23
^^^^
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    24
This means Human Machine Interface
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    25
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    26
Beremiz IDE
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    27
^^^^^^^^^^^^
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    28
This is the programming software for PLC which is Beremiz IDE
ac6408084c60 Doc: Add about section (PR #33)
Nadim Khan <34601107+nadim4114@users.noreply.github.com>
parents:
diff changeset
    29