Blame
| 08dfeb | Hargata Softworks | 2024-11-03 15:56:23 | 1 | # Kiosk |
| 2 | ||||
| 3 | ::: warning | |||
| 4 | # Future Feature | |||
| 5 | Only available in 1.4.0 and newer | |||
| 6 | ::: | |||
| 7 | ||||
| 8 | ## Kiosk View | |||
| 9 | Navigating to `https://yourlubeloggerdomain/kiosk` will bring up the Kiosk view. This is a pseudo real-time dashboard that refreshes approximately every minute(indicated by the progressbar at the very top of the page) | |||
| 10 | ||||
| 11 | By default(without any parameters), it will default to the Vehicle view. | |||
| 12 | ||||
| 13 |  | |||
| 14 | ||||
| 15 | Modify view by adding `kioskMode` to the URL, such as: `https://yourlubeloggerdomain/kiosk?kioskMode={mode}` | |||
| 16 | ||||
| 17 | Possible views: | |||
| 18 | - Vehicle - shows overview information of vehicles. | |||
| 4e418a | Hargata Softworks | 2024-11-03 20:11:27 | 19 | - Plan - shows all plans for vehicles, sorted by the priority and progress. |
| 08dfeb | Hargata Softworks | 2024-11-03 15:56:23 | 20 | - Reminder - shows all reminders for vehicles, sorted by urgency. |
| 21 | - Cycle - cycles through all of the view above. | |||
| 22 | ||||
| 23 | ## Excluding Vehicles | |||
| 24 | ||||
| 25 | By default, the dashboard will display all vehicles the user has access to; however, vehicles can be excluded by appending `exclusions` to the URL, such as `https://yourlubeloggerdomain/kiosk?exclusions={vehicleIds}` | |||
| 26 | ||||
| 27 | The vehicleId refers to the Id of the vehicle, visible in the address bar when viewing details for a specific vehicle, e.g.: | |||
| 28 | ||||
| 29 |  | |||
| 30 | ||||
| 4e418a | Hargata Softworks | 2024-11-03 20:11:27 | 31 | In the example above, the vehicleId is `1`. To exclude multiple vehicles, list them separated by `,` |
| 08dfeb | Hargata Softworks | 2024-11-03 15:56:23 | 32 | |
| 378645 | Hargata Softworks | 2024-11-03 15:57:04 | 33 | e.g.: `https://yourlubeloggerdomain/kiosk?exclusions=1,3,5` will exclude vehicles with Ids 1, 3, and 5 from having their information displayed on the view. |
| 08dfeb | Hargata Softworks | 2024-11-03 15:56:23 | 34 | |
| 35 | ## Full URL Example | |||
| 36 | ||||
| 37 | `https://yourlubeloggerdomain/kiosk?kioskMode=Cycle&exclusions=1,3,5` will cycle through different views and exclude data from vehicle Ids 1, 3, and 5. | |||
| 38 | ||||
| 39 | ## Setting Access Token | |||
| 40 | ||||
| f1f874 | Hargata Softworks | 2024-11-03 16:11:41 | 41 | If your use-case for the Kiosk involves a full-time display, you will need to set up an access token as the user session cookie set by LubeLogger expires in either 24 hours or 7 days(depending if `Remember Me` was selected during Login). Setting up an access token allows the kiosk to continue functioning even if the user session has long expired. |
| 42 | ||||
| 43 | 1. Ensure that your user's password does not contain `:` in it | |||
| 44 | 2. Encode `{yourusername}:{yourpassword}` in Base64 | |||
| 45 | 3. You will need to login at least once before navigating to your Kiosk URL | |||
| 46 | 4. Open up the developer's console(F12 on most browsers) | |||
| 47 | 5. Some browsers will require you to acknowledge what you're doing. | |||
| 48 | 6. Type in `setAccessToken('{Base64 Encoded token generated in step 2}')` | |||
| 49 | 7. Hit enter and you should get a response stating the access token was set. | |||
| 50 | ||||
| 51 | E.g.: If the username is `test` and the password is `1234` the base64 encoded token would be `dGVzdDoxMjM0` You would then type in `setAccessToken('dGVzdDoxMjM0')` in the developer's console. | |||
| 52 | ||||
| 53 | Test this by navigating to your LubeLogger instance in a different tab and logging out. Your kiosk dashboard should continue functioning. |