Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Where is the Documentation / Basic User Guide #44

Closed
GarethWright opened this issue Jul 27, 2023 · 23 comments · Fixed by #89
Closed

Where is the Documentation / Basic User Guide #44

GarethWright opened this issue Jul 27, 2023 · 23 comments · Fixed by #89
Labels
documentation Improvements or additions to documentation low hanging fruit

Comments

@GarethWright
Copy link

Forgive me if I've overlooked something but there's no user guide or basic instructions on how to use it?
Not even a description of what each button does?
@GameTec-live
Copy link
Contributor

nope, none yet... for the buttons afaik theres some info in the indigogo description.
Proper documentation is coming SoonTM

@GarethWright
Copy link
Author

GarethWright commented Jul 27, 2023 via email

@SieGoz
Copy link

SieGoz commented Jul 28, 2023

Hello,
I have the same problem...

@GameTec-live
Copy link
Contributor

to load something into the slot you need to use client software currently (please be pantient and understand that a lot of this is community driven and also the firmware as well as the client software are in early stages)...

For the client software there are more or less 2 options. The official CLI which supports all currently available functions (It can be found in this repo under the software folder and requires python, etc. watch icemans video on a good tutorial to building it) and my GUI. it works on android windows as well as linux but for example slot managment is still being worked on.

@SieGoz
Copy link

SieGoz commented Jul 28, 2023

Ok thanks !

@pl4nty
Copy link

pl4nty commented Jul 29, 2023 •
edited
Loading

For the CLI, the following worked for me in WSL2 Ubuntu based on Iceman's video. If you're also using WSL2, make sure to attach the USB device and set permissions first.

Setup:

git clone https://github.com/RfidResearchGroup/ChameleonUltra
cd ChameleonUltra/software/src
mkdir build
cd build
cmake ..
cd ../../script
python3 -m pip install -r requirements.txt

Usage:

python3 chameleon_cli_main.py
hw connect
hw mode set -m e
hw slot openall

Select a slot with the physical buttons. A red LED will indicate the selected slot.

hf mf eload -f yourbin.bin
hf mf sim --sak [hex SAK] --atqa [hex ATQA] --uid [hex UID]

Now you can disconnect and use buttons to select the slot. The LED will be red when selected, and green after it's read.

@GameTec-live
Copy link
Contributor

GameTec-live commented Jul 29, 2023 •
edited
Loading

For the CLI, the following worked for me in WSL2 Ubuntu based on Iceman's video. If you're also using WSL2, make sure to attach the USB device and set permissions first.

Setup:

git clone https://github.com/RfidResearchGroup/ChameleonUltra
cd ChameleonUltra/software/src
mkdir build
cd build
cmake ..
cd ../../script
python3 -m pip install -r requirements.txt

Usage:

python3 chameleon_cli_main.py
hw connect
hw mode set -m e
hw slot openall

Select a slot with the physical buttons. A red LED will indicate the selected slot.

hf mf eload -t bin -f yourbin.bin
hf mf sim --sak [hex SAK] --atqa [hex ATQA] --uid [hex UID]

You can also use hf mf eload -t hex -f yourhex.eml for hex-encoded dumps.

Now you can disconnect and use buttons to select the slot. The LED will be red when selected, and green after it's read.

on the latest cli specifying the type when using eload isnt required. also: its strongly recommended to update the fw...

you can either use the gui for that or do hw dfu and then use nrfutil:

nrfutil device program --firmware lite-dfu-app.zip --traitd nordicDfu

@GibbilyGooo
Copy link

GibbilyGooo commented Jul 29, 2023 via email

@pl4nty
Copy link

pl4nty commented Jul 29, 2023 •
edited
Loading

@GameTec-live thanks for the eload tip, I've updated my comment. how is the firmware versioned? I'm running v1.0 at the moment, but the other releases seem to be rolling. not sure I want to run rolling-release firmware at the moment

@GameTec-live
Copy link
Contributor

@GameTec-live thanks for the eload tip, I've updated my comment. how is the firmware versioned? I'm running v1.0 at the moment, but the other releases seem to be rolling. not sure I want to run rolling-release firmware at the moment

they arent versioned, because as you guessed, they are rolling... the factory fw is just old and has some bugs (same for v1 release)
good news though, the chameleon is unbrickable, because unless you intentionally unlock it, the bootloader is read only...

