You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This library is used to control one or more stepper motors with a ESP 32 module.
7
7
## Features
8
8
9
9
The library provides the following features:
10
-
- generating pulses for a connected stepper driver with a dir and step input
10
+
- generating pulses for a connected stepper driver with a direction and step input
11
11
- connection of emergency switch to stop all motion immendiately
12
12
- connection of limit switches / homing switches
13
13
- blocking and non blocking function calls possible
@@ -40,12 +40,12 @@ Decision matrix:
40
40
| --- | --- |
41
41
| You are using Wifi / Bluetooth or BLE in your project | if you send/receive data while the motor is moving: start the service on core 1<br/>if you only send / receive data while the motor is not moving: you might get away with starting the service on core 0, if you experience jitter, start it on core 1 |
42
42
| You are NOT using Wifi / Bluetooth or BLE in your project | start the service on core 0 |
43
-
| You have a lot of code in your loop() function that takes a lot of time for each loop execution | if you are not using wireless communication: start the service on core 0<br/>if you are using wireless communication, go to line one of this decision matrix, if this does not help you will most likely need to optimize your loop() function execution time or move to a event/interrupt based design |
43
+
| You have a lot of code in your loop() function that takes a lot of time for each loop execution | if you are not using wireless communication: start the service on core 0<br/>if you are using wireless communication, go to line one of this decision matrix, if this does not help you will most likely need to optimize your loop() function execution time or move to a event/interrupt based design. You can also try to increase the task priorty of the ESP Flexy Stepper task in ESP_FlexyStepper.cpp in the xTaskCreatePinnedToCore(...) function call|
44
44
45
45
For more details on the topic you can also have a look at the discussion in issue #4: https://github.com/pkerspe/ESP-FlexyStepper/issues/4
46
46
47
47
48
-
## Example
48
+
## Example Code
49
49
50
50
The following is an example of how to use the library as a service running in the "background" as a separate Task on the ESP32:
51
51
@@ -96,7 +96,7 @@ void loop()
96
96
}
97
97
98
98
// Notice that you can now do whatever you want in the loop function without the need to call processMovement().
99
-
// also you do not have to care if your loop processing times are too long.
99
+
// also you do not have to care if your loop processing times are too long (you might experience some jitter though if you do).
0 commit comments