Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit c6333445 authored by Deepak Khatri's avatar Deepak Khatri :dog:
Browse files

Update quick start guide

parent 7a12d4c4
1 merge request!117Update BeagleY-AI docs
...@@ -11,11 +11,9 @@ What's included in the box? ...@@ -11,11 +11,9 @@ What's included in the box?
When you purchase a BeagleY-AI, you'll get the following in the box: When you purchase a BeagleY-AI, you'll get the following in the box:
1. `BeagleY-AI <https://www.beagleboard.org/boards/beagley-ai>`_ 1. `BeagleY-AI <https://www.beagleboard.org/boards/beagley-ai>`_
2. 2.4GHz antennas 2. 2.4GHz antenna
3. Quick-start card 3. Quick-start card
.. tip:: For board files, 3D model, and more, you can checkout the `BeagleY-AI repository on OpenBeagle <https://openbeagle.org/beagley-ai/beagley-ai>`_.
.. todo:: Attaching antennas instructions for BeagleY-AI .. todo:: Attaching antennas instructions for BeagleY-AI
.. todo:: BeagleY-AI unboxing video .. todo:: BeagleY-AI unboxing video
...@@ -23,13 +21,30 @@ When you purchase a BeagleY-AI, you'll get the following in the box: ...@@ -23,13 +21,30 @@ When you purchase a BeagleY-AI, you'll get the following in the box:
Getting started Getting started
*************** ***************
To get started you need the following: To get started your BeagleY-AI you need the following:
1. :ref:`5V @ 3A power supply <accessories-power-supplies>` 1. :ref:`5V @ 3A power supply <accessories-power-supplies>`
2. MicroSD Card (32GB) 2. MicroSD Card (32GB)
3. Boot media (Software image) 3. Boot media (Software image)
.. note:: Instead of using a :ref:`power supply or power adapter <accessories-power-supplies>` if you are using a :ref:`USB type-A to type-C cable or type-C to type-C cable <accessories-cables-usb>` to connect the board to your laptop/PC then make sure it can supply at least 1000mA. You may need additional accessories based on the mode of operation, you can use your BeagleY-AI in different ways.
1. :ref:`USB Tethering by directly connecting via USB type-c port <beagley-ai-usb-tethering>`
2. :ref:`Headless connection via UART debug port <beagley-ai-headless>`
3. :ref:`Standalone connection with Monitor and other peripherals attached <standalone-connection>`
Easiest option is to connect the board directly to your PC or Laptop using a USB type-C to type-c cable. There is only one USB type-C port on board, if you
choose to use a dedicated power supply for first time setup, you may choose to access the board via any other methods listed above.
Power Supply
=============
To power the board you can either connect it to a dedicated power supply like a mobile charger or a wall adapter that
can provide 5V ≥ 3A. Checkout the :ref:`docs power supply page <accessories-power-supplies>` for power supply recommendations.
.. note::
Instead of using a :ref:`power supply or power adapter <accessories-power-supplies>` if you are using a :ref:`USB type-A to
type-C cable or type-C to type-C cable <accessories-cables-usb>` to connect the board to your laptop/PC then make sure it can supply at least 1000mA.
Boot Media (Software image) Boot Media (Software image)
============================ ============================
...@@ -52,53 +67,79 @@ Once flashed, you can insert the SD card into your BeagleY-AI as shown in the im ...@@ -52,53 +67,79 @@ Once flashed, you can insert the SD card into your BeagleY-AI as shown in the im
.. image:: images/beagley-ai-micro-sd-card.* .. image:: images/beagley-ai-micro-sd-card.*
Power Supply .. _beagley-ai-usb-tethering:
=============
To power the board you can either connect it to a dedicated power supply like a mobile charger or a wall adapter that USB Tethering
can provide 5V ≥ 3A. Checkout the `docs power supply page <https://docs.beagleboard.org/latest/accessories/power-supplies.html#accessories-power-supplies>`_ ==============
for power supply recommendations.
Board connection .. note::
================= If you are using the board with a fan or running a heavy task you should always power
the board with a dedicated power supply that can supply 5V ≥ 3A.
There is only one USB type-C port on board, if you choose to use a dedicated power supply for first time setup, you may access the board via one of the following methods: As per USB standards these are the current that each cable can supply:
1. Connection to HDMI display, Keyboard and Mouse - Type-A to Type-C - 900mA
2. UART using RPi debug probe or similar - Type-C to Type-C - 1500mA
3. Ethernet network connection
Another direct and easy option is to connect the board directly to your PC or Laptop using a USB type-C cable. Thus it's recommended to use type-C to type-C cable.
.. note:: To initially test your board, you can connect the board directly to your computer using a ``type-A to type-C`` or ``type-C to type-C`` cable shown in the image below.
If you are using the board with a fan or running a heavy task you should always power
the board with a dedicated power supply that can supply 5V ≥ 3A.
USB Tethering .. figure:: images/beagley-ai-tethered-connection.*
============== :align: center
:alt: BeagleY-AI tethered connection
To initially test your board, you can connect the board directly to your computer using a type-A to type-C cable shown in the image below. BeagleY-AI tethered connection
.. image:: images/beagley-ai-tethered-connection.* After connecting, you should see the power LED glow, and soon just like with other Beagles, BeagleY-AI will create a virtual wired connection on your computer. To access the board you can use the SSH command as shown below.
After connecting, you should see the power LED glow, and soon just like with other Beagles, you’ll see a virtual wired connection on your computer. To access the board you can use SSH as shown below. .. code:: shell
ssh debian@192.168.7.2
.. note:: .. note::
Here you must update the default password to something safer. Here you must update the default password to something safer.
.. image:: images/ssh-connection.* .. figure:: images/ssh-connection.*
:align: center
:alt: BeagleY-AI SSH connection
BeagleY-AI SSH connection
With this you have the access to BeagleY-AI terminal. Now, you can connect your board to WiFi,
try out all the cool demos and explore all the other ways to access your BeagleY-AI.
- :ref:`beagley-ai-connecting-wifi`
- :ref:`beagley-ai-demos`
.. _beagley-ai-headless:
Headless connection
===================
If you want to run your BeagleY-AI in headless mode, you need `Raspberry Pi Debug Probe <https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html>`_ or similar serial adapter.
.. _standalone-connection:
Standalone connection
=====================
To setup your BeagleY-AI for standalone usage, you need the following additional accessories,
Using BeagleY-AI 1. HDMI monitor
================= 2. micro HDMI to full-size HDMI cable
3. Wireless keyboard & mice combo
4. Ethernet cable (Optional)
To setup your BeagleY-AI for normal usage, connect the following: Make sure you have the sd Card with boot media (software image) inserted in to the BeagleY-AI. Now connect,
1. 5V ≥ 3A power supply 1. microHDMI to BeagleY-AI and full size HDMI to monitor
2. HDMI monitor using micro HDMI to full-size HDMI cable 2. keyboard and mice combo to one of the four USB port of BeagleY-AI
3. Ethernet cable from the board to your router 3. Power supply to USB type-c connector of BeagleY-AI
4. Wireless or wired keyboard & mice
.. image:: images/beagley-ai-tethered-connection.* The connection diagram below provides a clear representation of all the connections,
.. image:: images/standalone.*
If everything is connected properly you should see four penguins on your monitor. If everything is connected properly you should see four penguins on your monitor.
...@@ -122,12 +163,12 @@ Explore and build with your new BeagleY-AI board! ...@@ -122,12 +163,12 @@ Explore and build with your new BeagleY-AI board!
.. image:: images/htop.* .. image:: images/htop.*
.. _beagley-ai-connecting-wifi:
Connecting to WiFi Connecting to WiFi
=================== ===================
Connect 2x antennas to your BeagleY-AI board if not pre-attached. Once board is fully booted and you have access to the shell, follow the commands below to connect to any WiFi access point,
After successfully attaching the antenna, power up the board. Once booted you can follow the commands below to connect to any WiFi access point,
- To list the wireless devices attached, (you should see wlan0 listed) - To list the wireless devices attached, (you should see wlan0 listed)
...@@ -171,6 +212,11 @@ After successfully attaching the antenna, power up the board. Once booted you ca ...@@ -171,6 +212,11 @@ After successfully attaching the antenna, power up the board. Once booted you ca
ping 8.8.8.8 ping 8.8.8.8
Attach fan
==========
.. todo:: add instructions to attach raspberrypi official fan.
Demos and Tutorials Demos and Tutorials
******************* *******************
......
...@@ -11,6 +11,8 @@ If you want to know how BeagleY-AI is designed and the detailed specifications, ...@@ -11,6 +11,8 @@ If you want to know how BeagleY-AI is designed and the detailed specifications,
this chapter is for you. We are going to attept to provide you a short and crisp overview this chapter is for you. We are going to attept to provide you a short and crisp overview
followed by discussing each hardware design element in detail. followed by discussing each hardware design element in detail.
.. tip:: For board files, 3D model, and more, you can checkout the `BeagleY-AI repository on OpenBeagle <https://openbeagle.org/beagley-ai/beagley-ai>`_.
Block diagram and overview Block diagram and overview
*************************** ***************************
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment