oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/feature/2887-Align_Node_Types' into feature/3062-discriminators

Browse Source
This commit is contained in:
Marek Wolan
2025-02-04 15:20:48 +00:00
parent 7ebe7fa4ef 51bb3f5b07
commit f0326f4051
14 changed files with 35 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/how_to_guides/extensible_nodes.rst
View File

@@ -18,8 +18,7 @@ Node classes all inherit from the base Node Class, though new classes should inh
The use of an `__init__` method is not necessary, as configurable variables for the class should be specified within the `config` of the class, and passed at run time via your YAML configuration using the `from_config` method.
An example of how additional Node classes is below, taken from `router.py` withing PrimAITE.
An example of how additional Node classes is below, taken from `router.py` within PrimAITE.
.. code-block:: Python
@@ -53,4 +52,4 @@ class Router(NetworkNode, identifier="router"):
Changes to YAML file.
=====================
Nodes defined within configuration YAML files for use with PrimAITE 3.X should still be compatible following these changes.
While effort has been made to ensure that nodes defined within configuration YAML files for use with PrimAITE 3.X remain compatible with PrimAITE v4+, it is encouraged to review for minor changes needed.