frux-c / uhf_rfid

this is a uhf app for the flipper zero, that uses the YRM100 module.
190 stars 7 forks source link

[UHF]RFID App for FlipperZero

<img style=" width: 280px; height: auto;" src="assets/img/uhf_demo_app2.jpg"> <img style=" width: 280px; height: auto;" src="assets/img/uhf_demo_app.jpg"> <img style=" width: 280px; height: auto;" src="assets/img/P_20231205_154700.jpg"> <img style=" width: 280px; height: auto;" src="assets/img/P_20231205_154717.jpg">

Overview

This repository contains a UHF RFID application developed for FlipperZero, a versatile multi-tool device. The app leverages the YRM100 module to enable UHF RFID functionality.

What's Ongoing

Adding features to the app to make it more usable and stable. Currently, also addressing the issue page to fix bugs and improve the app. And also add the planned and requested features. For example, UI Change to show all info from initial scan; feature to identify the tag type and show the info accordingly; and more.

What's Changed

Features

Requirements

To run this application on FlipperZero, you will need:

Setup and Installation

  1. Ensure you have set up your FlipperZero device with the YRM100 module properly. You can also read more about how to setup the module from the Md5Stack Docs page. wiring diagram
  2. Clone this repository to the applications_user folder of your flipper firmware of your choice
  3. If you have VSCode setup with your flipper firmware.
    • Windows

      1. Press Ctrl+Shift+B on vscode while in the uhf_app folder
      2. Select the Launch App on Flipper option. And watch as the app launches on your flipper
        • If you don't have vscode setup you can use the cli command ./fbt COMPACT=1 DEBUG=0 launch APPSRC=applications_user\uhf_rfid
    • MacOS

      ... tbd

Usage

  1. Power on your FlipperZero device.
  2. Connect the uhf module to the flipper via gpio.
  3. Navigate to the UHF RFID app on FlipperZero's menu.
  4. Currently Read for EPC, TID, USER Banks are supported, as well as saving and Writing EPC, USER Banks ... will further update this page as it development goes

Contributions

As this app is still in the development stage, I welcome contributions to this project. If you find any issues or want to enhance the application, feel free to create a pull request.

Disclaimer

Extra Resources

Contact

For any inquiries or support, you can reach out to us at :