deploy: fa262fc

PandABlocks · Oct 21, 2024 · db668d3 · db668d3
1 parent 43c9462
commit db668d3
Show file tree

Hide file tree

Showing 91 changed files with 22,721 additions and 0 deletions.
diff --git a/4.0b1/.buildinfo b/4.0b1/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 422d7a8686e5442bb200749f20d6d9c7
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/4.0b1/.doctrees/contents.doctree b/4.0b1/.doctrees/contents.doctree
diff --git a/4.0b1/.doctrees/environment.pickle b/4.0b1/.doctrees/environment.pickle
diff --git a/4.0b1/.doctrees/index.doctree b/4.0b1/.doctrees/index.doctree
diff --git a/4.0b1/.doctrees/userguide/glossary.doctree b/4.0b1/.doctrees/userguide/glossary.doctree
diff --git a/4.0b1/.doctrees/userguide/monitoring_attribute_values.doctree b/4.0b1/.doctrees/userguide/monitoring_attribute_values.doctree
diff --git a/4.0b1/.doctrees/userguide/quick-start.doctree b/4.0b1/.doctrees/userguide/quick-start.doctree
diff --git a/4.0b1/.doctrees/userguide/understanding_attribute_state.doctree b/4.0b1/.doctrees/userguide/understanding_attribute_state.doctree
diff --git a/4.0b1/.doctrees/userguide/user_interface_overview.doctree b/4.0b1/.doctrees/userguide/user_interface_overview.doctree
diff --git a/4.0b1/.doctrees/userguide/working_with_a_design.doctree b/4.0b1/.doctrees/userguide/working_with_a_design.doctree
diff --git a/4.0b1/_images/PANDA-block-details.png b/4.0b1/_images/PANDA-block-details.png
diff --git a/4.0b1/_images/PANDA-layout-spread-out.png b/4.0b1/_images/PANDA-layout-spread-out.png
diff --git a/4.0b1/_images/PANDA-layout.png b/4.0b1/_images/PANDA-layout.png
diff --git a/4.0b1/_images/PANDA-new-link.png b/4.0b1/_images/PANDA-new-link.png
diff --git a/4.0b1/_images/attribute_lifecycle.svg b/4.0b1/_images/attribute_lifecycle.svg
diff --git a/4.0b1/_images/attribute_table.png b/4.0b1/_images/attribute_table.png
diff --git a/4.0b1/_images/attribute_value_table.png b/4.0b1/_images/attribute_value_table.png
diff --git a/4.0b1/_images/attribute_view_chart.png b/4.0b1/_images/attribute_view_chart.png
diff --git a/4.0b1/_images/block-list.png b/4.0b1/_images/block-list.png
diff --git a/4.0b1/_images/chart_options.png b/4.0b1/_images/chart_options.png
diff --git a/4.0b1/_images/disconnected_icon.png b/4.0b1/_images/disconnected_icon.png
diff --git a/4.0b1/_images/error_icon.png b/4.0b1/_images/error_icon.png
diff --git a/4.0b1/_images/information_icon.png b/4.0b1/_images/information_icon.png
diff --git a/4.0b1/_images/layout-button.png b/4.0b1/_images/layout-button.png
diff --git a/4.0b1/_images/locally_edited_icon.png b/4.0b1/_images/locally_edited_icon.png
diff --git a/4.0b1/_images/starting-ui.png b/4.0b1/_images/starting-ui.png
diff --git a/4.0b1/_images/ui_schematic.png b/4.0b1/_images/ui_schematic.png
diff --git a/4.0b1/_images/warning_icon.png b/4.0b1/_images/warning_icon.png
diff --git a/4.0b1/_images/window_popping_output.svg b/4.0b1/_images/window_popping_output.svg
diff --git a/4.0b1/_sources/contents.rst.txt b/4.0b1/_sources/contents.rst.txt
@@ -0,0 +1,22 @@
+Contents
+========
+
+.. toctree::
+    :caption: Overview
+
+    index
+
+.. toctree::
+    :caption: User Guide
+
+    userguide/quick-start
+    userguide/user_interface_overview
+    userguide/working_with_a_design
+    userguide/monitoring_attribute_values
+    userguide/understanding_attribute_state
+
+.. toctree::
+    :caption: Reference
+
+    userguide/glossary
+
diff --git a/4.0b1/_sources/index.rst.txt b/4.0b1/_sources/index.rst.txt
@@ -0,0 +1,17 @@
+Introduction
+============
+
+The PandABlocks-webcontrol package provides a webserver for a PandA. This
+exposes a browser based Graphical User Interface (GUI) that can be used to:
+
+- Inspect the available Functional Blocks present on the system
+- Connect Blocks together
+- Set and view Block parameters
+- Save a Design consisting of a number of connected Blocks and their parameters
+- Load a previously saved Design
+
+The documentation has two starting points:
+
+- The `Quick Start` gives a simple walkthrough on how to connect blocks together
+- The `User Interface Overview` and onwards gives more in depth information
+
diff --git a/4.0b1/_sources/userguide/glossary.rst.txt b/4.0b1/_sources/userguide/glossary.rst.txt
@@ -0,0 +1,183 @@
+Glossary
+========
+
+.. ##########
+.. links to external PandA related documentation
+.. ##########
+
+.. _PandABlocks-FPGA: https://pandablocks-fpga.readthedocs.io
+.. _malcolm: https://pymalcolm.readthedocs.io
+
+These are some commonly used terms in this documentation.
+
+.. glossary::
+
+  Attribute
+
+    A property of a `block`.
+
+    Attributes are divided into four categories based on their purpose:
+
+        * `Parameter Attribute`
+        * `Input Attribute`
+        * `Output Attribute`
+        * `Readback Attribute`
+
+  Attribute Group
+
+    A logically grouping of related `attributes <attribute>` within a `block`.
+
+    Within the user interface these are represented as a collapsable block
+    within the overall `Block Information Panel`.
+
+
+  Block
+
+    The graphical manifestation of a component within a `design`, encapsulating
+    its attributes, methods and connectivity to other blocks.
+
+    Blocks may represent, for example:
+
+        * Input and output controllers (interfaces to the FPGA).
+        * Configurable clocks.
+        * Logic lookup tables and logic gates.
+
+    A Block is defined my its underlying Block specification, which is
+    interrogated by `malcolm`_ and reflected into the user interface. For
+    example, the list of supported blocks available for a PandA device is
+    described in `PandABlocks-FPGA`_ documentation.
+
+
+  Block Information Panel
+
+    Panel displayed within the user inferface containing details of the
+    `attributes <attribute>` and `methods <method>` associated with the
+    currently selected `block` within the `layout`.
+
+
+  Child Block
+
+    A `block` within the `layout` of a `Parent Block`.
+
+    A Child Block may itself represent a Parent Block if its own functionality
+    can be further decomposed.
+
+
+  Design
+
+    The technical definition of the overall system, or a component within it,
+    describing the `blocks <block>` it contains, their `attributes <attribute>`
+    and the `links <link>` between them.  A Design is represented as a
+    `Parent Block` within the user interface.
+
+    Designs are presented graphically as a `layout` within the 'Layout Panel'
+    on the web interface allowing a user to build, configure and manage the
+    system represented by that Design.
+
+
+  Design Element
+
+    A generic term for any `block`, `attribute` or `link` currently forming the
+    focus of interest within the `layout` view of the PandABox User Interface.
+
+
+  Flowgraph
+
+    The graphical representation of a `design` showing the `Design Element`
+    within the Control System as presented within the user interface 'Layout
+    View'.
+
+
+  Input Attribute
+
+    An Input Attribute identifies the value (or stream of values) that will be
+    received into a `block` via a `Sink Port` on the Block to which the
+    attribute relates.  There is a 1:1 mapping between Input Attribute and Sink
+    Port.
+
+
+  Input Port
+
+    Synonym for `Sink Port`.
+
+
+  Layout
+
+    The graphical representation of a `design` within the web interface showing
+    the `blocks <block>` within the Design and the `links <link>` between them
+    based on the selected `Root Block`.
+
+
+  Link
+
+    The mechanism of transferring content from a `Source Port` in one `block`
+    to a `Sink Port` in a second Block.  Links can only be made between ports
+    of the same logical type (e.g. Boolean -> Boolean, int32 -> int32).
+
+
+  Method
+
+    Defines an **action** that can be performed by a `block` in support of the
+    purpose of that block.
+
+
+  Output Attribute
+
+    An Output Attribute identifies the value (or stream of values) that will be
+    transmitted via a `Source Port` out of the `block` to which the attribute
+    relates.  There is a 1:1 mapping between Output Attribute and Source Port.
+
+
+  Output Port
+
+    Synonym for `Source Port`.
+
+
+  Parameter Attribute
+
+    An attribute whose value can be set by a User within a `block` in order to
+    influence the behaviour of that `block`.
+
+
+  Parent Block
+
+    A `block` aggregating one-or-more `Child Blocks <Child Block>` each
+    performing an action or activity in support of its parent's functionality.
+
+    Parent blocks, together with their attributes and methods are typically
+    presented in the left-hand panel of the web interface when open in Layout
+    View.
+
+  Readback Attribute
+
+    An Attribute whose value is set automatically by a process within the
+    execution environment.  Readback attributes cannot be set manually via the
+    User Interface.
+
+
+  Root Block
+
+    The outermost entity defining the content presented within the user
+    interface.  If the outermost Block representing a `design` is selected this
+    encapulates the entire `design`, from where a user can 'drill down' to an
+    area of interest.  Otherwise the Root Block represents any configured
+    `block` within the `design`.
+
+
+  Source Port
+
+    A port on a `block` responsible for transmitting data generated within that
+    Block.
+
+    Every Source Port within a Block has a pre-defined type as described in the
+    Block specification.
+
+
+  Sink Port
+
+    A port on a `block` responsible for accepting data for utilisation within
+    that Block.
+
+    Every Sink Port within a Block has a pre-defined type as described in the
+    Block specification.
+