From d36e5416250d6a23ae56d1828740067eea3a2257 Mon Sep 17 00:00:00 2001 From: vitrinekast Date: Wed, 22 May 2024 11:57:11 +0200 Subject: [PATCH] update readme with OSC messages --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/README.md b/README.md index e69de29..d8d6755 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,50 @@ +# Printer Jam + +The arduino side of printer jam, where we listen to OSC messages and instruct our printers to execute the messages. + +## Libraries: +- [ArduinoOSC](https://github.com/hideakitai/ArduinoOSC); +- [Adafruit Motor Shield V2](https://adafruit.github.io/Adafruit_Motor_Shield_V2_Library/html/index.html); +- + +The following OSC messages are implemented: + +#### /stopAll +Stops all the motors and stepper motors from running +_note: for the stepper motor, release could indicate to keep spinning forever.. let's see!_ +#### /black/feed/f +Run the feed motor of the black printer forwards +#### /black/feed/b +Run the feed motor of the black printer backwards +#### /black/feed/r +Stop the feed motor of the black printer +#### /black/feed/speed +__immediately__ change the speed of the black printers feed motor. +#### /black/head/f +Run the head motor of the black printer forwards +#### /black/head/b +Run the head motor of the black printer backwards +#### /black/head/r +Stop the head motor of the black printer +#### /black/head/speed +__immediately__ change the speed of the black printers head motor. +#### /stepper/f +Run the motor of the stepper printer forwards +#### /stepper/b +Run the motor of the stepper printer backwards +#### /stepper/r +Stop the motor of the stepper printer +#### /stepper/type +Set the step type __for the next movement__ to (int): +- `1` "Single" means single-coil activation +- `2` "Double" means 2 coils are activated at once (for higher torque) +- `3` "Interleave" means that it alternates between single and double to get twice the resolution (but of course its half the speed). +- `4` "Microstepping" is a method where the coils are PWM'd to create smooth motion between steps. +#### /stepper/steps +Set the amount of steps being moved __for the next movement__ to X +#### /stepper/RPM +RPM = is how many revolutions per minute you want the stepper to turn. (similar to speed but much lower value) +__immediately__ change the RPM of the stepper motor printer's motor. + + +