search

RfidResearchGroup / ChameleonUltra

The new generation chameleon based on NRF52840 makes the performance of card emulation more stable. And gave the chameleon the ability to read, write, and decrypt cards.
https://chameleonultra.com
GNU General Public License v3.0
873 stars 147 forks source link

Adding a (not so) basic users guide #89

Closed GameTec-live closed 1 year ago

GameTec-live commented 1 year ago

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[bot] commented 1 year ago

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

github-actions[bot] commented 1 year ago

Built artifacts for commit 591b03e1b35a4e124d3fa48e1973111cf400c251

Firmware

Client

doegox commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

for the troubleshooting section:

GameTec-live commented 1 year ago

for the troubleshooting section:

will do!

doegox commented 1 year ago

for the troubleshooting section:

will do!

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

doegox commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

GameTec-live commented 1 year ago

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 commented 1 year ago

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:

doegox commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

doegox commented 1 year ago

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 commented 1 year ago

@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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

@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 commented 1 year ago

@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 commented 9 months ago

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 commented 9 months ago

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...