Skip to content

Commit

Permalink
Update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
brickbots committed Oct 16, 2023
1 parent cf15f38 commit 251a7a7
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 4 deletions.
4 changes: 0 additions & 4 deletions docs/source/BOM.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,6 @@ In addition to the 3d printed parts detailed in the `Build Guide <./build_guide.
- M2.5x20mm standoffs
-
- Between Pi and Hat Depending on your heatsink and such you may need longer or shorter amounts here and you'll probably need to screw a couple together to get this length
* - 4
- M2.5x6mm standoffs
-
- Between the 3d printed Pi mount and the Pi
* - 3
- M2.5x12mm thumbscrews
-
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,6 @@ Join the `PiFinder Discord server <https://discord.gg/Nk5fHcAtWD>`_ for support
quick_start
user_guide
build_guide
software
dev_guide
BOM
72 changes: 72 additions & 0 deletions docs/source/software.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@

Software Setup
==============

Once you've built or otherwise obtained a PiFinder, here's how to setup a fresh SD card to run it. You can do this completely headless (no monitor / keyboard) if desired.

General Pi Setup
----------------


* Create Image: I'd strongly recommend using the Rapsberry Pi imager. It's available for most platforms and lets you easily setup wifi and SSH for your new image.

* Select the 64-Bit version of Pi OS (**Legacy**) Lite (No Desktop Environment)

* **Make sure you select the Legacy Bullseye option here**

* Setup SSH / Wifi / User and Host name using the gear icon. Below is a screengrab showing the suggested settings.

* **The username must be** ``pifinder``
* The host name, password, network settings and locale should be customized for your needs.


.. image:: ../images/raspi_imager_settings.png
:target: ../images/raspi_imager_settings.png
:alt: Raspberry Pi Imager settings



* Once the image is burned to an SD card, insert it into the PiFinder and power it up. It will probably take a few minutes to boot the first time.
* SSH into the Pifinder using ``[email protected]`` and the password you setup.
* Update all packages. This is not strictly required, but is a good practice.

* ``sudo apt update``
* ``sudo apt upgrade``

* Enable SPI / I2C. The screen and IMU use these to communicate.
* run ``sudo raspi-config``
* Select 3 - Interface Options
* Then I4 - SPI and choose Enable
* Then I5 - I2C and choose Enable

PiFinder Software Install
-------------------------

Great! You have a nice fresh install of Raspberry Pi OS ready to go. The rest of the setup is completed by running the ``pifinder_setup.sh`` script in this repo. Here's the command to download and run the script in one step:

``wget -O - https://raw.githubusercontent.com/brickbots/PiFinder/release/pifinder_setup.sh | bash``

The script:


* Clone this repo
* Install the needed packages/dependencies
* Download some required astronomy data files
* Setup Wifi access point capabilities
* Create a samba share for pulling images, and observations logs and adding observing lists
* Finally, setup the PiFinder service to start on reboot.

Once the script is done, reboot the PiFinder:
``sudo shutdown -r now``

It will take up to two minutes to boot, but you should see the startup screen before too long:

.. image:: ../images/screenshots/WELCOME_001_docs.png
:target: ../images/screenshots/WELCOME_001_docs.png
:alt: Startup log


Catalog Images
--------------

You may now want to install all the catalog images. These allow you to view an image of every object in the catalog system. For more details please see the `Catalog Image Download <https://github.com/brickbots/PiFinder/blob/main/docs/user_guide_setup.md#catalog-image-download>`_ instructions.
Binary file added images/user_guide/ui_reference.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 251a7a7

Please sign in to comment.