README.md

PIR – BLE Reader

IDS: Code for the BLE reader used during the training phase of our model
See Releases »

Research Paper · Test Results · See Global Usage

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Execution
4. Tree Structure
5. Credits
6. Contact

---

About The Project

This code will be used in order to read the BLE during the training phase of our model for our IDS.

Built With

• Python

Getting Started

Prerequisites

• Install the latest version of pyenv (https://github.com/pyenv/pyenv-installer [ UNIX ], https://pyenv-win.github.io/pyenv-win/ [ WINDOWS ]) or update it with the following command:

  pyenv update

• Install the latest version of pipenv (https://pipenv.pypa.io/) or update it with the following command:

  pip install pipenv --upgrade

Installation

1. Clone the project

   git clone https://github.com/PIR-IDS/ble-reader.git

2. Install the dependencies by typing the following command while being in the project root:

   pipenv install --dev

⚠️ If you are using pyenv-win (WINDOWS) : If you do not have the version of Python used in the project, it is possible that pipenv does not detect pyenv, preventing you from using it directly. To solve this problem, first install the desired version pyenv install 3.10.0 and then instead of the above command use this one: pipenv --python %USERPROFILE%\.pyenv\pyenv-win\versions\3.10.0\python.exe install --dev

3. The project is now ready to run.

Usage

Execution

Run the following instructions to launch the reader, with <address> the device address and <filename> the file where you want the output to go in the out directory:

pipenv run read <address> [<filename>]

Tree Structure

TODO

Credits

Romain Monier [ GitHub ] – Co-developer
Noé Chauveau [ GitHub ] – Co-developer

Contact

Project Link : https://github.com/PIR-IDS/ble-reader

Organization Link : https://github.com/PIR-IDS