@GameTec-live
Copy link
Contributor

I’m getting errors at the cmake .. command when using git bash. What do you suggest is the appropriate install for cmake?

Thank you

Sent from Proton Mail for iOS

On Sat, Jul 29, 2023 at 2:56 AM, GameTec-live @.***(mailto:On Sat, Jul 29, 2023 at 2:56 AM, GameTec-live < wrote:

For the CLI, the following worked for me in WSL2 Ubuntu based on Iceman's video. If you're also using WSL2, make sure to attach the USB device and set permissions first.

Setup:

git clone https://github.com/RfidResearchGroup/ChameleonUltra
cd ChameleonUltra/software/src
mkdir build
cd build
cmake ..
cd ../../script
python3 -m pip install -r requirements.txt

Usage:

python3 chameleon_cli_main.py
hw connect
hw mode set -m e
hw slot openall

Select a slot with the physical buttons. A red LED will indicate the selected slot.

hf mf eload -t bin -f yourbin.bin
hf mf sim --sak [hex SAK] --atqa [hex ATQA] --uid [hex UID]

You can also use hf mf eload -t hex -f yourhex.eml for hex-encoded dumps.

Now you can disconnect and use buttons to select the slot. The LED will be red when selected, and green after it's read.

on the latest cli specifying the type wheb using eload isnt required. also: its strongly recommended to update the fw...

you can either use the gui for that or do hw dfu and thn use nrfutil:

nrfutil device program --firmware lite-dfu-app.zip --traitd nordicDfu

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.Message ID: @.***>

i recommend you use proxspace or wsl (as shown in video), proxspace has all tools already setup

@konkeydong75
Copy link

Can the device read/emulate Paxton Net2 cards?

@GarethWright
Copy link
Author

GarethWright commented Aug 1, 2023 via email

@konkeydong75
Copy link

Perfect, many thanks @GarethWright

@atkinchris
Copy link

cmake ..

Depending on your setup, you might need to run make after running cmake .., to actually build the binaries for nested, etc.

@doegox doegox added the documentation Improvements or additions to documentation label Aug 20, 2023
@ComicBit
Copy link

Solid documentation is super important for any product, especially for the new folks trying to get into this. Without it, they might just get turned off. Right now, the product's documentation isn't even close to what Flipper Zero has. The Flipper is killing it with both their detailed guides and a kickass community. We're really missing out by not focusing on this. It's kinda frustrating to see honestly.

@doegox
Copy link
Contributor

doegox commented Aug 21, 2023

Agreed. But hard to document an early moving target with new or changed features every day. And a few million dollars difference. Will you be part of the kickass community and help documenting?

@ComicBit
Copy link

I feel like the project's at a point where we could at least start drafting a basic guide on how to use it. A few examples and maybe some guidance on expanding its capabilities would be great. Creating "app-like" modules for people that want to develop new attacks sounds cool, though I get we're not there just yet. The main aim should be to encourage more contributions. I'm up for helping with docs and building the community, but I need a clearer grasp on the tool. Right now, I'm struggling in the most basic things. About the budget, I'm with you. But if the Chameleon Ultra can outdo what Flipper can't because of its hardware, we might be onto something big and some viral video could bring also some cash. It'd be awesome to see this become the new standard in NFC/RFID testing.

@xianglin1998
Copy link
Contributor

This is indeed our negligence. Starting from next week, I will try my best to arrange time to complete some of the community's existing needs, and write product's documentation.

@nuvious
Copy link

nuvious commented Aug 23, 2023

Let me know if you need help on this issue. I just got mine today and am loving it. Happy to draft some Quickstart user guides.

@GameTec-live
Copy link
Contributor

Okay, because noone is doing it, ima write guide for hw, fw, cli and gui...

@GameTec-live GameTec-live mentioned this issue Aug 24, 2023
Merged
@ComicBit
Copy link

I think we also need as part of this wiki how the device operates, which buttons to press and what does what, what's the bootloader mode etc. I was able to find for instance a reference on the fact that if you don't press the B button (i hope I remember that right) while pairing bluetooth, the device will refuse connection. I could find this only in some platform to purchase the device into the description

@GameTec-live
Copy link
Contributor

@ComicBit My plan is to put all of that into the FW section 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation low hanging fruit
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding a (not so) basic users guide GameTec-live/ChameleonUltra