From 17c4377d9958cf8db5ae503d08297d6b7de9568c Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Wed, 18 Jan 2023 20:29:24 -0900 Subject: [PATCH] add docs for QR codes --- docs/docs/tips-tricks.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docs/tips-tricks.md b/docs/docs/tips-tricks.md index 75501be..f8f836f 100644 --- a/docs/docs/tips-tricks.md +++ b/docs/docs/tips-tricks.md @@ -32,3 +32,10 @@ In some cases you may want to skip some items such as consumables, or items that !!! tip If you're migrating from an older version there is a action on the users profile page to assign IDs to all items. This will assign the next available ID to all items in the order of creation. You should _only_ do this once during the migration process. You should be especially cautious of this action if you're using the reset feature described in option number 2 + +## QR Codes + +Homebox has a built-in QR code generator that can be used to generate QR codes for your items. This is useful for tracking items with a mobile device. You can generate a QR code for any item by clicking the QR code icon in the top right of the item details page. The same can be done for the Labels and Locations page. Currently support is limited to generating one off QR Codes. + +However, the API endpoint is available for generating QR codes on the fly for any item (or any other data) if you provide a valid API key in the query parameters. An example url would look like `/api/v1/qrcode?data=https://homebox.fly.dev/item/{uuid}&access_token={api_key}`. Currently the easiest way to get an API token is to use one from an existing URL of the QR Code in the API key, but this will be improved in the future. +