QT/Serial-Studio
1
0
Fork 0
mirror of https://github.com/Serial-Studio/Serial-Studio.git synced 2025-01-31 17:42:55 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alex Spataru 2024-11-13 19:00:43 -05:00 committed by GitHub
parent cc8609cd94
commit 2b6f9912ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
examples/README.md
View File

@ -38,20 +38,17 @@ This directory contains various examples demonstrating how to use Serial Studio
### 5. UDP Function Generator ### 5. UDP Function Generator
- **Description**: This example generates real-time waveforms (sine, triangle, sawtooth, and square) and transmits them over an UDP socket locally. It is designed to generate data that can be visualized in **Serial Studio**, where you can observe and analyze the generated signals in real-time. The program is versatile and can also be used to stress-test Serial Studio's performance under continuous, high-frequency data streams. - **Description**: This example generates real-time waveforms (sine, triangle, sawtooth, and square) and transmits them over an UDP socket locally. It is designed to generate data that can be visualized in **Serial Studio**, where you can observe and analyze the generated signals in real-time. The program is versatile and can also be used to stress-test Serial Studio's performance under continuous, high-frequency data streams.
- **Contents**: - **Contents**:
- **udp_function_generator.c**: The main C program that generates waveforms and sends them via UDP. - **udp_function_generator.c**: The main C program that generates waveforms and sends them via UDP.
- **README.md**: Detailed setup and usage instructions for configuring and running the program with Serial Studio. - **README.md**: Detailed setup and usage instructions for configuring and running the program with Serial Studio.
- **Screenshots**: Includes `serial-studio-setup.png` for configuration and `waveform-visualization.png` showcasing real-time waveform plots in Serial Studio. - **Screenshots**: Includes `serial-studio-setup.png` for configuration and `waveform-visualization.png` showcasing real-time waveform plots in Serial Studio.
- **Key Features**: - **Key Features**:
- Generates multiple waveform types: sine, triangle, sawtooth, and square. - Generates multiple waveform types: sine, triangle, sawtooth, and square.
- Configurable waveform properties: frequency, phase, and transmission interval. - Configurable waveform properties: frequency, phase, and transmission interval.
- Sends waveform data over UDP, making it ideal for network-based signal processing. - Sends waveform data over UDP, making it ideal for network-based signal processing.
- Option to print generated data for debugging and analysis. - Option to print generated data for debugging and analysis.
- Warns about high frequencies that may cause aliasing or distortion. - Warns about high frequencies that may cause aliasing or distortion.
- :warning: Using sub-millisecond intervals is likely to overload Serial Studio's event system, potentially causing crashes and/or hangs. If you encounter this issue, consider running Serial Studio with a debugger and sharing your findings to help improve and address this limitation in future releases. Your feedback is invaluable in making Serial Studio more robust!
:warning: Using sub-millisecond intervals is likely to overload Serial Studio's event system, potentially causing crashes and/or hangs. If you encounter this issue, consider running Serial Studio with a debugger and sharing your findings to help improve and address this limitation in future releases. Your feedback is invaluable in making Serial Studio more robust!
## Getting Started ## Getting Started