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-29 13:35:53 -05:00 committed by GitHub
parent 149bef77c6
commit 488584c5e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
examples/LorenzAttractor/README.md
View File

@ -8,8 +8,6 @@ The Lorenz system, introduced by Edward Lorenz in 1963, is a set of three couple
![Lorenz Attractor in Serial Studio](doc/screenshot.png) ![Lorenz Attractor in Serial Studio](doc/screenshot.png)
---
## **Lorenz System Basics** ## **Lorenz System Basics**
The system is governed by the following equations: The system is governed by the following equations:
@ -31,16 +29,12 @@ Where:
The Arduino program uses the **Euler method** for numerical integration to calculate the system's state over time. The Arduino program uses the **Euler method** for numerical integration to calculate the system's state over time.
---
## **Project Features** ## **Project Features**
- **Real-Time Visualization**: View the Lorenz attractor's chaotic motion in real time. - **Real-Time Visualization**: View the Lorenz attractor's chaotic motion in real time.
- **Custom X-Axis Configuration**: Use Serial Studio's project editor to select datasets as X-axis sources. - **Custom X-Axis Configuration**: Use Serial Studio's project editor to select datasets as X-axis sources.
- **Dynamic Visualization**: Plot $x$, $y$, and $z$ values on 2D or 3D graphs using Serial Studio. - **Dynamic Visualization**: Plot $x$, $y$, and $z$ values on 2D or 3D graphs using Serial Studio.
---
## **Hardware Setup** ## **Hardware Setup**
### **Requirements** ### **Requirements**
@ -50,8 +44,6 @@ The Arduino program uses the **Euler method** for numerical integration to calcu
### **Connections** ### **Connections**
No additional hardware is required beyond the Arduino. Ensure the Arduino is connected to your computer via USB. No additional hardware is required beyond the Arduino. Ensure the Arduino is connected to your computer via USB.
---
## **Arduino Sketch** ## **Arduino Sketch**
The provided Arduino code simulates the Lorenz attractor and transmits the calculated values $x$, $y$ and $z$ to Serial Studio. Here's the complete code: The provided Arduino code simulates the Lorenz attractor and transmits the calculated values $x$, $y$ and $z$ to Serial Studio. Here's the complete code:
@ -109,8 +101,6 @@ void loop() {
} }
``` ```
---
## **Serial Studio Configuration** ## **Serial Studio Configuration**
### **1. Setting Up the Project** ### **1. Setting Up the Project**
@ -132,16 +122,12 @@ Here’s how your project editor should look:
![Serial Studio Project Setup](doc/project-setup.png) ![Serial Studio Project Setup](doc/project-setup.png)
---
## **Custom X-Axis Example** ## **Custom X-Axis Example**
With Serial Studio's new custom X-axis feature, you can map any dataset to serve as the X-axis source for plots. This is particularly useful for: With Serial Studio's new custom X-axis feature, you can map any dataset to serve as the X-axis source for plots. This is particularly useful for:
- Plotting values against elapsed time or packet numbers. - Plotting values against elapsed time or packet numbers.
- Creating advanced visualizations like the Lorenz attractor. - Creating advanced visualizations like the Lorenz attractor.
---
## **Troubleshooting** ## **Troubleshooting**
- **No Data Appears**: - **No Data Appears**: