From 9cac346d35ae7476abde7ebd53eccc202d596d8b Mon Sep 17 00:00:00 2001 From: GameTec_live Date: Fri, 29 Sep 2023 13:08:25 +0200 Subject: [PATCH] doc: explain first two pages --- docs/chameleonultragui.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/chameleonultragui.md b/docs/chameleonultragui.md index f84a9d7d..a28e618e 100644 --- a/docs/chameleonultragui.md +++ b/docs/chameleonultragui.md @@ -9,8 +9,33 @@ ## Page Breakdown ### Homepage - - +![CUGUI Homepage](./images/CUGUI-homepage.png) + +Starting from the top left youll find: + +- The device name: This says Chameleon Ultra or Chameleon Lite depending on the device connected +- The disconnect button: Pressing this icon cleanly disconnects the Chameleon, it is recommended to use this button whenever possible +- The connected port tells you where and how the chameleon is connected, followed by how it is connected (Connection Method), this displays a USB or bluetooth icon and last in that row is the battery charge display +- The used slots displays how many out of the 8 slots are used +- The Slotchanger: The currently selected slot is highlighted with a red circle, slots that cotain a card are filled out, everything else is a hollow circle. The arrows left and right allow you to change the currently selected slot. +- The Firmware version is pulled from the device and displays the version as well as the tag +- The check for updates button compares the firmware with github and then updates if a newer version is available +- Switch mode allows you to switch between reader and emulator mode, updating the icon accordingly +- The device settings allow you to change settings concerning the device, like changing the animation mode + +### Device settings +![Device Settings](./images/CUGUI-devicesettings1.png) +![Device Settings2](./images/CUGUI-devicesettings2.png) + +Top to bottom: +- Enter DFU mode: Enters the devices DFU mode. Allows the user to take over. +- Flash latest FW via DFU: Downloads the newest firmware from github, disregarding if the device is already up to date and flashes it. +- Flash .zip FW via DFU: Allows the user to select a zip theyd like to flash to the device +- The animation setting chooses if the device should play the bootup animation when brought into a RFID field +- The button config allows you to define both shortpress and longpress actions +- The BLE pairing toggle decides wheter pairing with a BLE Pin is required or not, enabling this increases security at the loss of convinience. Your able to set the Pin once pairing is enabled. +- Reset settings resets all device settings but does not wipe user data +- Factory reset **WIPES ALL USERDATA** and resets the device to factory settings ## How to use MFKEY32