Skip to content

XerumSrl/XRFID-Demo

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License

About The Project

The Android application is designed to provide a sample of the RFID capabilities of Zebra mobile devices. the server manages Fixed readers trough MQTT, printers and the data needed to pilot a full RFID workflow from Printig an RFID label to reading RFID tags

(back to top)

Built With

  • dotnet-badge
  • MAUI-badge
  • zebra-MAUI-badge
  • SF-badge
  • MudBlazor-badge
  • MQTTNet-badge

(back to top)

Getting Started

note: the android application cannot be deployed to Device Emulator or any non-Zebra devices, any device not mentioned in the Prerequisites section has not been tested and it is not guaranteed to work

Prerequisites

  • PowerShell 7 (only if you want to set up the server as a service)
  • Open ports 5098 and 7098 and/or forward them on the machine that is going to host the server
  • One of the following Zebra devices:
    • MC33x RFID
    • TC2x + RFD40
    • TC5x + RFD40
    • TC7x + RFD90
  • Visual Studio 2022 17.7 or later with the following workloads intalled:
    • ASP.NET and web development
    • .NET Multi-Platform App UI development
  • A syncfusion License Key, here is a guide to get a free SyncFusion Community license key

Build and deploy

  1. Clone the repo
    git clone https://github.com/XerumSrl/XRFID-Demo.git

Android Apllication

  1. Have your Device ready with ADB enabled
  2. Get a SyncFusion Community license key
  3. Open the Solution (If needed Authorize your PC on the ADB Prompt on the device)
  4. add your SyncFusion key in
    XRFID.Client.Mobile/App.xaml.cs at
    .RegisterLicense("your_syncfusion_license");
    
  5. Build XRFID.Demo.Client.Mobile
  6. Deploy to device

Server

  1. Build XRFID.Demo.Server
  2. Publish XRFID.Demo.Server
  3. Go to the publish folder
  4. Recommended: edit appsettings.json as you see fit (I recommend checking the Logfile output path)
  5. Optional: open Powershell 7 and execute this command to add the se server as a service (replace paths as needed):
    New-Service -Name XRFID.Demo.Server -BinaryPathName "{Path to publish folder}\XRFID.Demo.Server.exe --contentRoot C:\{Path to publish folder}" -Description "XRFID Demo Server" -DisplayName "XRFID Demo Server" -StartupType AutomaticDelayedStart
    

Connect Application

  1. Start XRFID.Demo.Server (either as a service or by exectuing it directly)
  2. Start Application on device
  3. Go to setting and note down DeviceId and name (name can be changed to any valid hostname string)
  4. in the API Enpoint field put the url wher the server is hosted
  5. On your PC open a browser and go to http://localhost:5098/swagger
  6. Go to Reader/Minimal post and add a reader with the Id and name you noted down.

(back to top)

Usage

This application can be used to look for RFID tags and pinpoint an RFID tag location and. the application can also scan a Barcode that can be used (with an appropriately configured backend) to get a collection of RFID tags and subsequently verify if they are present.

(back to top)

Roadmap

  • Easier device (reader) enrollment
  • Authenticated APIs
  • UI to Add data and devices to the backend

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the project
  2. Create your feature branch (git checkout -b amazing-feature)
  3. Commit your changes (git commit -m 'feat: Add some AmazingFeature')
  4. Push to the branch (git push origin amazing-feature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)