Skip to content

Commit 83190e2

Browse files
committed
Update docs with new start process
1 parent 692b2d7 commit 83190e2

8 files changed

Lines changed: 75 additions & 9 deletions

File tree

8.7 KB
Loading
8.26 KB
Loading
4.84 KB
Loading
4.6 KB
Loading
4.57 KB
Loading
4.43 KB
Loading

docs/source/quick_start.rst

Lines changed: 68 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@ Quick Start
22
================
33

44
.. note::
5-
This documentation is for v3 and v2.5 PiFinders running software 2.1.0 or above.
5+
This documentation is for v3 and v2.5 PiFinders running software 2.2.0 or above.
6+
You can see what version of software is running by lookin in the upper right of
7+
the welcome screen.
8+
69
If you need docs for a previous version please choose `1.x.x <https://pifinder.readthedocs.io/en/v1.11.2/index.html>`_
7-
or `2.0.x <https://pifinder.readthedocs.io/en/v2.0.4/index.html>`_
10+
, `2.0.x <https://pifinder.readthedocs.io/en/v2.0.4/index.html>`_
11+
or `2.1.x <https://pifinder.readthedocs.io/en/v2.1.1/index.html>`_
812

913
Congratulations on getting your hands on a PiFinder™! Whether you’ve built it from scratch, or ordered a completed model
1014
from BBLabs, you’re on your way to a whole new level of accuracy and ease while observing the night sky.
@@ -217,6 +221,10 @@ where it's pointing (see :ref:`quick_start:setting focus & first solve`)
217221
This delay is longer after the PiFinder has been off for a long period or moved a distance
218222
while it's turned off. Subsequent start ups at the same location should be quicker.
219223

224+
Leaving the PiFinder on the GPS Status screen will result in a faster lock time as
225+
this screen disables the camera, reducing the overall EM noise and helping the GPS
226+
reciever see more satellites.
227+
220228

221229

222230
Adjusting Brightness
@@ -234,6 +242,25 @@ site, you can turn the brightness down to preserve your dark-adapted vision.
234242

235243
Pressing any button, or moving the PFinder will wake it from power save mode.
236244

245+
Start with the Start menu
246+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
247+
248+
At the start of each session, you may need to do three things:
249+
250+
- Check and adjust camera focus
251+
- Align the PiFinder by telling it where your scope is pointing
252+
- Check the status of the GPS lock
253+
254+
We've organized these three items into the 'Start' menu listed at the top of the PiFinder main menu.
255+
256+
.. image:: images/quick_start/pifinder_main_menu.png
257+
258+
You may not need to do all of these things at the start of every session. The focus should generally remain
259+
the same from night to night and if you leave your PiFinder on your scope you may not need to adjust the
260+
alignment each time. To perform most functions the PiFinder will require a GPS signal, and this should
261+
happen automatically, but the GPS Status screen can be used to monitor progress towards a lock and also
262+
boosts the GPS signal. This can help in marginal situations or to speed things along.
263+
237264

238265
Setting Focus & First Solve
239266
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -245,11 +272,11 @@ some adjustment to see the dimmest stars.
245272

246273
Screw the lens in and out in the holder to adjust focus if needed.
247274

248-
Use the menu system to select the 'Camera' option
275+
Use the menu system to select the 'Focus' option under the 'Start' menu
249276

250-
.. image:: images/quick_start/main_menu_02_docs.png
277+
.. image:: images/quick_start/start_menu.png
251278

252-
The camera screen shows a live preview of what the camera is seeing. It uses special image processing to
279+
The Focus screen shows a live preview of what the camera is seeing. It uses special image processing to
253280
highlight stars and remove background skyglow so that you can easily focus your PiFinder camera.
254281

255282
If there are no stars visible or the image is too defocused he screen may seem too bright or dark or
@@ -302,9 +329,9 @@ are in the middle of your eyepiece each time.
302329
`click here <https://pifinder.readthedocs.io/en/v2.0.4/quick_start.html#alignment>`_
303330

304331

305-
To being, select the 'Align' option from the main menu
332+
To being, select the 'Align' option from the 'Start' menu
306333

307-
.. image:: images/quick_start/align_menu.png
334+
.. image:: images/quick_start/start_align_selected.png
308335

309336
You'll see a rendered star chart with constellation lines showing the area of the sky the
310337
PiFinder is seeing. If you instead see a message about not having a solve, return to the
@@ -360,6 +387,40 @@ unless you remove and re-attach your PiFinder to your telescope.
360387
alignment was not quite to your liking.
361388

362389

390+
GPS Status
391+
^^^^^^^^^^^
392+
393+
There is a GPS status indicator in the PiFinder title bar which will flash while the PiFinder is
394+
searching for it's position and time. This indicator will turn solid once the PiFinder knows where
395+
it's at and what time it is. You can monitor this process and activate a special signal boost mode
396+
via the 'GPS Status' menu item in the 'Start' menu.
397+
398+
.. image:: images/quick_start/start_gps_selected.png
399+
400+
This screen has two modes, one with basic details in larger text and a full details mode. You can
401+
switch between them using the SQUARE button.
402+
403+
.. list-table::
404+
405+
* - .. figure:: images/quick_start/GPS_Status.png
406+
407+
Easy to read summary
408+
409+
- .. figure:: images/quick_start/GPS_Status_details.png
410+
411+
Full details view
412+
413+
414+
If you are using the PiFinder under partially obstructed skies, or locking is just taking longer than
415+
you like, you can leave this screen active to enhance the GPS signal by temporarily stopping the camera.
416+
Like most electronics, the camera system generates electromagnetic noise that can make it more difficult
417+
for the subtle GPS satellite signals.
418+
419+
Once a lock is indicated, you can press the LEFT arrow to return to the menu, re-activate the camera,
420+
and continue on to find your first object!
421+
422+
423+
363424
Find Your First Object
364425
^^^^^^^^^^^^^^^^^^^^^^^^
365426
Now that you’re aligned, it’s time to explore! We'll walk you through the steps to select an object to find,

docs/source/user_guide.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ PiFinder™ User Manual
44
======================
55

66
.. note::
7-
This documentation is a work in progress for v3 and v2.5 PiFinders running software 2.0.0 or above.
8-
If you need docs for a previous version please `Click here <https://pifinder.readthedocs.io/en/v1.11.2/index.html>`_
7+
This documentation is for v3 and v2.5 PiFinders running software 2.2.0 or above.
8+
You can see what version of software is running by lookin in the upper right of
9+
the welcome screen.
10+
11+
If you need docs for a previous version please choose `1.x.x <https://pifinder.readthedocs.io/en/v1.11.2/index.html>`_
12+
, `2.0.x <https://pifinder.readthedocs.io/en/v2.0.4/index.html>`_
13+
or `2.1.x <https://pifinder.readthedocs.io/en/v2.1.1/index.html>`_
914

1015
Thanks for your interest in the PiFinder! This guide describes how to use a PiFinder but if you want information on building one, please see the :doc:`Build Guide <build_guide>` and the :doc:`Bill of Materials <BOM>`.
1116

0 commit comments

Comments
 (0)