README.md

IoT RFID Scanner

API Documentation - Postman

This project is designed for the Raspberry Pi Zero W, operating on Linux Kernel 5.10.103+. The core functionality of this project involves using an RFID (Radio Frequency Identification) scanner to read RFID tags, which could be used for access control or identity verification. The project takes advantage of the capabilities of Amazon Web Services (AWS) to extend the functionality of the local device to the cloud.

This project also includes an API that is accessible via port 5000. Additionally, the API provides a dashboard, which can be accessed at http://your_ip:5000/dashboard.

Demo

Screenshots

Tech Stack

Application: Python, boto3, picamera, mfrc522, Flask

Kernel: C

Features

• API (hosted on port 500)
• Web Dashboard (hosted at http://your_ip:5000/dashboard)
• Command Line Interface
• In-built Linux Kernel Module

Environment Variables

To run this project, you will need to add the following Environment Variables to your path or to the .env file.

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_SESSION_TOKEN

AWS_REGION

S3_BUCKET_NAME

Run Locally

Clone the project

git clone https://github.com/LiamTownsley2/CMP408-Internet-of-Things.git

Go to the project directory

cd CMP408-Internet-of-Things

Run the setup script

sudo -E ./startup.sh

License

GNU Affero General Public License v3.0

Author

• Liam Townsley (@LiamTownsley2)

Acknowledgements

• Readme Generator - readme.so