Merge branch 'master' of https://git.mylab.th-luebeck.de/fabian.john/cosa-tools-matlab

README.md

+Repo for MATLAB-Code used on a RedPitaya device
+-----
+
+Basic functionalities provided to access the RedPitaya via MQTT.  
+A oscilloscope and a signalgenerator are implemented via MQTT.
+
+### Hardware requirements:
+
+RedPitaya Stemlab Board 125-14 (V1.1)  
+5 Volt RedPitaya PSU  
+Ethernet Cable / Wifi-Stick  
+
+### Software requirements:
+MATLAB installed  
+Python 3 installed (3.8 tested)  
+Mosquitto MQTT Client installed  
+MQTT Broker access  
+
+
+### Folder structure:
+
+#### 1. [lib](./lib):
+
+The "cosaMqttClient.py" contains MQTT-functions to send messages understood by a python library.  
+And "mqtt_py_matlab.m" contains MQTT-functions used in MATLAB.  
+
+
+#### 1.1 [redpitaya](./lib/redpitaya):
+
+Contains classes to store the structure of the oscilloscope signalgenerator.  
+The "OscilloscopeProperties" class stores all values needed to control the oscilloscope.  
+The "SigGenProperties" class stores general values to generate waveforms.  
+Each waveform has a own class to store specific info.  
+The general values are inherited by the "SigGenProperties" class.  
+
+#### 2. [examples](./examples):
+
+Contains "test_mqtt_py.m" to explain basic mqtt transmissions.
+
+
+#### 2.1 [redpitaya](./examples/redpitaya):
+
+Collection of redpitaya specific examples.  
+The "analog\_read\_slow\_example.m" explains the usage of the external pin header to analog read by the ADC.  
+The "Oscilloscope_example.m" show how the "OscilloscopeProperties" class is applied on a RedPitaya.  
+The "SignalGenerator_example.m" show how the "SigGenProperties" class is applied on a RedPitaya.  
+
+#### 2.1 [py_venv](./examples/py_venv):
+
+Virtual Python3 environment. Not commited to the main branch.