Skip to content

Update unboxing_mini.rst #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update unboxing_mini.rst #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/unboxing/unboxing_mini.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Package Contents
Initial Inspection
##################

Before powering on, check all components are included and undamaged.

Before powering on, check that all components are included and undamaged.
1. Exterior
-----------

Expand Down Expand Up @@ -111,7 +111,7 @@ Before powering on, check all components are included and undamaged.

- All the necessary wires

.. **Coming soon**: picture of wire harness
.. **Coming soon**: a picture of the wire harness

.. .. image:: /_static/unboxing/.jpg
.. :alt: Magni 6 Mini Wires
Expand All @@ -122,15 +122,15 @@ Before powering on, check all components are included and undamaged.
3. Checklist
------------

- Ensure all pre-assembled components are firmly connected:
- Please ensure all pre-assembled components are firmly connected:

- MCB connected to Raspberry Pi 5 via the PCB connector.
- Motor wheels connected to MCB.
- Look for loose connector, cables, or wheels.

.. important::

The robot is shipped pre-assembled, but verify all parts are secure.
The robot is shipped pre-assembled, but let's verify that all parts are secure.

.. Watch this video for a visual guide on checking component connections and condition after unboxing:

Expand All @@ -140,10 +140,10 @@ Before powering on, check all components are included and undamaged.

|

If all components are securely connected and undamaged, proceed with adding the batteries in the robot.
If all components are securely connected and undamaged, proceed with inserting the batteries.

.. Important::
Upon receiving the package if any of the components:
Upon receiving the package, if any of the components:

- Are missing,
- Are not properly connected,
Expand All @@ -156,16 +156,16 @@ Battery Installation and Safety
###############################

The Magni 6 Mini uses two **lead-acid batteries**.
Ensure the Magni 6 Mini's these two batteries are safely installed and charged before powering on.
Ensure that the Magni 6 Mini's two batteries are safely installed and charged before powering on.
For for exact instructions on how to charge the batteries before adding them to ther robot: :doc:`../requirements/batteries`.

1. Inspect Batteries
1. Inspect the Batteries
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When changing the text inside header, sub-headers or any text that has the

"====="
"#####"
"~~~~~~"
"----------"

Be careful with the length of the text and the length of the string below it. They have to be the same otherwise we get syntax warning. They don't necessarily break the build, but they are annoying and show up in red colored warning text. When looking for a real error it's harder to go through all of this annoying warnings so I just have the habit of cleaning them.

To summarize:

If there is a title or a subtitle or subsubtitle (latex term), please note that the length of the symbol string below the title text should be the same as the title text length.

--------------------

- Look for visible damages (cracks, swellng, or leaks).
- Do not use damaged batteries.

2. Install Batteries
2. Install the Batteries
--------------------

- Place both batteries inside the chassis.
Expand All @@ -174,7 +174,7 @@ For for exact instructions on how to charge the batteries before adding them to

-----

Install First Battery
Install the First Battery
~~~~~~~~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to match the length of the subtitle above it.


Position the first BATTERY in the BASE according to the pictures below.
Expand Down Expand Up @@ -202,7 +202,7 @@ Pay close attention to its orientation.

|

Install Second Battery
Install the Second Battery
~~~~~~~~~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Match the length of the subtitle above it.


Use the BATTERY HOLDER to secure the second BATTERY in the BASE as shown in the picture.
Expand Down Expand Up @@ -230,7 +230,7 @@ Be careful with the wires.

|

Connect Batteries in Series
Connect the Batteries in Series
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Match the length of the subtitle above it.


Attach the yellow-green wire: red connector to the RED spade of the first battery, black connector to the BLACK spade of the second battery.
Expand Down Expand Up @@ -357,7 +357,7 @@ Attach on red spade connector to the 12V pin on the CONNECTION BOARD and the oth

|

Verify Wiring
Verify the Wiring
~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, match the length of the subtitle above it.


Ensure all spade connectors are firmly attached. Route wires as shown.
Expand Down Expand Up @@ -403,7 +403,7 @@ The wires should be connected like this:
3. Charging
-----------

- Use a multimeter to confirm voltage. Keep the batteries always charged.
- Use a multimeter to confirm the voltage. Keep the batteries fully charged.(Confusing, since you then tell them to charge the batteries once they're installed)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we can add a link to the Batteries Charging guide. We can say use fully charged batteries, followed by

If the batteries are inside the robot, charge with provided charger, otherwise charge with power supply.

Does this make more sense?

There is a proper explanation on charging inside the batteries page. Probably that is why I haven't gone into details for charging in this page. We can also explain it here in more detail, I just don't think charging is the highlight of the unboxing, so just link to the batteries page charging section should be sufficient.

What do you think about this?


.. TODO: Image of the voltage of the batteries.

Expand Down Expand Up @@ -459,23 +459,23 @@ Powering On
|


.. You can follow the following video for exact step-by-step guide of powering on the robot.
.. You can follow the following video for exact step-by-step guide to start the robot.

.. TODO: Video of powering on the robot.
.. TODO: Video of starting the robot.

.. **Coming soon**: step-by-step guide for powering on the robot.
.. **Coming soon**: step-by-step guide for starting the robot.

|

The robot is now powered on and ready for connection.
The robot is now powered up and ready for connection.

.. note::

If the Raspberry Pi's light is not green, ensure all components are properly connected.

.. warning::

Before messing with the hardware, switch the white switch off, to turn off the power to the robot.
Before trouble shooting, turn the white switch off, to turn off the power.


Next Step: Connecting
Expand Down