Skip to content

Commit

Permalink
Doc Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ClutchplateDude committed Nov 5, 2024
1 parent 400a3cc commit 3ea5980
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,14 @@ When using `avr-stub` as a debug interface, it requires 2 things:
Debugging is still a bit flakey, so you may need to try multiple times in order to get a solid debugging session.

More information is available in the [avr-stub documentation](https://github.com/jdolinay/avr_debug/tree/master/doc)

### Meade Command Documentation
The Meade commands page on the Wiki is generated by running:
```shell
python .\scripts\MeadeCommandParser.py
```
from the main directory. The page is generated in the scripts folder and needs to be copy pasted into the Wiki manually. Please add the version manually (for now) by pasting something like this:
```
> This documentation is current as of Firmware **V1.13.9**
{.is-warning}
```
4 changes: 2 additions & 2 deletions src/MeadeCommandProcessor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ bool gpsAqcuisitionComplete(int &indicator); // defined in c72_menuHA_GPS.hpp
// This attempts to find the hall sensor and to home the RA ring accordingly.
// Parameters:
// "x" is either 'R' or 'L' and determines the direction in which the search starts (L is CW, R is CCW).
// "n" (Optional) is the maximum number of degrees to move while searching for the sensor location. Defaults to 30degs. Limited to the range 15degs - 75degs.
// "n" (Optional) is the maximum number of degrees to move while searching for the sensor location. Defaults to 30degs. Limited to the range 5degs - 75degs.
// Remarks:
// The ring is first moved 30 degrees (or the given amount) in the initial direction. If no hall sensor is encountered,
// it will move twice the amount (60 degrees by default) in the opposite direction.
Expand All @@ -530,7 +530,7 @@ bool gpsAqcuisitionComplete(int &indicator); // defined in c72_menuHA_GPS.hpp
// This attempts to find the hall sensor and to home the DEC axis accordingly.
// Parameters:
// "x" is either 'U' or 'D' and determines the direction in which the search starts (U is up, D is down).
// "n" (Optional) is the maximum number of degrees to move while searching for the sensor location. Defaults to 30degs. Limited to the range 15degs - 75degs.
// "n" (Optional) is the maximum number of degrees to move while searching for the sensor location. Defaults to 30degs. Limited to the range 5degs - 75degs.
// Remarks:
// The ring is first moved 30 degrees (or the given amount) in the initial direction. If no hall sensor is encountered,
// it will move twice the amount (60 degrees by default) in the opposite direction.
Expand Down

0 comments on commit 3ea5980

Please sign in to comment.