# libpax

**Repository Path**: danmu_admin/libpax

## Basic Information

- **Project Name**: libpax
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-20
- **Last Updated**: 2026-07-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LibPAX

A library to estimate passenger (PAX) count based on Wi-Fi & Bluetooth signals based on the ESP32 chip.
This is a library meant to be used for enabling pax-counting in other projects.
For an application facilitating pax-counting, see [ESP32-Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter).
The library was extracted from the ESP32-Paxcounter project to enhance reusability.

## Usage

For using the library please refer to `libpax_api.h`.
All functions outside the `libpax_api.h` are considered internal and might change between releases.

**Note**: The library is not thread-safe.

### Compile time options

You must define one of the following compile time constants to select the framework you are working with:

```plain
LIBPAX_ARDUINO
LIBPAX_ESPIDF
```

To select the supported counting method you may use:

```plain
LIBPAX_WIFI 
LIBPAX_BLE
```

The number of remembered devices is limited to a maximum of 65535, requiring 8 KBytes of RAM.

## Examples

The `src` folder contains an example how to use libpax.

## Tests

The library contains unit tests, which can be run via:

```sh
pio test -e espidf -e arduino
```

Please note: The tests are executed on an esp32 which must be connected via USB.

## Changelog

Please refer to our separate [CHANGELOG.md](CHANGELOG.md) file for differences between releases.