Skip to content

Commit

Permalink
Add QR code scanner tool guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kylecorry31 committed Dec 12, 2023
1 parent 43680e1 commit aca4593
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ object Tools {
R.drawable.ic_qr_code,
R.id.action_tools_to_qr,
ToolCategory.Other,
guideId = R.raw.guide_tool_qr_code_scanner
),
Tool(
32,
Expand Down
31 changes: 31 additions & 0 deletions app/src/main/res/raw/guide_tool_qr_code_scanner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
The QR Code Scanner tool can be used to scan QR codes.

## Scanning a QR Code
To scan a QR code, just point your camera at the code. Once it is recognized, the contents will be displayed on your screen with some actions you can take.

### Location
If the QR code contains a location, you will have the following actions:
- **Beacon**: Create a beacon using the location. This will open the Beacon tool with the location pre-filled.
- **Maps**: Open the location in a map app on your phone.
- **Copy**: Copy the contents of the QR code to your clipboard.
- **Delete**: Delete the result from the list.

### URL
If the QR code contains a URL, you will have the following actions:
- **Open**: Open the URL in your default browser.
- **Copy**: Copy the contents of the QR code to your clipboard.
- **Delete**: Delete the result from the list.

### Text
If the QR code contains text or is an unsupported type, you will have the following actions:
- **Note**: Create a note with the text. This will create a note and display a banner at the bottom of the screen with a button to the note.
- **Copy**: Copy the contents of the QR code to your clipboard.
- **Delete**: Delete the result from the list.

## Sharing Data with QR Codes
Some tools support data sharing via QR codes. To use this, follow the instructions in the specific tool's guide to generate the code, and scan them with the QR Code Scanner tool. You can scan a beacon directly from the Beacon tool.

The tools which support data sharing are:
- Beacons
- Notes
- Navigation (your location)
1 change: 1 addition & 0 deletions site/guides.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const guides = [
'tool_notes',
'tool_packing_lists',
'tool_photo_maps',
'tool_qr_code_scanner',
'tool_ruler',
'tool_solar_panel_aligner',
'tool_temperature_estimation',
Expand Down

0 comments on commit aca4593

Please sign in to comment.