Skip to content

Commit

Permalink
Add beacons guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kylecorry31 committed Dec 17, 2023
1 parent e4f0f6f commit ed2c3a2
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ object Tools {
R.drawable.ic_location,
R.id.action_tools_to_beacons,
ToolCategory.Location,
guideId = R.raw.navigate
guideId = R.raw.guide_tool_beacons
),
Tool(
8,
Expand Down
92 changes: 92 additions & 0 deletions app/src/main/res/raw/guide_tool_beacons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
The Beacons tool can be used to save locations and navigate to them later.

## Creating a Beacon
1. Tap the '+' button in the bottom-right corner of the screen.
2. Click 'Beacon'.
3. Enter a name for the beacon.
4. Enter a location for the beacon. You can tap the GPS icon next to the location field to use your current location.
5. Fill out any of the optional fields you want to record.
6. Click the checkmark button in the top-right corner of the screen.

### Optional Fields
- **Elevation**: The elevation of the beacon. You can click the elevation icon next to the elevation field to use your current elevation.
- **Create at distance**: If you want to place a beacon a known distance and direction from a location, you can toggle this on. You will then need to enter the distance away and set the direction to the new location before you can save the beacon. The new beacon will be placed at the distance and direction away from the location entered above.
- **Group**: The group to add the beacon to. Tap a group and click 'OK' to add the beacon to that group. To create a new group, see the 'Organizing Beacons' section below.
- **Color**: The color to use for the beacon.
- **Icon**: The icon to use for the beacon.
- **Notes**: Any notes you want to record about the beacon.

### Creating from a QR Code
Beacons can be shared as a QR code by clicking the menu button on the beacon row you want to share, then selecting 'Share...'. You can then share the QR code to Trail Sense to create a beacon from it.

1. Tap the '+' button in the bottom-right corner of the screen.
2. Click 'QR Code'.
3. Scan the QR code you want to create a beacon from.
4. Follow the steps above to fill out the beacon information. Any information from the QR code will be prefilled.

### Creating from a GPX File
If you have locations saved in a GPX file, you can import them into Trail Sense as beacons.

1. Tap the '+' button in the bottom-right corner of the screen.
2. Click 'GPX File'.
3. Select the GPX file you want to create a beacon from.
4. Confirm that you want to import the beacons by clicking 'OK'. You can uncheck any beacons you don't want to import.
5. The beacons will be created in the current group.

## Viewing a Beacon
Beacons will be shown in the beacon list and display the distance to the beacon from your current location.

To open a beacon, click the beacon in the list. This will open the beacon details page. The following information will be shown:
- **Name**: The name of the beacon.
- **Location**: The location of the beacon.
- **Elevation**: The elevation of the beacon.
- **Distance**: The distance to the beacon from your current location.
- **Historic High/Low Temperature**: The historical average high and low temperature for the beacon's location. See the 'Climate' guide for more information.
- **Sunrise/Sunset**: The sunrise and sunset times for the beacon's location.
- **Notes**: Any notes you recorded about the beacon.

## Navigate to a Beacon
To navigate to a beacon, open the beacon you want to navigate to and click the 'Navigate' button at the bottom. This will open the navigation tool with the beacon as the destination. Alternatively, you can click the menu button on the beacon row you want to navigate to, then select 'Navigate'.

See the 'Navigation' guide for more information on how to use the navigation tool.

## Beacon Visibility
You can choose which beacons are visible on the Navigation and Photo Maps tools by clicking the eye icon on the right side of the beacon row. This will toggle the visibility of the beacon.

## Share a Beacon
You can share a beacon by clicking the menu button on the beacon row you want to share, then selecting 'Share...'. Alternatively, open the beacon and click the menu button in the top right, then choose 'Share...'. You can choose from the following options:

- **Copy**: Copies the beacon details to your clipboard.
- **QR Code**: Shares a QR code for the beacon.
- **Maps**: Shares the beacon to a maps application.
- **Send**: Shares the beacon details to another app as text.

## Edit a Beacon
To edit a beacon, open the beacon and click the edit button at the bottom. Alternatively, click the menu button on the beacon row you want to edit, then select 'Edit'.

See the 'Creating a Beacon' section above for information on the fields you can edit.

## Delete a Beacon
To delete a beacon, click the menu button on the beacon row you want to remove, then select 'Delete'. Alternatively, open the beacon, click the menu button in the top right, and choose 'Delete'.

## Exporting Beacons
To export beacons, open the group you want to export and click the menu button in the top-right corner of the screen. Select 'Export' unselct any beacons you don't want to export, then click 'OK'. The beacons will be exported to a GPX file.

## Organizing Beacons
You can organize beacons into groups. To create a group, click the '+' button in the bottom-right of the beacon list and select 'Group'. Give the group a name and click 'OK'. Click the group in the list to view the beacons in that group.

If you create a beacon or group while the group is opened, the new beacon or group will be added to the currently opened group.

To change the group of an existing beacon, click the menu button on the beacon row you want to move, select 'Move to', and choose the target group.

To rename a group, click the menu button on the group row you want to rename, then select 'Rename' and provide a new name.

You can delete a group (along with all beacons within it) by clicking the menu button on the group row you wish to remove, then selecting 'Delete'.

## Searching for Beacons
To search through your created beacons, use the search bar at the top of the beacon list. This search encompasses the current group and all subgroups. Additionally, you can sort beacons by distance, time, or name by clicking the menu button in the top right and selecting 'Sort'.

## Last Cell Signal Beacon
If you have Backtrack enabled (see the 'Paths' guide) and have it configured to record cell signal, you will see a beacon created for the last known location that you had a cell signal.

You can disable this beacon in Settings > Navigation > 'Last signal beacon'.
1 change: 1 addition & 0 deletions site/guides.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ const guides = [
'tool_astronomy',
'tool_augmented_reality',
'tool_battery',
'tool_beacons',
'tool_bubble_level',
'tool_cliff_height',
'tool_climate',
Expand Down

0 comments on commit ed2c3a2

Please sign in to comment.