Skip to content

Commit

Permalink
Implemented links to other files now that the controller and helper a…
Browse files Browse the repository at this point in the history
…re merged. Need both Circuit Diagram & Schematic Diagram.
  • Loading branch information
adelgadoj3 committed Apr 26, 2024
1 parent c95f677 commit 5744ca5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ endif::rootpath[]

[.text-right]

Link will go here when controller and helper are pushed[Improve this doc]
https://github.com/oss-slu-Pi4Micronaut/edit/develop/pi4micronaut-utils/src/docs/asciidoc/componets/outputComponents/servomotor.adoc[Improve this doc]

===== Overview
This section provides details of the Servo Motor, including the components and assembly instructions.
This section provides details of the Servo Motor, including the components, and assembly instructions.


===== Components
Expand All @@ -31,9 +31,9 @@ This section provides details of the Servo Motor, including the components and a
* Connect a jumper wire to 3.3V
* Connect a jumper wire to GPIO 18
* Connect a jumper wire to GND
* Connect the 3.3V jumper wire to the middle power wire receiver (Color: Red)
* Connect the GND jumper wire to the right ground wire receiver (Color: Brown or Black)
* Connect the GPIO 18 jumper wire to the left signal wire receiver (Color: Orange)
* Connect the 3.3V jumper wire to the power wire receiver (Color: Red)
* Connect the GND jumper wire to the ground wire receiver (Color: Brown or Black)
* Connect the GPIO 18 jumper wire to the signal wire receiver (Color: Orange)


===== Circuit Diagram
Expand Down Expand Up @@ -90,13 +90,13 @@ pwm:
----

===== Constructor and Methods
The constructor and the methods within the ServoMotorHelper class can be seen in our javadoc (Link will be provided when helper and controller are merged)
The constructor and the methods within the ServoMotorHelper class can be seen in our javadoc link:https://oss-slu-github.io/Pi4Micronaut/javadoc/com/opensourcewithslu/outputdevices/ServoMotorHelper.html[here].

===== Example Controller

====== This controller uses the Servo Motor to move the arm once prompted by the commands

[source,java]
----
Link will go here
include::../../../../../../components/src/main/java/com/opensourcewithslu/components/controllers/ServoMotorController.java[tag=ex]
----
2 changes: 2 additions & 0 deletions pi4micronaut-utils/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,5 @@ include::components/outputComponents/lcd1602.adoc[]
include::components/outputComponents/passivebuzzer.adoc[]

include::components/outputComponents/activebuzzer.adoc[]

include::components/outputComponents/servomotor.adoc[]

0 comments on commit 5744ca5

Please sign in to comment.