Adding a (not so) basic users guide

[GameTec-live]

Im doing it, im adding a users guide to ideally adress as much as possible. (closes #44 )
And because apperently not a lot of people know how rfid works, etc, @nemanjan00 had the idea of creating a RFID wiki (unrelated, but worth mentioning)

[github-actions]

You are welcome to add an entry to the CHANGELOG.md as well

[github-actions]

Built artifacts for commit 591b03e

Firmware

• Ultra APP DFU Package
• Ultra binaries
• Lite APP DFU Package
• Lite binaries

Client

• Linux
• macOS
• Windows

[doegox]

I would suggest to use multiple pages in a subdir from the start as it will grow too much for a single file :)

[GameTec-live]

I would suggest to use multiple pages in a subdir from the start as it will grow too much for a single file :)

just create a "documentation" folder then?

[doegox]

for the troubleshooting section:

• Python version mismatch, cf TypeError: 'type' object is not subscriptable #90
• linux: permissions and modemmanager
• LF: hardware issue related to screws, beware they are fragile...

[GameTec-live]

for the troubleshooting section:

• Python version mismatch, cf TypeError: 'type' object is not subscriptable #90
• linux: permissions and modemmanager
• LF: hardware issue related to screws, beware they are fragile...

will do!

[doegox]

for the troubleshooting section:

• Python version mismatch, cf TypeError: 'type' object is not subscriptable #90
• linux: permissions and modemmanager
• LF: hardware issue related to screws, beware they are fragile...

will do!

For python version mismatch, there is now a check in the CLI, now error should be clearer for users.

[doegox]

Beware many image links are broken (C:\Users\bened\Desktop\ChameleonUltra\docs\images\... and the ultra images too).
Also better to use JPG for photos.

[GameTec-live]

Beware many image links are broken (C:\Users\bened\Desktop\ChameleonUltra\docs\images\... and the ultra images too). Also better to use JPG for photos.

should be fixed...

[doegox]

Beware many image links are broken (C:\Users\bened\Desktop\ChameleonUltra\docs\images\... and the ultra images too). Also better to use JPG for photos.

should be fixed...

not until there are new commits ;)

[doegox]

ok I'll push comments/suggestions on the hw file, should be easy for you to integrate

[GameTec-live]

Id say that firmware is also mostly done? It feels like something is still missing, but idk what? (For compiling, etc, theres the "How_to_use_firmware.md", ig i could merge that into there too if needed?)

[doegox]

Id say that firmware is also mostly done? It feels like something is still missing, but idk what? (For compiling, etc, theres the "How_to_use_firmware.md", ig i could merge that into there too if needed?)

I would separate dev things and fw things for users. So you can add a subsection "development.md" which will basically be the current How_to_use_Firmware.md
And in the firmware.md I see topics for users, like:

• how to get precompiled fw and how to flash it
• what buttons and LEDs do mean in the various usages?
  • B on boot = DFU
  • A/B on app -> configurable, default behaviors are slot +1/-1 & long = copy IC/ID
  • slot selects, red=.. green=... blue=...
  • 4 pulsing green when charging (I'm not sure, <4 when battery is low?)
  • when CLI connected, LED chase in color of selected slot, left to right if slot 1,2,3,4, right to left if slot 5,6,7,8
  • white LED for external field detection (if current slot supports corresponding HF/LF)
  • sleep after N secs, can be interrupted by pressing a button
    And I'm probably forgetting things. I'm not fully aware of all the possible animations and their meaning

[doegox]

When you thing a section or 2 are ok, we can just merge this PR and open a new PR so we don't wait for all the guide to be ready before showing parts

[doegox]

oops I missed when you committed the first half of firmware.md so I can't add suggestions anymore on that part.
I will push directly the changes, only to firmware.md, in this branch

[doegox]

ok I've pushed more than firmware.md changes :D
for CLI: I think it's better to write a cheat sheet with common scenarios chaining the proper commands than an exhaustive list of commands that will be painful to maintain and that users can easily discover by themselves in the client,

[ComicBit]

Would be good to make a timeline of the future developments, I can help

[doegox]

Well this is opensource, everyone is contributing to what he prefers whenever he finds time.
I'm not sure how you could plan a roadmap with a timeline...

[ComicBit]

@doegox I am sorry but I don't know if there any paid contributors to the project. Of course there is no way to plan at a fast pace in an open source project if everyone is indeed doing it in their free time. Probably the right word I needed to use would have been Roadmap, to functionalities etc, and probably with large tolerance regarding the time. Just to be a conceptual map of what comes after and if someone wants to join, what they can indeed do to contribute

[doegox]

Yes if you can initiate sth similar to https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap that would be great!
Similarly, I think 1 or 2 wiki pages would suffice (roadmap & wishlist).

[ComicBit]

I would love that, can you tell me how to do it tho? I think I don't know where to take the accomplished parts already, and regarding the future I guess it would require a meeting of people understanding what would be the next things in the line and plan a draw for it. And whoever will feel like developing will do.

[doegox]

@ComicBit a good start is to collect the things still to be implemented detailed in https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/docs/technical_whitepaper.md and to collect feature ideas expressed in the open issues https://github.com/RfidResearchGroup/ChameleonUltra/issues

[ComicBit]

@doegox I opened a PR for the docs, give it a look, the things in the wishlist are there just as placeholder. I thought we could make a wiki already considering the amount of documents.

[wzqvip]

seems there's still no "key function" explained in detail currently. I wonder what's "charge" does. The option did not appear in https://docs.chameleonultragui.dev/.

[GameTec-live]

seems there's still no "key function" explained in detail currently. I wonder what's "charge" does. The option did not appear in https://docs.chameleonultragui.dev/.

it simply displays the battery charge on the leds... I should prob add it to the docs at some point...