Skip to content

Latest commit

 

History

History
186 lines (144 loc) · 5.08 KB

README.md

File metadata and controls

186 lines (144 loc) · 5.08 KB

PIR – Arduino Nano 33 BLE


Logo

IDS: Code for the Arduino Nano 33 BLE board
See Releases »

Research Paper · Test Results · See Global Usage

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Tree Structure
  5. Credits
  6. Contact

About The Project

This code will be used in order to detect anomalies and to inform our IDS about it.

Built With

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/wallet-card.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

Before running the tests on your machine, you need to follow these instructions: https://docs.platformio.org/en/latest/platforms/native.html#installation

Then, you can run the "desktop" (i.e. not necessitating the board) tests with the following command:

pio test -e native_debug -e native_release

If you want to run the tests for the board, you need to run this command with the board plugged:

pio test -e debug -e release

Documentation

Before generating the documentation on your machine, you need to follow these instructions: https://doxygen.nl/manual/install.html

Then, to generate the Doxygen documentation, run the following commands:

mkdir -p build/docs
doxygen

Tree Structure

TODO

Credits

Romain Monier [ GitHub ] – Co-developer
Morgan Pelloux [ GitHub ] – Co-developer
David Violes [ GitHub ] – Co-developer
Malik Sedira [ GitHub ] – Co-developer
Quentin Douarre [ GitHub ] – Co-developer
Noé Chauveau [ GitHub ] – Co-developer
Pierre Favary [ GitHub ] – Co-developer

Contact

Project Link : https://github.com/PIR-IDS/wallet-card

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