Git Product home page Git Product logo

libpax's Introduction

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. The library was extracted from the ESP32-Paxcounter project to enhance reusability.

Current version: 1.0.0 RC1

A 1.0 should follow shortly, after which API is considered stable.

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.

Compile time options

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

LIBPAX_ARDUINO
LIBPAX_ESPIDF

To select the supported counting method you may use:

LIBPAX_WIFI 
LIBPAX_BLE

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

Examples

The /examples folder contains an

Tests

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

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 file for differences between releases.

libpax's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.