noiapp-upy-esp32's Introduction

NOIAPP micropython apps & tools for ESP32

This project contains micropython implementations to interact with BLE with contact tracing devices.

Getting Started

These instructions will get you a copy of the project up and running on your eps32 board for development and testing purposes.

Prerequisites

To play with this software you neeed:

An Expressif ESP32 board;
to fullfill requirements for micropython for esp32:
- Micropython on the board, see here
- esptool
- A local version of Python3 with pyserial library
- A bash shell (Linux/Mac/Windows with Git Bash)

Installing

./setup.sh <serial>

where <serial> is the name of your serial device.

Executing

You can now run the tools by name with:

./run.sh <tool> [-f] args...

where

<tool> is the name of the script in tools without .py
-f follow the output indefinitely (press ^C to interrupt)
you can pass multiple args as strings (but do not put single quotes in it!)

args are then available inside the script in the array args as strings, and args[0] is the script name.

Tools

BLE sniffer

This simple tool scan for BLE advertising and output some information to help beacon analysis.

usage: ./run.sh bleSniffer -f 2000

the 2000 is the number of milliseconds it must be listening.

Contributing

Please read (italian) help us for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

noiapp-upy-esp32's People

Contributors

Stargazers

Watchers

noiapp-upy-esp32's Issues

Refactoring in lib and cmd folders

Place libraries under lib folder.
Place scripts under cmd folder.
The ./setup.sh should install files under lib in the device.
The ./run.sh should execute a script under cmd.

Generate Exposure Notification Service payload according A/G

The Exposure Notification Service payload has four sections:

Flags Section — Bluetooth Low Energy general discoverable mode (bit 1) shall be set to 1.
Complete 16-bit Service UUID Section — The UUID is 0xFD6F, and shall precede the Service Data section.
Service Data 16-bit UUID Section — This section shall have two different sections in its payload:
a. A 16 byte Rolling Proximity Identifier.
b. A 4 byte Associated Encrypted Metadata that contains the following (LSB first):
i. Byte 0 — Versioning.
• Bits 7:6 — Major version (01).
• Bits 5:4 — Minor version (00).
• Bits 3:0 — Reserved for future use.
ii. Byte 1 — Transmit power level.
• This is the measured radiated transmit power of Bluetooth Advertisement packets, and is used to
improve distance approximation. The range of this field shall be -127 to +127 dBm.
iii. Byte 2 — Reserved for future use.
iv. Byte 3 — Reserved for future use.

noiapp / noiapp-upy-esp32 Goto Github PK