PIR – BLE Scanner for Arduino

Code to scan the nearby BLE advertisments
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
   • Generation
   • Tests
   • Documentation
4. Tree Structure
5. Credits
6. Contact

---

About The Project

This code will be used in order to listen the advertising BLE devices with an arduino to spot potential attacker.

Built With

• C++
• Arduino Framework

Getting Started

Prerequisites

1. Install the latest version of Python 3 with pip (included): https://www.python.org/downloads/
2. Install the latest version of PlatformIO: https://docs.platformio.org/en/latest//core/installation.html#installation-methods

   pip install -U platformio

Installation

1. Clone the project

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

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

   pio pkg install

Using an IDE

If you want to use a specific IDE with this project, you can list the compatible ones by checking the --ide line with:

pio init -h

Choose your IDE with:

pio init --ide <ide>

⚠️ DO NOT COMMIT THE NEWLY CREATED FILES AFTER THE IDE INIT COMMAND.

You can add their name/location in the .git/info/exclude file to exclude them from the VCS without affecting the .gitignore file. You will also have to add the build directories created by your IDE in order to keep your artifacts outside of the project repository.

Usage

Execution

Use the following command in the project root to build and upload the firmware in the default debug mode (with the board plugged):

pio run -t upload

By adding the -e release option you will be in release mode.

Generation

You can also build the firmware in the default debug mode without uploading:

pio run

Again, by adding the -e release option you will be in release mode.

Tests

TODO

Documentation

Once the code is running on the Arduino, you can visualize the data in a terminal with the following command :

pio device monitor

You can save this output in a text file :

pio device monitor -f default -f log2file

---

Tree Structure

TODO

Credits

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

Contact

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

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