Allow custom ports

.gitignore

@@ -1,2 +1,222 @@
-__pycache__
 FBs/.vscode/tasks.json
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

README.md

@@ -2,47 +2,49 @@
 
 This repository is dedicated to all Function Blocks that might be used in DINASORE and 4DIAC already with a folder organization suitable to several needs. The main idea is to add new or update Functions Blocks according to new developments.
 
+To sync the function blocks with your DINASORE instances, see [sync](#sync).
+
 ## FBs
 
 The "FBs" folder contains the set of previously mentioned function blocks. What follows is a brief description of the contents of each sub-folder.
 
-### ARITHMETIC
+#### ARITHMETIC
 
 In this folder you will find function blocks that perform relatively simple mathematical calculations.
 
-### CLUSTERING
+#### CLUSTERING
 
 This folder contains function blocks that perform clustering methods.
 
-### DATA_HANDLING
+#### DATA_HANDLING
 
 This folder contains function blocks that handle the data that is given to them without changing its value.
 
-### DATA_TRANSFORMATIONS
+#### DATA_TRANSFORMATIONS
 
 In this folder you will find function blocks that perform certain operations on data, changing its value.
 
-### DB
+#### DB
 
 This folder contains function blocks for access and usage of databases.
 
-### FILES_AND_PLOTS
+#### FILES_AND_PLOTS
 
 This folder contains function blocks that read data from files and plot the respective graphs and other representations.
 
-### MISCELLANEOUS
+#### MISCELLANEOUS
 
 In this folder you will find function blocks that do not fit in any of the other categories. 
 
-### MQTT
+#### MQTT
 
 In this folder you will find function blocks that make use of the MQTT protocol for communication.
 
-### OPC-UA
+#### OPC-UA
 
 This folder contains function blocks that make use of the OPC-UA protocol for information display/fetch.
 
-#### INFO_WRAPPER
+##### INFO_WRAPPER
 
 <br>
 <div align="center"><img src="https://user-images.githubusercontent.com/47611246/134160017-59b17d7d-5d91-4708-aeb9-8570a8b76b30.png" /></div>
@@ -67,7 +69,7 @@ You can decide what the inputs are for the method by filling out the FB's INPUT
 
 **Note:** When you deploy a pipeline that is wrapped by INFO_WRAPPER to DINASORE from 4DIAC, DINASORE checks to see which inputs already have a value assigned to them. Consequently, if you specify the value of an input in 4DIAC, you will not have to specify its value again when calling the method.   
 
-#### METHOD_CALLER
+##### METHOD_CALLER
 
 <br>
 <div align="center"><img src="https://user-images.githubusercontent.com/47611246/134162073-a55f7d1e-838b-4e69-8fb5-9a983f149e99.png" /></div>
@@ -83,25 +85,31 @@ The METHOD_CALLER function block calls the OPC-UA that is specified in its prope
 
 The OUTPUT will be a list in the same format as INPUT_VARS. Its values are the ones from the pipeline that the method has finished calling.
 
-### OPTIMIZATION
+#### OPTIMIZATION
 
 This folder contains function blocks that optimize the inputs given.
 
-### SENSORS_AND_SIMULATORS
+#### SENSORS_AND_SIMULATORS
 
 This folder contains function blocks that are either sensors, simulators or tools for either of these types of function blocks.
 
-### TEST
+#### TEST
 
 This folder contains function blocks that are used by DINASORE's unit tests.
 
-### USE_CASES
+#### USE_CASES
 
 This folder further contains more folders, each representing a specific use case (pipeline) for which the function blocks that they contain were used.
 
 ## sync
 
-The "sync" folder is a package that allows you to synchronize your "FBs" folder with other local or remote DINASOREs. Synchronization with remote DINASORES requires an SSH connection with the device running the DINASORE in question. Instructions are as follows.
+The "sync" folder is a package that allows you to synchronize your "FBs" folder with other local or remote DINASOREs.
+
+If the the DINASORE is running local (and not in a Docker), set the address to `localhost` and the port to `-1`.
+
+Synchronization with remote DINASORES requires an SSH connection with the device running the DINASORE in question. Setup a SSH connection in the device running DINASORE using "openssh-server" for example. In your machine you should be able to SSH into the device like `ssh root@x.x.x.x -p 22`.
+
+If you are using Docker locally, don't forget to map the SSH port (by default 22) to the host. The address to be used in Docker locally should be `localhost`. So you would run `ssh root@localhost -p 22`.
 
 ### config.json
 
@@ -113,6 +121,7 @@ In this package you will find a configuration file called "config.json". This fi
     "dinasores": [ # array of dinasores to be synchronized       
         {
             "address": # DINASORE address ,
+            "port": # DINASORE port ,
             "usename": # SSH username ,
             "password": # SSH password ,
             "dinasore-path": # path to the DINASORE root folder in the device running the DINASORE in question
@@ -129,10 +138,12 @@ In this package you will find a configuration file called "config.json". This fi
     "dinasores": [
         {
             "address": "localhost",
+            "port": -1,
             "dinasore-path": ".../dinasore"
         },
         {
             "address": "192.168.1.14",
+            "port": 22,
             "username": "pi",
             "password": "raspberry"
             "dinasore-path": ".../dinasore"

sync/base_sync.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 
 class BaseSync(ABC):
-    
+
     @abstractmethod
     def synchronize(self):
         pass

sync/config.json

@@ -1,10 +1,11 @@
 {
-    "master-fbs-path": "C:/Users/Rafael/Documents/dinasore_function_blocks/FBs",
-    "dinasores": [        
+    "master-fbs-path": "./FBs",
+    "dinasores": [
         {
             "address": "localhost",
-            "dinasore-path": "C:/Users/Rafael/Documents/dinasore-cluster/dinasore-2/dinasore-ua" 
+            "port": 22,
+            "dinasore-path": "/dinasore"
         }
     ],
-    "strategy": ""
-}
+    "strategy": "wipe"
+}